buildtest

This documentation was last rebuild on Sep 25, 2020 and is intended for version 0.8.1.

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/

• Travis: https://travis-ci.com/buildtesters/buildtest

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

• Coveralls: https://coveralls.io/github/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 Buildspecs Overview.

A spin-off project called lmodule which is a Python API for Lmod. The buildtest module features were deprecated and moved to lmodule with the main object of automating 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
  • 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 with buildtest
  • Interacting with the client
  • Build Usage
  • Discover Buildspecs
  • Building a Test
  • Building by Executors
  • Control builds by Stages
  • Buildspecs
  • Test Reports (buildtest report)
  • buildtest schemas
  • Debug Mode
  • Accessing buildtest documentation
  • Logfile
• Configuring buildtest
  • Default Configuration
  • Executors
  • buildtest configuration for Cori @ NERSC
  • buildtest configuration for Ascent @ OLCF
  • buildspec roots
  • Before & After scripts for executors
  • CLI to buildtest configuration
  • Example Configurations
• Builder Process
  • Parse Stage
• Writing buildspecs
  • Global Schema
  • Buildspecs Overview
  • Compiler Schema
  • Batch Scheduler Support
• Scripting in buildtest
• Conference and Publications
  • Talks
  • Publications
  • Article

Development Guide

• Contributing Guide
  • Maintainers
  • General Tips
  • Contributing Topics
• API Reference
  • buildtest

License

buildtest is released under the MIT license

Indices and tables

• Index

• Module Index

• Search Page