コマンドライン実行機能のコマンドやオプションを確認しよう(CI/CD連携)

はじめに

T-DASHのコマンドライン実行では下記のようなコマンドやオプションを使用できます。このガイドでは、コマンドプロンプトを使用してT-DASHを操作する際に必要なコマンドやオプションを詳しく説明し、作業の効率化やタスクの自動化を実現します。豊富な機能を活用し、より柔軟なテストを目指しましょう。

ゴール

T-DASHをコマンドライン実行する際に使用できるコマンドやオプションを確認できる

前提

tdash.exeを所持している

概要

コマンド	オプション	概要
`setup`	`--silent`	非対話型で処理を進行させます。
	`--auth_proxy_address`	非対話型で処理を進行する際、T-DASHのアカウント認証で使用するプロキシサーバのアドレスを設定する
	`--auth_proxy_port`	非対話型で処理を進行する際、T-DASHのアカウント認証で使用するプロキシサーバのポート番号を設定する
	`--auth_proxy_account`	非対話型で処理を進行する際、T-DASHのアカウント認証で使用するプロキシサーバのアカウント名を設定する
	`--auth_proxy_password`	非対話型で処理を進行する際、T-DASHのアカウント認証で使用するプロキシサーバのパスワードを設定する

コマンド	オプション	概要
`show_testrun`	`--sync`	テストランを確認したいプロジェクトエクスポートフォルダを設定します。

コマンド	オプション	概要
`testrun`	`--testrun_memo`	テストランの実行メモを設定します。
	`--sync`	実行するテストランを取得するプロジェクトエクスポートフォルダを設定します。
	`--browser`	実行するブラウザを設定します。
	`--background`	バックグラウンド実行を設定します。
	`--output_report_dir_path`	レポートフォルダを出力するフォルダを設定します。
	`--use_existing_test`	syncフォルダを使用せずにテストを実行します。使用するテストデータはDB内の既存データに依存します。この設定は、–syncオプションよりも優先されます。
	`--silent`	非対話型で処理を進行させます。
	`--anytest_user`	AnyTest連携を行うためのAPIユーザー名を設定します。 ※AnyTest連携を行うかどうかは、テストラン作成時の「テスト環境選択」の設定に依存します。
	`--anytest_key`	AnyTest連携を行うためのAPアクセスキーを設定します。 ※AnyTest連携を行うかどうかは、実行対象のテストラン作成時の「テスト環境選択」の設定に依存します。
	`--anytest_device`	AnyTest連携で使用するデバイスのIDを設定します。
	`--anytest_runtime`	AnyTest連携の実行時間を設定します。 5~9999の半角数字で入力してください。
	`--qt_workspace`	QualityTracker連携のワークスペースを設定する ※–qt_workspaceオプションと–qt_apiオプションを同時に使用した場合のみ、QualityTracker連携を行います。
	`--qt_api`	QualityTracker連携のAPIキーを設定する ※–qt_workspaceオプションと–qt_apiオプションを同時に使用した場合のみ、QualityTracker連携を行います。
	`--qt_use_previous_testrun`	前回連携したQualityTracker上のテストランを使用するかどうかを設定します。 ※このオプションを使用する際は、`--use_existing_test`オプションも使用してください。
	`--qt_testrun`	連携対象のT-DASH上のテストランを実行対象のテストラン名の中から設定する
	`--qt_project`	連携対象のQualityTracker上のプロジェクトを設定する
	`--qt_scheduled_start_date`	QualityTracker連携のテスト予定開始日を設定する
	`--qt_scheduled_end_date`	QualityTracker連携のテスト予定終了日を設定する ※`--qt_scheduled_start_date`オプションに設定した日付よりも、後の日付を設定するようにしてください。
	`--test_proxy_address`	非対話型で処理を進行する際、テスト実行で使用するプロキシサーバのアドレスを設定する
	`--test_proxy_port`	非対話型で処理を進行する際、テスト実行で使用するプロキシサーバのポート番号を指定する
	`--test_proxy_url`	非対話型で処理を進行する際、テスト実行で使用するプロキシサーバを使用した疎通確認用のURLを指定する
	`--qt_proxy_address`	非対話型で処理を進行する際、QualityTracker連携時に使用するプロキシサーバのアドレスを設定する
	`--qt_proxy_port`	非対話型で処理を進行する際、QualityTracker連携時に使用するプロキシサーバのポートを設定する
	`--qt_proxy_account`	非対話型で処理を進行する際、QualityTracker連携時に使用するプロキシサーバのアカウントを設定する
	`--qt_proxy_password`	非対話型で処理を進行する際、QualityTracker連携時に使用するプロキシサーバのパスワードを設定する
	`--anytest_proxy_address`	非対話型で処理を進行する際、AnyTest連携時に使用するプロキシサーバのアドレスを設定する
	`--anytest_proxy_port`	非対話型で処理を進行する際、AnyTest連携時に使用するプロキシサーバのポートを設定する
	`--anytest_proxy_accoun`	非対話型で処理を進行する際、AnyTest連携時に使用するプロキシサーバのアカウントを設定する
	`--anytest_proxy_password`	非対話型で処理を進行する際、AnyTest連携時に使用するプロキシサーバのパスワードを設定する

詳細

setupコマンド

コマンド

概要
T-DASHをコマンドライン実行するためのセットアップを行います。
使用例
tdash.exe setup

オプション

--silent
- 概要
  非対話型で処理を進行させます。
- 使用例
  tdash.exe setup --silent
--auth_proxy_address
- 概要
  非対話型で処理を進行する際、T-DASHのアカウント認証で使用するプロキシサーバのアドレスを設定する
- 引数
  T-DASHのアカウント認証時に使用するプロキシのアドレス
- 使用例tdash.exe setup --silent --auth_proxy_address localhost --auth_proxy_port 8080
--auth_proxy_port
- 概要
  非対話型で処理を進行する際、T-DASHのアカウント認証で使用するプロキシサーバのポートを設定する
- 引数
  T-DASHのアカウント認証時に使用するプロキシのポート
- 使用例tdash.exe setup --silent --auth_proxy_address localhost --auth_proxy_port 8080
--auth_proxy_account
- 概要
  非対話型で処理を進行する際、T-DASHのアカウント認証で使用するプロキシサーバのアカウントを設定する
- 引数
  T-DASHのアカウント認証時に使用するプロキシのアカウント
- 使用例tdash.exe setup --silent --auth_proxy_address localhost --auth_proxy_port 8080 --auth_proxy_account account --auth_proxy_password password
--auth_proxy_password
- 概要
  非対話型で処理を進行する際、T-DASHのアカウント認証で使用するプロキシサーバのパスワードを設定する
- 引数
  T-DASHのアカウント認証時に使用するプロキシのパスワード
- 使用例tdash.exe setup --silent --auth_proxy_address localhost --auth_proxy_port 8080 --auth_proxy_account account --auth_proxy_password password

show_testrunコマンド

コマンド

概要
syncフォルダ内のテストラン名を表示します。
使用例
tdash.exe show_testrun

オプション

--sync
- 概要
  テストランを確認したいプロジェクトエクスポートフォルダを指定してください。
- 引数
  テストランを確認したいプロジェクトエクスポートフォルダのパス
  - デフォルト値
    コマンドライン実行用プロジェクトフォルダのsyncフォルダのパス
- 使用例
  tdash.exe show_testrun --sync /Path/to/sync

testrunコマンド

コマンド

概要
syncフォルダに含まれるテストランから引数に指定したテストランを実行します。
引数
実行したいテストラン名
※複数入力する場合、「/」で区切ってください。
使用例
tdash.exe testrun テストラン名○○/テストラン名□□

オプション

--testrun_memo
- 概要
  テストランの実行メモを設定します。
- 引数
  テストランの実行メモ
  - デフォルト値
    空文字
- 使用例
  tdash.exe testrun テストラン名○○ --testrun_memo テストラン名○○を実行する
--sync
- 概要
  実行するテストランを取得するプロジェクトエクスポートフォルダを設定します。
- 引数
  実行したいテストランを持つプロジェクトエクスポートフォルダのパス
  - デフォルト値
    コマンドライン実行用プロジェクトフォルダのsyncフォルダのパス
- 使用例
  tdash.exe testrun テストラン名○○ --sync /Path/to/sync
--browser
- 概要
  実行するブラウザを設定します。
- 引数
  実行したいブラウザ名
  ※使用可能なブラウザ名は「chrome」「edge」「firefox」です。
  ※複数指定する場合、「/」で区切ってください。
  - デフォルト値
    テストラン作成時に設定したブラウザ
- 使用例
  tdash.exe testrun テストラン名○○ --browser chrome/edge/firefox
--background
- 概要
  バックグラウンド実行を設定します。
- 引数
  不要
- 使用例
  tdash.exe testrun テストラン名○○ --background
--output_report_dir_path　
- 概要
  xunitファイルを出力するフォルダを設定します。
- 引数
  xunitファイルを出力したいフォルダ
  - デフォルト値
    T-DASHオリジナルレポートの出力フォルダ
- 使用例
  tdash.exe testrun テストラン名○○ --output_report_dir_path ./xunits
--use_existing_test
- 概要
  プロジェクトインポートせず、既存テストデータを使用します。
- 引数
  不要
- 使用例
  tdash.exe testrun テストラン名○○ --use_existing_test
--silent
- 概要
  非対話型で処理を進行させます。
- 引数
  不要
- 使用例
  tdash.exe testrun テストラン名○○ --silent
--anytest_user
- 概要
  AnyTest連携を行うためのAPIユーザー名を設定します。
  ※AnyTest連携を行うかどうかは、実行対象のテストラン作成時の「テスト環境選択」の設定に依存します。
- 引数
  AnyTestサービスのAPIユーザー名
  - デフォルト値
    空文字
- 使用例
  tdash.exe testrun AnyTest連携テストラン --anytest_user example@exmple.com --anytest_key dummyApiKey --anytest_device 170 --anytest_runtime 5
--anytest_key
- 概要
  AnyTest連携を行うためのAPアクセスキーを設定します。
  ※QualityTrackerサービスで確認してください。
  ※AnyTest連携を行うかどうかは、実行対象のテストラン作成時の「テスト環境選択」の設定に依存します。
- 引数
  AnyTestサービスのAPIアクセスキー
  - デフォルト値
    空文字
- 使用例
  tdash.exe testrun AnyTest連携テストラン --anytest_user example@exmple.com --anytest_key dummyApiKey --anytest_device 170 --anytest_runtime 5
--anytest_device
- 概要
  AnyTest連携で使用するデバイスのIDを設定します。
- 引数
  半角のデバイスID
  ※AnyTest公式ページで確認できます。
  - デフォルト値
    空文字
- 使用例
  tdash.exe testrun AnyTest連携テストラン --anytest_user example@exmple.com --anytest_key dummyApiKey --anytest_device 170 --anytest_runtime 5
--anytest_runtime
- 概要
  AnyTest連携の実行時間を設定します。
- 引数
  AnyTest連携の実行時間: 5~9999の半角数字
  - デフォルト値
    5
- 使用例
  tdash.exe testrun AnyTest連携テストラン --anytest_user example@exmple.com --anytest_key dummyApiKey --anytest_device 170 --anytest_runtime 5
--qt_workspace
- 概要
  QualityTracker連携のワークスペースを設定します。
  ※QualityTrackerサービスで確認してください。
  ※–qt_workspaceオプションと–qt_apiオプションを同時に使用した場合のみ、QualityTracker連携を行います。
- 引数
  QualityTracker連携のワークスペース
  - デフォルト値
    空文字
- 使用例
  tdash.exe testrun テストラン名○○ --qt_workspace workspace --qt_api dummyApiKey --qt_testrun テストラン名○○ --qt_project QTのプロジェクト名 --qt_scheduled_start_date 2023/10/02 --qt_scheduled_end_date 2023/10/02
--–qt_api
- 概要
  QualityTracker連携のAPIキーを設定します。
  ※QualityTrackerサービスで確認してください。
  ※–qt_workspaceオプションと–qt_apiオプションを同時に使用した場合のみ、QualityTracker連携を行います。
- 引数
  QualityTracker連携のAPIキー
  - デフォルト値
    空文字
- 使用例
  tdash.exe testrun テストラン名○○ --qt_workspace workspace --qt_api dummyApiKey --qt_testrun テストラン名○○ --qt_project QTのプロジェクト名 --qt_scheduled_start_date 2023/10/02 --qt_scheduled_end_date 2023/10/02
--qt_use_previous_testrun
- 概要
  前回連携したQualityTracker上のテストランを使用するかどうかを設定します。
- 引数
  不要
  - デフォルト値
    False
- 使用例
  tdash.exe testrun テストラン名○○ --qt_workspace workspace --qt_api dummyApiKey --qt_testrun テストラン名○○ --qt_project QTのプロジェクト名 --qt_scheduled_start_date 2023/10/02 --qt_scheduled_end_date 2023/10/02
--qt_testrun
- 概要
  連携対象のT-DASH上のテストランを実行対象のテストラン名の中から設定します。
- 引数
  連携対象のT-DASH上のテストラン名
  - デフォルト値
    空文字
- 使用例
  tdash.exe testrun テストラン名○○ --qt_workspace workspace --qt_api dummyApiKey --qt_testrun テストラン名○○ --qt_project QTのプロジェクト名 --qt_scheduled_start_date 2023/10/02 --qt_scheduled_end_date 2023/10/02
--qt_project
- 概要
  連携対象のQualityTracker上のプロジェクトを設定します。
  ※QualityTrackerサービスで確認してください。
- 引数
  連携対象のQualityTracker上のプロジェクト名を指定する
  - デフォルト値
    空文字
- 使用例
  tdash.exe testrun テストラン名○○ --qt_workspace workspace --qt_api dummyApiKey --qt_testrun テストラン名○○ --qt_project QTのプロジェクト名 --qt_scheduled_start_date 2023/10/02 --qt_scheduled_end_date 2023/10/02
--qt_scheduled_start_date
- 概要
  QualityTracker連携のテスト予定開始日を設定します。
- 引数
  テスト予定終了日: yyyy/mm/dd
  - デフォルト値
    コマンド実行日（yyyy/mm/dd）
- 使用例
  tdash.exe testrun テストラン名○○ --qt_workspace workspace --qt_api dummyApiKey --qt_testrun テストラン名○○ --qt_project QTのプロジェクト名 --qt_scheduled_start_date 2023/10/02 --qt_scheduled_end_date 2023/10/02
---qt_scheduled_end_date
- 概要
  QualityTracker連携のテスト予定終了日を設定します。
  --qt_scheduled_start_dateオプションに設定した日付よりも、後の日付を設定するようにしてください。
- 引数
  テスト予定終了日: yyyy/mm/dd
  - デフォルト値
    コマンド実行日（yyyy/mm/dd）
- 使用例
  tdash.exe testrun テストラン名○○ --qt_workspace workspace --qt_api dummyApiKey --qt_testrun テストラン名○○ --qt_project QTのプロジェクト名 --qt_scheduled_start_date 2023/10/02 --qt_scheduled_end_date 2023/10/02
–test_proxy_address
- 概要
  非対話型で処理を進行する際、テスト実行で使用するプロキシサーバのパスワードを設定する
- 引数
  テスト実行時に使用するプロキシのパスワード
- 使用例
  tdash.exe testrun テストラン名A --silent --test_proxy_address localhost --test_proxy_port 8080
–test_proxy_port
- 概要
  非対話型で処理を進行する際、テスト実行で使用するプロキシサーバのパスワードを設定する
- 引数
  テスト実行時に使用するプロキシのパスワード
- 使用例
  tdash.exe testrun テストラン名A --silent --test_proxy_address localhost --test_proxy_port 8080
–test_proxy_url
- 概要
  非対話型で処理を進行する際、テスト実行で使用するプロキシサーバを使用して、疎通確認する
- 引数
  テスト実行時に使用するプロキシを使用して、疎通確認したいページのURL
- 使用例
  tdash.exe testrun テストラン名A --silent --test_proxy_address localhost --test_proxy_port 8888 --test_proxy_url https://service.valtes.co.jp/t-dash/
–qt_proxy_address
- 概要
  非対話型で処理を進行する際、QualityTracker連携で使用するプロキシサーバのアドレスを設定する
- 引数
  QualityTracker連携時に使用するプロキシのパスワード
- 使用例
  tdash.exe testrun テストラン名○○ --qt_workspace workspace --qt_api dummyApiKey --qt_testrun テストラン名○○ --qt_project QTのプロジェクト名 --silent --qt_proxy_address localhost --qt_proxy_port 8080 --qt_proxy_account account --qt_proxy_password password
–qt_proxy_port
- 概要
  非対話型で処理を進行する際、QualityTracker連携で使用するプロキシサーバのポートを設定する
- 引数
  QualityTracker連携時に使用するプロキシのポート
- 使用例
  tdash.exe testrun テストラン名○○ --qt_workspace workspace --qt_api dummyApiKey --qt_testrun テストラン名○○ --qt_project QTのプロジェクト名 --silent --qt_proxy_address localhost --qt_proxy_port 8080 --qt_proxy_account account --qt_proxy_password password
–qt_proxy_account
- 概要
  非対話型で処理を進行する際、QualityTracker連携で使用するプロキシサーバのアカウントを設定する
- 引数
  QualityTracker連携時に使用するプロキシのアカウント
- 使用例
  tdash.exe testrun テストラン名○○ --qt_workspace workspace --qt_api dummyApiKey --qt_testrun テストラン名○○ --qt_project QTのプロジェクト名 --silent --qt_proxy_address localhost --qt_proxy_port 8080 --qt_proxy_account account --qt_proxy_password password
–qt_proxy_password
- 概要
  非対話型で処理を進行する際、QualityTracker連携で使用するプロキシサーバのパスワードを設定する
- 引数
  QualityTracker連携時に使用するプロキシのパスワード
- 使用例
  tdash.exe testrun テストラン名○○ --qt_workspace workspace --qt_api dummyApiKey --qt_testrun テストラン名○○ --qt_project QTのプロジェクト名 --silent --qt_proxy_address localhost --qt_proxy_port 8080 --qt_proxy_account account --qt_proxy_password password
–anytest_proxy_address
- 概要
  非対話型で処理を進行する際、AnyTest連携で使用するプロキシサーバのパスワードを設定する
- 引数
  AnyTest連携時に使用するプロキシのパスワード
- 使用例
  tdash.exe testrun AnyTest連携テストラン --anytest_user example@exmple.com --anytest_key dummyApiKey --anytest_device 170 --anytest_runtime 5 --silent --anytest_proxy_address localhost --anytest_proxy_port 8080 --anytest_proxy_account account --anytest_proxy_password password
–anytest_proxy_port
- 概要
  非対話型で処理を進行する際、AnyTest連携で使用するプロキシサーバのパスワードを設定する
- 引数
  AnyTest連携時に使用するプロキシのパスワード
- 使用例
  tdash.exe testrun AnyTest連携テストラン --anytest_user example@exmple.com --anytest_key dummyApiKey --anytest_device 170 --anytest_runtime 5 --silent --anytest_proxy_address localhost --anytest_proxy_port 8080 --anytest_proxy_account account --anytest_proxy_password password
–anytest_proxy_account
- 概要
  非対話型で処理を進行する際、AnyTest連携で使用するプロキシサーバのパスワードを設定する
- 引数
  AnyTest連携時に使用するプロキシのパスワード
- 使用例
  tdash.exe testrun AnyTest連携テストラン --anytest_user example@exmple.com --anytest_key dummyApiKey --anytest_device 170 --anytest_runtime 5 --silent --anytest_proxy_address localhost --anytest_proxy_port 8080 --anytest_proxy_account account --anytest_proxy_password password
–anytest_proxy_password
- 概要
  非対話型で処理を進行する際、AnyTest連携で使用するプロキシサーバのパスワードを設定する
- 引数
  AnyTest連携時に使用するプロキシのパスワード
- 使用例
  tdash.exe testrun AnyTest連携テストラン --anytest_user example@exmple.com --anytest_key dummyApiKey --anytest_device 170 --anytest_runtime 5 --silent --anytest_proxy_address localhost --anytest_proxy_port 8080 --anytest_proxy_account account --anytest_proxy_password password