MagicPod Web API(v1.0)を使用することでテストケースと共有ステップの情報をjson形式で取得することができます。ただし、1度のWeb APIコールで共有ステップを含めたテストケースの各ステップ内容を取得することは現状できません。
代わりに共有ステップを含めたテストケースの各ステップ内容を取得するためのPythonスクリプトを提供しています。このスクリプトを使用することで、以下のような共有ステップの内容を含んだhuman_readable_stepを取得することができます。
また、「total_step_count」は共有ステップを含めたステップ数です。ただし厳密なステップ数ではないため目安としてご活用ください。
{
"number": 4,
"name": "ホテル予約",
"url": "https://app.magicpod.com/<org_name>/<project_name>/4/",
"description": "ホテル予約ができることを確認する",
"human_readable_steps": "https://example.com/に遷移\n共有ステップ: 宿泊数を入力\n 「宿泊数」入力エリアに1とテキスト入力\n共有ステップ: 人数を入力\n 「人数」入力エリアに2とテキスト入力\n...",
...
"total_step_count": 5
}
使用方法
1. Pythonをインストールする
Pythonがマシンにインストールされていない場合は、こちらの手順に従いインストールします。
2. Pythonスクリプトをダウンロードする
MagicPodのGitHubリポジトリでget_full_test_cases_from_api.pyを右上のダウンロードボタンよりダウンロードし、任意の場所に保存してください。
3. Pythonスクリプトを実行する
手順1でダウンロードしたget_full_test_cases_from_api.pyを置いている場所をカレントディレクトリとし、以下のようにコマンドを実行してください。
特定のテストケース(共有ステップのhuman_readable_stepを含む)を取得する場合
python3 get_full_test_cases_from_api.py -t <token> -o <org_name> -p <project_name> <test_case_number(s)>
全てのテストケース(共有ステップのhuman_readable_stepを含む)を取得する場合
python3 get_full_test_cases_from_api.py -t <token> -o <org_name> -p <project_name>
特定のテストケースのhuman_readable_stepのみを取得する場合
python3 get_full_test_cases_from_api.py -t <token> -o <org_name> -p <project_name> <test_case_number> |
jq '.[].human_readable_steps' |
python3 -c 'import sys, json; [print(json.loads(l)) for l in sys.stdin]'
例えば「組織名:example_company」「プロジェクト名:example_pj」「取得するテストケース: 1 , 2」の場合は以下のようなコマンドでテストケース1,2の情報を取得できます。
python3 get_full_test_cases_from_api.py -t xxxxx -o example_company -p example_pj 1 2
トラブルシューティング
- コマンド実行時のエラーメッセージを確認し、必要があればソースコードを書き換えて対応してください。(ChatGPT等のAIの活用を推奨いたします)