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-codebuild-artifact-XXXXXXXXXXXX"にビルド成果物が存在する。
事前条件 [before]
主処理の実施は、以下の状態であることを前提とします。
- 事前条件1
- CodeBuildプロジェクト"handson-cli-codebuild-project"が存在する。
- 事前条件2
- アーティファクト用S3バケット"handson-cli-codebuild-artifact-XXXXXXXXXXXX"にビルド成果物が存在しない。
作業対象 [what]¶
- CodeBuildプロジェクト
標準時間(合計)¶
8分
パラメータ設定¶
| パラメータ設定の標準時間: | 2分 |
|---|
作業に必要なモノ・情報 [resource]¶
作業開始には、以下が全て揃っていることが必要です。
リソース1: CodeBuildプロジェクト名
- 作成するCodeBuildプロジェクトの名称です。
- 今回は"handson-cli-codebuild-project"とします。
パラメータの指定¶
作業に必要なパラメータを変数に格納をします。
0.1. CodeBuildプロジェクト名の指定¶
CodeBuildプロジェクト名を指定します。
変数の設定:
CODEB_PROJECT_NAME='handson-cli-codebuild-project'
パラメータの保存¶
設定されている変数の保存先となるファイル名を指定します。
変数の設定:
DIR_PARAMETER="${HOME}/tmp/parameter-handson-cli" FILE_PARAMETER="${DIR_PARAMETER}/$(date +%Y-%m-%d)-codebuild-build-create-expand-from_s3-to_s3.env" \ && echo ${FILE_PARAMETER}
結果(例):
${HOME}/tmp/parameter-handson-cli/2019-04-30-codebuild-build-create-expand-from_s3-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}" EOF cat ${FILE_PARAMETER}
下段の変数が入っていない、もしくは上段と同等の値が入っていない場合は、それぞれの手順番号に戻って変数の設定を行います。
タスクの実施¶
| タスク標準時間: | 6分 |
|---|
1. 前処理¶
1.1. 状態確認に必要な情報の取得¶
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-codebuild-artifact-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
処理対象の状態確認¶
主処理の実施は、以下の状態であることを前提とします。
前提と異なることが判明した場合、直ちに処理を中止します。
事前条件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-codebuild-artifact-XXXXXXXXXXXX"にビルド成果物が存在しない。
「アーティファクト用S3バケット"handson-cli-codebuild-artifact-XXXXXXXXXXXX"にビルド成果物が存在しない。」ことを確認します。
コマンド:
aws s3 ls s3://${CODEB_ARTIFACTS_LOCATION}/${CODEB_ARTIFACTS_NAME}/
結果(例):
(出力なし)
2. 主処理¶
Buildの実行¶
変数の確認:
cat << ETX # CODEB_PROJECT_NAME:"handson-cli-codebuild-project" CODEB_PROJECT_NAME="${CODEB_PROJECT_NAME}" ETX
コマンド:
aws codebuild start-build \ --project-name ${CODEB_PROJECT_NAME}
結果(例):
{ "build": { "id": "handson-cli-codebuild-project:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "arn": "arn:aws:codebuild:ap-northeast-1:XXXXXXXXXXXX:build/handson-cli-codebuild-project:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" "startTime": 15xxxxxxxx.000, "currentPhase": "SUBMITTED", "buildStatus": "IN_PROGRESS", "projectName": "handson-cli-codebuild-project", "source": { "type": "S3", "location": "handson-cli-codebuild-source-XXXXXXXXXXXX/handson-cli-codebuild.zip", "insecureSsl": false }, "artifacts": { "location": "arn:aws:s3:::handson-cli-codebuild-artifact-XXXXXXXXXXXX/handson-cli-codebuild-project", "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-codebuild-artifact-XXXXXXXXXXXX"にビルド成果物が存在する。
「アーティファクト用S3バケット"handson-cli-codebuild-artifact-XXXXXXXXXXXX"にビルド成果物が存在する。」ことを確認します。
コマンド:
aws s3 ls s3://${CODEB_ARTIFACTS_LOCATION}/${CODEB_ARTIFACTS_NAME}
結果(例):
2019-04-30 01:23:45 xxxx handson-cli-codebuild-project.zip