buildtest.cli.cdash

Module Contents

Functions

cdash_cmd(args[, default_configuration, open_browser, ...])

This method is entry point for buildtest cdash command which implements uploading

view_cdash_project(cdash_config, config_file[, ...])

Open CDASH project in browser which can be done by running buildtest cdash view.

upload_test_cdash(build_name, configuration[, site, ...])

This method is responsible for reading report file and pushing results to CDASH
buildtest.cli.cdash.cdash_cmd(args, default_configuration=None, open_browser=True, report_file=None)[source]

This method is entry point for buildtest cdash command which implements uploading results to CDASH server and command line interface to open CDASH project.

Parameters:

  • args (dict) – Parsed arguments from ArgumentParser.parse_args

  • default_configuration (buildtest.config.SiteConfiguration, optional) – The loaded default configuration which is an instance of SiteConfiguration class

  • open_browser (bool, optional) – boolean to control if we open page in web browser using webbrowser.open(). This is enabled by default, but can be turned off especially when running regression test where we don’t want to see the page

buildtest.cli.cdash.view_cdash_project(cdash_config, config_file, open_browser=None)[source]

Open CDASH project in browser which can be done by running buildtest cdash view. :param cdash_config: Loaded CDASH configuration from configuration file :type cdash_config: dict :param config_file: Path to configuration file :type config_file: str :param open_browser: Determine whether to open file in browser. This option is useful for regression check since we dont want to open file during a run :type open_browser: bool, optional

buildtest.cli.cdash.upload_test_cdash(build_name, configuration, site=None, report_file=None, open_browser=None)[source]

This method is responsible for reading report file and pushing results to CDASH server. User can specify cdash settings in configuration file or pass them in command line. The command buildtest cdash upload will upload results to CDASH.

Shown below is an example output. In this example demo is the build name that shows up in CDASH result.

(buildtest)  ~/Documents/github/buildtest/ [buildtest_build*] buildtest cdash upload -o demo
Reading report file:  /Users/siddiq90/Documents/github/buildtest/var/report.json
Uploading 1 tests
Build Name:  demo
site:  generic
MD5SUM: 02049fc1dad67acdeac79a4ffc24e553
You can view the results at: https://my.cdash.org//viewTest.php?buildid=2181193
Parameters:

  • build_name (str) – build name that shows up in CDASH

  • configuration (buildtest.config.SiteConfiguration) – Instance of SiteConfiguration class that contains the configuration file

  • site (str, optional) – Site name that shows up in CDASH

  • report (str, optional) – Path to report file when uploading results. This is specified via buildtest cdash upload -r command

  • open_browser (str, optional) – Open CDASH report in web browser. This is specified via buildtest cdash upload --open command