buildtest.cli.report

Module Contents

Classes

Report

param configuration: Instance of SiteConfiguration class that is loaded buildtest configuration.

Functions

is_int(val)	Check if input is an integer by running int(). If its successful we
list_report()	This method will list all report files. This method will implement buildtest report list command.
clear_report()	This method will clear all report files. We read file BUILDTEST_REPORTS and remove all report files and also remove content of BUILDTEST_REPORTS.
report_cmd(args, configuration[, report_file])	Entry point for buildtest report command
report_summary(report, configuration[, detailed, color])	This method will print summary for report file which can be retrieved via buildtest report summary command
print_report_summary_output(report, table, ...[, ...])	Print output of buildtest report summary.

Attributes

logger
PASS
FAIL

buildtest.cli.report.logger

buildtest.cli.report.PASS = 'PASS'

buildtest.cli.report.FAIL = 'FAIL'

buildtest.cli.report.is_int(val)

Check if input is an integer by running int(). If its successful we return True otherwise returns False

class buildtest.cli.report.Report(configuration, **kwargs)

Parameters:

• configuration (buildtest.config.SiteConfiguration) – Instance of SiteConfiguration class that is loaded buildtest configuration.

• **kwargs – Arbitrary keyword arguments. This will set report parameters for report class.

default_row_count = 50

format_field_description

filter_field_description

format_fields

filter_fields

display_table

format_fields_detailed = 'name,id,user,state,returncode,runtime,outfile,errfile,buildspec'

set_report_parameters(**kwargs)

Set report parameters for report class.

reportfile()

Return full path to report file

get()

Return raw content of report file

validate_filter_and_format_fields()

_check_filter_fields()

This method will validate filter fields buildtest report --filter by checking if field is valid filter field. If one specifies an invalid filter field, we will raise an exception

Raises:

BuildTestError – Raise exception if its in invalid filter field. If returncode is not an integer we raise exception

_check_format_fields()

Check all format arguments (–format) are valid, the arguments are specified in format (–format key1=val1,key2=val2). We make sure each key is valid format field.

Raises:

BuildTestError – If format field is not valid

_check_start_and_end_fields()

Check start argument (–start) and end argument (–end) are valid. The start argument is specified in format (–start yyyy-mm-dd), end argument in format (–end yyyy-mm-dd), or both (–start yyyy-mm-dd –end yyyy-mm-dd).

Raises:

BuildTestError – If –start is greater than –end or –end is greater than current time - datetime.datetime.now()

load_report()

This method is responsible for loading report file. If file not found or report is empty dictionary we raise an error. The report file is loaded if its valid JSON file and returns as dictionary containing entire report of all tests.

Raises:

SystemExit – If report file doesn’t exist or path is not a file. If the report file is empty upon loading we raise an error.

validate_buildspec_filter()

validate_state_filter()

filter_buildspecs_from_report()

This method filters the report table input filter --filter buildspec. If entry found in buildspec cache we add to list

filter_by_start_end(test)

This method will return a boolean (True/False) to check if test should be included from report. Given an input test, we check if a test record has ‘starttime’ and ‘endtime’ fields in range specified by --start and --end by the user. If there is a match we return True. A False indicates the test will not be incldued in report.

Parameters:

test (dict) – Test record loaded as dictionary

_filter_by_names(name)

Filter test by name of test. This method will return True if record should be processed, otherwise returns False

Parameters:

name (str) – Name of test to filter

_filter_by_tags(test)

This method will return a boolean (True/False) to check if test should be skipped from report. Given an input test, we check if test has ‘tags’ property in buildspec and if tagnames specified by --filter tags are found in the test. If there is a match we return False. A True indicates the test will be filtered out.

Parameters:

test (dict) – Test recorded loaded as dictionary

_filter_by_executor(test)

Filters test by executor property given input parameter buildtest report --filter executor:<executor>. If there is no match we return True otherwise returns False.

Parameters:

test (dict) – Test recorded loaded as dictionary

_filter_by_state(test)

This method filters test by state property based on input parameter buildtest report --filter state:<STATE>. If there is no match we return True otherwise returns False.

Parameters:

test (dict) – Test recorded loaded as dictionary

_filter_by_returncode(test)

Returns True/False if test is filtered by returncode. We will get input returncode in filter field via buildtest report --filter returncode:<CODE> with one in test and if there is a match we return True otherwise returns False.

Parameters:

test (dict) – Test recorded loaded as dictionary

process_report()

filter_tests(tests)

add_tests_to_display_table(tests, buildspec, name)

print_format_fields()

Displays list of format field which implements command buildtest report --helpformat

print_filter_fields()

Displays list of help filters which implements command buildtest report --helpfilter

print_raw_filter_fields()

Print list of filter fields which implements command buildtest report --filterfields

print_raw_format_fields()

Print list of format fields which implements command buildtest report --formatfields

print_report(terse=None, row_count=None, noheader=None, title=None, count=None, color=None)

This method will print report table after processing report file. By default we print output in table format but this can be changed to terse format which will print output in parseable format.

Parameters:

• terse (bool, optional) – Print output int terse format

• row_count (bool, optional) – Print total number of records from the table

• noheader (bool, optional) – Determine whether to print header in terse format

• title (str, optional) – Table title to print out

• count (int, optional) – Number of rows to be printed in terse format

• color (str, optional) – An instance of a string class that tells print_report what color the output should be printed in.

In this example, we display output in tabular format which works with --filter and --format option.

bash-3.2$ buildtest report --filter name=root_disk_usage --format name,state,returncode
Reading report file: /Users/siddiq90/Documents/GitHubDesktop/buildtest/var/report.json

+-----------------+---------+--------------+
| name            | state   |   returncode |
+=================+=========+==============+
| root_disk_usage | PASS    |            0 |
+-----------------+---------+--------------+
| root_disk_usage | PASS    |            0 |
+-----------------+---------+--------------+
| root_disk_usage | PASS    |            0 |
+-----------------+---------+--------------+

In terse format each output is separated by PIPE symbol (|*). The first row contains headers followed by content of the report.

bash-3.2$ buildtest report --filter name=root_disk_usage --format name,state,returncode --terse
name|state|returncode
root_disk_usage|PASS|0
root_disk_usage|PASS|0
root_disk_usage|PASS|0

You can avoid printing the header table by specifying –no-header option

bash-3.2$ buildtest report --filter name=root_disk_usage --format name,state,returncode --terse --no-header
root_disk_usage|PASS|0
root_disk_usage|PASS|0
root_disk_usage|PASS|0

latest_testid_by_name(name)

Given a test name return test id of latest run

Parameters:

name (str) – Name of test to search in report file and retrieve corresponding test id

get_names()

Return a list of test names from report file

get_random_tests(num_items=1)

Returns a list of random test names from the list of available test. The test are picked using random.sample

Parameters:

num_items (int, optional) – Number of test items to retrieve

get_buildspecs()

Return a list of buildspecs in report file

get_test_by_state(state)

Return a list of test names by state from report file

get_testids()

Return a list of test ids from the report file

_testid_lookup()

Return a dict where key represents full id of test and value is a dictionary containing two values name and buildspec property which contains name of test and path to buildspec file.

lookup()

Create a lookup dictionary with keys corresponding to name of test names and values are list of test ids.

from buildtest.cli.report import Report
r = Report()
r.lookup()
{'exit1_fail': ['913ce128-f425-488a-829d-d5d898113e8b', '54fc3dfe-50c5-4d2c-93fc-0c26364d215d', '70971081-84f9-462e-809b-a7d438a480bf'], 'exit1_pass': ['775a5545-bac5-468d-994d-85b22544306b', '0e908a64-fc81-4606-8ef4-78360563618e', '17082a05-ba32-4ef1-a38a-c2c6ea125bae', '3f50a73c-e333-4bbb-a722-aa5d72f98ac1', '964cd416-ad91-42be-bc1c-e25119f6df5d']}

builder_names()

Return a list of builder names in builder format which is in the form: <NAME>/<TESTID>.

get_random_builder_names(num_items=1)

Return a list of random builder names from report file.

Parameters:

num_items (int, optional) – Number of items to retrieve

breakdown_by_test_names()

Returns a dictionary with number of test runs, pass test and fail test by testname

fetch_records_by_ids(testids)

Fetch a test record given a list of test identifier.

Parameters:

testids (list) – A list of test IDs to search in report file and retrieve JSON record for each test.

buildtest.cli.report.list_report()

This method will list all report files. This method will implement buildtest report list command.

buildtest.cli.report.clear_report()

This method will clear all report files. We read file BUILDTEST_REPORTS and remove all report files and also remove content of BUILDTEST_REPORTS. This method will implement buildtest report clear command.

buildtest.cli.report.report_cmd(args, configuration, report_file=None)

Entry point for buildtest report command

buildtest.cli.report.report_summary(report, configuration, detailed=None, color=None)

This method will print summary for report file which can be retrieved via buildtest report summary command :param report: An instance of Report class :type report: buildtest.cli.report.Report :param configuration: An instance of SiteConfiguration class :type configuration: buildtest.config.SiteConfiguration :param detailed: An instance of bool, flag for printing a detailed report. :type detailed: bool :param color: An instance of str, color that the report should be printed in :type color: str

buildtest.cli.report.print_report_summary_output(report, table, pass_results, fail_results, color=None, detailed=None)

Print output of buildtest report summary.

Parameters:

• report (buildtest.cli.report.Report) – An instance of Report class

• table (rich.table.Table) – An instance of Rich Table class

• pass_results (buildtest.cli.report.Report) – An instance of Report class with filtered output by state=PASS

• fail_results (buildtest.cli.report.Report) – An instance of Report class with filtered output by state=FAIL

• color (str) – An instance of a string class that tells print_report_summary what color the output should be printed in.

• detailed (bool, optional) – Print detailed output of the report summary if buildtest report summary --detailed is specified