以前没有针对 Spanner 的数据层单元测试框架,后端服务在完成编码后 DAO 层单测的数据,基本经过 Mock 的方式,或对测试数据库的读写来实现。这种单测手段存在一些问题:node
目前公司部分服务的单元测试依赖以上两种方式, 本文介绍一种经过模拟 Spanner 的方式, 来解决以上问题。linux
目前有两个业界用得比较多的 Spanner 的模拟器:git
本文仅介绍 cloud-spanner-emulator。github
注:使用 handy-spanner 做为单测和 BDD 测试 的数据存储也是一个不错的选择, 关于 BDD 测试 , 可参考 Go 项目的 BDD 实践
cloud-spanner-emulator 支持如下几种方式完成初始化:sql
本地能够经过 gcloud 的方式调用 spanner emulator:docker
gcloud config configurations create emulator gcloud config set auth/disable_credentials true gcloud config set project your-project-id gcloud config set api_endpoint_overrides/spanner http://localhost:9010/ gcloud spanner instances create test-instance \ --config=emulator-config --description="Test Instance" --nodes=1
线上经过预编译 linux 二进制程序 + docker 镜像提供 spanner emulator 环境。shell
对于线上和线下环境 spanner 模拟器初始化步骤的差别,可在项目中的 unit_test.sh 脚本作处理:数据库
# export spanner emulator env if [ "x_$NODE_ENV" != "x_local" ]; then /spanner/emulator/init.sh /spanner/emulator/start.sh fi export SPANNER_EMULATOR_HOST=localhost:9010
以 Go 项目为例, 咱们的开发脚手架封装有一个 spannerClient,对 DB 的 CURD 操做经过同一个全局的 spannerClient 完成。因此要接入 Cloud Spanner Emulator 仅仅须要在初始化 spannerClient 连上测试的 DB实例:segmentfault
var db = "projects/emulator-project/instances/emulator-instance/databases/example-db" func InitTestingSpannerClient() { cli, err := spanner.NewClient(context.TODO(), db, spanner2.ClientConfig{SessionPoolConfig: spanner2.SessionPoolConfig{ MaxOpened: 200, MinOpened: 5, MaxIdle: 10, }}) if err != nil { logger.Critical(context.TODO(), "Connecting to spanner emulator failed: %v!", zap.Error(err)) } spannerClient = cli }
同时咱们须要初始化一个 AdminClient, 用于调用Cloud Spanner数据库管理API, 进行 DDL 操做:后端
func InitTestingSpannerAdminClient() { emulatorAddr := os.Getenv("SPANNER_EMULATOR_HOST") var opts []option.ClientOption opts = append( opts, option.WithEndpoint(emulatorAddr), option.WithGRPCDialOption(grpc.WithInsecure()), option.WithoutAuthentication(), ) var err error TestingSpannerAdminClient, err = dbadmin.NewDatabaseAdminClient(context.Background(), opts...) if err != nil { panic(fmt.Sprintf("Setting up testing's Spanner admin client failed: %v", err)) } }
初始化 spannerClient 和 spannerAdminClient 以后, 在作单元测试以前建立数据表,并灌数据到 Emulator。 封装了如下函数,经过原生 Spanner SDK 直接操做数据:
建立 Tables:
func CreateTables(ctx context.Context, statements []string) error { matches := regexp.MustCompile("^(.*)/databases/(.*)$").FindStringSubmatch(db) if matches == nil || len(matches) != 3 { return fmt.Errorf("Invalid database id %s", db) } // if db.State == "READY" _, err := TestingSpannerAdminClient.GetDatabase(ctx, &dbadminpb.GetDatabaseRequest{ Name: db, }) if err == nil { return nil } op, err := TestingSpannerAdminClient.CreateDatabase(ctx, &adminpb.CreateDatabaseRequest{ Parent: matches[1], CreateStatement: "CREATE DATABASE `" + matches[2] + "`", ExtraStatements: statements, }) if err != nil { return err } if _, err := op.Wait(ctx); err != nil { return err } return nil }
更新 Schema:
func UpdateMockData(ctx context.Context, statements ...string) error { op, err := TestingSpannerAdminClient.UpdateDatabaseDdl(ctx, &dbadminpb.UpdateDatabaseDdlRequest{ Database: dbName, Statements: statements, }) if err != nil { return err } return op.Wait(mockCtx) }
删除 Mock 数据:
func DeleteMockData(ctx context.Context, table string, key interface{}) (err error) { _, err = spannerClient.NativeClient().Apply(ctx, []*spanner2.Mutation{ spanner2.Delete(table, spanner2.Key{key}), }) return }
新增 Mock 数据:
func InsertMockData(table string, keys []string, vals []interface{}) (err error) { _, err = spannerClient.NativeClient().Apply(context.TODO(), []*spanner2.Mutation{spanner2.Insert(table, keys, vals)}) return }
查询 Mock 数据:
func GetMockData(query string, params map[string]interface{}) ([]interface, error) { stmt := spanner2.NewStatement(query) stmt.Params = params rows := spannerClient.NativeClient().Single().Query(context.TODO(), stmt) var ret []interface{} err := rows.Do(func(row *spanner2.Row) error { var meta string if err := row.Columns(&meta); err != nil { return fmt.Errorf("decode Colunms error: %v", err) } ret = append(ret, meta) return nil }) if err != nil { return ret, err } return ret, nil
本文主要介绍了官方的 Cloud Spanner Emulator: 如何初始化环境、进行单元测试以及对 Mock 数据的处理 。经过 Spanner Emulator, 来弥补 GCP Spanenr 在 DAO 层单元测试上的缺失。