テストコード例(Go)

## はじめに
Goを使用したテストコード例を記載します。
テスト例の記載に伴い、テストパターン、網羅性を少し検討してみました。

## テストコード例
以下は、Go言語で書かれたGORMを使用して、データベースにユーザーが存在しない場合に新しいユーザーを追加するテストケースの例です。

### テストケースの概要

- **関数の概要**: 特定の `UserID` と `TargetUserID` でユーザーを検索し、存在しない場合は新しいユーザーを追加する。
- **テストの目的**: ユーザーが存在しない場合に、新しいユーザーがデータベースに正しく追加されるかを確認する。

### テストコード

```go
package main

import (
    "log"
    "testing"
    "time"

    "gorm.io/driver/sqlite"
    "gorm.io/gorm"
)

type User struct {
    UserID       int `gorm:"primaryKey"`
    TargetUserID int `gorm:"primaryKey"`
    Name         string
    Timestamp    time.Time
}

func addUserIfNotExists(db *gorm.DB, userID, targetUserID int, name string) error {
    var user User
    err := db.Where("user_id = ? AND target_user_id = ?", userID, targetUserID).First(&user).Error
    if err == gorm.ErrRecordNotFound {
        newUser := User{
            UserID:       userID,
            TargetUserID: targetUserID,
            Name:         name,
            Timestamp:    time.Now(),
        }
        if err := db.Create(&newUser).Error; err != nil {
            return err
        }
        log.Printf("New user added: %+v\n", newUser)
    } else if err != nil {
        return err
    }
    return nil
}

func setupDatabase(t *testing.T) *gorm.DB {
    db, err := gorm.Open(sqlite.Open("test.db"), &gorm.Config{})
    if err != nil {
        t.Fatalf("Failed to connect to database: %v", err)
    }
    db.Migrator().DropTable(&User{})
    db.AutoMigrate(&User{})
    return db
}

func TestAddUserIfNotExists(t *testing.T) {
    db := setupDatabase(t)
    defer db.Migrator().DropTable(&User{})

    // Test adding a new user when none exists
    userID := 1
    targetUserID := 2
    name := "John Doe"
    if err := addUserIfNotExists(db, userID, targetUserID, name); err != nil {
        t.Fatalf("Failed to add user: %v", err)
    }

    // Check if user was added
    var users []User
    if err := db.Find(&users).Error; err != nil {
        t.Fatalf("Failed to fetch users: %v", err)
    }
    if len(users) != 1 {
        t.Errorf("Expected 1 user in database, got %d", len(users))
    } else if users[0].Name != name {
        t.Errorf("Expected user name to be %s, got %s", name, users[0].Name)
    }
}
```

このテストケースは、指定された `UserID` と `TargetUserID` がデータベースに存在しない場合に新しいユーザーを追加する関数の挙動を検証します。データベースのセットアップとクリーンアップを含め、ユーザーの追加が適切に行われるかどうかを確認します。

### 説明
先のテストの詳細を記載します。
指定された `UserID` と `TargetUserID` がデータベースに存在しない場合に新しいユーザーを追加する関数 `addUserIfNotExists` の挙動を検証します。

データベースのセットアップとクリーンアップは `setupDatabase` 関数を使用して行われ、テストの開始前にデータベースをクリーンな状態にリセットします。このプロセスは、テストが他のデータに依存しない独立した状態で実行されることを保証します。

関数 `addUserIfNotExists` は、GORM の `First` メソッドを使用して特定の `UserID` と `TargetUserID` を持つユーザーの存在を確認し、見つからない場合には `Create` メソッドを用いて新しいユーザーをデータベースに追加します。この関数のテストは、ユーザーがデータベースに正しく追加されたことを確認することに加え、エラーハンドリングが適切に行われるかも検証します。エラーが発生した場合、テストは適切なエラーメッセージを出力して失敗します。

テストの最終段階では、`Find` メソッドを使用してデータベースから全ユーザーを取得し、追加されたユーザーのデータが期待通りであることを確認します。これにはユーザーの数が正確に1であること、そして追加されたユーザーの名前が指定した値に一致するかを検証するステップが含まれます。

このテストケースを通じて、データが存在しない場合にデータを追加するロジックが正確に機能していることを確認し、将来的にこの関数を使用する際の信頼性を保証します。



## テスト結果
`ok` と表示される場合、テストが成功していることを意味します。Goの標準テストフレームワークは、テストが成功すると通常、追加のログ出力を行いません。ログを見るには、テストが失敗するか、またはテストの実行時に `-v` オプション（verboseモード）を指定する必要があります。

### テストをVerboseモードで実行
テストをコマンドラインから実行する場合に `-v` オプションを追加することで、`t.Log` や `t.Logf` による出力を含むすべてのログが表示されます。例えば、以下のように実行します：

```bash
go test -v
```

このコマンドは、成功したテストに関する情報も出力します。

### テストが成功した際のログの扱い
テストが成功した場合、ログを確認する必要がないと判断されることが多いため、標準的なテスト出力では省略されます。しかし、開発プロセス中やデバッグの際に、成功したテストの内部状態を知りたい場合もあるため、Verboseモードが用意されています。

### ログを出したい場合
もしテスト中のある条件や情報を常に出力したい場合は、 `log.Printf` や `fmt.Printf` を使用することで、Verboseモードに関わらず常に出力することが可能です。

## テストパターンのテストデータについて

### テストの透明性と再現性について

テストでは通常、以下の原則が求められます：

1. **テストの独立性**：各テストは他のテストと独立していて、実行順序を変更してもテスト結果に影響を与えないことが望ましいです。これにより、テストの再現性と信頼性が保証されます。

2. **データの追跡性**：各テスト実行後には、何がテストされたのか、どのようなデータが生成または使用されたのかが明確にわかるようにデータを残すことが理想的です。これにより、テストの透明性が確保され、問題発生時の追跡やデバッグが容易になります。

### 連続したプロセスのテストの場合

一部のシナリオ、特に注文処理システムのような連続したビジネスプロセスをテストする場合、各テストケースが直前のテストケースの結果に依存することがあります。この場合、テストの独立性は保てない可能性があります。

### テストデータの再現性が難しい場合の対策

連続したプロセスのテストでは、テスト中に生成されたデータそのものの完全な再現が難しい場合があります。このような場合の対策として、以下のアプローチが考えられます：

- **ログの活用**：テストの各ステップでの操作とデータ変更を詳細にログに記録し、何が行われたのか、どのような結果が得られたのかを明確にします。この情報は、テストの評価や問題解析時に非常に役立ちます。

- **結果の文書化**：テストの結果として得られたデータのスナップショットを保持し、テスト報告書やドキュメントにこれを反映させます。これにより、テストがどのように実行され、どのような結果が得られたかを明確に伝えることができます。

このように、テストの独立性が完全には保てない場合でも、テストの透明性と追跡可能性を確保することで、テストの有効性を高め、再現性の問題を補うことができます。

## テストパターン
ただのメモになりますが、今後検討したいので記載します。
テストは通常、以下のようないくつかのカテゴリに分類されます：

1. **正常系テスト（ハッピーパステスト）**:
   - 予想される正常な入力や条件でアプリケーションが期待通りに動作することを確認します。これには新規ユーザー追加やユーザー数の上限チェックなどが含まれ、システムが正しいパラメーターとともに適切に機能するかを検証します。

2. **異常系テスト（エラーパステスト）**:
   - エラーが発生する可能性のある条件や入力を試して、アプリケーションが適切にエラーを処理し、予期せぬ問題に対処できるかどうかを確認します。これにはデータベース接続の失敗、トランザクションのロールバック、コンカレンシー問題などが含まれます。

3. **エッジケーステスト**:
   - システムの限界や特異点を試すテストで、通常の使用範囲の境界に位置するシナリオをテストします。例えば、ユーザー数がちょうど上限に達した場合や、入力値が最大または最小のケースなどがこれに該当します。

4. **セキュリティテスト**:
   - アプリケーションが様々なセキュリティ脅威や攻撃から適切に保護されているかを評価します。これには権限の確認、SQLインジェクションの防止、データの暗号化などが含まれます。

5. **パフォーマンステスト**:
   - アプリケーションのパフォーマンスと効率性を評価するテストで、大量のデータやリクエストを処理する能力、応答時間、リソース使用量などが測定されます。

これらのテストを通じて、アプリケーションが様々な状況下で予定通りに機能し、予期せぬ問題や負荷がかかった際にも安定して動作することを確認します。特にデータベースを含むバックエンドのシステムでは、データ整合性とシステムの堅牢性を確保するために、これらのテストが非常に重要です。

### 異常系のテストの共通化について
異常系テストは、しばしばアプリケーションの複数の部分で同じようなシナリオに適用されるため、テストのロジックを共通化して再利用することができます。

例えばデータベース接続の失敗やコンカレンシーのテストは、異なる関数やモジュール間で共通化して行うことが可能で、効率的です。これにより、テストのメンテナンスや更新を容易にし、一貫性を保ちながらコードベース全体での品質保証を向上させることができます。

#### データベース接続の失敗テストの共通化

データベース接続が必要なすべての機能で、接続失敗のシナリオをテストするための共通のヘルパーメソッドやモックオブジェクトを用意することができます。たとえば、データベース接続を模倣するモックを作成して、接続失敗時の振る舞いをシミュレートし、各機能がこのエラーを適切に処理しているかを確認します。これにより、接続エラーが発生した際のエラーハンドリングやリトライロジックの整合性をアプリケーション全体で保証できます。

#### コンカレンシーのテストの共通化

コンカレンシーとは複数のトランザクションが同時に実行される場合のデッドロックや競合のことです。
コンカレンシーに関するテストも同様に、異なる部分で発生する可能性のある競合やデッドロックを一元的に試験するためのテストケースを設計することが有効です。コンカレンシー問題はしばしばアプリケーションの異なる層やコンポーネントで発生するため、これを一括してテストすることで、アプリケーションの耐障害性とスケーラビリティを向上させることが可能です。例えば、特定のリソースへの同時アクセスを行うテストを複数の機能で共通化し、ロック管理やトランザクションの整合性が全体として保持されているかを検証します。

#### 共通化テストの実施方法

1. **モックとスタブの使用**: 外部依存性を排除し、テストを独立させるためにモックやスタブを活用します。これにより、特定のエラー条件やコンカレンシー状況を容易に再現できます。
2. **共通ライブラリの開発**: 共通のエラー処理や競合解決ロジックを含むライブラリを開発し、これをアプリケーション全体で使用します。これにより、コードの重複を減らし、テストの一貫性を保つことができます。
3. **統合テストとエンドツーエンドテストの強化**: システム全体を通じてデータベースのエラーハンドリングやコンカレンシー問題を検証するための統合テストやエンドツーエンドテストを充実させます。

このように、共通のエラーシナリオを効率的にテストするための戦略を構築し、実装することは、テストプロセスを最適化し、アプリケーションの堅牢性を高める上で非常に重要です。

## テスト網羅性
ただのメモ程度ですが、今後検証したいので残しておきます。

テストでプログラムのすべての分岐を網羅することは、理想的な目標ではありますが、実際にはすべての分岐をテストすることは非常に困難で、場合によっては不可能な場合もあります。テストの網羅性にはいくつかの異なるレベルがあり、どれだけの網羅が必要かは、プロジェクトの要件、リスク評価、利用されるリソースによって異なります。

### テストの網羅性に関する主要な指標

1. **ステートメントカバレッジ（行カバレッジ）**:
   - コード内の各ステートメントが少なくとも一度は実行されるかどうかを測定します。これは最も基本的なカバレッジの形式で、全ての行がテストされているかを確認します。

2. **ブランチカバレッジ（分岐カバレッジ）**:
   - if文や条件演算子など、コード内のすべての分岐がテストによって実行されることを保証します。このカバレッジはステートメントカバレッジよりも詳細で、条件の真偽値の両方が評価されることを確認します。

3. **パスカバレッジ**:
   - プログラム内の可能なすべての実行パスをカバーすることを目指します。この種のカバレッジは非常に厳格であり、複雑な条件やループを含む大規模なソフトウェアではすべてのパスをテストすることが非常に困難または不可能になることがあります。

### 実践的なアプローチ

- **リスクベースのアプローチ**: ソフトウェアの重要な部分やエラーが発生すると高リスクの影響がある部分に焦点を当ててテストを行います。すべての分岐をテストする代わりに、最も重要な機能やリスクの高い領域を優先します。

- **優先順位付けと段階的アプローチ**: 全ての分岐を一度にテストするのではなく、最も重要な機能から順にテストを行い、時間とリソースの制約の中で最大のカバレッジを目指します。

- **自動化**: テストの自動化を利用して、効率的により多くのケースをカバーすることができます。自動化されたテストは、新しいコードが追加されたときに再実行が容易で、時間をかけずに大量のテストを繰り返すことが可能です。

### 結論

理論的には全ての分岐をテストすることが理想ですが、実際にはプロジェクトのスコープ、リソース、時間の制約に基づいて合理的なカバレッジを目指すことが一般的です。完全なカバレッジは達成が難しいため、最も影響力の高い部分に焦点を当てることが重要です。


## 参考記事
https://qiita.com/atotto/items/f6b8c773264a3183a53c

https://qiita.com/r-shinhama/items/36c899284b87d03e1f63

https://tech-note.bikunbikun.com/entry/2019/12/01/100000