buildtest

This documentation was last rebuild on May 18, 2022 and is intended for version 0.14.0.

If you are working off a latest release please see https://buildtest.readthedocs.io/en/latest/ for documentation. If you are working off devel branch then please refer to https://buildtest.readthedocs.io/en/devel/ which references the devel branch.

Useful Links

• Source Code: https://github.com/buildtesters/buildtest

• Documentation: http://buildtest.rtfd.io/

• Schema Docs: https://buildtesters.github.io/buildtest/

• ReadTheDocs: https://readthedocs.org/projects/buildtest/

• CodeCov: https://codecov.io/gh/buildtesters/buildtest

• Slack Channel: http://hpcbuildtest.slack.com

• Slack Invite: https://hpcbuildtest.herokuapp.com

• CodeFactor: https://www.codefactor.io/repository/github/buildtesters/buildtest

• Snyk: https://app.snyk.io/org/buildtesters/

• NERSC Test Repository: https://github.com/buildtesters/buildtest-nersc

Description

buildtest is a testing framework to help HPC sites write test for their system as part of their routine acceptance & regression test. buildtest provides a YAML interface to write tests which buildtest can validate and generate shell scripts that can run on your HPC system. The test template (YAML) is called buildspec which can define one or more test instance that is validated by a json schema. buildtest supports the following batch schedulers: IBM Spectrum LSF, Slurm, PBS and Cobalt. We publish the schema documentation, json schemas, and schema examples at https://buildtesters.github.io/buildtest/ which is useful when you are writing buildspecs.

To get started with buildtest, please see Installing buildtest and Getting Started Guide.

A spin-off project called lmodule is a Python API for Lmod. The buildtest module features were deprecated and moved to lmodule with the main objective is to automate module load testing. For more details on lmodule see https://github.com/buildtesters/lmodule

Background

• Summary of buildtest
  • Background
  • Motivation
  • Inception of buildtest
  • Preview of buildtest
  • Target Audience & Use Case
  • Timeline
  • Related Projects and community efforts

Tutorial

• Installing buildtest
  • Requirements
  • Cloning buildtest
  • Installing buildtest
  • Specify Python Wrapper via BUILDTEST_PYTHON
  • Development Dependencies (Optional)
  • Usage (buildtest --help)
• Buildtest Tutorial
  • Building Test via buildtest (buildtest build)
  • Buildspecs Interface
  • Query Test Report
• Buildspec Tutorial
  • Global Schema
  • Buildspec Overview
  • Using Compiler Schema
  • Buildtest Spack Integration
  • Tutorials Setup

Reference

• Configuring buildtest
  • Overview
  • Defining Compilers at your site
  • Site Examples
• Batch Scheduler Support
  • Slurm
  • LSF
  • PBS
  • Cobalt
  • Jobs exceeds max_pend_time
  • Access PBS Container
• Build and Test Process
  • Discover Buildspecs
  • Parse Buildspecs
  • Building Buildspecs
  • Running Buildspecs
• Additional Features
  • Accessing build history (buildtest history)
  • Accessing buildtest documentation
  • Disabling Colored Output
  • CDASH Integration (buildtest cdash)
  • Cleaning buildtest files (buildtest clean)
  • Changing Directories (buildtest cd)
  • Get Path for Test (buildtest path)
  • Buildtest Debug Report (buildtest debugreport)
  • Command Line Interface to buildtest configuration
• Buildtest Schemas
  • CLI for buildtest schemas (buildtest schema)
  • Schema Naming Convention
  • Schema Files
  • Schema Examples
• Facility Test Examples
  • Single Test Multiple Compilers
  • MPI Example
  • OpenMP Hello Processor Scaling Test
  • Cray Burst Buffer & Data Warp
• Using buildtest at HPC sites
  • Picking a version of buildtest
  • Configuring buildtest for your site
  • Writing Test
• Conference and Publications
  • Talks
  • Publications
  • Article

Development Guide

• Contributing Guide
  • Overview
  • Contributing Topics
• buildtest API Reference
  • buildtest
• Buildtest Command Reference
  • Named Arguments
  • COMMANDS
  • Sub-commands:

License

buildtest is released under the MIT license

Indices and tables

• Index

• Module Index

• Search Page