buildtest.buildsystem.checks
¶
Module Contents¶
Functions¶
|
Check status check of |
|
This method will return a boolean (True/False) based on runtime specified in buildspec and check with test runtime. |
|
This method conducts a regular expression check using |
|
This method will perform status check for |
|
This method will perform status check for |
|
This method will perform status check for |
|
This method will convert input argument |
|
Perform check on assert greater and equal when |
|
This method is perform Assert Equality used when |
|
This method is perform Assert Range used when |
Attributes¶
- buildtest.buildsystem.checks.logger¶
- buildtest.buildsystem.checks.returncode_check(builder)[source]¶
Check status check of
returncode
field if specified in status property.- Parameters
builder (buildtest.builders.base.BuilderBase) – An instance of BuilderBase class used for printing the builder name
- buildtest.buildsystem.checks.runtime_check(builder)[source]¶
This method will return a boolean (True/False) based on runtime specified in buildspec and check with test runtime. User can specify both min and max, or just specify min or max.
- Parameters
builder (buildtest.builders.base.BuilderBase) – An instance of BuilderBase class used for printing the builder name
- buildtest.buildsystem.checks.regex_check(builder)[source]¶
This method conducts a regular expression check using re.search with regular expression defined in Buildspec. User must specify an output stream (stdout, stderr) to select when performing regex. In buildtest, this would read the .out or .err file based on stream and run the regular expression to see if there is a match. This method will return a boolean True indicates there is a match otherwise False if
regex
object not defined orre.search
doesn’t find a match.- Parameters
builder (buildtest.builders.base.BuilderBase) – An instance of BuilderBase class used for printing the builder name
- Returns
Returns True if their is a regex match otherwise returns False.
- Return type
- buildtest.buildsystem.checks.exists_check(builder)[source]¶
This method will perform status check for
exists
property. Each value is tested for file existence and returns a boolean to inform if all files exist or not.- Parameters
builder (buildtest.builders.base.BuilderBase) – An instance of BuilderBase class used for printing the builder name
- Returns
A boolean for exists status check
- Return type
- buildtest.buildsystem.checks.is_file_check(builder)[source]¶
- This method will perform status check for
is_file
property. Each item inis_file
is checked by determining if its a file. The return is a single boolean where we perform a logical AND to determine final status check for is_file
- Parameters
builder (buildtest.builders.base.BuilderBase) – An instance of BuilderBase class used for printing the builder name
- Returns
A boolean for is_file status check
- Return type
- This method will perform status check for
- buildtest.buildsystem.checks.is_dir_check(builder)[source]¶
- This method will perform status check for
is_dir
property. Each item inis_dir
is checked by determining if its a directory. The return is a single boolean where we perform a logical AND to determine final status check for
is_dir
- Parameters
builder (buildtest.builders.base.BuilderBase) – An instance of BuilderBase class used for printing the builder name
- Returns
A boolean for
is_dir
status check- Return type
- This method will perform status check for
- buildtest.buildsystem.checks.convert_metrics(metric_value, ref_value, dtype)[source]¶
This method will convert input argument
metric_value
andref_value
to the datatype defined bydtype
which can be int, float, or str- Parameters
metric_value – Value assigned to metric that is converted to its type defined by dtype
ref_value – Reference value for the metric that is converted to its type defined by dtype
dtype (str) – A string value which can be ‘str’, ‘int’, ‘float’
- Returns
A tuple consisting of (metric_value, ref_value)
- Return type
Tuple
- buildtest.buildsystem.checks.assert_ge_check(builder)[source]¶
Perform check on assert greater and equal when
assert_ge
is specified in buildspec. The return is a boolean value that determines if the check has passed. One can specify multiple assert checks to check each metric with its reference value. When multiple items are specified, the operation is a logical AND and all checks must beTrue
.- Returns
True or False for performance check
assert_ge
- Return type
- buildtest.buildsystem.checks.assert_eq_check(builder)[source]¶
This method is perform Assert Equality used when
assert_eq
property is specified in status check. This method will evaluate each metric value reference value and store assertion in list. The list of assertion is logically AND which will return a True or False for the status check.- Returns
True or False for performance check
assert_eq
- Return type
- buildtest.buildsystem.checks.assert_range_check(builder)[source]¶
This method is perform Assert Range used when
assert_range
property is specified in status check. This method will evaluate each metric value with lower and upper bound and store assertion in list. The list of assertion is logically AND which will return a True or False for the status check.- Returns
True or False for performance check
assert_range
- Return type