[アップデート]AWS CodeBuildの新しいデバッグ機能であるSandbox環境によるデバッグを試してみた

#!/bin/bash
set -e

_wait() {
    read -p "Press return to continue "
}

_print() {
    printf "$1\n"
}

install_session_manager_plugin() {
    # get session manager installer url based on CPU architecture
    architecture=$(uname -m)
    case $architecture in
        "arm" | "arm64" | "aarch64")
            installer_url="https://s3.amazonaws.com/session-manager-downloads/plugin/latest/mac_arm64/session-manager-plugin.pkg"
            ;;
        "x86_64")
            installer_url="https://s3.amazonaws.com/session-manager-downloads/plugin/latest/mac/session-manager-plugin.pkg"
            ;;
        *)
            echo "Unsupported CPU architecture. Couldn't install AWS Session Manager plugin"
            exit 1
            ;;
    esac

    if command -v session-manager-plugin; then
        echo "Updating Session Manager plugin from signed installer"
    else
        echo "Installing Session Manager plugin from signed installer"
    fi
    _wait

    curl $installer_url -o "session-manager-plugin.pkg"
    sudo installer -pkg session-manager-plugin.pkg -target /
    # Do not fail if symlink exists
    set +e && sudo ln -s /usr/local/sessionmanagerplugin/bin/session-manager-plugin /usr/local/bin/session-manager-plugin && set -e
    rm "session-manager-plugin.pkg"

    session-manager-plugin
    echo "Successfully installed AWS Session Manager plugin"
}

update_ssh_config() {
    ssh_config_content="\nHost codebuild-sandbox-ssh*
    StrictHostKeyChecking no
    LogLevel INFO
    ForwardAgent yes
    ControlMaster auto
    ControlPersist 10m
    ProxyCommand sh -c \"$HOME/.aws/codebuild-dev-env/codebuild-sandbox-connect.sh %%n\""

    mkdir -p ~/.ssh
    touch ~/.ssh/config

    found_ssh_config=0
    grep -Fxq "Host codebuild-sandbox-ssh*" ~/.ssh/config || found_ssh_config=$?
    if [ $found_ssh_config -eq 0 ]; then
        echo "Found SSH config for hostname alias 'codebuild-sandbox-ssh*'. Skipping SSH config update"
    else
        echo "Adding the following lines to ~/.ssh/config:"
        _print "$ssh_config_content\n"
        _wait
        _print "$ssh_config_content" >> ~/.ssh/config
        echo "Successfully modified local SSH configuration"
    fi
}

# define proxy command script content
start_connection_script_content=$(cat <<- "END"
#!/bin/bash
set -e

start_dev_environment_connection() {
    export AWS_EXECUTION_ENV="DevEnvSSHAccess"

    if ! command -v aws; then
        echo "Please make sure you have AWS CLI installed. Refer to the documentation for installation steps: https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html" >> /dev/stderr
        exit 1
    fi

    aws_cli_version_string_temp=$(aws --version)
    aws_cli_version="$(echo $aws_cli_version_string_temp | grep -ozE "aws-cli/([0-9]{1,}\.)+[0-9]{1,}" | grep -aoE "([0-9]{1,}\.)+[0-9]{1,}")"

    # compare installed AWS CLI version with minimum supported version
    if (echo minimum 2.9.4; echo installed $aws_cli_version) | sort -Vk2 | tail -1 | grep -q minimum; then
        echo "You are using an older version of AWS CLI that doesn't support CodeBuild commands. Please update AWS CLI to the latest version to be able connect to the dev environment via SSH." >> /dev/stderr
        echo "Refer to the documentation for installation steps: https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html" >> /dev/stderr
        exit 1
    fi

    hostname=$1
    OLDIFS=$IFS
    IFS='='
    if [[ $hostname == *"?"* ]]; then
        IFS='?'
    fi
    sandboxId=""
    region=""
    read -a input_array <<< "$hostname"
    if [ ${#input_array[*]} -eq 2 ]
    then
        sandboxId=${input_array[1]}
        region=$(echo $sandboxId | grep -oE ":[a-z]{2}-[a-z]{1,}-[0-9]{1,}:" | tr -d ':')
    else
        region=${input_array[1]}
        accountId=${input_array[2]}
        projectName=${input_array[3]}
        sandboxUUID=${input_array[4]}
        sandboxId="arn:aws:codebuild:${region}:${accountId}:sandbox/${projectName}:${sandboxUUID}"
    fi
    IFS=$OLDIFS

    response=$(
        aws codebuild start-sandbox-connection \\
        --sandbox-id $sandboxId \\
        --region $region
    )
    if [ $? -ne 0 ]; then
        >/dev/stderr echo $response
        exit 1
    fi

    read SESSION_ID STREAM_URL TOKEN_VALUE <<< $(echo $response | jq --raw-output '.ssmSession.sessionId, .ssmSession.streamUrl, .ssmSession.tokenValue')

    export AWS_SSM_START_SESSION_RESPONSE="
    {
        \\"streamUrl\\": \\"$STREAM_URL\\",
        \\"tokenValue\\": \\"$TOKEN_VALUE\\",
        \\"sessionId\\": \\"$SESSION_ID\\"
    }
    "
    session-manager-plugin AWS_SSM_START_SESSION_RESPONSE $region "StartSession"
}

start_dev_environment_connection $1
END
)

place_proxy_command_script() {
    mkdir -p ~/.aws/codebuild-dev-env
    touch ~/.aws/codebuild-dev-env/codebuild-sandbox-connect.sh

    # Do not touch proxy command script if it doesn't need to be updated
    if [ "$(cat ~/.aws/codebuild-dev-env/codebuild-sandbox-connect.sh)" == "$start_connection_script_content" ]; then
        return
    fi

    echo
    echo "Placing SSH proxy command script in ~/.aws/codebuild-dev-env/codebuild-sandbox-connect.sh"
    _wait

    _print "$start_connection_script_content" > ~/.aws/codebuild-dev-env/codebuild-sandbox-connect.sh
    chmod +x ~/.aws/codebuild-dev-env/codebuild-sandbox-connect.sh

    echo "Successfully placed SSH proxy command script in ~/.aws/codebuild-dev-env/"
}

check_aws_cli_version() {
    if ! command -v aws; then
        echo
        echo "ERROR: "
        echo "Please make sure you have AWS CLI installed. Refer to the documentation for installation steps: https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html"
        exit 1
    fi

    aws --version &> aws_cli_version_string_temp.txt
    aws_cli_version="$(cat aws_cli_version_string_temp.txt | grep -ozE "aws-cli/([0-9]{1,}\.)+[0-9]{1,}" | grep -aoE "([0-9]{1,}\.)+[0-9]{1,}")"
    rm aws_cli_version_string_temp.txt

    # compare installed AWS CLI version with minimum supported version
    if (echo minimum 2.9.4; echo installed $aws_cli_version) | sort -Vk2 | tail -1 | grep -q minimum; then
        echo
        echo "ERROR: "
        echo "You are using an older version of AWS CLI that doesn't support CodeBuild commands. Please update AWS CLI to the latest version to be able connect to the dev environment via SSH." >> /dev/stderr
        echo "Refer to the documentation for installation steps: https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html" >> /dev/stderr
        exit 1
    fi
}

install_jq_tool() {
  if ! command -v jq; then
    if command -v brew
        then
            echo "Found brew. Installing jq tool"
            _wait
            brew install jq
        elif command -v port
        then
            echo "Found port. Installing jq tool"
            _wait
            port install jq
        elif command -v fink
        then
            echo "Found dnf. Installing jq tool"
            _wait
            fink install jq
        else
            echo
            echo "ERROR: "
            echo "Please make sure you have the jq tool installed: https://jqlang.org/"
            exit 1
        fi
    fi
}

_main() {
    check_aws_cli_version

    install_jq_tool
    install_session_manager_plugin
    update_ssh_config
    place_proxy_command_script

    _print "Configured local environment for SSH access to CodeBuild Sandboxes"
}

_main