Scripts

This package also provides the following CLI:

• okify_regtests: Assist with okifying new outputs as new truths to resolve failing tests; only run this when you are very sure the new outputs are correct.

okify_regtests

The okify_regtests command “okifies” a set of failing regression test results, by overwriting truth files on Artifactory so that a set of failing regression test results becomes correct. It requires JFrog CLI (https://jfrog.com/getcli/) configured with valid credentials (jf login) and write access to the desired truth file repository (jwst-pipeline, roman-pipeline, etc.).

To see the syntax and usage, from a terminal, type:

okify_regtests --help

usage: okify_regtests [-h] [--version] [--dry-run] [--output-dir OUTPUT_DIR]
                      {jwst,roman} run-number

"Okifies" a set of failing regression test results, by overwriting truth files
on Artifactory so that a set of failing regression test results becomes
correct. Requires JFrog CLI (https://jfrog.com/getcli/) configured with
credentials (jf login) and write access to the desired truth file repository
(jwst-pipeline, roman-pipeline, etc.).

positional arguments:
  {jwst,roman}          Observatory to overwrite truth files for on
                        Artifactory.
  run-number            GitHub Actions job number of regression test run (see 
                        https://github.com/spacetelescope/RegressionTests/acti
                        ons).

options:
  -h, --help            show this help message and exit
  --version             Print package version and exit.
  --dry-run             Do nothing (passes the --dry-run flag to JFrog CLI).
  --output-dir OUTPUT_DIR
                        Store downloaded artifacts in the given path. Defaults
                        to a temporary directory.

Example for jwst:

okify_regtests jwst 956 --dry-run

Example for roman:

okify_regtests roman 1317