В этой статье для реализации модульного тестирования в основном используются инструменты Ginkgo[2], gomock[3] и Gomega[4]. Студенты, которые раньше этого не понимали, могут сначала ознакомиться с соответствующими документами.
$ go get github.com/onsi/ginkgo/v2/ginkgo
$ go get github.com/onsi/gomega
Первая команда — получить ginkgo и установить ginkgo исполняемый файл в GOPATH/bin –- Вам нужно поставить его на свой компьютер GOPATH Настройте его и настройте. Вторая команда устанавливает все gomega библиотека. Таким образом, вы можете импортировать gomega Включите это в свой тестовый код:
import "github.com/onsi/gomega"
import "github.com/onsi/ginkgo"
Ginkgo подключается к существующей инфраструктуре тестирования Go, и вы можете использовать go test для запуска пакета Ginkgo. Это также означает, что тесты Ginkgo можно использовать наряду с традиционным тестированием Go. И go test, и ginkgo проведут все тесты в вашем наборе.
Используйте Dockertest для завершения интеграционного теста базы данных соединений Golang нашего сервиса. Библиотека Dockertest предоставляет простые в использовании команды для запуска контейнеров Docker и их использования для тестирования. Простое понимание инструмента Dockertest заключается в использовании Docker для создания контейнера, его остановки и удаления после завершения тестового запуска. Более подробную информацию можно найти в официальном представлении Dockertest[5].
Установите Докертест
go get -u github.com/ory/dockertest/v3
Напишите код конфигурации Dockertest и используйте его для тестирования. Перейдите в service/user/internal/data/ и создайте в каталоге новый файл docker_mysql.go. Напишите код следующим образом:
package data
import (
"database/sql"
"fmt"
"github.com/ory/dockertest/v3" // Обратите внимание на введение этого индивидуального пакета.
"log"
"time"
)
func DockerMysql(img, version string) (string, func()) {
return innerDockerMysql(img, version)
}
// инициализация Docker mysql контейнер
func innerDockerMysql(img, version string) (string, func()) {
// uses a sensible default on windows (tcp/http) and linux/osx (socket)
pool, err := dockertest.NewPool("")
pool.MaxWait = time.Minute * 2
if err != nil {
log.Fatalf("Could not connect to docker: %s", err)
}
// pulls an image, creates a container based on it and runs it
resource, err := pool.Run(img, version, []string{"MYSQL_ROOT_PASSWORD=secret", "MYSQL_ROOT_HOST=%"})
if err != nil {
log.Fatalf("Could not start resource: %s", err)
}
conStr := fmt.Sprintf("root:secret@(localhost:%s)/mysql?parseTime=true", resource.GetPort("3306/tcp"))
if err := pool.Retry(func() error {
var err error
db, err := sql.Open("mysql", conStr)
if err != nil {
return err
}
return db.Ping()
}); err != nil {
log.Fatalf("Could not connect to docker: %s", err)
}
// Функция обратного вызова закрывает контейнер
return conStr, func() {
if err = pool.Purge(resource); err != nil {
log.Fatalf("Could not purge resource: %s", err)
}
}
}
Используйте Ginkgo для написания тестового кода, который ссылается на Dockertest, или создайте новый файл data_suite_test.go в этом каталоге. Напишите код следующим образом: В коде есть подробные комментарии, поэтому я не буду объяснять его здесь слишком подробно.
package data_test
import (
"context"
"github.com/pkg/errors"
"gorm.io/gorm"
"testing"
"user/internal/conf"
"user/internal/data"
. "github.com/onsi/ginkgo"
. "github.com/onsi/gomega"
)
// тест data метод
func TestData(t *testing.T) {
// Ginkgo позвонив Fail(description string) функция, указывающая на сбой
// использовать RegisterFailHandler Передайте эту функцию Gomega ... это верно Ginkgo и Gomega единственная точка соединения между
RegisterFailHandler(Fail)
// уведомить Ginkgo Запустите тестовый пакет. Если кто-либо из ваших specs Неудача, Гинкго будет автоматически использовать testing.T неудача.
RunSpecs(t, "test biz data ")
}
var cleaner func() // Определить удаление mysql Функция обратного вызова контейнера
var Db *data.Data // используется для теста data
var ctx context.Context // контекст
// initialize AutoMigrate gorm метод, который автоматически создает таблицы
func initialize(db *gorm.DB) error {
err := db.AutoMigrate(
&data.User{},
)
return errors.WithStack(err)
}
// ginkgo использовать BeforeEach для твоего Specs Установить статус
var _ = BeforeSuite(func() {
// Перед выполнением тестовых операций с базой данных, перед связью docker Создано контейнером mysql
//con, f := data.DockerMysql("mysql", "latest")
con, f := data.DockerMysql("mariadb", "latest")
cleaner = f // Завершенный тест,Закрытие обратного вызова для контейнерметода
config := &conf.Data{Database: &conf.Data_Database{Driver: "mysql", Source: con}}
db := data.NewDB(config)
mySQLDb, _, err := data.NewData(config, nil, db, nil)
if err != nil {
return
}
if err != nil {
return
}
Db = mySQLDb
err = initialize(db)
if err != nil {
return
}
Expect(err).NotTo(HaveOccurred())
})
// После окончания теста Закрыть и удалить с помощью функции обратного вызова docker Создано контейнером
var _ = AfterSuite(func() {
cleaner()
})
Чтобы протестировать моделируемое соединение с базой данных, запустите команду go test в этом каталоге и получите следующие результаты:
Примечание. Здесь вы можете видеть, что, хотя есть 0 пройденных, есть также 0 сбойных. Это потому, что мы не проверяли это здесь. Мы просто проверяем, успешно ли соединение с базой данных, и мы не выполняли такие операции, как CURD. Операция здесь может быть медленной, поскольку образ mysql будет извлечен из Docker Hub. В этой статье используется образ mariadb, и я заранее загрузил образ mariadb:latest. Если на вашем компьютере установлен процессор Apple M1, рекомендуется использовать его. Мариадб.
Долгая подготовительная работа наконец завершена. Теперь давайте формально напишем код модульного теста.
Или создайте новый файл user_test.go в каталоге данных и напишите следующее содержимое:
package data_test
import (
. "github.com/onsi/ginkgo"
. "github.com/onsi/gomega"
"user/internal/biz"
"user/internal/data"
)
var _ = Describe("User", func() {
var ro biz.UserRepo
var uD *biz.User
BeforeEach(func() {
// Вот Db да data_suite_test.go определено в документе
ro = data.NewUserRepo(Db, nil)
// Здесь вы можете импортировать собранные извне данные.
uD = &biz.User{
ID: 1,
Mobile: "13803881388",
Password: "admin123456",
NickName: "aliliin",
Role: 1,
Birthday: 693629981,
}
})
// настраивать It Блок для добавления отдельной индивидуальной спецификации
It("CreateUser", func() {
u, err := ro.CreateUser(ctx, uD)
Ω(err).ShouldNot(HaveOccurred())
// собранные данные mobile для 13803881388
Ω(u.Mobile).Should(Equal("13803881388")) // Номер мобильного телефона должен быть номером мобильного телефона, записанным при создании для.
})
})
Ω — это синтаксис пакета gomega, а это использование пакета гинкго.
Или запустите команду go test в этом каталоге и получите следующие результаты:
// gomock В основном состоит из двух частей: gomock Библиотеки и вспомогательные инструменты генерации кода mockgen
go get github.com/golang/mock
go get github.com/golang/mock/gomock
Измените файл user/internal/biz/user.go.
package biz
// Обратите внимание, что эта строка добавляет mock команда данных
//go:generate mockgen -destination=../mocks/mrepo/user.go -package=mrepo . UserRepo
type UserRepo interface {
CreateUser(context.Context, *User) (*User, error)
}
Войдите в каталог biz и выполните команду
mockgen -destination=../mocks/mrepo/user.go -package=mrepo . UserRepo
Здесь мы используем инструмент Mockgen, предоставленный Gomock, для создания реализации интерфейса, который будет имитироваться. При создании кода макета мы используем инструмент Mockgen. Он может автоматически генерировать код на основе заданного интерфейса.
После выполнения вы увидите дополнительный файл service/user/internal/mocks/mrepo/user.go.
В каталоге уровня biz добавьте файл biz_suite_test.go со следующим содержимым:
package biz_test
import (
"context"
"github.com/golang/mock/gomock"
. "github.com/onsi/ginkgo"
. "github.com/onsi/gomega"
"testing"
)
func TestBiz(t *testing.T) {
RegisterFailHandler(Fail)
RunSpecs(t, "biz user test")
}
var ctl *gomock.Controller
var cleaner func()
var ctx context.Context
var _ = BeforeEach(func() {
ctl = gomock.NewController(GinkgoT())
cleaner = ctl.Finish
ctx = context.Background()
})
var _ = AfterEach(func() {
// remove any mocks
cleaner()
})
По-прежнему в каталоге бизнес-слоя добавьте новый файл user_test.go со следующим содержимым:
package biz_test
import (
"github.com/golang/mock/gomock"
. "github.com/onsi/ginkgo"
. "github.com/onsi/gomega"
"user/internal/biz"
"user/internal/mocks/mrepo"
)
var _ = Describe("UserUsecase", func() {
var userCase *biz.UserUsecase
var mUserRepo *mrepo.MockUserRepo
BeforeEach(func() {
mUserRepo = mrepo.NewMockUserRepo(ctl)
userCase = biz.NewUserUsecase(mUserRepo, nil)
})
It("Create", func() {
info := &biz.User{
ID: 1,
Mobile: "13803881388",
Password: "admin123456",
NickName: "aliliin",
Role: 1,
Birthday: 693629981,
}
mUserRepo.EXPECT().CreateUser(ctx, gomock.Any()).Return(info, nil)
l, err := userCase.Create(ctx, info)
Ω(err).ShouldNot(HaveOccurred())
Ω(err).ToNot(HaveOccurred())
Ω(l.ID).To(Equal(int64(1)))
Ω(l.Mobile).To(Equal("13803881388"))
})
})
Или запустите команду go test в каталоге бизнес-слоя и получите следующие результаты:
На данный момент метод тестирования операторов SQL на уровне данных и метод тестирования базовой логики в biz написаны и пройдены. Модульные тесты уровня сервиса аналогичны и не будут здесь писаться.