День 14 · Первый тест: go test · страница 1 из 7

Зачем тест и как устроен первый

В днях 11–13 появились свои функции. Функцию пишут один раз, а вызывают из разных мест и правят потом много раз: поменялась цена, добавился ещё один порог, вынесли кусок в отдельную функцию. После каждой такой правки надо знать, считает ли она по-прежнему верно.

До сих пор ответ на этот вопрос вы получали руками: запустили программу, посмотрели на числа, сравнили с тем, что посчитали на бумаге. Сегодня эту работу начнёт делать программа — тест.

Ручная проверка: что с ней не так

Ситуация. Есть функция, которая считает стоимость заказа в копейках: цена 4500 коп. за штуку, от 12 штук скидка 10 процентов.

package main

func price(qty int) int {
	total := qty * 4500
	if qty >= 12 {
		total = total - total/10
	}
	return total
}

Чтобы посмотреть на неё в работе, рядом пишут main, который её зовёт:

package main

import "fmt"

func main() {
	fmt.Println(price(3))
	fmt.Println(price(12))
}

Что увидите.

stagiaire@lab:~/gocourse/day14/scratch$ go run .
13500
48600

Как это читать. 3 × 4500 = 13500 — скидки нет, порог не взят. 12 × 4500 = 54000, скидка 5400, к оплате 48600. Числа сошлись с тем, что посчитано на бумаге. Функция работает.

Проверка заняла минуту, и у неё четыре беды:

Тест снимает все четыре: это программа, которая вызывает вашу функцию и сама сравнивает результат с ожидаемым. Она лежит рядом с кодом, её запускают одной командой, и запускать её может кто угодно и сколько угодно раз.

Тест — это тоже программа

В Go для тестов не нужно ничего устанавливать: они встроены в язык и в команду go. Правил всего четыре, и они жёсткие — по ним go test находит тесты сам.

Первый тест к функции price целиком:

package main

import "testing"

func TestPrice(t *testing.T) {
	got := price(3)
	want := 13500
	if got != want {
		t.Errorf("price(3) = %d, хотели %d", got, want)
	}
}

Что увидите.

stagiaire@lab:~/gocourse/day14/scratch$ go test .
ok  	day14/scratch	0.005s

Как это читать — по строкам.

ok и имя пакета — весь вывод удачного прогона. day14/scratch — путь пакета: имя модуля из go.mod и каталог. 0.005s — время прогона, у вас будет своё число.

Имена got и want — общая привычка: так тесты пишут и в стандартной библиотеке Go, и в рабочих проектах. Не «правильный ответ» и «мой ответ», а «получено» и «хотели».

Попробуйте сейчас: функция и ручная проверка.

Цель: в scratch лежит функция price, и вы видите её результат глазами.

1. Наберите функцию в отдельный файл:

✎ Наберите в файл scratch/price.goКопировать

package main

func price(qty int) int {
	total := qty * 4500
	if qty >= 12 {
		total = total - total/10
	}
	return total
}

2. Замените заготовку scratch/main.go на вызов этой функции:

✎ Наберите в файл scratch/main.goКопировать

package main

import "fmt"

func main() {
	fmt.Println(price(3))
	fmt.Println(price(12))
}

3. Запустите:

▶ ВыполнитеКопировать

cd ~/gocourse/day14/scratch
go run .

Готово, когда: программа напечатала две строки — 13500 и 48600. Два файла в одном каталоге — это один пакет: main.go видит price без всяких импортов, как в дне 13.

Что делает go test

Команда go test . — точка значит «пакет в текущем каталоге» — делает четыре шага:

1. собирает пакет вместе с файлами _test.go;
2. находит в нём все функции, чьё имя начинается с Test и у которых правильный параметр;
3. запускает каждую такую функцию;
4. печатает итог: ok, если ни одна не пожаловалась, и FAIL, если хоть одна пожаловалась.

Файлы _test.go попадают только в тестовую сборку. Обычная сборка их не видит — тест не увеличивает вашу программу и не попадает к пользователю:

stagiaire@lab:~/gocourse/day14/scratch$ go run .
13500
48600
stagiaire@lab:~/gocourse/day14/scratch$ go build .
stagiaire@lab:~/gocourse/day14/scratch$ gofmt -l .

go run печатает то же, что печатал до появления теста, go build молча собирает программу, gofmt -l не жалуется — файл теста форматируется по тем же правилам, что и остальной код.

Второй запуск go test подряд выглядит иначе:

stagiaire@lab:~/gocourse/day14/scratch$ go test .
ok  	day14/scratch	(cached)
stagiaire@lab:~/gocourse/day14/scratch$ go test -count=1 .
ok  	day14/scratch	0.009s

(cached) значит: ни один файл пакета не менялся, результат тот же, что в прошлый раз, — прогонять заново не за чем. Это не ошибка и не обман: как только вы поправите хоть один файл, тест прогонится по-настоящему. Ключ -count=1 заставляет прогнать заново в любом случае.

Попробуйте сейчас: первый тест.

Цель: go test . в scratch печатает ok.

1. Наберите тест в файл рядом с кодом:

✎ Наберите в файл scratch/price_test.goКопировать

package main

import "testing"

func TestPrice(t *testing.T) {
	got := price(3)
	want := 13500
	if got != want {
		t.Errorf("price(3) = %d, хотели %d", got, want)
	}
}

2. Запустите тест, потом ещё раз:

▶ ВыполнитеКопировать

cd ~/gocourse/day14/scratch
go test .
go test .

3. И убедитесь, что обычный запуск программы не изменился:

▶ ВыполнитеКопировать

go run .

Готово, когда: первый go test . напечатал ok и время, второй — ok и (cached), а go run . печатает те же две строки — пункт t_test.

Что может пойти не так

Три частые беды — и все три не про вашу логику, а про правила из таблицы выше. go test про них говорит по-разному.

Файл назван pricetest.go вместо price_test.go — тест просто не найден:

?   	day14/scratch	[no test files]

Знак ? вместо ok значит «тестов нет». Это не ошибка, код возврата нулевой — и поэтому такую беду легко не заметить.

Имя функции начинается с маленькой буквы (testPrice):

ok  	day14/scratch	0.005s [no tests to run]

Файл найден, а тестовых функций в нём нет: имя должно начинаться с Test, и следующая буква — заглавная.

Забыли import "testing":

# day14/scratch [day14/scratch.test]
./price_test.go:3:19: undefined: testing
FAIL	day14/scratch [build failed]
FAIL

Это обычная ошибка компилятора, такая же, как в дне 01: файл, строка, колонка, причина. [build failed] — «пакет даже не собрался», до запуска тестов дело не дошло.

Попробуйте сейчас: репозиторий дня.

Цель: в ~/gocourse/day14 есть репозиторий с первым коммитом — заготовками дня. Каждое задание дальше заканчивается своим коммитом, тест коммитится вместе с кодом.

▶ ВыполнитеКопировать

cd ~/gocourse/day14
git init
git add .
git commit -m "день 14: заготовки"
git log --oneline

Готово, когда: git log --oneline печатает одну строку с вашим сообщением. Если git просит подпись автора — git config --global user.name и user.email, как в дне 11. Что и когда коммитят — седьмая страница.

Дальше: как читать вывод упавшего теста — course next