Refactor the boskos flow in periodic-kubernetes-containerd-conformance-test-ppc64le job

Author: Amulyam24

config/jobs/periodic/kubernetes/test-kubernetes-periodics.yaml

@@ -94,6 +94,8 @@ periodics:
           env:
             - name: "BOSKOS_HOST"
               value: "boskos.test-pods.svc.cluster.local"
+            - name: "USER"
+              value: "periodic-k8s-containerd-conformance-job"
           resources:
             requests:
               memory: "5Gi"
@@ -112,20 +114,13 @@ periodics:
 
               export PATH=$GOPATH/bin:$PATH
               export GO111MODULE=on
-
+              source "./hack/boskos.sh"
 
               make install-deployer-tf
               TF_LATEST="v1.9.8"
-
               RESOURCE_TYPE="powervs-k8s-conformance"
-              USER="periodic-k8s-containerd-conformance-job"
-
-              trap cleanup EXIT
 
-              cleanup(){
-                # stop the boskos heartbeat
-                [[ -z ${HEART_BEAT_PID:-} ]] || kill -9 "${HEART_BEAT_PID}" || true
-              }
+              trap 'cleanup ${HEART_BEAT_PID:-}' EXIT
 
               curl -fsSL https://releases.hashicorp.com/terraform/${TF_LATEST:1}/terraform_${TF_LATEST:1}_linux_amd64.zip -o ./terraform.zip
               unzip -o ./terraform.zip  >/dev/null 2>&1
@@ -148,46 +143,32 @@ periodics:
               TIMESTAMP=$(date +%s)
               jq --arg key0 'k8s-build-version' --arg value0 $K8S_BUILD_VERSION '. | .[$key0]=$value0' <<<'{}' > $ARTIFACTS/metadata.json
 
-
               set +o errexit
+              # If BOSKOS_HOST is set then acquire a resource from Boskos.
+              if [ -n "${BOSKOS_HOST:-}" ]; then
+                  # Check out the resource from Boskos and store the produced environment
+                  # variables in a temporary file.
+                   account_env_var_file="$(mktemp)"
+                   checkout_account ${RESOURCE_TYPE} 1> "${account_env_var_file}"
+                   checkout_account_status="${?}"
 
-              heartbeat_account(){
-                count=0
-                url="http://${BOSKOS_HOST}/update?name=${BOSKOS_RESOURCE_NAME}&state=busy&owner=${USER}"
-                while [ ${count} -lt 120 ]
-                do
-                  status_code=$(curl -s -o /dev/null -w '%{http_code}' -X POST ${url})
-                  if [[ ${status_code} != 200 ]]; then
-                    echo "Heart beat to resource '${BOSKOS_RESOURCE_NAME}' failed due to invalid response, status code: ${status_code}"
-                    exit 1
-                  fi
-                  count=$(( $count + 1 ))
-                  sleep 60
-                done
-              }
+                  # If the checkout process was a success then load the
+                  # environment variables into this process.
+                  [ "${checkout_account_status}" = "0" ] && . "${account_env_var_file}"
 
-              if [ -n "${BOSKOS_HOST:-}" ]; then
-                set +o xtrace
-                url="http://${BOSKOS_HOST}/acquire?type=${RESOURCE_TYPE}&state=free&dest=busy&owner=${USER}"
-                output=$(curl -X POST ${url})
-                [ $? = 0 ] && status_code=200
+                  # Always remove the account environment variable file which
+                  # could contain sensitive information.
+                  rm -f "${account_env_var_file}"
 
-                if [[ ${status_code} == 200 && ${output} =~ "failed" ]]; then
-                  echo "Failed to acquire resource from Boskos of type ${RESOURCE_TYPE}"
-                  exit 1
-                elif [[ ${status_code} == 200 ]]; then
-                  export BOSKOS_RESOURCE_NAME=$(echo ${output} | jq -r '.name')
-                  export BOSKOS_REGION=$(echo ${output} | jq -r '.userdata["region"]')
-                  export BOSKOS_RESOURCE_ID=$(echo ${output} | jq -r '.userdata["service-instance-id"]')
-                  export BOSKOS_ZONE=$(echo ${output} | jq -r '.userdata["zone"]')
-                  rm -rf output.json
-                else
-                  echo "Failed to acquire resource due to invalid response, status code : ${status_code}"
-                  exit 1
-                fi
+                  if [ ! "${checkout_account_status}" = "0" ]; then
+                      echo "error getting account from boskos" 1>&2
+                      exit "${checkout_account_status}"
+                  fi
 
-                heartbeat_account >> "$ARTIFACTS/boskos.log" 2>&1 &
-                HEART_BEAT_PID=$(echo $!)
+                  # Run the heart beat process to tell Boskos that we are still
+                  # using the checked out resource periodically.
+                  heartbeat_account >> "$ARTIFACTS/boskos.log" 2>&1 &
+                  HEART_BEAT_PID=$(echo $!)
               fi
 
               set -o xtrace
@@ -226,14 +207,7 @@ periodics:
                   exit $rc2
               fi
 
-              if [ -n "${BOSKOS_HOST:-}" ]; then
-                url="http://${BOSKOS_HOST}/release?name=${BOSKOS_RESOURCE_NAME}&dest=dirty&owner=${USER}"
-                status_code=$(curl -w '%{http_code}' -X POST ${url})
-                if [[ ${status_code} != 200 ]]; then
-                  echo "Failed to release resource: ${BOSKOS_RESOURCE_NAME}"
-                  exit 1
-                fi
-              fi
+              [ -z "${BOSKOS_HOST:-}" ] || release_account >> "$ARTIFACTS/boskos.log" 2>&1
 
   - name: periodic-kubernetes-containerd-e2e-node-tests-ppc64le
     labels: