Logo
stable

Background

  • Summary of buildtest

Getting Started

  • Installing buildtest
  • Quick Start Guide

Tutorial

  • Command Line Tutorial
  • Buildspec Tutorial
  • Buildtest Tutorial on Perlmutter

How-to-guides

  • How to configure buildtest
  • Batch Scheduler Support
  • Troubleshooting Buildtest

Explanation

  • Build and Test Process
  • Using buildtest at HPC sites

Reference

  • Buildtest Command Line Reference
  • Writing Buildspecs
    • Global Schema
    • Compilation Example
    • Defining Metrics
    • Test Dependency
    • Running Test Across Multiple Executors
    • Customize Shell
    • Running Tests in Containers (Experimental)
    • Status Checks
    • Comparison Operators
  • Additional Features
  • Buildtest Schemas
  • Facility Test Examples
  • buildtest API Reference
  • Buildtest Command Reference
  • Conference and Publications

Development Guide

  • Contributing Guide

Useful Links

  • Buildtest Github repo
  • Buildtest Slack
  • buildtest at NERSC
buildtest
  • Writing Buildspecs
  • Edit on GitHub
Previous Next

Writing Buildspecs

Buildspec Reference

  • Global Schema
    • Schema Definition
    • Example Buildspec
    • Defining Maintainers
    • Test Names
    • Buildspec Structure
  • Compilation Example
    • Hello World Example
    • STREAM Benchmark Example
  • Defining Metrics
    • Metrics with Regex Type via β€˜re’
    • Extract line numbers in Metrics
    • Invalid Metrics
  • Test Dependency
    • Test Dependency by returncode
    • Test Dependency by state
  • Running Test Across Multiple Executors
    • Multiple Executors
    • Scheduler Directives
    • Cray Burst Buffer and Data Warp
    • Custom Status by Executor
  • Customize Shell
    • Shell Type
    • Customize Shebang
    • Python Shell
  • Running Tests in Containers (Experimental)
    • Running a docker container
    • Running a Singularity container
    • Run Commands in Container
    • Running Scripts in Container
    • Specify Volume Mounts
    • Running Test in Container Executor
  • Status Checks
    • returncode: Return Code Matching
    • regex: Regular Expression on stdout/stderr
    • file_regex: Regular Expression on files
    • runtime: Passing Test based on runtime
    • state: Explicitly Declare Status of Test
    • File Checks
    • file_count: File Count
    • linecount: Line Count on Stdout/Stderr
    • file_linecount: Line Count on File
    • re: Modify regular expression method
    • post_run: Specify Post Run Tests
  • Comparison Operators
    • assert_ge: Greater Equal
    • assert_gt: Greater Than
    • assert_le: Less Than Equal
    • assert_lt: Less Than
    • assert_eq: Equal
    • assert_ne: Not Equal
    • assert_range: Upper and Lower Bound
    • contains, not_contains: Contains and Not Contains
Previous Next

© Copyright Copyright (c) 2021-2024, The Regents of the University of California, through Lawrence Berkeley National Laboratory (subject to receipt of any required approvals from the U.S. Dept. of Energy), Shahzeb Siddiqui, and Vanessa Sochat. All rights reserved.. Revision b270f3cd.

Built with Sphinx using a theme provided by Read the Docs.