storage_test_helper

Storage Test Helper

一、这是什么

用于辅助测试Storage的实现是否OK的测试工具，辅助提高开发效率。

二、安装依赖

go get -u github.com/storage-lock/go-storage-test-helper

三、如何使用

3.1 实现Storage

根据存储介质的特性自行实现Storage，这里就随便找一个空实现的例子，这个例子是肯定跑不过测试的，只是为了演示流程使用：

package examples

import (
	"context"
	"github.com/golang-infrastructure/go-iterator"
	"github.com/storage-lock/go-storage"
	"time"
)

type FooStorage struct {
}

var _ storage.Storage = &FooStorage{}

func (x *FooStorage) GetName() string {
	return ""
}

func (x *FooStorage) Init(ctx context.Context) error {
	return nil
}

func (x *FooStorage) UpdateWithVersion(ctx context.Context, lockId string, exceptedVersion, newVersion storage.Version, lockInformation *storage.LockInformation) error {
	return nil
}

func (x *FooStorage) CreateWithVersion(ctx context.Context, lockId string, version storage.Version, lockInformation *storage.LockInformation) error {
	return nil
}

func (x *FooStorage) DeleteWithVersion(ctx context.Context, lockId string, exceptedVersion storage.Version, lockInformation *storage.LockInformation) error {
	return nil
}

func (x *FooStorage) Get(ctx context.Context, lockId string) (string, error) {
	return "", nil
}

func (x *FooStorage) GetTime(ctx context.Context) (time.Time, error) {
	return time.Now(), nil
}

func (x *FooStorage) Close(ctx context.Context) error {
	return nil
}

func (x *FooStorage) List(ctx context.Context) (iterator.Iterator[*storage.LockInformation], error) {
	return nil, nil
}

3.2 添加依赖

在你自己的Storage实现的差不多了的时候，在此项目中执行：

go get -u github.com/storage-lock/go-storage-test-helper

把此测试库添加到你自己的Storage的依赖中。

3.3 创建单元测试

为你的Storage创建一个单元测试，比如下面是测试FooStorage：

package examples

import (
	storage_test_helper "github.com/storage-lock/go-storage-test-helper"
	"testing"
)

func TestFooStorage(t *testing.T) {
	// 在要测试的Storage实现的仓库中创建好Storage，然后传递给方法测试
	storage_test_helper.TestStorage(t, &FooStorage{})
}

再看一个更贴近实际例子的，比如下面是一个MySQL Storage的单元测试：

package mysql_storage

import (
	"context"
	storage_test_helper "github.com/storage-lock/go-storage-test-helper"
	"github.com/stretchr/testify/assert"
	"os"
	"testing"
)

func TestNewMySQLStorage(t *testing.T) {
	envName := "STORAGE_LOCK_MYSQL_DSN"
	dsn := os.Getenv(envName)
	assert.NotEmpty(t, dsn)
	connectionGetter := NewMySQLConnectionManagerFromDSN(dsn)
	s, err := NewMySQLStorage(context.Background(), &MySQLStorageOptions{
		ConnectionManager: connectionGetter,
		TableName:         "storage_lock_test",
	})
	assert.Nil(t, err)
    // 重点在与这一句，把 *testing.T 和 storage.Storage 传进去 
	storage_test_helper.TestStorage(t, s)
}

保证此单元测试通过，你可以在CI中执行单元测试以保证你每次修改之后Storage都能够正常工作。