Это второе из серии руководств по модульному тестированию языка Go с нуля. В нем рассказывается, как использовать инструменты go-sqlmock и miniredis для проведения пробного тестирования MySQL и Redis.
В предыдущей статье «Go Single Test Series 2 — Сетевое тестирование» мы рассказали, как использовать инструменты httptest и gock для сетевого тестирования. Помимо сетевых зависимостей, мы также часто используем в разработке различные базы данных, такие как распространенные MySQL и Redis. В этой статье будут приведены примеры, демонстрирующие, как имитировать MySQL и Redis при написании модульных тестов.
Пример кода «Пройдите одиночный тест от нуля до скользкой серии» загружен на Github.,Нажмите👉🏻https://github.com/go-quiz/golang-unit-test-demo Посмотреть полный исходный код.
sqlmock это реализация sql/driver
макетная библиотека. Для имитации каких-либо действий не требуется устанавливать реальное соединение с базой данных. sql поведение водителя. Его очень удобно использовать для макетирования при написании модульных тестов. Результат выполнения оператора sql.
go get github.com/DATA-DOG/go-sqlmock
Здесь используетсяgo-sqlmock
Базовый пример кода, представленный в официальной документации.。 В коде ниже,Мы реализовалиrecordStats
Эта функция используется для записи соответствующих данных, генерируемых при просмотре продуктов пользователями.。Конкретная реализованная функция заключается в выполнении следующих действий дважды за одну транзакцию.SQLдействовать: - существоватьproducts
Количество просмотров текущего товара в таблице+1 - существоватьproduct_viewers
В таблице фиксируются пользователи, просматривавшие текущий продукт.id
// app.go
package main
import "database/sql"
// recordStats Записывайте информацию о продукте, просматриваемом пользователем
func recordStats(db *sql.DB, userID, productID int64) (err error) {
// Открыть транзакцию
// Управляйте таблицами представлений и product_viewers.
tx, err := db.Begin()
if err != nil {
return
}
defer func() {
switch err {
case nil:
err = tx.Commit()
default:
tx.Rollback()
}
}()
// Обновить таблицу продуктов
if _, err = tx.Exec("UPDATE products SET views = views + 1"); err != nil {
return
}
// Вставьте часть данных в таблицу Product_viewers.
if _, err = tx.Exec(
"INSERT INTO product_viewers (user_id, product_id) VALUES (?, ?)",
userID, productID); err != nil {
return
}
return
}
func main() {
// ПРИМЕЧАНИЕ. Процесс тестирования не требует реального подключения.
db, err := sql.Open("mysql", "root@/blog")
if err != nil {
panic(err)
}
defer db.Close()
// Пользователь с идентификатором пользователя 1 просмотрел продукт с идентификатором продукта 5.
if err = recordStats(db, 1 /*some user id*/, 5 /*some product id*/); err != nil {
panic(err)
}
}
сейчассуществоватьмы должныкодсерединаизrecordStats
Написание функций Модульное тестирование,Но не хочусуществоватьтест Во время процесса подключитесь к реальной базе данных.тест。На данный момент мы можем использовать его, как показано в примере кода ниже.sqlmock
Инструменты, которые можно использоватьmockданные Библиотекадействовать。
package main
import (
"fmt"
"testing"
"github.com/DATA-DOG/go-sqlmock"
)
// TestShouldUpdateStats вариант использования успешного выполнения sql
func TestShouldUpdateStats(t *testing.T) {
// Имитация объекта *sql.DB без подключения к реальной базе данных
db, mock, err := sqlmock.New()
if err != nil {
t.Fatalf("an error '%s' was not expected when opening a stub database connection", err)
}
defer db.Close()
// Возвращаемый результат, когда макет выполняет указанный оператор SQL
mock.ExpectBegin()
mock.ExpectExec("UPDATE products").WillReturnResult(sqlmock.NewResult(1, 1))
mock.ExpectExec("INSERT INTO product_viewers").WithArgs(2, 3).WillReturnResult(sqlmock.NewResult(1, 1))
mock.ExpectCommit()
// Передайте макет объекта БД в нашу функцию.
if err = recordStats(db, 2, 3); err != nil {
t.Errorf("error was not expected while updating stats: %s", err)
}
// Обеспечить достижение ожидаемых результатов
if err := mock.ExpectationsWereMet(); err != nil {
t.Errorf("there were unfulfilled expectations: %s", err)
}
}
// TestShouldRollbackStatUpdatesOnFailure Вариант использования теста для сбоя выполнения и отката sql
func TestShouldRollbackStatUpdatesOnFailure(t *testing.T) {
db, mock, err := sqlmock.New()
if err != nil {
t.Fatalf("an error '%s' was not expected when opening a stub database connection", err)
}
defer db.Close()
mock.ExpectBegin()
mock.ExpectExec("UPDATE products").WillReturnResult(sqlmock.NewResult(1, 1))
mock.ExpectExec("INSERT INTO product_viewers").
WithArgs(2, 3).
WillReturnError(fmt.Errorf("some error"))
mock.ExpectRollback()
// now we execute our method
if err = recordStats(db, 2, 3); err == nil {
t.Errorf("was expecting an error, but there was none")
}
// we make sure that all expectations were met
if err := mock.ExpectationsWereMet(); err != nil {
t.Errorf("there were unfulfilled expectations: %s", err)
}
}
В приведенном выше коде определены тестовый пример, который выполняется успешно, и тестовый пример, в котором не удается выполнить откат, чтобы гарантировать возможность тестирования каждой логической ветки в нашем коде, что не только улучшает покрытие модульными тестами, но и обеспечивает стабильность кода. Прочность.
Выполните модульный тест и посмотрите окончательные результаты теста.
❯ go test -v
=== RUN TestShouldUpdateStats
--- PASS: TestShouldUpdateStats (0.00s)
=== RUN TestShouldRollbackStatUpdatesOnFailure
--- PASS: TestShouldRollbackStatUpdatesOnFailure (0.00s)
PASS
ok golang-unit-test-demo/sqlmock_demo 0.011s
Вы можете видеть, что результаты обоих тестовых случаев соответствуют ожиданиям, и модульный тест пройден.
Во многих сценариях использования инструментов ORM,Также можно использоватьgo-sqlmock
Библиотекаmockданные Библиотекадействоватьруководитьтест。
Помимо частого использования MySQL, Redis также часто используется в повседневной разработке. В следующем разделе мы узнаем, как имитировать операции, связанные с Redis, при модульном тестировании.
miniredisэто чистыйgoреализовано для Модульное тестированиеизredis server。Это простой и удобный в использованиииз、основанный на памятиизredisЗаменять,Он имеет настоящий TCP-интерфейс,Вы можете думать об этом какredisВерсияизnet/http/httptest
。
Когда мы пишем модульные тесты для некоторого кода, содержащего операции Redis, мы можем использовать его для имитации операций Redis.
go get github.com/alicebob/miniredis/v2
здесь сgithub.com/go-redis/redis
Библиотека Например,Программа, содержащая несколькоRedisдействоватьизDoSomethingWithRedis
функция。
// redis_op.go
package miniredis_demo
import (
"context"
"github.com/go-redis/redis/v8" // Обратите внимание на импортированную версию
"strings"
"time"
)
const (
KeyValidWebsite = "app:valid:website:list"
)
func DoSomethingWithRedis(rdb *redis.Client, key string) bool {
// Здесь может быть некоторая логика для операций Redis
ctx := context.TODO()
if !rdb.SIsMember(ctx, KeyValidWebsite, key).Val() {
return false
}
val, err := rdb.Get(ctx, key).Result()
if err != nil {
return false
}
if !strings.HasPrefix(val, "https://") {
val = "https://" + val
}
// настраивать blog key Срок действия истекает через пять секунд
if err := rdb.Set(ctx, "blog", val, 5*time.Second).Err(); err != nil {
return false
}
return true
}
подизкодда, я используюminiredis
БиблиотекадляDoSomethingWithRedis
Написание функцийиз Модульное тестированиекод,вminiredis
не только поддержкаmockОбычно используетсяизRedisдействовать,Он также предоставляет множество практических справочных функций.,Например, проверьтеkeyиз Соответствует ли значение ожидаемомуизs.CheckGet()
и помогите проверитьkeyСрок годностиизs.FastForward()
。
// redis_op_test.go
package miniredis_demo
import (
"github.com/alicebob/miniredis/v2"
"github.com/go-redis/redis/v8"
"testing"
"time"
)
func TestDoSomethingWithRedis(t *testing.T) {
// издеваться над Redis server
s, err := miniredis.Run()
if err != nil {
panic(err)
}
defer s.Close()
// Подготовьте данные
s.Set("q1mi", "liwenzhou.com")
s.SAdd(KeyValidWebsite, "q1mi")
// Подключите Redis макета server
rdb := redis.NewClient(&redis.Options{
Addr: s.Addr(), // mock redis адрес сервера
})
// функция вызова
ok := DoSomethingWithRedis(rdb, "q1mi")
if !ok {
t.Fatal()
}
// Вы можете вручную проверить, составляет ли значение в Redis ожидаемое значение.
if got, err := s.Get("blog"); err != nil || got != "https://liwenzhou.com" {
t.Fatalf("'blog' has the wrong value")
}
// Вы также можете использовать справочный инструмент для проверки
s.CheckGet(t, "blog", "https://liwenzhou.com")
// Просроченный чек
s.FastForward(5 * time.Second) // Перемотка вперед на 5 секунд
if s.Exists("blog") {
t.Fatal("'blog' should not have existed anymore")
}
}
Выполните тест выполнения и просмотрите результаты модульного теста:
❯ go test -v
=== RUN TestDoSomethingWithRedis
--- PASS: TestDoSomethingWithRedis (0.00s)
PASS
ok golang-unit-test-demo/miniredis_demo 0.052s
miniredis
В основном поддерживает подавляющее большинствоизRedisЗаказ,Вы можете узнать больше об использовании, просмотрев документацию.
Конечно, помимо использованияminiredis
Построить локальноredis Помимо серверного метода, для укладки отдельных методов также можно использовать различные инструменты для укладки свай. Конкретный метод макетирования, который следует использовать при написании модульных тестов, по-прежнему зависит от реальной ситуации.
Написание кода для ежедневной работы Модульное тестирование时如何处理данные Библиотекаиз Зависимости являются наиболее распространенными.извопрос,В этой статье объясняется, как использоватьgo-sqlmock
иminiredis
инструментmockСвязанные зависимости。 В следующей статье мы пойдем еще дальше и подробно представим, как имитировать интерфейсы при написании модульных тестов.