QualityForward APIを使って、テナントで作成されたテストサイクルの情報を一括でエクスポートする方法についてご紹介します。
※フリープランではAPIを使用することはできません
テストサイクルのエクスポートはブラウザ上でも取得が可能ですが、分析の為に過去のデータを全てエクスポートしたい場合などエクスポートの数が多い場合にAPIを利用し一括で行うことで作業を効率化することができます。
また、ご紹介するサンプルコードはGitHub上にも上がっていますので、皆さん是非ご利用ください。
※Python 3.7にて動作を確認しています。
QualityForward APIについて
QualityForward API(=qfAPI)では、テストスイート・テストサイクルのデータ読み書きや、テストフェーズなどの作成が行えます。
API仕様書はQualityForwardのヘルプ画面にてリンクが記載されていますので、そちらからご参照ください。
サンプルの利用方法
GitHub上にサンプルコードが上がっていますので、以下の方法でzipファイルをダウンロードしてください。
[手順]
1. https://github.com/Veriserve/qf_api_sampleにアクセス
2.『Download Zip』をクリック
3. 任意のフォルダに解凍
サンプルを利用するには、APIキーの発行が必要です。発行はプロジェクト管理者以上の権限を持つユーザーが行えます。
開発環境の構築
今回利用するサンプルはPythonといくつかライブラリを利用しますので、それぞれインストールします。
[手順]
１．Python3をインストール
以下のような構築ガイドを確認し、Python3の環境を整えてください。
２．ライブラリのインストール
ダウンロードしたファイルの [sample]>[cycle_export] フォルダまで移動し、以下のコマンドで、ライブラリをインストールします
pip install -r requirements.txt
[補足] Windowsをご利用の場合
フォルダを開いた状態でパス部分に「cmd」と入力すると対象のフォルダがカレントの状態でコマンドプロンプトが起動できます。
実行方法
以下のコマンドでスクリプトを実行すると、指定したフォルダにファイルが格納されます。
python download_under_project.py -a [apiキー]
※ apiキーを指定する際、角括弧[]は削除してください
スクリプトを実行すると、以下のようにフェーズでフォルダ分けされて出力されます。
