This repository is Cori Testsuite with buildtest. A mirror of this repository is located at https://software.nersc.gov/siddiq90/buildtest-cori used for running gitlab CI specified in file .gitlab-ci.yml.
To get started clone this repo on Cori as follows:
git clone https://github.com/buildtesters/buildtest-cori
buildtest configuration file is read at $HOME/.buildtest if you don't have a directory please run
mkdir $HOME/.buildtest
Next, navigate to buildtest-cori directory and copy your site configuration to the following location
cd buildtest-cori
cp .config.yml $HOME/.buildtest/config.yml
Assuming you have installed buildtest you can view and validate your configuration via:
buildtest config validate
buildtest config view
Please make sure you are using tip of devel with buildtest when writing tests. You should sync your local devel with upstream
fork, for more details see https://buildtest.readthedocs.io/en/devel/contributing/code_contribution_guide.html
First time around you should discover all buildspecs this can be done via buildtest buildspec find. The command below will find
and validate all buildspecs in the buildtest-cori repo and load them in buildspec cache.
$ buildtest buildspec find --root /path/to/buildtest-cori/buildspecs
The buildspecs are loaded in buildspec cache file (JSON) that is used by buildtest buildspec find for querying cache. Subsequent runs will
read from cache. For more details see buildspec interface.
Note: All tests are written in YAML using .yml extension
To build tests use buildtest build command for example we build all tests in system directory as follows
buildtest build -b system/
You can specify multiple buildspecs either files or directory via -b option
buildtest build -b slurm/partition.yml -b slurmutils/
You can exclude a buildspec via -x option this behaves same way as -b option so you can specify
a directory or filepath which could be absolute path, or relative path. This is useful when
you want to run multiple tests grouped in directory but exclude a few.
buildtest build -b slurm -x slurm/sinfo.yml
buildtest can run tests via tags which can be useful when grouping tests, to see a list of available tags you
can run: buildtest buildspec find --tags
For instance if you want to run all lustre tests you can use buildtest build --tags option.
(buildtest) siddiq90@cori10:~/github/buildtest-cori> buildtest build --tags lustre
User: siddiq90
Hostname: cori10
Platform: Linux
Current Time: 2021/04/13 21:47:43
buildtest path: /global/homes/s/siddiq90/github/buildtest/bin/buildtest
buildtest version: 0.9.5
python path: /global/homes/s/siddiq90/.conda/envs/buildtest/bin/python
python version: 3.8.8
Test Directory: /global/homes/s/siddiq90/.buildtest/var/tests
Configuration File: /global/homes/s/siddiq90/.buildtest/config.yml
+-------------------------------+
| Stage: Discovering Buildspecs |
+-------------------------------+
Discovered Buildspecs:
/global/u1/s/siddiq90/github/buildtest-cori/buildspecs/filesystem/lustre.yml
BREAKDOWN OF BUILDSPECS BY TAGS
lustre
----------------------------------------------------------------------------
/global/u1/s/siddiq90/github/buildtest-cori/buildspecs/filesystem/lustre.yml
+---------------------------+
| Stage: Parsing Buildspecs |
+---------------------------+
schemafile | validstate | buildspec
-------------------------+--------------+------------------------------------------------------------------------------
script-v1.0.schema.json | True | /global/u1/s/siddiq90/github/buildtest-cori/buildspecs/filesystem/lustre.yml
name description
------------------- ---------------------------
lustre_osts List all lustre OSTs
lustre_mdts List all lustre MDTs
lustre_nstaff_quota Show quota for group nstaff
+----------------------+
| Stage: Building Test |
+----------------------+
name | id | type | executor | tags | testpath
---------------------+----------+--------+-----------------+---------------------------------------------+--------------------------------------------------------------------------------------------------------------
lustre_osts | d44454aa | script | cori.local.bash | ['daily', 'system', 'filesystem', 'lustre'] | /global/homes/s/siddiq90/.buildtest/var/tests/cori.local.bash/lustre/lustre_osts/3/stage/generate.sh
lustre_mdts | f5730b5e | script | cori.local.bash | ['daily', 'system', 'filesystem', 'lustre'] | /global/homes/s/siddiq90/.buildtest/var/tests/cori.local.bash/lustre/lustre_mdts/3/stage/generate.sh
lustre_nstaff_quota | 479d1b57 | script | cori.local.bash | ['daily', 'system', 'filesystem', 'lustre'] | /global/homes/s/siddiq90/.buildtest/var/tests/cori.local.bash/lustre/lustre_nstaff_quota/3/stage/generate.sh
+---------------------+
| Stage: Running Test |
+---------------------+
name | id | executor | status | returncode
---------------------+----------+-----------------+----------+--------------
lustre_osts | d44454aa | cori.local.bash | PASS | 0
lustre_mdts | f5730b5e | cori.local.bash | PASS | 0
lustre_nstaff_quota | 479d1b57 | cori.local.bash | PASS | 0
+----------------------+
| Stage: Test Summary |
+----------------------+
Passed Tests: 3/3 Percentage: 100.000%
Failed Tests: 0/3 Percentage: 0.000%
Writing Logfile to: /tmp/buildtest_0m3fe3m9.log
A copy of logfile can be found at $BUILDTEST_ROOT/buildtest.log - /global/homes/s/siddiq90/github/buildtest/buildtest.log
When you write buildspecs, please make sure you attach one or more tags to the test that way your test will get picked up during one of the CI checks. Shown
below is a summary of tag description
- daily - this tag is used for running daily system checks using gitlab CI. Tests should run relatively quick
- system - this tag is used for classifying all system tests that may include: system configuration, servers, network, cray tests. This tag should be used
- slurm - this tag is used for slurm test that includes slurm utility check, slurm controller, etc... This tag shouldn't be used for job submission that is managed by jobs tag. The
slurmtag tests should be short running test that use a Local Executor. - jobs - this tag is used for testing slurm policies by submitting jobs to scheduler.
- compile - this tag is used for compilation of application (OpenMP, MPI, OpenACC, CUDA, upc, bupc, etc...)
- e4s - this tag is used for running tests from E4S Testsuite for E4S stack deployed on Cori.
- module - this tag is used for testing module system
- benchmark - this tag is used for benchmark tests. This can be application benchmarks, mini-benchmarks, kernels, etc...
You can use buildtest report and buildtest inspect to query tests. The commands differ slightly and data is
represented differently. The buildtest report command will show output in tabular form and only show some of the metadata,
if you want to access the entire test record use buildtest inspect command which displays the content in JSON format.
For more details on querying tests see https://buildtest.readthedocs.io/en/devel/gettingstarted/query_test_report.html
There is a github workflow .mirror_to_cori.yml
responsible for mirroring upstream project to https://software.nersc.gov/siddiq90/buildtest-cori. We have setup a gitlab
secret that contains gitlab personal access token created from
https://software.nersc.gov/-/profile/personal_access_tokens. The Personal access token must have read_api, read_repository, write_repository scope.
Tests are run on schedule basis with one schedule corresponding to one gitlab job in .gitlab-ci.yml. The scheduled pipelines are configured in
https://software.nersc.gov/siddiq90/buildtest-cori/-/pipeline_schedules. Each schedule has a variable defined to control which pipeline
is run. In the .gitlab-ci.yml we make use of conditional rules using only. For example the daily
system test has variable defined DAILYCHECK set to True and the gitlab job is defined as follows:
scheduled_system_check:
stage: test
only:
refs:
- schedules
variables:
- $DAILYCHECK == "True"
The scheduled jobs are run at different intervals (1x/day, 1x/week, etc...) at different times of day to avoid overloading the system. The gitlab jobs
will run jobs based on tags, alternately some tests may be defined by running all tests in a directory (buildtest build -b apps). If you want to add a new
scheduled job, please define a new schedule with an appropriate time. The
target branch should be devel and define a unique variable used to distinguish scheduled jobs. Next, create a job in .gitlab-ci.yml that references
the scheduled job based on the variable name.
The validate_tests gitlab job is responsible for validating buildspecs, please review this job when contributing tests. The buildspec must pass validation
in order for buildtest to build and run the test.
buildtest-cori mirror repo has integration with Github and Slack. The integrations can be found at https://software.nersc.gov/siddiq90/buildtest-cori/-/settings/integrations. The Github integration will push result back to upstream project: https://github.com/buildtesters/buildtest-cori. The CI checks are pushed to buildtest Slack at #cori-testsuite workspace.
buildtest will push test results to CDASH server
at https://my.cdash.org/index.php?project=buildtest-cori using buildtest cdash upload command which
uploads all tests found in report file found in $HOME/.buildtest/report.json.
To contribute back you will want to make sure your buildspec is validated before you contribute back, this could be
done by running test manually buildtest build or see if buildspec is valid via buildtest buildspec find. It
would be good to run your test and make sure it is working as expected, you can view test detail using buildtest inspect id <ID>
or see Test Inspection section.
buildtest relies on json schema to validate buildspecs and you will need to understand the json schema to understand how to write valid tests. To get all schemas run the following:
$ buildtest schema
global.schema.json
definitions.schema.json
settings.schema.json
compiler-v1.0.schema.json
script-v1.0.schema.json
The schemas script, compiler, global are of interest when writing buildspec to view the json content for script
schema you can run buildtest schema -n script-v1.0.schema.json --json.
To view all examples for script schema you can run buildtest schema -n script-v1.0.schema.json --examples which will show
all invalid/valid tests. buildtest will validate each example before it shows content which will be help understand how to write
tests and see all the edge cases.
Alternately you can see all published schemas and examples on https://buildtest.readthedocs.io/en/devel/buildspecs/schema_examples.html
If you want to contribute your tests, please see CONTRIBUTING.md
- buildtest documentation: https://buildtest.readthedocs.io/en/devel/
- buildtest schema docs: https://buildtesters.github.io/buildtest/
- Getting Started: https://buildtest.readthedocs.io/en/devel/getting_started.html
- Writing Buildspecs: https://buildtest.readthedocs.io/en/devel/writing_buildspecs.html
- Contributing Guide: https://buildtest.readthedocs.io/en/devel/contributing.html