テスト仕様書を設計書からGeminiで自動生成！〜生成AIを活用した仕組みづくりでドキュメント陳腐化を防ぐ！〜

# ログイン

## 概要

- TODOアプリを利用するための認証機能。

## 画面イメージ

## 項目設計
| 項目名 | I/O |データ型 | 制約 |
|---|---|---|---|
| メールアドレス | I | String | 必須、最大255文字、メールアドレス形式 |
| パスワード | I | String | 必須、8文字〜12文字、半角英数字記号 |

## 動作一覧

| 動作名 | 説明| トリガー | 処理内容 | 成功時の挙動 | 失敗時の挙動 |
|---|---|---|---|---|---|
|入力内容の検証 | ユーザーが「メールアドレス」および「パスワード」を入力した際にリアルタイムで検証を実施する。| ・入力欄への文字入力<br>・フォーカス移動 | メールアドレス欄: 必須チェック、形式チェック<br>パスワード欄: 必須チェック、最小文字数の確認 | 入力欄の下にエラー表示なし。| エラーメッセージを入力欄下に表示し、該当入力欄を赤枠で強調。 |
| ログインボタンの状態切り替え | 入力欄に有効な値が入力された場合に「ログインボタン」を有効化となる。| 入力欄の値が変更されたとき| メールアドレスとパスワードが両方有効な場合: ボタン有効化<br>どちらかが無効な場合: ボタン無効化| ボタンがクリック可能となる。| ボタンが非活性状態となる。|
| ログイン | ユーザーが「ログインボタン」をクリックした際にログイン処理を実施。| ログインボタンクリック | メールアドレスとパスワードをサーバーに送信し、認証処理を実施する。| ログイン成功: トップページへ遷移<br>ログイン失敗: エラーメッセージを表示| エラーメッセージを表示|

principalSet://iam.googleapis.com/projects/<プロジェクト番号>/locations/global/workloadIdentityPools/<プールID>/attribute.repository/<組織名>/<リポジトリ名>

projects/<プロジェクト番号>/locations/global/workloadIdentityPools/<プールID>/providers/<プロバイダーID>

import os
import sys
from google import genai
from google.genai import types

# 設定値
PROJECT_ID = "<プロジェクトID>"
LOCATION = "us-central1"
MODEL_NAME = "gemini-2.0-flash-exp"
TEMPERATURE = 0
TOP_P = 0.95
MAX_OUTPUT_TOKENS = 8192
RESPONSE_MODALITIES = ["TEXT"]
TEST_SPEC_HEADER = "ケースID, テスト大項目,テスト中項目,小項目,テスト内容,期待結果,実施日時,ステータス"
SYSTEM_INSTRUCTION = f"""システムの設計書が渡されるので、設計に対してテストを作成してください。
テスト仕様書をカンマ区切りで出力してください。
テスト仕様書以外の情報は不要です。
ヘッダ行は以下のようにしてください。
{TEST_SPEC_HEADER}
実施日、ステータスは空欄で構いません。
"""

SAFETY_SETTINGS = [types.SafetySetting(
    category="HARM_CATEGORY_HATE_SPEECH",
    threshold="OFF"
  ),types.SafetySetting(
    category="HARM_CATEGORY_DANGEROUS_CONTENT",
    threshold="OFF"
  ),types.SafetySetting(
    category="HARM_CATEGORY_SEXUALLY_EXPLICIT",
    threshold="OFF"
  ),types.SafetySetting(
    category="HARM_CATEGORY_HARASSMENT",
    threshold="OFF"
  )
]

def generate_test_spec(document: str) -> str:
    """設計ドキュメントからテスト仕様書を生成する。

    Args:
        document: 設計ドキュメントのテキスト。

    Returns:
        生成されたテスト仕様書のテキスト。
    """
    client = genai.Client(
        vertexai=True,
        project=PROJECT_ID,
        location=LOCATION
    )

    contents = [
        types.Content(
            role="user",
            parts=[types.Part.from_text(document)]
        )
    ]

    generate_content_config = types.GenerateContentConfig(
        temperature=TEMPERATURE,
        top_p=TOP_P,
        max_output_tokens=MAX_OUTPUT_TOKENS,
        response_modalities=RESPONSE_MODALITIES,
        safety_settings=SAFETY_SETTINGS,
        system_instruction=[types.Part.from_text(SYSTEM_INSTRUCTION)],
    )

    response = client.models.generate_content(
        model=MODEL_NAME,
        contents=contents,
        config=generate_content_config,
    )
    return response.text


if __name__ == "__main__":
    if len(sys.argv) < 2:
        print("使用法: python script.py <設計書ファイル>")
        sys.exit(1)

    input_file_paths = sys.argv[1:]
    for input_file_path in input_file_paths:
      try:
        with open(input_file_path, "r") as f:
          design_document = f.read()
      except FileNotFoundError:
        print(f"エラー: ファイル '{input_file_path}' が見つかりません。")
        sys.exit(1)
      test_spec_content = generate_test_spec(design_document)
      output_file_path = input_file_path.replace("docs", "tests").replace(".md", ".csv")
      os.makedirs(os.path.dirname(output_file_path), exist_ok=True)
      with open(output_file_path, "w") as f:
        f.write(test_spec_content)
      print(f"テスト仕様書を '{output_file_path}' に保存しました。")

name: Generate test spec
on:
  pull_request:

jobs:
  generate_test_spec:
    permissions:
      contents: write
      pull-requests: write
      id-token: write

    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - name: Diff files /docs/**
        id: diff_files
        run: |
            changed=$(git diff --name-only origin/${{ github.base_ref }} HEAD --relative docs/ | wc -l)
            echo "::set-output name=changed::$changed"

      - uses: google-github-actions/auth@v2
        if: ${{ steps.diff_files.outputs.changed != '0' }}
        with:
          workload_identity_provider: ${{ secrets.workload_identity_provider }}
          service_account: ${{ secrets.service_account }}

      - name: Set up Cloud SDK
        if: ${{ steps.diff_files.outputs.changed != '0' }}
        uses: google-github-actions/setup-gcloud@v2

      - name: Set up Python
        uses: actions/setup-python@v5
        if: ${{ steps.diff_files.outputs.changed != '0' }}
        with:
          python-version: '3.11'

      - name: Install dependencies
        if: ${{ steps.diff_files.outputs.changed != '0' }}
        run: |
          python -m pip install --upgrade pip
          pip install google-genai


      - name: generate_test_spec
        if: ${{ steps.diff_files.outputs.changed != '0' }}
        run: |
          diff_files=$(git diff --name-only origin/${{ github.base_ref }} HEAD --relative docs/ | tr '\n' ' ')
          # 設計書1つにに対してテスト仕様書を1つ生成する
          python .github/scripts/generate_test_spec.py $diff_files

      - name: Commit test spec
        if: ${{ steps.diff_files.outputs.changed != '0' }}
        run: |
          git config --global user.email "github-actions[bot]@users.noreply.github.com"
          git config --global user.name "github-actions[bot]"
          git add tests/

          if git diff --cached --exit-code; then
            echo "No changes to commit. Skipping..."
          else
            git commit -m "Add test spec"
            git push origin HEAD:${{ github.head_ref }}
          fi