jenkins_generic_jobΒΆ

jenkins_generic_job is a script in CIMEROOT/scripts/Tools.

$ ./jenkins_generic_job --help
usage: 
jenkins_generic_job [-g] [-d] [--verbose]
OR
jenkins_generic_job --help

EXAMPLES:
    # Run the tests and compare baselines 
    > jenkins_generic_job
    # Run the tests, compare baselines, and update dashboard 
    > jenkins_generic_job -d
    # Run the tests, generating a full set of baselines (useful for first run on a machine) 
    > jenkins_generic_job -g

Jenkins runs this script to perform a test of an e3sm test suite. Essentially,
a wrapper around create_test and wait_for_tests that handles cleanup of old
test results and ensures that the batch system is left in a clean state.

options:
  -h, --help            show this help message and exit
  -d, --debug           Print debug information (very verbose) to file /home/t
                        itters/devel/E3SM/cime/master/scripts/Tools/jenkins_ge
                        neric_job.log (default: False)
  -v, --verbose         Add additional context (time and file) to log messages
                        (default: False)
  -s, --silent          Print only warnings and error messages (default:
                        False)
  -g, --generate-baselines
                        Generate baselines (default: False)
  --baseline-compare    Do baseline comparisons. Off by default. (default:
                        False)
  --submit-to-cdash     Send results to CDash (default: False)
  -n, --no-submit       Force us to not send results to CDash, overrides
                        --submit-to-cdash. Useful for CI (default: False)
  --update-success      Record test success in baselines. Only the nightly
                        process should use this in general. (default: False)
  --no-update-success   For us to not record test success in baselines,
                        overrides --update-success. Useful for CI. (default:
                        False)
  --no-batch            Do not use batch system even if on batch machine
                        (default: False)
  -c CDASH_BUILD_NAME, --cdash-build-name CDASH_BUILD_NAME
                        Build name to use for CDash submission. Default will
                        be <TEST_SUITE>_<BRANCH>_<COMPILER> (default: None)
  -p CDASH_PROJECT, --cdash-project CDASH_PROJECT
                        The name of the CDash project where results should be
                        uploaded (default: E3SM)
  -b BASELINE_NAME, --baseline-name BASELINE_NAME
                        Baseline name for baselines to use. Also impacts
                        dashboard job name. Useful for testing a branch other
                        than next or master (default: None)
  -B BASELINE_ROOT, --baseline-root BASELINE_ROOT
                        Baseline area for baselines to use. Default will be
                        config_machine value for machine (default: None)
  -O OVERRIDE_BASELINE_NAME, --override-baseline-name OVERRIDE_BASELINE_NAME
                        Force comparison with these baseines without impacting
                        dashboard or test-id. (default: None)
  -t TEST_SUITE, --test-suite TEST_SUITE
                        Override default e3sm test suite that will be run
                        (default: None)
  -r SCRATCH_ROOT, --scratch-root SCRATCH_ROOT
                        Override default e3sm scratch root. Use this to avoid
                        conflicting with other jenkins jobs (default: None)
  --cdash-build-group CDASH_BUILD_GROUP
                        The build group to be used to display results on the
                        CDash dashboard. (default: ACME_Latest)
  -j PARALLEL_JOBS, --parallel-jobs PARALLEL_JOBS
                        Number of tasks create_test should perform
                        simultaneously. Default will be min(num_cores,
                        num_tests). (default: None)
  --walltime WALLTIME   Force a specific walltime for all tests. (default:
                        None)
  -m MACHINE, --machine MACHINE
                        The machine for which to build tests, this machine
                        must be defined in the config_machines.xml file for
                        the given model. Default is to match the name of the
                        machine in the test name or the name of the machine
                        this script is run on to the NODENAME_REGEX field in
                        config_machines.xml. This option is highly unsafe and
                        should only be used if you know what you're doing.
                        (default: None)
  --compiler COMPILER   Compiler to use to build cime. Default will be the
                        default defined for the machine. (default: None)
  --check-throughput    Fail if throughput check fails (fail if tests slow
                        down) (default: False)
  --check-memory        Fail if memory check fails (fail if tests footprint
                        grows) (default: False)