Как написать тест чтобы защититься от race condition?

Question

[di]

Допустим есть у меня некая библиотека

package v1

var balance int

//Deposit ...
func Deposit(amount int) {
	balance = balance + amount
}

//Balance ...
func Balance() int {
	return balance
}

func setBalance(amount int) {
	balance = amount
}

Здесь возможно состояние гонки, если вызвать функцию в разных горутинах.

Имеет ли право на жизнь такой тест кейс?

func TestRaceDeposit(t *testing.T) {
	setBalance(0)
	ch := make(chan struct{})
	go func() {
		Deposit(10)
		ch <- struct{}{}
	}()
	Deposit(10)
	<-ch
	if Balance() != 20 {
		t.Errorf("unexpected balance: value - %d expect 20", Balance())
	}
}

Чтобы при запуске тестов с флагом -race иметь возможность отлавливать состояние гонки

Comments

[di]

Спасибо Владислав Фурсов, Роман Мирр, uvelichitel за участие) В конечном итоге тесты написал следующие)

func TestDeposit(t *testing.T) {
	setBalance(0)
	Deposit(100)
	expect := 100
	got := Balance()
	if got != expect {
		t.Errorf(
			"unexpected balance: value - %d expect %d", got, expect)
	}
}

func TestRaceDeposit(t *testing.T) {
	go Deposit(10)
	Deposit(10)
}

Answer 1

[Владислав]

Я бы написал так

func TestRaceDeposit(t *testing.T) {
	setBalance(0)

	var wg sync.WaitGroup
	for i := 0; i < 10; i++ {
		wg.Add(1)
		go func() {
			Deposit(10)
			wg.Done()
		}()
	}

	wg.Wait()

	expect := 100
	got := Balance()
	if got != expect {
		t.Errorf("unexpected balance: value - %d expect %d", got, expect)
	}
}

Comments

[d'Ivan]

go func() {
      Deposit(10)
      wg.Done()
    }()

еще можно так:

go func() {
      defer wg.Done()
      Deposit(10)
    }()

[Владислав]

Роман Мирр, обычно я всегда пишу с использованием defer, но в данном случае спокойно можно обойтись без него, так как тут всего 2 строки.

Answer 2

[uvelichitel]

Race detector достаточно умный, не требует ничего военно-специфического вроде sync.WaitGroup. Чтобы диагностировать race достаточно просто обратиться к незащищенным данным асинхронно.

func TestRaceDeposit(t *testing.T) {
  setBalance(0)
  go Deposit(10)   //Просто этого вызова уже достаточно
  Deposit(10)
  if Balance() != 20 {
    t.Errorf("unexpected balance: value - %d expect 20", Balance())
  }
}

Comments

[di]

есть трабла в том что Balance() не будет равен 20, надо дождаться пока горутина выполнит свою работу до конца.
А так да, согласен. Если убрать проверку
if Balance() != 20 {
то все хорошо будет.
Может быть ее как раз следует убрать?

[uvelichitel]

Alex, В тестах вы проверяете корректность логики. if Balance() != 20 { проверяет правильно ли работает ваш balanse. Флаг -race добавляет проверку на защищенность данных.

[Владислав]

Я бы не сказал, что он умный(хотя может поумнел), у меня в практике был случай(где-то на go 1.8), когда без цикла с запуском нескольких горутин, race детектился через раз, что не подобает нормальному тесту, но там и функция была сложнее. После этого я стал использовать циклы.