Upgrade to Pro — share decks privately, control downloads, hide ads and more …

自動テストのないプロダクトの開発効率化への道【DeNA TechCon 2021】/techc...

自動テストのないプロダクトの開発効率化への道【DeNA TechCon 2021】/techcon2021-14

昨今、クリーンアーキテクチャやDDDの流行によって、メンテナンス性が高くテストし易い設計のノウハウは広く知られてきたと思います。
しかし、それらを開発途中の実プロダクトに導入することは中々難しく、自動テストがない、入れるのが難しいと困っている方々も多いのではないでしょうか。
このセッションでは、メンテナンス性が低いプロダクトをどのようにすればメンテナンス性の高いプロダクトに向かうことができるのか、大きな流れを紹介します。
そして、自動テストを導入する為の第一歩として、Go言語プロダクトにおけるデータベースを利用したテストの事例紹介をしていきます。
その事例の中でテストデータ生成ツールを開発したのでそちらも合わせてご紹介します。

DeNA_Tech

March 03, 2021
Tweet

More Decks by DeNA_Tech

Other Decks in Technology

Transcript

  1. 参考文献:https://bit.ly/3nYqtgn Network Access Database File System Access Use external system

    Multiple threads Sleep Statements System properties Time limit (sec) Small No No No No No No No 60 Medium localhost Yes Yes Discouraged Yes Yes Yes 300 Large Yes Yes Yes Yes Yes Yes Yes 900+ テスト実行時にシステムやアプリが依存している 特性に基づいて、テストの大きさを3つに分類
  2. 1. 外から見た動作を変えないように 大きめのテスト(Medium や Large Test)を入れる 2. そのテストが担保している範囲でアプリケーショ ンの疎結合の度合いを上げるようなリファクタリ ングを実施

    3. Small Testを入れてより粒度の高い確認をする 具体的には「レガシーコードからの脱却」を参照 https://www.oreilly.co.jp/books/9784873118864/
  3. 1. データベースの Setup 2. テストデータの Setup 3. アプリケーションの Setup 4.

    アプリケーションの実行 5. テストアサーション 6. アプリケーションの Teardown 7. テストデータの Teardown 8. データベースの Teardown テストデータとテストケース をどうやって管理するの か? テストデータをどうやって削 除するのか?
  4. • 静的な生成 ◦ SQLファイルで管理 ◦ データフォーマットを基に生成 ▪ github.com/go-testfixtures/testfixtures • ◦

    ▪ github.com/bxcodec/faker ▪ github.com/bluele/factory-go 今回はコードでテストデー タを管理したい
  5. • テーブル駆動テストでわかりやすくしたい ◦ ◦ • テストは使い捨てではなく今後も使い続ける予定 ◦ • データベースにCloud Spannerを利用

    ◦ 内製のORMを利用 ◦ ◦ 外部キー制約を無効にできない テストデータ、基本は共通化しないが 特定の状態を再利用できるようにする
  6. package model type User struct { UserId string `spanner:”UserId” span:“id”`

    Name string `spanner:”Name”` Email string `spanner:”Email”` } package factory type User struct { UserId *string Name *string Email *string } // フィールドに入力された値を元にモデルを生成 func (u *User) Build() *User // 永続化 func (u *User) Create(...) (*User, error) user := user.Create(ctx, dbinstance) テストデータ入力用 の構造体を準備 この構造体を使って テストデータを生成 ポインタ型にすることによって値が入力 されているかゼロ値か判定できる 入力されていない場合はランダム値、 もしくはテスト用のデフォルト値を利用 テストに必要な フィールドだけ自 分で設定
  7. package model type User struct { UserId string `spanner:”ID” span:“id”`

    Name string `spanner:”Name”` Email string `spanner:”Email”` RegionId string `spanner:"RegionId" span:”id”` } package factory type User struct { model *model.User Region *Region UserId *string Name *string Email *string } // u.Region.Create() を実行してから自身も永続化 func (u *User) Create(...) (*User, error) user := (&factory.User{ Email: String(“example.invalid”), Region: &factory.Region{Name: String(“Japan”)}}).Build() user.Create(ctx, dbinstance) テストデータ入力用 の構造体を準備 この構造体を使って データ生成し、永続化 依存テーブルのPK Regionテーブルの データ入力用の構造体 依存テーブルを含むデータが生 成される nilの場合は自動で作られるよう にすることもできる
  8. package factory type interface { Databuild } type func func

    (f UserDatabuilderFunc) Databuild { return f(model) } package factory var UserTraits = struct { Banned func() UserDatabuilderFunc InvalidEmail func() UserDatabuilderFunc }{ Banned: func() UserDatabuilderFunc { return func(m *model.User) *model.User { m.Banned = true return m } }, InvalidEmail func() UserDatabuilderFunc { return func(m *model.User) *model.User { m.Email = “example.com/invalid” return m } }, } package model type User struct { ... Banned bool Email string } テストデータの組み立てを インターフェース化 入力パラメータを元にデータを生成するロ ジックもこのインターフェースで実装される どういった状態なのか、 クロージャーを使って それぞれ定義していく
  9. package model type User struct { UserId string `spanner:”ID” span:“id”`

    Name string `spanner:”Name”` Email string `spanner:”Email”` RegionId string `spanner:"AddressId" span:”id”` } package factory type User struct { Region *Region UserId *string Name *string Email *string } // 構造体に入力された値を元にモデルを生成 func (u *User) Build() *User // 構造体の永続化 func (u *User) Create(...) (*User, error) 依存関係あり データ入力用の構造体 とメソッドを自動生成 package factory type Region struct { RegionId *string Name *string } package model type Region struct { RegionId string `spanner:”ID” span:“id”` Name string `spanner:"Name"` } 依存関係ない
  10. func (t *testing.T) { type inputs struct { email string

    password string } tests := []struct { name string testData *factory.User inputs inputs wantErr bool }{ { name: "正常系: 登録されているリージョンからログインできること", testData: (&factory.User{ Region: &factory.Region{ Name: "Japan"}, Email: "[email protected]", PasswordHash: generateHash("password")}).Build(), inputs: inputs{ email: "[email protected]", password: "password", region: "Japan"}, wantErr: false, }, } • テスト名 • DBに入れるデータ • 検証対象の引数 • 戻り値の検証