shipyard/tools/execute_shipyard_action.sh

#!/bin/bash
# Copyright 2018 AT&T Intellectual Property.  All other rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

# This is a common script that is used by the deploy_site, update_site,
# update_software and redeploy_server scripts

set -ex

check_timeout_counter() {

    # Check total elapsed time
    # The default time out is set to 1.5 hr
    if [[ $counter -ge $max_shipyard_count ]]; then
        echo 'Worflow Execution Timed Out!'
        break
    fi
}

run_action () {

    # Define Variables
    action=$1
    action_args="${@:2}"

    # Define Color
    NC='\033[0m'
    RED='\033[0;31m'
    GREEN='\033[0;32m'

    # Get the path of the directory where the script is located
    # Source Base Docker Command
    DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
    cd ${DIR} && source shipyard_docker_base_command.sh

    # Execute action
    echo -e "Execute ${action} Dag...\n"

    ${base_docker_command} ${SHIPYARD_IMAGE} create action ${action} ${action_args}

    # The status or lifecycle phase of an action can be
    #
    # 1) Pending - The action is scheduled or preparing for execution.
    # 2) Processing - The action is underway.
    # 3) Complete - The action has completed successfully.
    # 4) Failed - The action has encountered an error, and has failed.
    # 5) Paused - The action has been paused by a user.
    # 6) Unknown (*) - Unknown State for corner cases
    # 7) null - We will end up with a `null` response from Shipyard if we
    #           query the status of the task with an expired keystone token.
    #           Note that this should never happen if we use Shipyard CLI as
    #           new token is retrieved each time. Description for state 'null'
    #           is included here for information only.
    #
    # Print current list of actions in Shipyard
    ${base_docker_command} ${SHIPYARD_IMAGE} get actions

    # Retrieve the ID of the action that is currently being executed
    # We will attempt to fetch the action ID for 3 times
    echo -e "Retrieving Action ID...\n"
    action_id=`${base_docker_command} ${SHIPYARD_IMAGE} get actions | grep ${action} | grep -i Processing | awk '{print $2}'`

    # Initialize variables
    retrieve_shipyard_action_counter=0
    retrieve_shipyard_action_limit=2

    while [[ $retrieve_shipyard_action_counter -le ${retrieve_shipyard_action_limit} ]];
    do
        if [[ ${action_id} ]]; then
            echo -e "The Action ID is" ${action_id}
            break

        elif [[ $retrieve_shipyard_action_counter == ${retrieve_shipyard_action_limit} ]]; then
            echo -e "Failed to Retrieve Action ID!"
            exit 1

        else
            echo -e "Unable to Retrieve Action ID!"
            echo -e "Retrying in 30 seconds..."
            sleep 30

            action_id=`${base_docker_command} ${SHIPYARD_IMAGE} get actions | grep ${action} | grep -i Processing | awk '{print $2}'`

            ((retrieve_shipyard_action_counter ++))
        fi
    done

    # Initialize 'action_lifecycle' to 'Pending'
    action_lifecycle="Pending"

    # Initialize counter to 1
    counter=1

    while true;
    do
        # Get Current State of Action Lifecycle
        describe_action=$(${base_docker_command} ${SHIPYARD_IMAGE} describe "${action_id}")
        action_lifecycle=$(echo "${describe_action}" | grep -i "Lifecycle" | awk '{print $2}')
        action_steps=$(echo "${describe_action}" | grep -i "step/" | awk '{print $3}')

        if [[ $action_lifecycle == "Complete" ]]; then
            echo -e '\nSuccessfully performed' ${action}
            echo -e '\n'
            break
        fi

        # Check Dag state
        if [[ $action_lifecycle == "Failed" ]] || [[ $action_lifecycle == "Paused" ]] || \
           [[ $action_lifecycle == "Unknown"* ]] || [[ $action_lifecycle == "null" ]]; then
            echo -e "Dag Execution is in" ${RED}$action_lifecycle${NC} "state\n"
            break
        else
            echo -e "Dag Execution is in" ${GREEN}$action_lifecycle${NC} "state\n"

            # Back off between each iteration
            echo -e "Back Off for $shipyard_query_time seconds...\n"
            sleep $shipyard_query_time

            # Step counter and check the timeout counter
            ((counter++))
            check_timeout_counter
        fi
    done

    # Return exit code so that we can use it to determine the final
    # state of the workflow
    if [[ $action_lifecycle == "Complete" ]]; then
        # Return the error if any of the steps failed to execute.
        for step in ${action_steps}; do
            if [ "${step}" == "failed" ]; then
                exit 1
            fi
        done

        # None of the steps failed to execute, success.
        exit 0
    fi

    exit 1
}

# Calls 'run_action' function
run_action "${@}"