CTest: Add documentation and release notes for SubmitURL

This commit is contained in:
Regina Pfeifer 2019-01-11 14:18:12 +01:00 committed by Brad King
parent d6475daa79
commit 2915a75615
6 changed files with 45 additions and 14 deletions

View File

@ -6,6 +6,7 @@ Perform the :ref:`CTest Submit Step` as a :ref:`Dashboard Client`.
:: ::
ctest_submit([PARTS <part>...] [FILES <file>...] ctest_submit([PARTS <part>...] [FILES <file>...]
[SUBMIT_URL <url>]
[HTTPHEADER <header>] [HTTPHEADER <header>]
[RETRY_COUNT <count>] [RETRY_COUNT <count>]
[RETRY_DELAY <delay>] [RETRY_DELAY <delay>]
@ -39,6 +40,10 @@ The options are:
Specify an explicit list of specific files to be submitted. Specify an explicit list of specific files to be submitted.
Each individual file must exist at the time of the call. Each individual file must exist at the time of the call.
``SUBMIT_URL <url>``
The ``http`` or ``https`` URL of the dashboard server to send the submission
to. If not given, the :variable:`CTEST_SUBMIT_URL` variable is used.
``HTTPHEADER <HTTP-header>`` ``HTTPHEADER <HTTP-header>``
Specify HTTP header to be included in the request to CDash during submission. Specify HTTP header to be included in the request to CDash during submission.
This suboption can be repeated several times. This suboption can be repeated several times.
@ -68,6 +73,7 @@ Submit to CDash Upload API
:: ::
ctest_submit(CDASH_UPLOAD <file> [CDASH_UPLOAD_TYPE <type>] ctest_submit(CDASH_UPLOAD <file> [CDASH_UPLOAD_TYPE <type>]
[SUBMIT_URL <url>]
[HTTPHEADER <header>] [HTTPHEADER <header>]
[RETRY_COUNT <count>] [RETRY_COUNT <count>]
[RETRY_DELAY <delay>] [RETRY_DELAY <delay>]
@ -80,5 +86,5 @@ with a content hash of the file. If CDash does not already have the file,
then it is uploaded. Along with the file, a CDash type string is specified then it is uploaded. Along with the file, a CDash type string is specified
to tell CDash which handler to use to process the data. to tell CDash which handler to use to process the data.
This signature accepts the ``HTTPHEADER``, ``RETRY_COUNT``, ``RETRY_DELAY``, This signature accepts the ``SUBMIT_URL``, ``HTTPHEADER``, ``RETRY_COUNT``,
``RETURN_VALUE`` and ``QUIET`` options as described above. ``RETRY_DELAY``, ``RETURN_VALUE`` and ``QUIET`` options as described above.

View File

@ -574,6 +574,7 @@ Variables for CTest
/variable/CTEST_RUN_CURRENT_SCRIPT /variable/CTEST_RUN_CURRENT_SCRIPT
/variable/CTEST_SCP_COMMAND /variable/CTEST_SCP_COMMAND
/variable/CTEST_SITE /variable/CTEST_SITE
/variable/CTEST_SUBMIT_URL
/variable/CTEST_SOURCE_DIRECTORY /variable/CTEST_SOURCE_DIRECTORY
/variable/CTEST_SVN_COMMAND /variable/CTEST_SVN_COMMAND
/variable/CTEST_SVN_OPTIONS /variable/CTEST_SVN_OPTIONS

View File

@ -1109,38 +1109,45 @@ Configuration settings include:
* :module:`CTest` module variable: ``CTEST_CURL_OPTIONS`` * :module:`CTest` module variable: ``CTEST_CURL_OPTIONS``
``DropLocation`` ``DropLocation``
The path on the dashboard server to send the submission. Legacy option. When ``SubmitURL`` is not set, it is constructed from
``DropMethod``, ``DropSiteUser``, ``DropSitePassword``, ``DropSite``, and
``DropLocation``.
* `CTest Script`_ variable: :variable:`CTEST_DROP_LOCATION` * `CTest Script`_ variable: :variable:`CTEST_DROP_LOCATION`
* :module:`CTest` module variable: ``DROP_LOCATION`` if set, * :module:`CTest` module variable: ``DROP_LOCATION`` if set,
else ``CTEST_DROP_LOCATION`` else ``CTEST_DROP_LOCATION``
``DropMethod`` ``DropMethod``
Specify the method by which results should be submitted to the Legacy option. When ``SubmitURL`` is not set, it is constructed from
dashboard server. The value may be ``http`` or ``https``. ``DropMethod``, ``DropSiteUser``, ``DropSitePassword``, ``DropSite``, and
``DropLocation``.
* `CTest Script`_ variable: :variable:`CTEST_DROP_METHOD` * `CTest Script`_ variable: :variable:`CTEST_DROP_METHOD`
* :module:`CTest` module variable: ``DROP_METHOD`` if set, * :module:`CTest` module variable: ``DROP_METHOD`` if set,
else ``CTEST_DROP_METHOD`` else ``CTEST_DROP_METHOD``
``DropSite`` ``DropSite``
The dashboard server name. Legacy option. When ``SubmitURL`` is not set, it is constructed from
``DropMethod``, ``DropSiteUser``, ``DropSitePassword``, ``DropSite``, and
``DropLocation``.
* `CTest Script`_ variable: :variable:`CTEST_DROP_SITE` * `CTest Script`_ variable: :variable:`CTEST_DROP_SITE`
* :module:`CTest` module variable: ``DROP_SITE`` if set, * :module:`CTest` module variable: ``DROP_SITE`` if set,
else ``CTEST_DROP_SITE`` else ``CTEST_DROP_SITE``
``DropSitePassword`` ``DropSitePassword``
The dashboard server login password, if any Legacy option. When ``SubmitURL`` is not set, it is constructed from
(for ``ftp``, ``http``, and ``https``). ``DropMethod``, ``DropSiteUser``, ``DropSitePassword``, ``DropSite``, and
``DropLocation``.
* `CTest Script`_ variable: :variable:`CTEST_DROP_SITE_PASSWORD` * `CTest Script`_ variable: :variable:`CTEST_DROP_SITE_PASSWORD`
* :module:`CTest` module variable: ``DROP_SITE_PASSWORD`` if set, * :module:`CTest` module variable: ``DROP_SITE_PASSWORD`` if set,
else ``CTEST_DROP_SITE_PASWORD`` else ``CTEST_DROP_SITE_PASWORD``
``DropSiteUser`` ``DropSiteUser``
The dashboard server login user name, if any Legacy option. When ``SubmitURL`` is not set, it is constructed from
(for ``ftp``, ``http``, and ``https``). ``DropMethod``, ``DropSiteUser``, ``DropSitePassword``, ``DropSite``, and
``DropLocation``.
* `CTest Script`_ variable: :variable:`CTEST_DROP_SITE_USER` * `CTest Script`_ variable: :variable:`CTEST_DROP_SITE_USER`
* :module:`CTest` module variable: ``DROP_SITE_USER`` if set, * :module:`CTest` module variable: ``DROP_SITE_USER`` if set,
@ -1166,6 +1173,14 @@ Configuration settings include:
* :module:`CTest` module variable: ``SITE``, * :module:`CTest` module variable: ``SITE``,
initialized by the :command:`site_name` command initialized by the :command:`site_name` command
``SubmitURL``
The ``http`` or ``https`` URL of the dashboard server to send the submission
to.
* `CTest Script`_ variable: :variable:`CTEST_SUBMIT_URL`
* :module:`CTest` module variable: ``SUBMIT_URL`` if set,
else ``CTEST_SUBMIT_URL``
``TriggerSite`` ``TriggerSite``
Legacy option. Not used. Legacy option. Not used.

View File

@ -0,0 +1,7 @@
ctest-submit-url
----------------
* CTest learned to accept the dashboard server submission URL from a single
variable. See the ``SubmitURL`` setting in :manual:`ctest(1)`,
the :variable:`CTEST_SUBMIT_URL` variable, and the ``SUBMIT_URL``
argument of the :command:`ctest_submit` command.

View File

@ -0,0 +1,5 @@
CTEST_SUBMIT_URL
----------------
Specify the CTest ``SubmitURL`` setting
in a :manual:`ctest(1)` dashboard client script.

View File

@ -28,10 +28,7 @@ To enable submissions to a CDash server, create a ``CTestConfig.cmake``
file at the top of the project with content such as:: file at the top of the project with content such as::
set(CTEST_NIGHTLY_START_TIME "01:00:00 UTC") set(CTEST_NIGHTLY_START_TIME "01:00:00 UTC")
set(CTEST_DROP_METHOD "http") set(CTEST_SUBMIT_URL "http://my.cdash.org/submit.php?project=MyProject")
set(CTEST_DROP_SITE "my.cdash.org")
set(CTEST_DROP_LOCATION "/submit.php?project=MyProject")
set(CTEST_DROP_SITE_CDASH TRUE)
(the CDash server can provide the file to a project administrator who (the CDash server can provide the file to a project administrator who
configures ``MyProject``). Settings in the config file are shared by configures ``MyProject``). Settings in the config file are shared by