CodeBuild / Client / get_report_group_trend

get_report_group_trend

CodeBuild.Client.get_report_group_trend(**kwargs)

Analyzes and accumulates test report values for the specified test reports.

See also: AWS API Documentation

Request Syntax

response = client.get_report_group_trend(
    reportGroupArn='string',
    numOfReports=123,
    trendField='PASS_RATE'|'DURATION'|'TOTAL'|'LINE_COVERAGE'|'LINES_COVERED'|'LINES_MISSED'|'BRANCH_COVERAGE'|'BRANCHES_COVERED'|'BRANCHES_MISSED'
)

Parameters:

• reportGroupArn (string) –

  [REQUIRED]

  The ARN of the report group that contains the reports to analyze.

• numOfReports (integer) –

  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.

• trendField (string) –

  [REQUIRED]

  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.

Return type:

dict

Returns:

Response Syntax

{
    'stats': {
        'average': 'string',
        'max': 'string',
        'min': 'string'
    },
    'rawData': [
        {
            'reportArn': 'string',
            'data': 'string'
        },
    ]
}

Response Structure

• (dict) –

  • stats (dict) –

    Contains the accumulated trend data.

    • average (string) –

      Contains the average of all values analyzed.

    • max (string) –

      Contains the maximum value analyzed.

    • min (string) –

      Contains the minimum value analyzed.

  • rawData (list) –

    An array that contains the raw data for each report.

    • (dict) –

      Contains the unmodified data for the report. For more information, see .

      • reportArn (string) –

        The ARN of the report.

      • data (string) –

        The value of the requested data field from the report.

Exceptions

• CodeBuild.Client.exceptions.InvalidInputException

• CodeBuild.Client.exceptions.ResourceNotFoundException