Performance Checks¶
Defining Metrics¶
buildtest provides a method to define test metrics in the buildspecs which can be used to
store arbitrary content from the output/error file into named metric. A metric is
defined using the metrics property where each element under the metrics property
is the name of the metric which must be a unique name. A metric can apply regular expression
on stdout, stderr like in this example below. The metrics are captured in the test report which can
be queried via buildtest report or buildtest inspect. Shown below is an example
where we define two metrics named hpcg_rating and hpcg_state.
buildspecs:
metric_regex_example:
executor: generic.local.sh
type: script
description: capture result metric from output
run: echo "HPCG result is VALID with a GFLOP/s rating of=63.6515"
tags: tutorials
metrics:
hpcg_rating:
type: float
regex:
exp: '(\d+\.\d+)$'
stream: stdout
hpcg_state:
type: str
regex:
exp: '(VALID)'
stream: stdout
The metrics will not impact behavior of test, it will only impact the test report. By default
a metric will be an empty dictionary if there is no metrics property. If we fail to match
a regular expression, the metric will be defined as an empty string.
Note
If your regular expression contains an escape character \ you must surround your
string in single quotes ' as pose to double quotes "
Let’s build this test.
buildtest build -b tutorials/metrics_regex.yml
$ buildtest build -b tutorials/metrics_regex.yml
╭───────────────────────────── buildtest summary ──────────────────────────────╮
│ │
│ User: docs │
│ Hostname: build-19398495-project-280831-buildtest │
│ Platform: Linux │
│ Current Time: 2023/02/06 21:51:52 │
│ buildtest path: /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ buildtest version: 1.1 │
│ python path: /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ python version: 3.7.15 │
│ Configuration File: /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ Test Directory: /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ Report File: /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ Command: /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ │
╰──────────────────────────────────────────────────────────────────────────────╯
─────────────────────────── Discovering Buildspecs ────────────────────────────
Discovered buildspecs
╔══════════════════════════════════════════════════════════════════════════════╗
║ buildspec ║
╟──────────────────────────────────────────────────────────────────────────────╢
║ /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/t… ║
╚══════════════════════════════════════════════════════════════════════════════╝
Total Discovered Buildspecs: 1
Total Excluded Buildspecs: 0
Detected Buildspecs after exclusion: 1
────────────────────────────── Parsing Buildspecs ──────────────────────────────
Valid Buildspecs: 1
Invalid Buildspecs: 0
/home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/tutorials/metrics_regex.yml: VALID
Total builder objects created: 1
Builders by type=script
┏━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━┓
┃ builder ┃ type ┃ executor ┃ compiler ┃ nodes ┃ procs ┃ descrip… ┃ builds… ┃
┡━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━┩
│ metric_… │ script │ generic… │ None │ None │ None │ capture │ /home/… │
│ │ │ │ │ │ │ result │ │
│ │ │ │ │ │ │ metric │ │
│ │ │ │ │ │ │ from │ │
│ │ │ │ │ │ │ output │ │
└──────────┴────────┴──────────┴──────────┴───────┴───────┴──────────┴─────────┘
──────────────────────────────── Building Test ─────────────────────────────────
metric_regex_example/7895930c: Creating test directory: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/tests/generic.local.sh/metrics_regex/metric_regex_example/7895930c
metric_regex_example/7895930c: Creating the stage directory: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/tests/generic.local.sh/metrics_regex/metric_regex_example/7895930c/stage
metric_regex_example/7895930c: Writing build script: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/tests/generic.local.sh/metrics_regex/metric_regex_example/7895930c/metric_regex_example_build.sh
──────────────────────────────── Running Tests ─────────────────────────────────
Spawning 1 processes for processing builders
───────────────────────────────── Iteration 1 ──────────────────────────────────
metric_regex_example/7895930c does not have any dependencies adding test to queue
metric_regex_example/7895930c: Current Working Directory : /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/tests/generic.local.sh/metrics_regex/metric_regex_example/7895930c/stage
metric_regex_example/7895930c: Running Test via command: sh --norc --noprofile -eo pipefail metric_regex_example_build.sh
metric_regex_example/7895930c: Test completed in 0.003269 seconds
metric_regex_example/7895930c: Test completed with returncode: 2
metric_regex_example/7895930c: Writing output file - /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/tests/generic.local.sh/metrics_regex/metric_regex_example/7895930c/metric_regex_example.out
metric_regex_example/7895930c: Writing error file - /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/tests/generic.local.sh/metrics_regex/metric_regex_example/7895930c/metric_regex_example.err
In this iteration we are going to run the following tests: [metric_regex_example/7895930c]
Test Summary
┏━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━┓
┃ ┃ ┃ ┃ checks ┃ ┃ ┃
┃ ┃ ┃ ┃ (ReturnCode, ┃ ┃ ┃
┃ ┃ ┃ ┃ Regex, ┃ ┃ ┃
┃ builder ┃ executor ┃ status ┃ Runtime) ┃ returncode ┃ runtime ┃
┡━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━┩
│ metric_regex │ generic.loc… │ FAIL │ N/A N/A N/A │ 2 │ 0.003269 │
│ _example/789 │ │ │ │ │ │
│ 5930c │ │ │ │ │ │
└──────────────┴──────────────┴────────┴───────────────┴────────────┴──────────┘
Passed Tests: 0/1 Percentage: 0.000%
Failed Tests: 1/1 Percentage: 100.000%
Adding 1 test results to /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/report.json
Writing Logfile to: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/logs/buildtest_sj1dbudj.log
We can query the metrics via buildtest report which will display all metrics as a comma separted
Key/Value pair. We can use buildtest report --format metrics to extract all metrics for a test.
Internally, we store the metrics as a dictionary but when we print them out via buildtest report we
join them together into a single string. Shown below is the metrics for the previous build.
buildtest report --filter buildspec=tutorials/metrics_regex.yml --format name,metrics
$ buildtest report --filter buildspec=tutorials/metrics_regex.yml --format name,metrics
Report File: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/report.json
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ name ┃ metrics ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ metric_regex_example │ hpcg_rating=,hpcg_state= │
└────────────────────────────────────┴─────────────────────────────────────────┘
You can define a metric based on variables or environment variables
which requires you have set vars or env property in the buildspec. The vars and
env is a property under the metric name that can be used to reference name
of variable or environment variable. If you reference an invalid name, buildtest will assign the metric an empty string.
In this next example, we define two metrics gflop and foo that are assigned to variable GFLOPS and
environment variable FOO.
Comparison Operators¶
buildtest supports several comparison operators as part of status check such as >, >=, <=, <, ==, !=. Each metric is compared with a reference value that can be useful when running performance checks. In this section we will cover the following comparison:
Greater Equal¶
buildtest can determine status check based on performance check. In this next example, we will run the
STREAM memory benchmark and capture metrics named copy, scale
add and triad from the output and perform an Assertion Greater Equal (assert_ge) with a reference value.
The assert_ge contains a list of assertions where each metric name is
referenced via name that is compared with the reference value defined by ref property. The comparison
is metric_value >= ref, where metric_value is the value assigned to the metric name captured by the regular
expression. The type field in the metric section is used for the type conversion which can be float, int, or string.
The item is a numeric field used in match.group to retrieve the output
from the regular expression search. The item must be non-negative number.
1buildspecs:
2 stream_test:
3 type: script
4 executor: generic.local.bash
5 description: Run stream test with metrics example using assert greater equal
6 env:
7 OMP_NUM_THREADS: 4
8 run: |
9 wget https://raw.githubusercontent.com/jeffhammond/STREAM/master/stream.c
10 gcc -openmp -o stream stream.c
11 ./stream
12 metrics:
13 copy:
14 type: float
15 regex:
16 exp: 'Copy:\s+(\S+)\s+.*'
17 stream: stdout
18 item: 1
19 scale:
20 type: float
21 regex:
22 exp: 'Scale:\s+(\S+)\s+.*'
23 stream: stdout
24 item: 1
25 add:
26 type: float
27 regex:
28 exp: 'Add:\s+(\S+)\s+.*'
29 stream: stdout
30 item: 1
31 triad:
32 type: float
33 regex:
34 exp: 'Triad:\s+(\S+)\s+.*'
35 stream: stdout
36 item: 1
37 status:
38 assert_ge:
39 - name: copy
40 ref: 5000
41 - name: scale
42 ref: 5500
43 - name: add
44 ref: 6000
45 - name: triad
46 ref: 6500
buildtest will evaluate each assertion in the list and use a logical AND to determine the final
status of assert_ge.
Let’s build this test, take a close look at the output of buildtest build and take note of the assertion
statement.
buildtest build -b tutorials/perf_checks/assert_ge.yml
$ buildtest build -b tutorials/perf_checks/assert_ge.yml
╭───────────────────────────── buildtest summary ──────────────────────────────╮
│ │
│ User: docs │
│ Hostname: build-19398495-project-280831-buildtest │
│ Platform: Linux │
│ Current Time: 2023/02/06 21:51:54 │
│ buildtest path: /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ buildtest version: 1.1 │
│ python path: /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ python version: 3.7.15 │
│ Configuration File: /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ Test Directory: /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ Report File: /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ Command: /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ │
╰──────────────────────────────────────────────────────────────────────────────╯
─────────────────────────── Discovering Buildspecs ────────────────────────────
Discovered buildspecs
╔══════════════════════════════════════════════════════════════════════════════╗
║ buildspec ║
╟──────────────────────────────────────────────────────────────────────────────╢
║ /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/t… ║
╚══════════════════════════════════════════════════════════════════════════════╝
Total Discovered Buildspecs: 1
Total Excluded Buildspecs: 0
Detected Buildspecs after exclusion: 1
────────────────────────────── Parsing Buildspecs ──────────────────────────────
Valid Buildspecs: 1
Invalid Buildspecs: 0
/home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/tutorials/perf_checks/assert_ge.yml: VALID
Total builder objects created: 1
Builders by type=script
┏━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━┓
┃ builder ┃ type ┃ executor ┃ compiler ┃ nodes ┃ procs ┃ descrip… ┃ builds… ┃
┡━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━┩
│ stream_… │ script │ generic… │ None │ None │ None │ Run │ /home/… │
│ │ │ │ │ │ │ stream │ │
│ │ │ │ │ │ │ test │ │
│ │ │ │ │ │ │ with │ │
│ │ │ │ │ │ │ metrics │ │
│ │ │ │ │ │ │ example │ │
│ │ │ │ │ │ │ using │ │
│ │ │ │ │ │ │ assert │ │
│ │ │ │ │ │ │ greater │ │
│ │ │ │ │ │ │ equal │ │
└──────────┴────────┴──────────┴──────────┴───────┴───────┴──────────┴─────────┘
──────────────────────────────── Building Test ─────────────────────────────────
stream_test/39883b09: Creating test directory: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/tests/generic.local.bash/assert_ge/stream_test/39883b09
stream_test/39883b09: Creating the stage directory: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/tests/generic.local.bash/assert_ge/stream_test/39883b09/stage
stream_test/39883b09: Writing build script: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/tests/generic.local.bash/assert_ge/stream_test/39883b09/stream_test_build.sh
──────────────────────────────── Running Tests ─────────────────────────────────
Spawning 1 processes for processing builders
───────────────────────────────── Iteration 1 ──────────────────────────────────
stream_test/39883b09 does not have any dependencies adding test to queue
stream_test/39883b09: Current Working Directory : /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/tests/generic.local.bash/assert_ge/stream_test/39883b09/stage
stream_test/39883b09: Running Test via command: bash --norc --noprofile -eo pipefail stream_test_build.sh
stream_test/39883b09: Test completed in 1.632983 seconds
stream_test/39883b09: Test completed with returncode: 0
stream_test/39883b09: Writing output file - /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/tests/generic.local.bash/assert_ge/stream_test/39883b09/stream_test.out
stream_test/39883b09: Writing error file - /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/tests/generic.local.bash/assert_ge/stream_test/39883b09/stream_test.err
stream_test/39883b09: testing metric: copy if 5969.5 >= 5000.0 - Check: True
stream_test/39883b09: testing metric: scale if 6778.3 >= 5500.0 - Check: True
stream_test/39883b09: testing metric: add if 8895.2 >= 6000.0 - Check: True
stream_test/39883b09: testing metric: triad if 8522.7 >= 6500.0 - Check: True
stream_test/39883b09: Greater Equal Check: True
In this iteration we are going to run the following tests: [stream_test/39883b09]
Test Summary
┏━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━┓
┃ ┃ ┃ ┃ checks ┃ ┃ ┃
┃ ┃ ┃ ┃ (ReturnCode, ┃ ┃ ┃
┃ ┃ ┃ ┃ Regex, ┃ ┃ ┃
┃ builder ┃ executor ┃ status ┃ Runtime) ┃ returncode ┃ runtime ┃
┡━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━┩
│ stream_test/ │ generic.loc… │ PASS │ False False │ 0 │ 1.632983 │
│ 39883b09 │ │ │ False │ │ │
└──────────────┴──────────────┴────────┴───────────────┴────────────┴──────────┘
Passed Tests: 1/1 Percentage: 100.000%
Failed Tests: 0/1 Percentage: 0.000%
Adding 1 test results to /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/report.json
Writing Logfile to: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/logs/buildtest_gmxdktwm.log
Let’s run buildtest inspect query -o stream_test to retrieve the test details and output of STREAM test.
buildtest inspect query -o stream_test
$ buildtest inspect query -o stream_test
─────────────── stream_test/39883b09-9432-4300-a8df-d61b5aaa9cb3 ───────────────
Executor: generic.local.bash
Description: Run stream test with metrics example using assert greater equal
State: PASS
Returncode: 0
Runtime: 1.632983 sec
Starttime: 2023/02/06 21:51:54
Endtime: 2023/02/06 21:51:55
Command: bash --norc --noprofile -eo pipefail stream_test_build.sh
Test Script: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/tests/generic.local.bash/assert_ge/stream_test/39883b09/stream_test.sh
Build Script: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/tests/generic.local.bash/assert_ge/stream_test/39883b09/stream_test_build.sh
Output File: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/tests/generic.local.bash/assert_ge/stream_test/39883b09/stream_test.out
Error File: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/tests/generic.local.bash/assert_ge/stream_test/39883b09/stream_test.err
Log File: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/logs/buildtest_gmxdktwm.log
Metrics
┏━━━━━━━┳━━━━━━━━┓
┃ Name ┃ Value ┃
┡━━━━━━━╇━━━━━━━━┩
│ copy │ 5969.5 │
│ scale │ 6778.3 │
│ add │ 8895.2 │
│ triad │ 8522.7 │
└───────┴────────┘
─ Output File: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/che… ─
-------------------------------------------------------------
STREAM version $Revision: 5.10 $
-------------------------------------------------------------
This system uses 8 bytes per array element.
-------------------------------------------------------------
Array size = 10000000 (elements), Offset = 0 (elements)
Memory per array = 76.3 MiB (= 0.1 GiB).
Total memory required = 228.9 MiB (= 0.2 GiB).
Each kernel will be executed 10 times.
The *best* time for each kernel (excluding the first iteration)
will be used to compute the reported bandwidth.
-------------------------------------------------------------
Your clock granularity/precision appears to be 1 microseconds.
Each test below will take on the order of 24852 microseconds.
(= 24852 clock ticks)
Increase the size of the arrays if this shows that
you are not getting at least 20 clock ticks per test.
-------------------------------------------------------------
WARNING -- The above is only a rough guideline.
For best results, please be sure you know the
precision of your system timer.
-------------------------------------------------------------
Function Best Rate MB/s Avg time Min time Max time
Copy: 5969.5 0.026889 0.026803 0.027006
Scale: 6778.3 0.023722 0.023605 0.023896
Add: 8895.2 0.027112 0.026981 0.027212
Triad: 8522.7 0.028339 0.028160 0.028973
-------------------------------------------------------------
Solution Validates: avg error less than 1.000000e-13 on all three arrays
-------------------------------------------------------------
Greater Than¶
In this example, we perform a > operation, this can be done via assert_gt property
1buildspecs:
2 assert_gt_example:
3 type: script
4 executor: generic.local.bash
5 description: Run stream test with metrics example using assert greater than.
6 env:
7 OMP_NUM_THREADS: 4
8 run: |
9 wget https://raw.githubusercontent.com/jeffhammond/STREAM/master/stream.c
10 gcc -openmp -o stream stream.c
11 ./stream
12 metrics:
13 copy:
14 type: float
15 regex:
16 exp: 'Copy:\s+(\S+)\s+.*'
17 stream: stdout
18 item: 1
19 scale:
20 type: float
21 regex:
22 exp: 'Scale:\s+(\S+)\s+.*'
23 stream: stdout
24 item: 1
25 add:
26 type: float
27 regex:
28 exp: 'Add:\s+(\S+)\s+.*'
29 stream: stdout
30 item: 1
31 triad:
32 type: float
33 regex:
34 exp: 'Triad:\s+(\S+)\s+.*'
35 stream: stdout
36 item: 1
37 status:
38 assert_gt:
39 - name: copy
40 ref: 5000
41 - name: scale
42 ref: 5500
43 - name: add
44 ref: 6000
45 - name: triad
46 ref: 6500
Less Than Equal¶
In this example, we perform a <= operation, this can be done via assert_le property
1buildspecs:
2 assert_le_example:
3 type: script
4 executor: generic.local.bash
5 description: Run stream test with metrics example using assert less than equal
6 env:
7 OMP_NUM_THREADS: 4
8 run: |
9 wget https://raw.githubusercontent.com/jeffhammond/STREAM/master/stream.c
10 gcc -openmp -o stream stream.c
11 ./stream
12 metrics:
13 copy:
14 type: float
15 regex:
16 exp: 'Copy:\s+(\S+)\s+.*'
17 stream: stdout
18 item: 1
19 scale:
20 type: float
21 regex:
22 exp: 'Scale:\s+(\S+)\s+.*'
23 stream: stdout
24 item: 1
25 add:
26 type: float
27 regex:
28 exp: 'Add:\s+(\S+)\s+.*'
29 stream: stdout
30 item: 1
31 triad:
32 type: float
33 regex:
34 exp: 'Triad:\s+(\S+)\s+.*'
35 stream: stdout
36 item: 1
37 status:
38 assert_le:
39 - name: copy
40 ref: 5000
41 - name: scale
42 ref: 5500
43 - name: add
44 ref: 6000
45 - name: triad
46 ref: 6500
Assert Equal¶
buildtest can perform assert equality check with metrics to determine status of test. In this next example, we define
four metrics x, y, first, and last which will be compared with its reference value. We introduce a new
property assert_eq which is composed of list of assertions. Each reference is converted to its appropriate
type (int, float, str).
1buildspecs:
2 assert_eq_example:
3 type: script
4 executor: generic.local.bash
5 description: Test for assert equality
6 vars:
7 X: 1
8 Y: 1.5
9 first: John
10 last: Smith
11 run: |
12 echo "X: $X"
13 echo "Y: $Y"
14 echo "Name: $first $last"
15 metrics:
16 x:
17 type: int
18 regex:
19 stream: stdout
20 exp: 'X:\s+(\S+)\s+.*'
21 item: 1
22 y:
23 type: float
24 regex:
25 stream: stdout
26 exp: 'Y:\s+(\S+)\s+.*'
27 item: 1
28 first:
29 type: str
30 regex:
31 stream: stdout
32 exp: 'Name:\s+(\S+)\s+.*'
33 item: 1
34 last:
35 type: str
36 regex:
37 stream: stdout
38 exp: '(Smith)$'
39 item: 1
40 status:
41 assert_eq:
42 - name: x
43 ref: 1
44 - name: y
45 ref: 1.5
46 - name: first
47 ref: John
48 - name: last
49 ref: Smith
This test is expected to pass where all assertions are True. Let’s build the test and see the output
buildtest build -b tutorials/perf_checks/assert_eq.yml
$ buildtest build -b tutorials/perf_checks/assert_eq.yml
╭───────────────────────────── buildtest summary ──────────────────────────────╮
│ │
│ User: docs │
│ Hostname: build-19398495-project-280831-buildtest │
│ Platform: Linux │
│ Current Time: 2023/02/06 21:51:56 │
│ buildtest path: /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ buildtest version: 1.1 │
│ python path: /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ python version: 3.7.15 │
│ Configuration File: /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ Test Directory: /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ Report File: /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ Command: /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ │
╰──────────────────────────────────────────────────────────────────────────────╯
─────────────────────────── Discovering Buildspecs ────────────────────────────
Discovered buildspecs
╔══════════════════════════════════════════════════════════════════════════════╗
║ buildspec ║
╟──────────────────────────────────────────────────────────────────────────────╢
║ /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/t… ║
╚══════════════════════════════════════════════════════════════════════════════╝
Total Discovered Buildspecs: 1
Total Excluded Buildspecs: 0
Detected Buildspecs after exclusion: 1
────────────────────────────── Parsing Buildspecs ──────────────────────────────
Valid Buildspecs: 1
Invalid Buildspecs: 0
/home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/tutorials/perf_checks/assert_eq.yml: VALID
Total builder objects created: 1
Builders by type=script
┏━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━┓
┃ builder ┃ type ┃ executor ┃ compiler ┃ nodes ┃ procs ┃ descrip… ┃ builds… ┃
┡━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━┩
│ assert_… │ script │ generic… │ None │ None │ None │ Test for │ /home/… │
│ │ │ │ │ │ │ assert │ │
│ │ │ │ │ │ │ equality │ │
└──────────┴────────┴──────────┴──────────┴───────┴───────┴──────────┴─────────┘
──────────────────────────────── Building Test ─────────────────────────────────
assert_eq_example/e88a3cc6: Creating test directory: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/tests/generic.local.bash/assert_eq/assert_eq_example/e88a3cc6
assert_eq_example/e88a3cc6: Creating the stage directory: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/tests/generic.local.bash/assert_eq/assert_eq_example/e88a3cc6/stage
assert_eq_example/e88a3cc6: Writing build script: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/tests/generic.local.bash/assert_eq/assert_eq_example/e88a3cc6/assert_eq_example_build.sh
──────────────────────────────── Running Tests ─────────────────────────────────
Spawning 1 processes for processing builders
───────────────────────────────── Iteration 1 ──────────────────────────────────
assert_eq_example/e88a3cc6 does not have any dependencies adding test to queue
assert_eq_example/e88a3cc6: Current Working Directory : /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/tests/generic.local.bash/assert_eq/assert_eq_example/e88a3cc6/stage
assert_eq_example/e88a3cc6: Running Test via command: bash --norc --noprofile -eo pipefail assert_eq_example_build.sh
assert_eq_example/e88a3cc6: Test completed in 0.006045 seconds
assert_eq_example/e88a3cc6: Test completed with returncode: 0
assert_eq_example/e88a3cc6: Writing output file - /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/tests/generic.local.bash/assert_eq/assert_eq_example/e88a3cc6/assert_eq_example.out
assert_eq_example/e88a3cc6: Writing error file - /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/tests/generic.local.bash/assert_eq/assert_eq_example/e88a3cc6/assert_eq_example.err
assert_eq_example/e88a3cc6: testing metric: x if 1 == 1 - Check: True
assert_eq_example/e88a3cc6: testing metric: y if 1.5 == 1.5 - Check: True
assert_eq_example/e88a3cc6: testing metric: first if John == John - Check: True
assert_eq_example/e88a3cc6: testing metric: last if Smith == Smith - Check: True
assert_eq_example/e88a3cc6: Equality Check: True
In this iteration we are going to run the following tests: [assert_eq_example/e88a3cc6]
Test Summary
┏━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━┓
┃ ┃ ┃ ┃ checks ┃ ┃ ┃
┃ ┃ ┃ ┃ (ReturnCode, ┃ ┃ ┃
┃ ┃ ┃ ┃ Regex, ┃ ┃ ┃
┃ builder ┃ executor ┃ status ┃ Runtime) ┃ returncode ┃ runtime ┃
┡━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━┩
│ assert_eq_ex │ generic.loc… │ PASS │ False False │ 0 │ 0.006045 │
│ ample/e88a3c │ │ │ False │ │ │
│ c6 │ │ │ │ │ │
└──────────────┴──────────────┴────────┴───────────────┴────────────┴──────────┘
Passed Tests: 1/1 Percentage: 100.000%
Failed Tests: 0/1 Percentage: 0.000%
Adding 1 test results to /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/report.json
Writing Logfile to: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/logs/buildtest_qzaae4vb.log
buildtest inspect query -o assert_eq_example
$ buildtest inspect query -o assert_eq_example
──────────── assert_eq_example/e88a3cc6-d26c-4b92-b467-d250820cdab9 ────────────
Executor: generic.local.bash
Description: Test for assert equality
State: PASS
Returncode: 0
Runtime: 0.006045 sec
Starttime: 2023/02/06 21:51:56
Endtime: 2023/02/06 21:51:56
Command: bash --norc --noprofile -eo pipefail assert_eq_example_build.sh
Test Script: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/tests/generic.local.bash/assert_eq/assert_eq_example/e88a3cc6/assert_eq_example.sh
Build Script: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/tests/generic.local.bash/assert_eq/assert_eq_example/e88a3cc6/assert_eq_example_build.sh
Output File: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/tests/generic.local.bash/assert_eq/assert_eq_example/e88a3cc6/assert_eq_example.out
Error File: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/tests/generic.local.bash/assert_eq/assert_eq_example/e88a3cc6/assert_eq_example.err
Log File: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/logs/buildtest_qzaae4vb.log
Metrics
┏━━━━━━━┳━━━━━━━┓
┃ Name ┃ Value ┃
┡━━━━━━━╇━━━━━━━┩
│ x │ 1 │
│ y │ 1.5 │
│ first │ John │
│ last │ Smith │
└───────┴───────┘
─ Output File: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/che… ─
X: 1
Y: 1.5
Name: John Smith
In the next example, we have two tests to highlight some exceptions. In the first test, we define an invalid metric name invalid_metric
in assert_eq since this metric was not defined in metrics field, therefore this test will fail. The second test will fail because we have
a mismatch in value captured by metric x which is 1 however the reference value is 2.
1buildspecs:
2 assert_eq_invalid_metric:
3 type: script
4 executor: generic.local.bash
5 description: An invalid metric name will cause failure
6 vars:
7 X: 1
8 run: |
9 echo "X: $X"
10 metrics:
11 x:
12 type: int
13 regex:
14 stream: stdout
15 exp: 'X:\s+(\S+)\s+.*'
16 item: 1
17 status:
18 assert_eq:
19 - name: x
20 ref: 1
21 - name: invalid_metric
22 ref: 'hello'
23 assert_eq_mismatch:
24 type: script
25 executor: generic.local.bash
26 description: This test will fail because there is a mismatch in metric x assert equality
27 vars:
28 X: 1
29 run: |
30 echo "X: $X"
31 metrics:
32 x:
33 type: int
34 regex:
35 stream: stdout
36 exp: 'X:\s+(\S+)\s+.*'
37 item: 1
38 status:
39 assert_eq:
40 - name: x
41 ref: 2
Let’s build this test and see the output.
buildtest build -b tutorials/perf_checks/assert_eq_exceptions.yml
$ buildtest build -b tutorials/perf_checks/assert_eq_exceptions.yml
╭───────────────────────────── buildtest summary ──────────────────────────────╮
│ │
│ User: docs │
│ Hostname: build-19398495-project-280831-buildtest │
│ Platform: Linux │
│ Current Time: 2023/02/06 21:51:57 │
│ buildtest path: /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ buildtest version: 1.1 │
│ python path: /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ python version: 3.7.15 │
│ Configuration File: /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ Test Directory: /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ Report File: /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ Command: /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ │
╰──────────────────────────────────────────────────────────────────────────────╯
─────────────────────────── Discovering Buildspecs ────────────────────────────
Discovered buildspecs
╔══════════════════════════════════════════════════════════════════════════════╗
║ buildspec ║
╟──────────────────────────────────────────────────────────────────────────────╢
║ /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/t… ║
╚══════════════════════════════════════════════════════════════════════════════╝
Total Discovered Buildspecs: 1
Total Excluded Buildspecs: 0
Detected Buildspecs after exclusion: 1
────────────────────────────── Parsing Buildspecs ──────────────────────────────
Valid Buildspecs: 1
Invalid Buildspecs: 0
/home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/tutorials/perf_checks/assert_eq_exceptions.yml: VALID
Total builder objects created: 2
Builders by type=script
┏━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━┓
┃ builder ┃ type ┃ executor ┃ compiler ┃ nodes ┃ procs ┃ descrip… ┃ builds… ┃
┡━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━┩
│ assert_… │ script │ generic… │ None │ None │ None │ An │ /home/… │
│ │ │ │ │ │ │ invalid │ │
│ │ │ │ │ │ │ metric │ │
│ │ │ │ │ │ │ name │ │
│ │ │ │ │ │ │ will │ │
│ │ │ │ │ │ │ cause │ │
│ │ │ │ │ │ │ failure │ │
├──────────┼────────┼──────────┼──────────┼───────┼───────┼──────────┼─────────┤
│ assert_… │ script │ generic… │ None │ None │ None │ This │ /home/… │
│ │ │ │ │ │ │ test │ │
│ │ │ │ │ │ │ will │ │
│ │ │ │ │ │ │ fail │ │
│ │ │ │ │ │ │ because │ │
│ │ │ │ │ │ │ there is │ │
│ │ │ │ │ │ │ a │ │
│ │ │ │ │ │ │ mismatch │ │
│ │ │ │ │ │ │ in │ │
│ │ │ │ │ │ │ metric x │ │
│ │ │ │ │ │ │ assert │ │
│ │ │ │ │ │ │ equality │ │
└──────────┴────────┴──────────┴──────────┴───────┴───────┴──────────┴─────────┘
──────────────────────────────── Building Test ─────────────────────────────────
assert_eq_invalid_metric/44e905e8: Creating test directory: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/tests/generic.local.bash/assert_eq_exceptions/assert_eq_invalid_metric/44e905e8
assert_eq_invalid_metric/44e905e8: Creating the stage directory: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/tests/generic.local.bash/assert_eq_exceptions/assert_eq_invalid_metric/44e905e8/stage
assert_eq_invalid_metric/44e905e8: Writing build script: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/tests/generic.local.bash/assert_eq_exceptions/assert_eq_invalid_metric/44e905e8/assert_eq_invalid_metric_build.sh
assert_eq_mismatch/80989820: Creating test directory: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/tests/generic.local.bash/assert_eq_exceptions/assert_eq_mismatch/80989820
assert_eq_mismatch/80989820: Creating the stage directory: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/tests/generic.local.bash/assert_eq_exceptions/assert_eq_mismatch/80989820/stage
assert_eq_mismatch/80989820: Writing build script: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/tests/generic.local.bash/assert_eq_exceptions/assert_eq_mismatch/80989820/assert_eq_mismatch_build.sh
──────────────────────────────── Running Tests ─────────────────────────────────
Spawning 1 processes for processing builders
───────────────────────────────── Iteration 1 ──────────────────────────────────
assert_eq_mismatch/80989820 does not have any dependencies adding test to queue
assert_eq_invalid_metric/44e905e8 does not have any dependencies adding test to queue
assert_eq_mismatch/80989820: Current Working Directory : /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/tests/generic.local.bash/assert_eq_exceptions/assert_eq_mismatch/80989820/stage
assert_eq_mismatch/80989820: Running Test via command: bash --norc --noprofile -eo pipefail assert_eq_mismatch_build.sh
assert_eq_mismatch/80989820: Test completed in 0.005631 seconds
assert_eq_mismatch/80989820: Test completed with returncode: 0
assert_eq_mismatch/80989820: Writing output file - /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/tests/generic.local.bash/assert_eq_exceptions/assert_eq_mismatch/80989820/assert_eq_mismatch.out
assert_eq_mismatch/80989820: Writing error file - /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/tests/generic.local.bash/assert_eq_exceptions/assert_eq_mismatch/80989820/assert_eq_mismatch.err
assert_eq_mismatch/80989820: testing metric: x if 1 == 2 - Check: False
assert_eq_mismatch/80989820: Equality Check: False
assert_eq_invalid_metric/44e905e8: Current Working Directory : /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/tests/generic.local.bash/assert_eq_exceptions/assert_eq_invalid_metric/44e905e8/stage
assert_eq_invalid_metric/44e905e8: Running Test via command: bash --norc --noprofile -eo pipefail assert_eq_invalid_metric_build.sh
assert_eq_invalid_metric/44e905e8: Test completed in 0.005425 seconds
assert_eq_invalid_metric/44e905e8: Test completed with returncode: 0
assert_eq_invalid_metric/44e905e8: Writing output file - /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/tests/generic.local.bash/assert_eq_exceptions/assert_eq_invalid_metric/44e905e8/assert_eq_invalid_metric.out
assert_eq_invalid_metric/44e905e8: Writing error file - /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/tests/generic.local.bash/assert_eq_exceptions/assert_eq_invalid_metric/44e905e8/assert_eq_invalid_metric.err
assert_eq_invalid_metric/44e905e8: testing metric: x if 1 == 1 - Check: True
assert_eq_invalid_metric/44e905e8: Unable to find metric: invalid_metric. List of valid metrics are the following: ['x']
assert_eq_invalid_metric/44e905e8: Equality Check: False
In this iteration we are going to run the following tests: [assert_eq_mismatch/80989820, assert_eq_invalid_metric/44e905e8]
Test Summary
┏━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━┓
┃ ┃ ┃ ┃ checks ┃ ┃ ┃
┃ ┃ ┃ ┃ (ReturnCode, ┃ ┃ ┃
┃ ┃ ┃ ┃ Regex, ┃ ┃ ┃
┃ builder ┃ executor ┃ status ┃ Runtime) ┃ returncode ┃ runtime ┃
┡━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━┩
│ assert_eq_in │ generic.loc… │ FAIL │ False False │ 0 │ 0.005425 │
│ valid_metric │ │ │ False │ │ │
│ /44e905e8 │ │ │ │ │ │
├──────────────┼──────────────┼────────┼───────────────┼────────────┼──────────┤
│ assert_eq_mi │ generic.loc… │ FAIL │ False False │ 0 │ 0.005631 │
│ smatch/80989 │ │ │ False │ │ │
│ 820 │ │ │ │ │ │
└──────────────┴──────────────┴────────┴───────────────┴────────────┴──────────┘
Passed Tests: 0/2 Percentage: 0.000%
Failed Tests: 2/2 Percentage: 100.000%
Adding 2 test results to /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/report.json
Writing Logfile to: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/logs/buildtest_hpy79mzr.log
Assert Not Equal¶
In this section, we will discuss the inverse equality operation Not Equal check (!=) with reference value.
We can use assert_ne property to perform != check, it works similar to assert_eq with data types int,
float and str. In this example, we check the metrics x, y, first and last and each metric
should pass. The reference value is converted to the data-type (type field) for each metrics
1buildspecs:
2 assert_ne_example:
3 type: script
4 executor: generic.local.bash
5 description: Test for assert not equal
6 vars:
7 X: 1
8 Y: 1.5
9 first: John
10 last: Smith
11 run: |
12 echo "X: $X"
13 echo "Y: $Y"
14 echo "Name: $first $last"
15 metrics:
16 x:
17 type: int
18 regex:
19 stream: stdout
20 exp: 'X:\s+(\S+)\s+.*'
21 item: 1
22 y:
23 type: float
24 regex:
25 stream: stdout
26 exp: 'Y:\s+(\S+)\s+.*'
27 item: 1
28 first:
29 type: str
30 regex:
31 stream: stdout
32 exp: 'Name:\s+(\S+)\s+.*'
33 item: 1
34 last:
35 type: str
36 regex:
37 stream: stdout
38 exp: '(Smith)$'
39 item: 1
40 status:
41 assert_ne:
42 - name: x
43 ref: 2
44 - name: y
45 ref: 2.5
46 - name: first
47 ref: Robert
48 - name: last
49 ref: Brown
We expect this test to pass. In order to run this test, you can do the following
buildtest build -b tutorials/perf_checks/assert_ne.yml
$ buildtest build -b tutorials/perf_checks/assert_ne.yml
╭───────────────────────────── buildtest summary ──────────────────────────────╮
│ │
│ User: docs │
│ Hostname: build-19398495-project-280831-buildtest │
│ Platform: Linux │
│ Current Time: 2023/02/06 21:51:58 │
│ buildtest path: /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ buildtest version: 1.1 │
│ python path: /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ python version: 3.7.15 │
│ Configuration File: /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ Test Directory: /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ Report File: /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ Command: /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ │
╰──────────────────────────────────────────────────────────────────────────────╯
─────────────────────────── Discovering Buildspecs ────────────────────────────
Discovered buildspecs
╔══════════════════════════════════════════════════════════════════════════════╗
║ buildspec ║
╟──────────────────────────────────────────────────────────────────────────────╢
║ /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/t… ║
╚══════════════════════════════════════════════════════════════════════════════╝
Total Discovered Buildspecs: 1
Total Excluded Buildspecs: 0
Detected Buildspecs after exclusion: 1
────────────────────────────── Parsing Buildspecs ──────────────────────────────
Valid Buildspecs: 1
Invalid Buildspecs: 0
/home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/tutorials/perf_checks/assert_ne.yml: VALID
Total builder objects created: 1
Builders by type=script
┏━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━┓
┃ builder ┃ type ┃ executor ┃ compiler ┃ nodes ┃ procs ┃ descrip… ┃ builds… ┃
┡━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━┩
│ assert_… │ script │ generic… │ None │ None │ None │ Test for │ /home/… │
│ │ │ │ │ │ │ assert │ │
│ │ │ │ │ │ │ not │ │
│ │ │ │ │ │ │ equal │ │
└──────────┴────────┴──────────┴──────────┴───────┴───────┴──────────┴─────────┘
──────────────────────────────── Building Test ─────────────────────────────────
assert_ne_example/c5b21d43: Creating test directory: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/tests/generic.local.bash/assert_ne/assert_ne_example/c5b21d43
assert_ne_example/c5b21d43: Creating the stage directory: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/tests/generic.local.bash/assert_ne/assert_ne_example/c5b21d43/stage
assert_ne_example/c5b21d43: Writing build script: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/tests/generic.local.bash/assert_ne/assert_ne_example/c5b21d43/assert_ne_example_build.sh
──────────────────────────────── Running Tests ─────────────────────────────────
Spawning 1 processes for processing builders
───────────────────────────────── Iteration 1 ──────────────────────────────────
assert_ne_example/c5b21d43 does not have any dependencies adding test to queue
assert_ne_example/c5b21d43: Current Working Directory : /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/tests/generic.local.bash/assert_ne/assert_ne_example/c5b21d43/stage
assert_ne_example/c5b21d43: Running Test via command: bash --norc --noprofile -eo pipefail assert_ne_example_build.sh
assert_ne_example/c5b21d43: Test completed in 0.005581 seconds
assert_ne_example/c5b21d43: Test completed with returncode: 0
assert_ne_example/c5b21d43: Writing output file - /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/tests/generic.local.bash/assert_ne/assert_ne_example/c5b21d43/assert_ne_example.out
assert_ne_example/c5b21d43: Writing error file - /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/tests/generic.local.bash/assert_ne/assert_ne_example/c5b21d43/assert_ne_example.err
assert_ne_example/c5b21d43: testing metric: x if 1 != 2 - Check: True
assert_ne_example/c5b21d43: testing metric: y if 1.5 != 2.5 - Check: True
assert_ne_example/c5b21d43: testing metric: first if John != Robert - Check: True
assert_ne_example/c5b21d43: testing metric: last if Smith != Brown - Check: True
assert_ne_example/c5b21d43: Not Equal Check: True
In this iteration we are going to run the following tests: [assert_ne_example/c5b21d43]
Test Summary
┏━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━┓
┃ ┃ ┃ ┃ checks ┃ ┃ ┃
┃ ┃ ┃ ┃ (ReturnCode, ┃ ┃ ┃
┃ ┃ ┃ ┃ Regex, ┃ ┃ ┃
┃ builder ┃ executor ┃ status ┃ Runtime) ┃ returncode ┃ runtime ┃
┡━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━┩
│ assert_ne_ex │ generic.loc… │ PASS │ False False │ 0 │ 0.005581 │
│ ample/c5b21d │ │ │ False │ │ │
│ 43 │ │ │ │ │ │
└──────────────┴──────────────┴────────┴───────────────┴────────────┴──────────┘
Passed Tests: 1/1 Percentage: 100.000%
Failed Tests: 0/1 Percentage: 0.000%
Adding 1 test results to /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/report.json
Writing Logfile to: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/logs/buildtest_9riiwvzv.log
Assert Range¶
The assert_range property can be used to test performance for a metric given a lower and upper bound. This property expects
one to specify lower and upper field which must be an integer or floating point number to perform comparison. buildtest will
perform an assertion, if metric value is in the range specified by lower and upper, then test will pass. Shown below
is an example using the assert_range property with stream benchmark.
1buildspecs:
2 assert_range_ex:
3 type: script
4 executor: generic.local.bash
5 description: Example on assert_range
6 env:
7 OMP_NUM_THREADS: 4
8 run: |
9 wget https://raw.githubusercontent.com/jeffhammond/STREAM/master/stream.c
10 gcc -openmp -o stream stream.c
11 ./stream
12 metrics:
13 copy:
14 type: float
15 regex:
16 exp: 'Copy:\s+(\S+)\s+.*'
17 stream: stdout
18 item: 1
19 scale:
20 type: float
21 regex:
22 exp: 'Scale:\s+(\S+)\s+.*'
23 stream: stdout
24 item: 1
25 add:
26 type: float
27 regex:
28 exp: 'Add:\s+(\S+)\s+.*'
29 stream: stdout
30 item: 1
31 triad:
32 type: float
33 regex:
34 exp: 'Triad:\s+(\S+)\s+.*'
35 stream: stdout
36 item: 1
37 status:
38 assert_range:
39 - name: copy
40 lower: 5000
41 upper: 20000
42 - name: scale
43 lower: 4500
44 upper: 20000
45 - name: add
46 lower: 4300
47 upper: 20000
48 - name: triad
49 lower: 5600
50 upper: 20000
Let’s build this test and see the output
buildtest build -b tutorials/perf_checks/assert_range.yml
$ buildtest build -b tutorials/perf_checks/assert_range.yml
╭───────────────────────────── buildtest summary ──────────────────────────────╮
│ │
│ User: docs │
│ Hostname: build-19398495-project-280831-buildtest │
│ Platform: Linux │
│ Current Time: 2023/02/06 21:51:59 │
│ buildtest path: /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ buildtest version: 1.1 │
│ python path: /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ python version: 3.7.15 │
│ Configuration File: /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ Test Directory: /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ Report File: /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ Command: /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ │
╰──────────────────────────────────────────────────────────────────────────────╯
─────────────────────────── Discovering Buildspecs ────────────────────────────
Discovered buildspecs
╔══════════════════════════════════════════════════════════════════════════════╗
║ buildspec ║
╟──────────────────────────────────────────────────────────────────────────────╢
║ /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/t… ║
╚══════════════════════════════════════════════════════════════════════════════╝
Total Discovered Buildspecs: 1
Total Excluded Buildspecs: 0
Detected Buildspecs after exclusion: 1
────────────────────────────── Parsing Buildspecs ──────────────────────────────
Valid Buildspecs: 1
Invalid Buildspecs: 0
/home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/tutorials/perf_checks/assert_range.yml: VALID
Total builder objects created: 1
Builders by type=script
┏━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━┓
┃ builder ┃ type ┃ executor ┃ compiler ┃ nodes ┃ procs ┃ descrip… ┃ builds… ┃
┡━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━┩
│ assert_… │ script │ generic… │ None │ None │ None │ Example │ /home/… │
│ │ │ │ │ │ │ on │ │
│ │ │ │ │ │ │ assert_… │ │
└──────────┴────────┴──────────┴──────────┴───────┴───────┴──────────┴─────────┘
──────────────────────────────── Building Test ─────────────────────────────────
assert_range_ex/85a06b57: Creating test directory: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/tests/generic.local.bash/assert_range/assert_range_ex/85a06b57
assert_range_ex/85a06b57: Creating the stage directory: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/tests/generic.local.bash/assert_range/assert_range_ex/85a06b57/stage
assert_range_ex/85a06b57: Writing build script: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/tests/generic.local.bash/assert_range/assert_range_ex/85a06b57/assert_range_ex_build.sh
──────────────────────────────── Running Tests ─────────────────────────────────
Spawning 1 processes for processing builders
───────────────────────────────── Iteration 1 ──────────────────────────────────
assert_range_ex/85a06b57 does not have any dependencies adding test to queue
assert_range_ex/85a06b57: Current Working Directory : /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/tests/generic.local.bash/assert_range/assert_range_ex/85a06b57/stage
assert_range_ex/85a06b57: Running Test via command: bash --norc --noprofile -eo pipefail assert_range_ex_build.sh
assert_range_ex/85a06b57: Test completed in 1.412812 seconds
assert_range_ex/85a06b57: Test completed with returncode: 0
assert_range_ex/85a06b57: Writing output file - /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/tests/generic.local.bash/assert_range/assert_range_ex/85a06b57/assert_range_ex.out
assert_range_ex/85a06b57: Writing error file - /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/tests/generic.local.bash/assert_range/assert_range_ex/85a06b57/assert_range_ex.err
assert_range_ex/85a06b57: testing metric: copy if 5000.0 <= 5961.9 <= 20000.0 - Check: True
assert_range_ex/85a06b57: testing metric: scale if 4500.0 <= 6763.9 <= 20000.0 - Check: True
assert_range_ex/85a06b57: testing metric: add if 4300.0 <= 8944.9 <= 20000.0 - Check: True
assert_range_ex/85a06b57: testing metric: triad if 5600.0 <= 8486.0 <= 20000.0 - Check: True
assert_range_ex/85a06b57: Range Check: True
In this iteration we are going to run the following tests: [assert_range_ex/85a06b57]
Test Summary
┏━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━┓
┃ ┃ ┃ ┃ checks ┃ ┃ ┃
┃ ┃ ┃ ┃ (ReturnCode, ┃ ┃ ┃
┃ ┃ ┃ ┃ Regex, ┃ ┃ ┃
┃ builder ┃ executor ┃ status ┃ Runtime) ┃ returncode ┃ runtime ┃
┡━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━┩
│ assert_range │ generic.loc… │ PASS │ False False │ 0 │ 1.412812 │
│ _ex/85a06b57 │ │ │ False │ │ │
└──────────────┴──────────────┴────────┴───────────────┴────────────┴──────────┘
Passed Tests: 1/1 Percentage: 100.000%
Failed Tests: 0/1 Percentage: 0.000%
Adding 1 test results to /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/report.json
Writing Logfile to: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/logs/buildtest_b0of8cjz.log
Note that performance results may vary on your system and depending on the metric value you may want to adjust the lower and upper bound to match your requirement.
Contains and Not Contains¶
Buildtest can perform status check with a list of reference values and check if metrics value is in the list. The
property contains and not_contains can be used to perform this type of check. The ref property is a list of
reference values that a metric must have to pass metrics check.
In example below we have two tests, the first test perform contains and not_contains on metrics x. We expect both
status check will pass. The second test is expected to fail because metric x will store integer value 1 but the list has
string equivalent ‘1’.
1buildspecs:
2 contains_and_not_contains:
3 type: script
4 executor: generic.local.bash
5 description: Status check based on contains and not contains where test pass
6 vars:
7 X: 1
8 run: |
9 echo "X: $X"
10 metrics:
11 x:
12 type: int
13 regex:
14 stream: stdout
15 exp: 'X:\s+(\S+)\s+.*'
16 item: 1
17 status:
18 contains:
19 - name: x
20 ref: [1, 2, 4, 8]
21 not_contains:
22 - name: x
23 ref: [2, 4]
24 assert_contains_fail:
25 type: script
26 executor: generic.local.bash
27 description: Status check based on contains where test fails
28 vars:
29 X: 1
30 run: |
31 echo "X: $X"
32 metrics:
33 x:
34 type: int
35 regex:
36 stream: stdout
37 exp: 'X:\s+(\S+)\s+.*'
38 item: 1
39 status:
40 contains:
41 - name: x
42 ref: [ '1', 2, 4, 8 ]
You can run this test, by running the following command
buildtest build -b tutorials/perf_checks/contains.yml
$ buildtest build -b tutorials/perf_checks/contains.yml
╭───────────────────────────── buildtest summary ──────────────────────────────╮
│ │
│ User: docs │
│ Hostname: build-19398495-project-280831-buildtest │
│ Platform: Linux │
│ Current Time: 2023/02/06 21:52:01 │
│ buildtest path: /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ buildtest version: 1.1 │
│ python path: /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ python version: 3.7.15 │
│ Configuration File: /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ Test Directory: /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ Report File: /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ Command: /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ │
╰──────────────────────────────────────────────────────────────────────────────╯
─────────────────────────── Discovering Buildspecs ────────────────────────────
Discovered buildspecs
╔══════════════════════════════════════════════════════════════════════════════╗
║ buildspec ║
╟──────────────────────────────────────────────────────────────────────────────╢
║ /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/t… ║
╚══════════════════════════════════════════════════════════════════════════════╝
Total Discovered Buildspecs: 1
Total Excluded Buildspecs: 0
Detected Buildspecs after exclusion: 1
────────────────────────────── Parsing Buildspecs ──────────────────────────────
Valid Buildspecs: 1
Invalid Buildspecs: 0
/home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/tutorials/perf_checks/contains.yml: VALID
Total builder objects created: 2
Builders by type=script
┏━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━┓
┃ builder ┃ type ┃ executor ┃ compiler ┃ nodes ┃ procs ┃ descrip… ┃ builds… ┃
┡━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━┩
│ contain… │ script │ generic… │ None │ None │ None │ Status │ /home/… │
│ │ │ │ │ │ │ check │ │
│ │ │ │ │ │ │ based on │ │
│ │ │ │ │ │ │ contains │ │
│ │ │ │ │ │ │ and not │ │
│ │ │ │ │ │ │ contains │ │
│ │ │ │ │ │ │ where │ │
│ │ │ │ │ │ │ test │ │
│ │ │ │ │ │ │ pass │ │
├──────────┼────────┼──────────┼──────────┼───────┼───────┼──────────┼─────────┤
│ assert_… │ script │ generic… │ None │ None │ None │ Status │ /home/… │
│ │ │ │ │ │ │ check │ │
│ │ │ │ │ │ │ based on │ │
│ │ │ │ │ │ │ contains │ │
│ │ │ │ │ │ │ where │ │
│ │ │ │ │ │ │ test │ │
│ │ │ │ │ │ │ fails │ │
└──────────┴────────┴──────────┴──────────┴───────┴───────┴──────────┴─────────┘
──────────────────────────────── Building Test ─────────────────────────────────
contains_and_not_contains/fef3f06d: Creating test directory: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/tests/generic.local.bash/contains/contains_and_not_contains/fef3f06d
contains_and_not_contains/fef3f06d: Creating the stage directory: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/tests/generic.local.bash/contains/contains_and_not_contains/fef3f06d/stage
contains_and_not_contains/fef3f06d: Writing build script: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/tests/generic.local.bash/contains/contains_and_not_contains/fef3f06d/contains_and_not_contains_build.sh
assert_contains_fail/5dab8d6c: Creating test directory: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/tests/generic.local.bash/contains/assert_contains_fail/5dab8d6c
assert_contains_fail/5dab8d6c: Creating the stage directory: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/tests/generic.local.bash/contains/assert_contains_fail/5dab8d6c/stage
assert_contains_fail/5dab8d6c: Writing build script: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/tests/generic.local.bash/contains/assert_contains_fail/5dab8d6c/assert_contains_fail_build.sh
──────────────────────────────── Running Tests ─────────────────────────────────
Spawning 1 processes for processing builders
───────────────────────────────── Iteration 1 ──────────────────────────────────
contains_and_not_contains/fef3f06d does not have any dependencies adding test to queue
assert_contains_fail/5dab8d6c does not have any dependencies adding test to queue
contains_and_not_contains/fef3f06d: Current Working Directory : /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/tests/generic.local.bash/contains/contains_and_not_contains/fef3f06d/stage
contains_and_not_contains/fef3f06d: Running Test via command: bash --norc --noprofile -eo pipefail contains_and_not_contains_build.sh
contains_and_not_contains/fef3f06d: Test completed in 0.005465 seconds
contains_and_not_contains/fef3f06d: Test completed with returncode: 0
contains_and_not_contains/fef3f06d: Writing output file - /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/tests/generic.local.bash/contains/contains_and_not_contains/fef3f06d/contains_and_not_contains.out
contains_and_not_contains/fef3f06d: Writing error file - /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/tests/generic.local.bash/contains/contains_and_not_contains/fef3f06d/contains_and_not_contains.err
contains_and_not_contains/fef3f06d: testing metric: x if 1 in [1, 2, 4, 8] - Check: True
contains_and_not_contains/fef3f06d: Contains Check: True
contains_and_not_contains/fef3f06d: testing metric: x if 1 not in [2, 4] - Check: True
contains_and_not_contains/fef3f06d: Not Contains Check: True
assert_contains_fail/5dab8d6c: Current Working Directory : /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/tests/generic.local.bash/contains/assert_contains_fail/5dab8d6c/stage
assert_contains_fail/5dab8d6c: Running Test via command: bash --norc --noprofile -eo pipefail assert_contains_fail_build.sh
assert_contains_fail/5dab8d6c: Test completed in 0.005374 seconds
assert_contains_fail/5dab8d6c: Test completed with returncode: 0
assert_contains_fail/5dab8d6c: Writing output file - /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/tests/generic.local.bash/contains/assert_contains_fail/5dab8d6c/assert_contains_fail.out
assert_contains_fail/5dab8d6c: Writing error file - /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/tests/generic.local.bash/contains/assert_contains_fail/5dab8d6c/assert_contains_fail.err
assert_contains_fail/5dab8d6c: testing metric: x if 1 in ['1', 2, 4, 8] - Check: False
assert_contains_fail/5dab8d6c: Contains Check: False
In this iteration we are going to run the following tests: [contains_and_not_contains/fef3f06d, assert_contains_fail/5dab8d6c]
Test Summary
┏━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━┓
┃ ┃ ┃ ┃ checks ┃ ┃ ┃
┃ ┃ ┃ ┃ (ReturnCode, ┃ ┃ ┃
┃ ┃ ┃ ┃ Regex, ┃ ┃ ┃
┃ builder ┃ executor ┃ status ┃ Runtime) ┃ returncode ┃ runtime ┃
┡━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━┩
│ contains_and │ generic.loc… │ PASS │ False False │ 0 │ 0.005465 │
│ _not_contain │ │ │ False │ │ │
│ s/fef3f06d │ │ │ │ │ │
├──────────────┼──────────────┼────────┼───────────────┼────────────┼──────────┤
│ assert_conta │ generic.loc… │ FAIL │ False False │ 0 │ 0.005374 │
│ ins_fail/5da │ │ │ False │ │ │
│ b8d6c │ │ │ │ │ │
└──────────────┴──────────────┴────────┴───────────────┴────────────┴──────────┘
Passed Tests: 1/2 Percentage: 50.000%
Failed Tests: 1/2 Percentage: 50.000%
Adding 2 test results to /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/report.json
Writing Logfile to: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/v1.2/var/logs/buildtest_nqh7sguf.log