Analyzes and accumulates test report values for the specified test reports.
Parameters:
-
report_group_arn
(NonEmptyString)
–
The ARN of the report group that contains the reports to analyze.
-
num_of_reports
(Optional[PageSize], default:
None
)
–
The number of reports to analyze. This operation always retrieves the most recent reports.
If this parameter is omitted, the most recent 100 reports are analyzed.
-
trend_field
(ReportGroupTrendFieldType)
–
The test report value to accumulate. This must be one of the following values:
- Test reports:
-
- DURATION
-
Accumulate the test run times for the specified reports.
- PASS_RATE
-
Accumulate the percentage of tests that passed for the specified test reports.
- TOTAL
-
Accumulate the total number of tests for the specified test reports.
- Code coverage reports:
-
- BRANCH_COVERAGE
-
Accumulate the branch coverage percentages for the specified test reports.
- BRANCHES_COVERED
-
Accumulate the branches covered values for the specified test reports.
- BRANCHES_MISSED
-
Accumulate the branches missed values for the specified test reports.
- LINE_COVERAGE
-
Accumulate the line coverage percentages for the specified test reports.
- LINES_COVERED
-
Accumulate the lines covered values for the specified test reports.
- LINES_MISSED
-
Accumulate the lines not covered values for the specified test reports.
Raises:
Source code in docs_src/capo_codebuild/_services/code_build.py
| def get_report_group_trend(
self,
report_group_arn: "capo_codebuild.types.non_empty_string.NonEmptyString",
trend_field: "capo_codebuild.types.report_group_trend_field_type.ReportGroupTrendFieldType",
*,
config_overrides: Optional[CodeBuildClientConfig] = None,
num_of_reports: Optional["capo_codebuild.types.page_size.PageSize"] = None,
) -> "capo_codebuild.types.get_report_group_trend_output.GetReportGroupTrendOutput":
"""<p>Analyzes and accumulates test report values for the specified test reports.</p>
Args:
report_group_arn: <p>The ARN of the report group that contains the reports to analyze.</p>
num_of_reports: <p>The number of reports to analyze. This operation always retrieves the most recent reports.</p> <p>If this parameter is omitted, the most recent 100 reports are analyzed.</p>
trend_field: <p>The test report value to accumulate. This must be one of the following values:</p> <dl> <dt>Test reports:</dt> <dd> <dl> <dt>DURATION</dt> <dd> <p>Accumulate the test run times for the specified reports.</p> </dd> <dt>PASS_RATE</dt> <dd> <p>Accumulate the percentage of tests that passed for the specified test reports.</p> </dd> <dt>TOTAL</dt> <dd> <p>Accumulate the total number of tests for the specified test reports.</p> </dd> </dl> </dd> </dl> <dl> <dt>Code coverage reports:</dt> <dd> <dl> <dt>BRANCH_COVERAGE</dt> <dd> <p>Accumulate the branch coverage percentages for the specified test reports.</p> </dd> <dt>BRANCHES_COVERED</dt> <dd> <p>Accumulate the branches covered values for the specified test reports.</p> </dd> <dt>BRANCHES_MISSED</dt> <dd> <p>Accumulate the branches missed values for the specified test reports.</p> </dd> <dt>LINE_COVERAGE</dt> <dd> <p>Accumulate the line coverage percentages for the specified test reports.</p> </dd> <dt>LINES_COVERED</dt> <dd> <p>Accumulate the lines covered values for the specified test reports.</p> </dd> <dt>LINES_MISSED</dt> <dd> <p>Accumulate the lines not covered values for the specified test reports.</p> </dd> </dl> </dd> </dl>
Raises:
capo_codebuild.errors.invalid_input_exception.InvalidInputException: <p>The input value that was provided is not valid.</p>
capo_codebuild.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified Amazon Web Services resource cannot be found.</p>
capo_codebuild.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_codebuild.types.get_report_group_trend_input.GetReportGroupTrendInput]",
) -> OperationResponse[
"capo_codebuild.types.get_report_group_trend_output.GetReportGroupTrendOutput"
]:
import capo_codebuild._operations.code_build_20161006.get_report_group_trend
output, http_response = (
capo_codebuild._operations.code_build_20161006.get_report_group_trend.get_report_group_trend(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("GetReportGroupTrend")
)
input_: capo_codebuild.types.get_report_group_trend_input.GetReportGroupTrendInput = {
"report_group_arn": report_group_arn,
"trend_field": trend_field,
}
if num_of_reports is not None:
input_["num_of_reports"] = num_of_reports
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|