パラメーターの優先順位
デフォルトの設定ファイル、環境変数、カスタム設定ファイル、CLI パラメーターなど、さまざまな場所でパラメーターを設定できるほか、場合によってはデフォルト値を使用することもできます。さまざまな場所で設定されたパラメーターの優先順位は、次の表のとおりです。1 が最も優先され、5 が最低です。
| 優先順位 | ソース |
|---|---|
| 1 | CLI パラメーター |
| 2 | カスタム設定ファイル |
| 3 | 環境変数 |
| 4 | デフォルトの設定ファイル |
| 5 | デフォルト値 |
設定ファイル
設定ファイルは、TestRail CLI にパラメーター、オプション、設定、選択値を渡すのに使用できます。設定ファイルは、YAML フォーマットで記述します。
利用可能なフィールド:
| フィールド名 | 説明 |
|---|---|
| host | 結果を送信する TestRail インスタンスの URL を指定します。 |
| project | テスト ランを作成するプロジェクトの名前を指定します。 |
| project_id | プロジェクト ID です。TestRail 内でプロジェクト名が重複している場合にだけ使用されます。 |
| username | 認証に使用するユーザー名です。 |
| password | 認証に使用するパスワードです。 |
| key | 認証に使用する API キーです。 |
| file | 使用する結果ファイルのファイル名またはファイルパスを指定します。 |
| title | TestRail に作成するテスト ランのタイトルを指定します。 |
| verbose | true の場合、冗長モードが有効化されます (デフォルト値は false)。 |
| verify | データが正常に追加されたことを検証します。 |
| insecure | セキュアではないリクエストを許可します。 |
| silent | true の場合、サイレンス モード(標準出力のみ)が有効化されます (デフォルト値は false)。 |
| config | 使用する設定ファイルのファイル名またはファイルパスを指定します。 |
| batch_size | TestRail に渡す結果のバッチ サイズを指定します。 |
| timeout | 終了する前に追加の結果を待機する秒数を指定します。 |
| auto_creation_response | 自動作成プロンプトのレスポンスを設定します。設定されていない場合、リソース (スイート、テスト ケースなど) を作成するかどうかを尋ねるプロンプトが表示されます。 |
| suite_id | テスト ランを作成するスイート ID を指定します。 |
| run_id | 更新するラン ID を指定します。 |
| milestone_id | テスト ランを作成するマイルストーン ID を指定します。 |
| close_run | すべての結果を追加した後にランをクローズするかどうかを指定します (デフォルト値は false)。 |
| case_fields | ケース作成時に入力する必要があるケース フィールドのディクショナリをキー/値のペアとして指定します。 |
| result_fields | 結果作成時に入力する必要がある結果フィールドのディクショナリをキー/値のペアとして指定します。 |
| run_description | テスト ランの説明に追加するテキストです (たとえば、CI ジョブへのリンクを追加する場合など)。 |
設定ファイルの例:
host: https://fakename.testrail.io/
project: My TestRail Project
username: myuser@name.com
password: StrongP@ssword
file: PATH/result_file.xml
title: Automated Tests
config: PATH/alternate_config.yml
batch_size: 20
timeout: 5.5
auto_creation_response: true
case_fields:
type_id: 1,
priority_id: 3
custom_field_id: [2, 4]
デフォルトの設定ファイル
デフォルトの設定ファイルは config.yaml または config.yml という名前で trcli 実行モジュールと同じディレクトリに保存する必要があります。実行モジュールの pip インストールのデフォルトのパスは、システムおよび python の設定 (venv) によって異なります。
カスタム設定ファイル
デフォルトの設定ファイルのほかに、パラメーターとして -c/--config の後にカスタム設定ファイルを指定して渡すことができます。
環境変数
環境変数を設定することで、trcli ツールにパラメーターおよびオプションを渡すことができます。変数は TR_CLI_PARAMETER_NAME_CAPITALIZED という名前である必要があります。
たとえば -h/--host の場合: TR_CLI_HOST
--yes/--noパラメーターは特別なケースです。 TR_CLI_AUTO_CREATION_RESPONSE という名前の変数に値 true を指定すると自動作成が有効になり、 false を指定すると無効になります。
パラメーター名に - が含まれる場合、_ に変更する必要があります。
例: --project-id の場合、環境変数名は TR_CLI_PROJECT_ID になります。
環境変数の設定
システムによって、変数の設定方法は異なります。以下に、単一のセッション用に環境変数を設定する方法の例をいくつか挙げます。この場合、変数は別のターミナル セッションには適用されません。
# Windows cmd set TR_CLI_PROJECT=project name # Windows powershell $env:TR_CLI_PROJECT="project name" # Linux export TR_CLI_PROJECT="project name" for Linux-like systems