Microsoft.Testing.Platform (MTP) CLI 選項參考

本文提供一個 MTP 命令列選項的中央入口。

平台選項

  • @

    指定回應檔的名稱。 回應檔案名稱必須緊接 @ 字元後面,且字元與回應檔案名稱之間 @ 不得留白。

    回應檔中的選項將被解讀為彷彿它們在命令列的那個位置。 你不能用反斜線字 \ 元來串接行數。 使用回應檔案可以幫助處理可能超出終端機限制的長命令行。 您可以將回應檔與內嵌命令行自變數結合。 例如:

    ./TestExecutable.exe @"filter.rsp" --timeout 10s
    

    其中 filter.rsp 可以有下列內容:

    --filter "A very long filter"
    

    或者,單一 rsp 檔案可用來指定逾時和篩選,如下所示:

    ./TestExecutable.exe @"arguments.rsp"
    
    --filter "A very long filter" --timeout 10s
    

    備註

    使用 dotnet test時,SDK 命令列解析器採用逐行標記法,回應檔案中的每一行視為單一標記。 此時,每個參數必須在獨立的行上:

    --filter
    A very long filter
    --timeout
    10s
    
  • --config-file

    指定 testconfig.json 檔案。

  • --debug

    啟動時會暫停測試執行,這樣你就可以把除錯器附加到測試程序上。 相當於將TESTINGPLATFORM_WAIT_ATTACH_DEBUGGER設定1。 瀏覽器平台不支援。

    備註

    此選項自 1.9.0 版本起在 MTP 中提供。 它取代了先前 --debug-wait-attach 的選項(由 MTP 1.6.0 引入);舊名稱已被移除,且不得再使用。

  • --diagnostic

    啟用診斷記錄。 預設的日誌層級是 Trace。 檔案會以以下命名格式寫入輸出目錄:log_[MMddHHssfff].diag

  • --diagnostic-synchronous-write

    強制內建檔案記錄器同步寫入記錄。 適用於如果程序崩潰時,您不想遺失任何日誌條目的情況。 這會拖慢測試執行速度。

  • --diagnostic-output-directory

    診斷記錄的輸出目錄,如果未指定的話,檔案會產生在預設的 TestResults 目錄中。

  • --diagnostic-file-prefix

    記錄檔名稱的前置詞。 預設為 "log"

  • --diagnostic-verbosity

    當使用 --diagnostic 開關時,定義訊息顯示的詳盡程度。 可用的值為 TraceDebugInformationWarningErrorCritical

  • --exit-on-process-exit

    如果依賴進程結束,則離開測試進程。 必須提供 PID。

  • --filter-uid

    會根據測試節點的 UID 來篩選要執行的測試。 接受一個或多個 UID。

    備註

    此選項自 MTP 版本 1.8.0 起提供。

  • --help

    輸出有關如何使用命令的說明。

  • --ignore-exit-code

    允許忽略某些非零結束代碼,並改為以 0傳回 。 如需更多資訊,請參閱 忽略特定退出代碼

  • --info

    顯示關於 .NET 測試應用程式的進階資訊,例如:

    • 平臺。
    • 環境。
    • 每個已註冊的命令行提供者,例如其 nameversiondescriptionoptions
    • 每個已註冊的工具,例如其 commandnameversiondescription等和所有指令行提供者。

    這項功能可用來瞭解那些將註冊相同命令列選項的擴充功能,或多個擴充功能版本(或平台)之間的可用選項變化。

  • --list-tests

    列出可用測試但未執行。 可選擇性地取一個參數來控制輸出格式: text (預設、人類可讀)或 json

    備註

    json輸出格式自 2.3.0 版本起可在 MTP 中取得。

  • --maximum-failed-tests

    指定達到的測試失敗數目上限,當達到時,將會停止測試回合。 若要支援此切換,架構作者需要實作 IGracefulStopTestExecutionCapability 功能。 到達該測試失敗數量時的退出代碼為13。 欲了解更多資訊,請參閱 MTP出口代碼

    備註

    此功能自 MTP 1.5 版本起可使用。

  • --minimum-expected-tests

    指定預期要執行的測試數目下限。 根據預設,至少應該執行一個測試。

  • --no-banner

    停用啟動橫幅、版權訊息及遙測橫幅。 同樣的效果也可透過 TESTINGPLATFORM_NOBANNER or DOTNET_NOLOGO 環境變數達成。

  • --results-directory

    測試結果將要放置的目錄。 如果指定的目錄不存在,則會建立它。 預設是在包含測試應用程式的目錄中的 TestResults

  • --timeout

    全域測試執行逾時。 採用一個自變數做為字串,格式 <value>[h|m|s] 其中 <value> 為 float。

  • --treenode-filter

    使用樹狀篩選運算式來篩選要執行的測試。 樹狀篩選器在進階情境中可提供比 --filter 更豐富的比對方式。

各情境的延伸選項

請參考下表快速找到延長選項。

Scenario 功能文件
收集程式代碼涵蓋範圍 程式碼涵蓋範圍
收集崩潰或懸掛的備份 崩潰與懸浮傾倒
產生測試報告(例如 TRX) 測試報告
自訂終端輸出 終端輸出
套用主機層級控制 即時重載
重試未通過測試 重試
執行使用 Microsoft Fakes 框架的測試 Microsoft 假貨
發布 OpenTelemetry 的追蹤與指標 OpenTelemetry

在你的測驗應用程式中發現選項

執行您的測試可執行檔 --help 以列出當前擴充套件集中可用的選項。

若要對註冊醫療提供者及選項進行進階診斷,請使用 --info

另請參閱