ctest_submit

儀表板客戶端 的身份執行 CTest 提交步驟

ctest_submit([PARTS <part>...] [FILES <file>...]
             [SUBMIT_URL <url>]
             [BUILD_ID <result-var>]
             [HTTPHEADER <header>]
             [RETRY_COUNT <count>]
             [RETRY_DELAY <delay>]
             [RETURN_VALUE <result-var>]
             [CAPTURE_CMAKE_ERROR <result-var>]
             [QUIET]
             )

將結果提交到儀表板伺服器。預設情況下,會提交所有可用的部分。

選項如下:

PARTS <part>...

指定要提交的部分子集。有效的部分名稱有:

Start      = nothing
Update     = ctest_update results, in Update.xml
Configure  = ctest_configure results, in Configure.xml
Build      = ctest_build results, in Build.xml
Test       = ctest_test results, in Test.xml
Coverage   = ctest_coverage results, in Coverage.xml
MemCheck   = ctest_memcheck results, in DynamicAnalysis.xml and
             DynamicAnalysis-Test.xml
Notes      = Files listed by CTEST_NOTES_FILES, in Notes.xml
ExtraFiles = Files listed by CTEST_EXTRA_SUBMIT_FILES
Upload     = Files prepared for upload by ctest_upload(), in Upload.xml
Submit     = nothing
Done       = Build is complete, in Done.xml
FILES <file>...

指定要提交的特定檔案的明確清單。每個個別檔案在呼叫時都必須存在。

SUBMIT_URL <url>

在 3.14 版本中新增。

要將提交發送到的儀表板伺服器的 httphttps URL。如果未給定,則使用 CTEST_SUBMIT_URL 變數。

BUILD_ID <result-var>

在 3.15 版本中新增。

將 CDash 指派給此建置的 ID 儲存在 <result-var> 變數中。

HTTPHEADER <HTTP-header>

在 3.9 版本中新增。

指定在提交期間包含在 CDash 請求中的 HTTP 標頭。例如,可以將 CDash 設定為僅接受來自已驗證客戶端的提交。在這種情況下,您應該在標頭中提供持有人令牌。

ctest_submit(HTTPHEADER "Authorization: Bearer <auth-token>")

可以重複多次此子選項以設定多個標頭。

RETRY_COUNT <count>

指定逾時提交的重試次數。

RETRY_DELAY <delay>

指定在逾時提交後,嘗試重新提交之前要等待的時間長度(以秒為單位)。

RETURN_VALUE <result-var>

如果成功,則在 <result-var> 變數中儲存 0,如果失敗則儲存非零值。

CAPTURE_CMAKE_ERROR <result-var>

在 3.13 版本中新增。

如果執行命令時有任何錯誤,則在 <result-var> 變數中儲存 -1,並防止 ctest 在發生錯誤時傳回非零值。

QUIET

在 3.3 版本中新增。

抑制所有原本會列印到控制台的非錯誤訊息。

提交到 CDash 上傳 API

在 3.2 版本中新增。

ctest_submit(CDASH_UPLOAD <file> [CDASH_UPLOAD_TYPE <type>]
             [SUBMIT_URL <url>]
             [BUILD_ID <result-var>]
             [HTTPHEADER <header>]
             [RETRY_COUNT <count>]
             [RETRY_DELAY <delay>]
             [RETURN_VALUE <result-var>]
             [QUIET])

第二個簽章用於透過 CDash 檔案上傳 API 將檔案上傳到 CDash。API 首先發送一個上傳到 CDash 的請求以及檔案的內容雜湊。如果 CDash 尚未擁有該檔案,則會上傳該檔案。除了檔案之外,還會指定 CDash 類型字串,以告知 CDash 要使用哪個處理程式來處理資料。

此簽章以與第一個簽章相同的方式解讀選項。

在 3.8 版本中新增:新增 RETRY_COUNTRETRY_DELAYQUIET 選項。

在 3.9 版本中新增:新增 HTTPHEADER 選項。

在 3.13 版本中新增:新增 RETURN_VALUE 選項。

在 3.14 版本中新增:新增 SUBMIT_URL 選項。

在 3.15 版本中新增:新增 BUILD_ID 選項。