test-writing

name	test-writing
description	Pythonのテストコードを作成・修正するときに使用。

テスト方針

• DummyApi、DummyService、FakeClient のような自前の疑似実装は原則追加しない。
• monkeypatch や mock は、外部API、ネットワーク、時刻、環境変数、ファイルシステム外の副作用など、テストで制御しないと不安定になる境界に限定して使用する。
• 関数呼び出しの詳細に強く結びついたテストは、原則として追加しないでください。
• mock.assert_called_once_with(...) のような配線確認だけのテストは、明確な回帰防止上の理由がある場合に限って追加してください。
• テストを書くときは「そのテストが将来の設計変更を不必要に妨げないか」を確認してください。
• ただし、外部API連携、ジョブ投入、通知送信、永続化など、副作用の境界にある処理では、呼び出し確認テストを許可します。
• argparseなどのCLIパーサーで制御している部分はテストを作成しないでください。たとえば必須引数が指定されない場合のエラーなどです。これはライブラリの責務だからです。

テストの実行方法

• uv run pytest を使う。

テストコードの具体的なスタイル

• テストファイルのディレクトリ構成やファイル名は、annofabcli/配下のプロダクションコードと対応させる。
• 例外確認には pytest.raises を使用する。
• pytest.raises ではエラーメッセージ文字列の確認は行わない。
• 一時ディレクトリが必要な場合は tmp_path fixture を使う。
• WebAPI にアクセスするテストには pytest.mark.access_webapi を付与する。CLI テストは、引数上はローカル処理に見えても共通ログイン処理を通る場合があるので注意する。