「 サンプルを使用したテストレポート AWS CLI」

CreateReportGroupInput.json という名前のファイルを作成します。

S3 バケットに、テスト結果をエクスポートするフォルダを作成します。

以下を CreateReportGroupInput.json にコピーします。<bucket-name> で、S3 バケットの名前を使用します。<path-to-folder> で、S3 バケット内のフォルダへのパスを入力します。

{
  "name": "<report-name>",
  "type": "TEST",
  "exportConfig": {
    "exportConfigType": "S3",
    "s3Destination": {
      "bucket": "<bucket-name>",
      "path": "<path-to-folder>",
      "packaging": "NONE"
    }
  }
}

CreateReportGroupInput.json が含まれているディレクトリで次のコマンドを実行します。

aws codebuild create-report-group --cli-input-json file://CreateReportGroupInput.json

出力は次のようになります。reportGroup の ARN を書き留めます。これは、このレポートグループを使用するプロジェクトを作成するときに使用します。

{
  "reportGroup": {
    "arn": "arn:aws:codebuild:us-west-2:123456789012:report-group/<report-name>",
    "name": "<report-name>",
    "type": "TEST",
    "exportConfig": {
      "exportConfigType": "S3",
      "s3Destination": {
        "bucket": "<s3-bucket-name>",
        "path": "<folder-path>",
        "packaging": "NONE",
        "encryptionKey": "arn:aws:kms:us-west-2:123456789012:alias/aws/s3"
      }
    },
    "created": 1570837165.885,
    "lastModified": 1570837165.885
  }
}

buildspec.yml という名前の buildspec ファイルを作成します。

次のYAMLを buildspec.yml ファイルのテンプレートとして使用します。テストを実行するコマンドを必ず含めてください。reports セクションで、テストケースの結果を含むファイルを指定します。これらのファイルは、CodeBuild でアクセスできるテスト結果を保存します。作成から 30 日後に有効期限が切れます。これらのファイルは、S3 バケットにエクスポートする生のテストケース結果ファイルとは異なります。

version: 0.2
    phases:
    install:
        runtime-versions:
            java: openjdk8
    build:
      commands:
        - echo Running tests 
        - <enter commands to run your tests>
        
    reports:
      <report-name-or-arn>: #test file information
      files:
        - '<test-result-files>'
      base-directory: '<optional-base-directory>'
      discard-paths: false #do not remove file paths from test result files

project.json という名前のファイルを作成します。このファイルには、create-project コマンドの入力が含まれます。

次の JSON を project.json にコピーします。source で、ソースファイルを含むリポジトリのタイプと場所を入力します。serviceRole で、使用しているロールの ARN を指定します。

{
  "name": "test-report-project",
  "description": "sample-test-report-project",
  "source": {
    "type": "CODECOMMIT|CODEPIPELINE|GITHUB|S3|BITBUCKET|GITHUB_ENTERPRISE|NO_SOURCE",
    "location": "<your-source-url>"
  },
  "artifacts": {
    "type": "NO_ARTIFACTS"
  },
  "cache": {
    "type": "NO_CACHE"
  },
  "environment": {
    "type": "LINUX_CONTAINER",
    "image": "aws/codebuild/standard:5.0",
    "computeType": "small"
  },
  "serviceRole": "arn:aws:iam::<your-aws-account-id>:role/service-role/<your-role-name>"
}

project.json が含まれているディレクトリで次のコマンドを実行します。これにより、test-project という名前のプロジェクトが作成されます。

aws codebuild create-project --cli-input-json file://project.json

ビルドを開始するには、次のコマンドを実行します。「test-report-project」は、上記で作成されたビルドプロジェクトの名前です。出力に表示されるビルド ID を書き留めます。

aws codebuild start-build --project-name test-report-project

次のコマンドを実行して、レポートの ARN を含むビルドに関する情報を取得します。<build-id> で、ビルド ID を指定します。出力の「reportArns」プロパティのレポート ARN を書き留めます。

aws codebuild batch-get-builds --ids <build-id>

次のコマンドを実行して、レポートの詳細を取得します。<report-arn> で、レポート ARN を指定します。

aws codebuild batch-get-reports --report-arns <report-arn>

出力は次のようになります。このサンプル出力は、成功、失敗、スキップされたテスト、エラーの結果、または不明なステータスを返したテストの数を示しています。

{
  "reports": [
    {
      "status": "FAILED",
      "reportGroupArn": "<report-group-arn>",
      "name": "<report-group-name>",
      "created": 1573324770.154,
      "exportConfig": {
        "exportConfigType": "S3",
        "s3Destination": {
          "bucket": "<amzn-s3-demo-bucket>",
          "path": "<path-to-your-report-results>",
          "packaging": "NONE",
          "encryptionKey": "<encryption-key>"
        }
      },
      "expired": 1575916770.0,
      "truncated": false,
      "executionId": "arn:aws:codebuild:us-west-2:123456789012:build/<name-of-build-project>:2c254862-ddf6-4831-a53f-6839a73829c1",
      "type": "TEST",
      "arn": "<report-arn>",
      "testSummary": {
        "durationInNanoSeconds": 6657770,
        "total": 11,
        "statusCounts": {
          "FAILED": 3,
          "SKIPPED": 7,
          "ERROR": 0,
          "SUCCEEDED": 1,
          "UNKNOWN": 0
        }
      }
    }
  ],
  "reportsNotFound": []
}

レポートのテストケースに関する情報を一覧表示するには、次のコマンドを実行します。<report-arn> で、レポートの ARN を指定します。オプションの --filter パラメータでは、(SUCCEEDED、FAILED、SKIPPED、 ERROR、または UNKNOWN) の 1 つのステータス結果指定できます。

aws codebuild describe-test-cases \
    --report-arn <report-arn> \
    --filter status=SUCCEEDED|FAILED|SKIPPED|ERROR|UNKNOWN

出力は次のようになります。

{
  "testCases": [
    {
      "status": "FAILED",
      "name": "Test case 1",
      "expired": 1575916770.0,
      "reportArn": "<report-arn>",
      "prefix": "Cucumber tests for agent",
      "message": "A test message",
      "durationInNanoSeconds": 1540540,
      "testRawDataPath": "<path-to-output-report-files>"
    },
    {
      "status": "SUCCEEDED",
      "name": "Test case 2",
      "expired": 1575916770.0,
      "reportArn": "<report-arn>",
      "prefix": "Cucumber tests for agent",
      "message": "A test message",
      "durationInNanoSeconds": 1540540,
      "testRawDataPath": "<path-to-output-report-files>"
    }
  ]
}