Amazon CodeBuild · JSON Structure

Amazon Codebuild Code Coverage Structure

Contains code coverage report information.

Line coverage measures how many statements your tests cover. A statement is a single instruction, not including comments, conditionals, etc.

Branch coverage determines if your tests cover every possible branch of a control structure, such as an if or case statement.

Type: object Properties: 10
AmazonCI/CDBuildContinuous IntegrationDevOpsTesting

CodeCoverage is a JSON Structure definition published by Amazon CodeBuild, describing 10 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id reportARN filePath lineCoveragePercentage linesCovered linesMissed branchCoveragePercentage branchesCovered branchesMissed expired

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-codebuild/refs/heads/main/json-structure/amazon-codebuild-code-coverage-structure.json",
  "name": "CodeCoverage",
  "description": "<p>Contains code coverage report information.</p> <p>Line coverage measures how many statements your tests cover. A statement is a single instruction, not including comments, conditionals, etc.</p> <p>Branch coverage determines if your tests cover every possible branch of a control structure, such as an <code>if</code> or <code>case</code> statement.</p>",
  "type": "object",
  "properties": {
    "id": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NonEmptyString"
        },
        {
          "description": "The identifier of the code coverage report."
        }
      ]
    },
    "reportARN": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NonEmptyString"
        },
        {
          "description": "The ARN of the report."
        }
      ]
    },
    "filePath": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NonEmptyString"
        },
        {
          "description": "The path of the test report file."
        }
      ]
    },
    "lineCoveragePercentage": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Percentage"
        },
        {
          "description": "The percentage of lines that are covered by your tests."
        }
      ]
    },
    "linesCovered": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NonNegativeInt"
        },
        {
          "description": "The number of lines that are covered by your tests."
        }
      ]
    },
    "linesMissed": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NonNegativeInt"
        },
        {
          "description": "The number of lines that are not covered by your tests."
        }
      ]
    },
    "branchCoveragePercentage": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Percentage"
        },
        {
          "description": "The percentage of branches that are covered by your tests."
        }
      ]
    },
    "branchesCovered": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NonNegativeInt"
        },
        {
          "description": "The number of conditional branches that are covered by your tests."
        }
      ]
    },
    "branchesMissed": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NonNegativeInt"
        },
        {
          "description": "The number of conditional branches that are not covered by your tests."
        }
      ]
    },
    "expired": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "The date and time that the tests were run."
        }
      ]
    }
  }
}