1. ソースクレデンシャルの削除 (GitHub: personal access token)

作業の目的 [why]

CodeBuildに登録されているGitHubのpersonal access tokenを削除します。

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

完了条件 [after]

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

完了条件1
GitHubのpersonal access tokenがCodeBuildに登録されていない。

事前条件 [before]

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

事前条件1
GitHubのpersonal access tokenがCodeBuildに登録されている。

作業対象 [what]

  • CodeBuild ソースクレデンシャル

標準時間(合計)

8分

パラメータ設定

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

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

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

リソース1: ソースクレデンシャルサーバタイプ

  • 削除するソースクレデンシャルのサーバタイプです。
  • 今回は"GITHUB"とします。

リソース2: ソースクレデンシャル認証タイプ

  • 削除するソースクレデンシャルの認証タイプです。
  • 今回は"PERSONAL_ACCESS_TOKEN"とします。

パラメータの指定

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

0.0. リージョンの指定

変数の設定

export AWS_DEFAULT_REGION='ap-northeast-1'

0.1. ソースクレデンシャルサーバタイプの指定

ソースクレデンシャルサーバタイプを指定します。

変数の設定:

CODEB_SOURCE_SERVER_TYPE='GITHUB'

0.2. ソースクレデンシャル認証タイプの指定

ソースクレデンシャル認証タイプを指定します。

変数の設定:

CODEB_SOURCE_AUTH_TYPE='PERSONAL_ACCESS_TOKEN'

パラメータの保存

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

変数の設定:

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

結果(例):

${HOME}/tmp/parameter-handson-cli/2019-04-30-codebuild-source_credentials-delete.env

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

変数の確認:

cat << EOF > ${FILE_PARAMETER}

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

  # 0.1. CODEB_SOURCE_SERVER_TYPE:"GITHUB"
         CODEB_SOURCE_SERVER_TYPE="${CODEB_SOURCE_SERVER_TYPE}"
  # 0.2. CODEB_SOURCE_AUTH_TYPE:"PERSONAL_ACCESS_TOKEN"
         CODEB_SOURCE_AUTH_TYPE="${CODEB_SOURCE_AUTH_TYPE}"

EOF

cat ${FILE_PARAMETER}

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

タスクの実施

タスク標準時間:6分

1. 前処理

1.1. 処理対象の状態確認

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

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

事前条件1: GitHubのpersonal access tokenがCodeBuildに登録されている。

「GitHubのpersonal access tokenがCodeBuildに登録されている。」ことを確認します。

コマンド:

aws codebuild list-source-credentials \
  --query "sourceCredentialsInfos[? \
    serverType == \`${CODEB_SOURCE_SERVER_TYPE}\` \
    && authType == \`${CODEB_SOURCE_AUTH_TYPE}\` \
    ].arn" \
  --output text

結果(例):

arn:aws:codebuild:ap-northeast-1:XXXXXXXXXXXX:token/github

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

ソースクレデンシャルARNの取得

コマンド:

CODEB_SOURCE_CREDENTIALS_ARN=$( \
  aws codebuild list-source-credentials \
    --query "sourceCredentialsInfos[? \
      serverType == \`${CODEB_SOURCE_SERVER_TYPE}\` \
      && authType == \`${CODEB_SOURCE_AUTH_TYPE}\` \
      ].arn" \
    --output text \
) \
  && echo ${CODEB_SOURCE_CREDENTIALS_ARN}

結果(例):

arn:aws:codebuild:ap-northeast-1:XXXXXXXXXXXX:token/github

2. 主処理

Source Credentialsの削除

パラメータの確認:

cat << ETX

  # CODEB_SOURCE_CREDENTIALS_ARN:"arn:aws:codebuild:ap-northeast-1:XXXXXXXXXXXX:token/github"
    CODEB_SOURCE_CREDENTIALS_ARN="${CODEB_SOURCE_CREDENTIALS_ARN}"

ETX

コマンド:

aws codebuild delete-source-credentials \
  --arn ${CODEB_SOURCE_CREDENTIALS_ARN}

結果(例):

{
  "arn": "arn:aws:codebuild:ap-northeast-1:XXXXXXXXXXXX:token/github"
}

3. 後処理

完了条件の確認

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

完了条件1: GitHubのpersonal access tokenがCodeBuildに登録されていない。

「GitHubのpersonal access tokenがCodeBuildに登録されていない。」ことを確認します。

コマンド:

aws codebuild list-source-credentials \
  --query "sourceCredentialsInfos[? \
    serverType == \`${CODEB_SOURCE_SERVER_TYPE}\` \
    && authType == \`${CODEB_SOURCE_AUTH_TYPE}\` \
    ].arn" \
  --output text

結果(例):

(出力なし)

完了