buildtest

This documentation was last rebuild on Jan 20, 2021 and is intended for version 0.9.2.

Please refer to https://buildtest.readthedocs.io/en/latest/ for documentation on latest release. If you are working off devel branch then please to devel docs at https://buildtest.readthedocs.io/en/devel/.

Status

Source Code

• buildtest framework: https://github.com/buildtesters/buildtest

Test Repositories

• Cori @ NERSC: https://github.com/buildtesters/buildtest-cori

• Stampede2 @ TACC: https://github.com/buildtesters/buildtest-stampede2

Useful Links

• 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

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

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

• Slack Channel: http://hpcbuildtest.slack.com. Click Here to Join Slack

Description

buildtest is a HPC testing framework to help sites perform acceptance & regression testing of an HPC system. buildtest utilizes json schema to define structure of test written in YAML called a Buildspec File. The schema docs is a resource that hosts buildtest schemas and documents all field attributes for each schema, this will be useful when you are writting buildspecs.

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

To get started with buildtest, please review the Terminology and proceed to Installing buildtest followed by Getting Started.

For additional reference, you can read Summary of buildtest and Conference and Publications.

Background

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

Reference

• Installing buildtest
  • Requirements
  • Cloning buildtest
  • Installing buildtest
  • Development Dependencies (Optional)
  • Usage (buildtest --help)
• Getting Started
  • Interacting with the client
  • Build Usage
  • Discover Buildspecs
  • Building a Test
  • Building by Executors
  • Control builds by Stages
  • Rebuild Tests
  • Buildspecs Interface
  • Format buildspec cache
  • Test Reports (buildtest report)
  • Test Inspection
  • buildtest schemas
  • Debug Mode
  • Accessing buildtest documentation
  • Logfile
• Configuring buildtest
  • Default Configuration
  • What is an executor?
  • Executor Declaration
  • buildtest configuration for Cori @ NERSC
  • buildspec roots
  • Configuring Module Tool
  • before_script and after_script for executors
  • Compiler Declaration
  • Detect Compilers (Experimental Feature)
  • buildtest configuration for Ascent @ OLCF
  • buildtest configuration for JLSE @ ANL
  • CLI to buildtest configuration
  • Example Configurations
• Writing buildspecs
  • Global Schema
  • Buildspecs Overview
  • Compiler Schema
  • Batch Scheduler Support
  • Buildtest Schemas
• Build and Test Process
  • Pipeline
  • Parse Stage
• Scripting in buildtest
  • Discovering Buildspecs
  • Build Phase
  • Run Phase
• Conference and Publications
  • Talks
  • Publications
  • Article

Development Guide

• Contributing Guide
  • Contributing Topics
• API Reference
  • buildtest

License

buildtest is released under the MIT license

Indices and tables

• Index

• Module Index

• Search Page