1. ビルドの実行 (handson-cli-codebuild-project)¶

作業の目的 [why]¶

CodeBuildプロジェクト"handson-cli-codebuild-project"のビルドを実行します。

完了条件/事前条件 [設計者用情報]

完了条件 [after]

主処理は、以下を満たしたときに成功したものとします。

完了条件1: CodeBuildプロジェクト"handson-cli-codebuild-project"のビルドフェイズが"COMPLETED"である。
完了条件2: CodeBuildプロジェクト"handson-cli-codebuild-project"のビルドステータスが"SUCCEEDED"である。
完了条件3: アーティファクト用S3バケット"handson-cli-artifacts-XXXXXXXXXXXX"にビルド成果物が存在する。

事前条件 [before]

主処理の実施は、以下の状態であることを前提とします。

事前条件1: CodeBuildプロジェクト"handson-cli-codebuild-project"が存在する。
事前条件2: アーティファクト用S3バケット"handson-cli-artifacts-XXXXXXXXXXXX"にビルド成果物が存在しない。
事前条件3: ソースコード用CodeCommitリポジトリ"handson-cli-repository"が存在する。
事前条件4: ソースコード用CodeCommitリポジトリ"handson-cli-repository"のブランチ"feature/feature-handson-cli"にCommitIDが存在する。

作業対象 [what]¶

CodeBuildサービス

標準時間(合計)¶

8分

パラメータ設定¶

パラメータ設定の標準時間:	2分

作業に必要なモノ・情報 [resource]¶

作業開始には、以下が全て揃っていることが必要です。

リソース1: CodeBuildプロジェクト名

ビルドするCodeBuildプロジェクトの名称です。
今回は"handson-cli-codebuild-project"とします。

リソース2: CodeCommitリポジトリ名

ビルドするCodeBuildプロジェクトのソースが置かれているCodeCommitリポジトリ名です。
今回は"handson-cli-repository"とします。

リソース3: Gitブランチ名

ビルドするCodeBuildプロジェクトのソースのブランチ名です。
今回は"feature/feature-handson-cli"とします。

パラメータの指定¶

作業に必要なパラメータを変数に格納をします。

0.0. リージョンの指定¶

変数の設定

export AWS_DEFAULT_REGION='ap-northeast-1'

0.1. CodeBuildプロジェクト名の指定¶

CodeBuildプロジェクト名を指定します。

変数の設定:

CODEB_PROJECT_NAME='handson-cli-codebuild-project'

0.2. CodeCommitリポジトリ名の指定¶

CodeCommitリポジトリ名を指定します。

変数の設定:

CODEC_REPOSITORY_NAME='handson-cli-repository'

0.3. Gitブランチ名の指定¶

Gitブランチ名を指定します。

変数の設定:

GIT_BRANCH_NAME='feature/feature-handson-cli'

パラメータの保存¶

設定されている変数の保存先となるファイル名を指定します。

変数の設定:

DIR_PARAMETER="${HOME}/tmp/parameter-handson-cli"
FILE_PARAMETER="${DIR_PARAMETER}/$(date +%Y-%m-%d)-codebuild-build-create-expand-from_codecommit-to_s3.env" \
  && echo ${FILE_PARAMETER}

結果(例):

${HOME}/tmp/parameter-handson-cli/2019-04-30-codebuild-build-create-expand-from_codecommit-to_s3.env

各変数に正しいパラメータ値が格納されていることを確認しながら保存します。

変数の確認:

cat << EOF > ${FILE_PARAMETER}

  # 0.0. AWS_DEFAULT_REGION:"ap-northeast-1"
         AWS_DEFAULT_REGION="${AWS_DEFAULT_REGION}"

  # 0.1. CODEB_PROJECT_NAME:"handson-cli-codebuild-project"
         CODEB_PROJECT_NAME="${CODEB_PROJECT_NAME}"
  # 0.2. CODEC_REPOSITORY_NAME:"handson-cli-repository"
         CODEC_REPOSITORY_NAME="${CODEC_REPOSITORY_NAME}"
  # 0.3. GIT_BRANCH_NAME:"feature/feature-handson-cli"
         GIT_BRANCH_NAME="${GIT_BRANCH_NAME}"

EOF

cat ${FILE_PARAMETER}

下段の変数が入っていない、もしくは上段と同等の値が入っていない場合は、それぞれの手順番号に戻って変数の設定を行います。

タスクの実施¶

課題

(未検証)

タスク標準時間:	6分

1. 前処理¶

1.1. 処理対象の状態確認¶

主処理の実施は、以下の状態であることを前提とします。

前提と異なることが判明した場合、直ちに処理を中止します。

事前条件1: CodeBuildプロジェクト"handson-cli-codebuild-project"が存在する。

「CodeBuildプロジェクト"handson-cli-codebuild-project"が存在する。」ことを確認します。

コマンド:

aws codebuild list-projects \
  --query "projects[]" \
  | grep ${CODEB_PROJECT_NAME}

結果(例):

"handson-cli-codebuild-project",

事前条件2: アーティファクト用S3バケット"handson-cli-artifacts-XXXXXXXXXXXX"にビルド成果物が存在しない。

「アーティファクト用S3バケット"handson-cli-artifacts-XXXXXXXXXXXX"にビルド成果物が存在しない。」ことを確認します。

artifactsロケーションを取得します。

コマンド:

CODEB_ARTIFACTS_LOCATION=$( \
  aws codebuild batch-get-projects --names ${CODEB_PROJECT_NAME} \
    --query "projects[].artifacts.location" \
    --output text \
) \
  && echo ${CODEB_ARTIFACTS_LOCATION}

結果(例):

handson-cli-artifacts-XXXXXXXXXXXX

artifacts名を取得します。

コマンド:

CODEB_ARTIFACTS_NAME=$( \
  aws codebuild batch-get-projects --names ${CODEB_PROJECT_NAME} \
    --query "projects[].artifacts.name" \
    --output text \
) \
  && echo ${CODEB_ARTIFACTS_NAME}

結果(例):

handson-cli-codebuild-project.zip

コマンド:

aws s3 ls s3://${CODEB_ARTIFACTS_LOCATION}/${CODEB_ARTIFACTS_NAME}/

結果(例):

(出力なし)

事前条件3: ソースコード用CodeCommitリポジトリ"handson-cli-repository"が存在する。

「ソースコード用CodeCommitリポジトリ"handson-cli-repository"が存在する。」ことを確認します。

コマンド:

aws codecommit list-repositories \
  --query "repositories[?repositoryName == \`${CODEC_REPOSITORY_NAME}\`].repositoryName" \
  --output text

結果(例):

handson-cli-repository

事前条件4: ソースコード用CodeCommitリポジトリ"handson-cli-repository"のブランチ"feature/feature-handson-cli"にCommitIDが存在する。

「ソースコード用CodeCommitリポジトリ"handson-cli-repository"のブランチ"feature/feature-handson-cli"にCommitIDが存在する。」ことを確認します。

コマンド:

aws codecommit get-branch \
  --repository-name ${CODEC_REPOSITORY_NAME} \
  --branch-name ${GIT_BRANCH_NAME} \
  --query "branch.commitId" \
  --output text

結果(例):

|CODEC_COMMIT_ID|

1.2. 主処理に必要な情報の取得¶

コミットIDの取得

コマンド:

CODEC_COMMIT_ID=$( \
  aws codecommit get-branch \
    --repository-name ${CODEC_REPOSITORY_NAME} \
    --branch-name ${GIT_BRANCH_NAME} \
    --query "branch.commitId" \
    --output text \
) \
  && echo ${CODEC_COMMIT_ID}

結果(例):

|CODEC_COMMIT_ID|

2. 主処理¶

Buildの実行¶

変数の確認:

cat << ETX

  # CODEB_PROJECT_NAME:"handson-cli-codebuild-project"
    CODEB_PROJECT_NAME="${CODEB_PROJECT_NAME}"
  # CODEC_COMMIT_ID:"|CODEC_COMMIT_ID|"
    CODEC_COMMIT_ID="${CODEC_COMMIT_ID}"

ETX

コマンド:

aws codebuild start-build \
  --project-name ${CODEB_PROJECT_NAME} \
  --source-version ${CODEC_COMMIT_ID}

結果(例):

{
  "build": {
    "id": "handson-cli-codebuild-project:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "arn": "arn:aws:codebuild:ap-northeast-1:XXXXXXXXXXXX:build/||CODEB_PROJECT_NAME|:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "startTime": 1542619939.000,
    "currentPhase": "QUEUED",
    "buildStatus": "IN_PROGRESS",
    "sourceVersion": "feature/feature-handson-cli",
    "projectName": "handson-cli-codebuild-project",
    "phases": [
        {
            "phaseType": "SUBMITTED",
            "phaseStatus": "SUCCEEDED",
            "startTime": 1542619939.000,
            "endTime": 1542619939.000,
            "durationInSeconds": 0
        },
        {
            "phaseType": "QUEUED",
            "startTime": 1542619939.000
        }
    ],
    "source": {
        "type": "CODECOMMIT",
        "location": "https://git-codecommit.ap-northeast-1.amazonaws.com/v1/repos/handson-cli-repository",
        "insecureSsl": false
    },
    "artifacts": {
        "location": "arn:aws:s3:::handson-cli-artifacts-XXXXXXXXXXXX/handson-cli-codebuild-project.zip",
        "encryptionDisabled": false
    },
    "cache": {
        "type": "NO_CACHE"
    },
    "environment": {
        "type": "LINUX_CONTAINER",
        "image": "ubuntu/python/3.6.5",
        "computeType": "BUILD_GENERAL1_SMALL",
        "environmentVariables": [],
        "privilegedMode": false
    },
    "serviceRole": "arn:aws:iam::XXXXXXXXXXXX:role/handson-cli-codebuild-role",
    "logs": {
        "deepLink": "https://console.aws.amazon.com/cloudwatch/home?region=ap-northeast-1#logEvent:group=null;stream=null"
    },
    "timeoutInMinutes": 60,
    "buildComplete": false,
    "initiator": "handson-cli-codebuild-role/i-xxxxxxxxxxxxxxxxx",
    "encryptionKey": "arn:aws:kms:ap-northeast-1:XXXXXXXXXXXX:alias/aws/s3"
  }
}

3. 後処理¶

3.1. 状態確認に必要な情報の取得¶

ビルドIDの取得

プロジェクトに存在するビルドのIDを全て取得します。

コマンド:

ARRAY_CODEB_BUILD_IDS=$( \
  aws codebuild list-builds-for-project \
    --project-name ${CODEB_PROJECT_NAME} \
    --query 'ids' \
    --output text \
) \
  && echo ${ARRAY_CODEB_BUILD_IDS}

結果(例):

handson-cli-codebuild-project:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

プロジェクト内のビルドで完了していない(つまり実行中の)もののIDを取得します。

コマンド:

CODEB_BUILD_ID=$( \
  aws codebuild batch-get-builds \
    --ids ${ARRAY_CODEB_BUILD_IDS} \
    --query 'builds[?currentPhase != `COMPLETED`].id' \
    --output text \
) \
  && echo ${CODEB_BUILD_ID}

結果(例):

handson-cli-codebuild-project:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

3.2. 完了条件の確認¶

主処理は、以下を満たしたときに成功したものとします。

完了条件1: CodeBuildプロジェクト"handson-cli-codebuild-project"のビルドフェイズが"COMPLETED"である。

「CodeBuildプロジェクト"handson-cli-codebuild-project"のビルドフェイズが"COMPLETED"である。」ことを確認します。

コマンド:

CODEB_BUILD_PHASE=$( \
  aws codebuild batch-get-builds \
    --ids ${CODEB_BUILD_ID} \
    --query "builds[].currentPhase" \
    --output text \
) \
  && echo ${CODEB_BUILD_PHASE}

結果(例):

COMPLETED

完了条件2: CodeBuildプロジェクト"handson-cli-codebuild-project"のビルドステータスが"SUCCEEDED"である。

「CodeBuildプロジェクト"handson-cli-codebuild-project"のビルドステータスが"SUCCEEDED"である。」ことを確認します。

コマンド:

CODEB_BUILD_STATUS=$( \
  aws codebuild batch-get-builds \
    --ids ${CODEB_BUILD_ID} \
    --query "builds[].buildStatus" \
    --output text \
) \
  && echo ${CODEB_BUILD_STATUS}

結果(例):

SUCCEEDED

完了条件3: アーティファクト用S3バケット"handson-cli-artifacts-XXXXXXXXXXXX"にビルド成果物が存在する。

「アーティファクト用S3バケット"handson-cli-artifacts-XXXXXXXXXXXX"にビルド成果物が存在する。」ことを確認します。

コマンド:

aws s3 ls s3://${CODEB_ARTIFACTS_LOCATION}/${CODEB_ARTIFACTS_NAME}

結果(例):

2019-04-30 01:23:45       xxxx handson-cli-codebuild-project.zip

prototype.opslearn.jp

1. ビルドの実行 (handson-cli-codebuild-project)¶

作業の目的 [why]¶

作業対象 [what]¶

標準時間(合計)¶

パラメータ設定¶

作業に必要なモノ・情報 [resource]¶

パラメータの指定¶

0.0. リージョンの指定¶

0.1. CodeBuildプロジェクト名の指定¶

0.2. CodeCommitリポジトリ名の指定¶

0.3. Gitブランチ名の指定¶

パラメータの保存¶

タスクの実施¶

1. 前処理¶

1.1. 処理対象の状態確認¶

1.2. 主処理に必要な情報の取得¶

2. 主処理¶

Buildの実行¶

3. 後処理¶

3.1. 状態確認に必要な情報の取得¶

3.2. 完了条件の確認¶

完了¶