canary report#

Create reports from Canary results

canary report [-h] report-type ...

Optional arguments

-h, --help: Show this help message and exit.

Subcommands

report gitlab-mr
report cdash

report markdown
report junit

report json

report html

canary report gitlab-mr#

canary report gitlab-mr [-h] [--cdash-url CDASH_URL] [-a ACCESS_TOKEN]

Optional arguments

-h, --help: show this help message and exit
--cdash-url CDASH_URL: Add a link to a CDash report for this MR
-a ACCESS_TOKEN, --access-token ACCESS_TOKEN: GitLab access token that allows GET/POST to the merge request API

canary report cdash#

canary report cdash [-h] subcommands ...

Optional arguments

-h, --help: show this help message and exit

Subcommands

report cdash create

report cdash post

report cdash summary

report cdash make-gitlab-issues

canary report cdash create#

canary report cdash create [-h] [--name-format {short,long}] [--build name] [--site name] [-f file] [-d directory]
                       [--track track | --build-stamp stamp] [-n CHUNK_SIZE] [-L LABEL]
                       [--subproject-labels LABELS]

Optional arguments

-h, --help: show this help message and exit
--name-format {short,long}: Name as shown on the CDash landing page [default: short]
--build name: The name of the build that will be reported to CDash.
--site name: The site name that will be reported to CDash. [default: current system hostname]
-f file: Read site, build, and buildstamp from this XML file (eg, Build.xml or Configure.xml)
-d directory: Write reports to this directory [default: $session/_reports/cdash]
--track track: Results will be reported to this group on CDash [default: Experimental]
--build-stamp stamp: Instead of letting the CDash reporter prepare the buildstamp which, when combined with build name, site and project, uniquely identifies the build, provide this argument to identify the build yourself. Format: %Y%m%d-%H%M-<track>
-n CHUNK_SIZE: The results will be split into chunks of N entries per XML file. If N is -1 the XML will be not be split and will be stored as a single file.
-L LABEL: Label that will be treated as a subproject
--subproject-labels LABELS: Comma-separated list of labels that will be treated as subprojects

canary report cdash post#

canary report cdash post [-h] --project CDASH_PROJECT --url CDASH_URL [--done] [files ...]

Positional arguments

files: XML files to post

Optional arguments

-h, --help: show this help message and exit
--project CDASH_PROJECT, --cdash-project CDASH_PROJECT: The CDash project
--url CDASH_URL, --cdash-url CDASH_URL: The base CDash url (do not include project)
--done: Post Done.xml to the build.

canary report cdash summary#

canary report cdash summary [-h] [--project CDASH_PROJECT] [--url CDASH_URL] [-t TRACK] [-m MAILTO] [-s SKIP_SITE]
                        [-o OUTPUT]

Optional arguments

-h, --help: show this help message and exit
--project CDASH_PROJECT, --cdash-project CDASH_PROJECT: The CDash project
--url CDASH_URL, --cdash-url CDASH_URL: The base CDash url (do not include project)
-t TRACK, --track TRACK: CDash build groups to pull from CDash [default: all]
-m MAILTO, --mailto MAILTO: Email addresses to send the summary.
-s SKIP_SITE, --skip-site SKIP_SITE: Sites to skip (accepts Python regular expression)
-o OUTPUT: Filename to write the html summary [default: stdout]

canary report cdash make-gitlab-issues#

canary report cdash make-gitlab-issues [-h] --cdash-url CDASH_URL --cdash-project CDASH_PROJECT --gitlab-url
                                   GITLAB_URL --gitlab-api-url GITLAB_API_URL --gitlab-project-id
                                   GITLAB_PROJECT_ID [-a ACCESS_TOKEN] [-d DATE] [-f FILTER_GROUPS]
                                   [--skip-site SKIP_SITE] [--dont-close-missing]

Optional arguments

-h, --help: show this help message and exit
--cdash-url CDASH_URL: The base CDash url, do not include project
--cdash-project CDASH_PROJECT: The base CDash project
--gitlab-url GITLAB_URL: The GitLab project url
--gitlab-api-url GITLAB_API_URL: The GitLab project’s API url
--gitlab-project-id GITLAB_PROJECT_ID: The GitLab project’s ID
-a ACCESS_TOKEN: The GitLab read/write API access token.
-d DATE, --date DATE: Date to retrieve from CDash
-f FILTER_GROUPS, --filtergroups FILTER_GROUPS: Groups to pull down from CDash
--skip-site SKIP_SITE: Sites to skip (accepts Python regular expression)
--dont-close-missing: Don’t close issues belonging to missing tests

canary report markdown#

canary report markdown [-h] [-o OUTPUT_DIR]

Optional arguments

-h, --help: show this help message and exit
-o OUTPUT_DIR, --output-dir OUTPUT_DIR: Output directory [default: MARKDOWN]

canary report junit#

canary report junit [-h] [-o OUTPUT]

Optional arguments

-h, --help: show this help message and exit
-o OUTPUT, --output OUTPUT: Output file [default: junit.xml]

canary report json#

canary report json [-h] [-o OUTPUT]

Optional arguments

-h, --help: show this help message and exit
-o OUTPUT, --output OUTPUT: Output file [default: canary.json]

canary report html#

canary report html [-h] [-o OUTPUT_DIR]

Optional arguments

-h, --help: show this help message and exit
-o OUTPUT_DIR, --output-dir OUTPUT_DIR: Output directory [default: HTML]