jjb/xci/xci-set-scenario.sh

   1 #!/bin/bash
   2 # SPDX-license-identifier: Apache-2.0
   3 ##############################################################################
   4 # Copyright (c) 2018 SUSE and others.
   5 # All rights reserved. This program and the accompanying materials
   6 # are made available under the terms of the Apache License, Version 2.0
   7 # which accompanies this distribution, and is available at
   8 # http://www.apache.org/licenses/LICENSE-2.0
   9 ##############################################################################
  10 set -o pipefail
  11 set -x
  12
  13 #----------------------------------------------------------------------
  14 # This script is used by CI and executed by Jenkins jobs.
  15 # You are not supposed to use this script manually if you don't know
  16 # what you are doing.
  17 #----------------------------------------------------------------------
  18
  19 # This function allows developers to specify the impacted scenario by adding
  20 # the info about installer and scenario into the commit message or using
  21 # the topic branch names. This results in either skipping the real verification
  22 # totally or skipping the determining the installer and scenario programmatically.
  23 # It is important to note that this feature is only available to generic scenarios
  24 # and only single installer/scenario pair is allowed.
  25 # The input in commit message should be placed at the end of the commit message body,
  26 # before the signed-off and change-id lines.
  27 #
  28 # Pattern to be searched in Commit Message
  29 #   deploy-scenario:<scenario-name>
  30 #   installer-type:<installer-type>
  31 # Examples:
  32 #   deploy-scenario:os-odl-nofeature
  33 #   installer-type:osa
  34 #
  35 #   deploy-scenario:k8-nosdn-nofeature
  36 #   installer-type:kubespray
  37 #
  38 # Patterns to be searched in topic branch name
  39 #   skip-verify
  40 #   skip-deployment
  41 #   force-verify
  42 function override_scenario() {
  43     echo "Processing $GERRIT_PROJECT patchset $GERRIT_REFSPEC"
  44
  45     # ensure the metadata we record is consistent for all types of patches including skipped ones
  46     # extract releng-xci sha
  47     XCI_SHA=$(cd $WORKSPACE && git rev-parse HEAD)
  48
  49     # extract scenario sha which is same as releng-xci sha for generic scenarios
  50     SCENARIO_SHA=$XCI_SHA
  51
  52     # process topic branch names
  53     if [[ "$GERRIT_TOPIC" =~ skip-verify|skip-deployment|force-verify ]]; then
  54         [[ "$GERRIT_TOPIC" =~ force-verify ]] && echo "Forcing CI verification using default scenario and installer!"
  55         [[ "$GERRIT_TOPIC" =~ skip-verify|skip-deployment ]] && echo "Skipping verification!"
  56         echo "INSTALLER_TYPE=osa" > $WORK_DIRECTORY/scenario.properties
  57         echo "DEPLOY_SCENARIO=os-nosdn-nofeature" >> $WORK_DIRECTORY/scenario.properties
  58         echo "XCI_SHA=$XCI_SHA" >> $WORK_DIRECTORY/scenario.properties
  59         echo "SCENARIO_SHA=$SCENARIO_SHA" >> $WORK_DIRECTORY/scenario.properties
  60         echo "PROJECT_NAME=$GERRIT_PROJECT" >> $WORK_DIRECTORY/scenario.properties
  61         exit 0
  62     fi
  63
  64     # process commit message
  65     if [[ "$GERRIT_CHANGE_COMMIT_MESSAGE" =~ "installer-type:" && "$GERRIT_CHANGE_COMMIT_MESSAGE" =~ "deploy-scenario:" ]]; then
  66         INSTALLER_TYPE=$(echo $GERRIT_CHANGE_COMMIT_MESSAGE | awk '/installer-type:/' RS=" " | cut -d":" -f2)
  67         DEPLOY_SCENARIO=$(echo $GERRIT_CHANGE_COMMIT_MESSAGE | awk '/deploy-scenario:/' RS=" " | cut -d":" -f2)
  68
  69         if [[ -z "$INSTALLER_TYPE" || -z "$DEPLOY_SCENARIO" ]]; then
  70             echo "Installer type or deploy scenario is not specified. Falling back to programmatically determining them."
  71         else
  72             echo "Recording the installer '$INSTALLER_TYPE' and scenario '$DEPLOY_SCENARIO' for downstream jobs"
  73             echo "INSTALLER_TYPE=$INSTALLER_TYPE" > $WORK_DIRECTORY/scenario.properties
  74             echo "DEPLOY_SCENARIO=$DEPLOY_SCENARIO" >> $WORK_DIRECTORY/scenario.properties
  75             echo "XCI_SHA=$XCI_SHA" >> $WORK_DIRECTORY/scenario.properties
  76             echo "SCENARIO_SHA=$SCENARIO_SHA" >> $WORK_DIRECTORY/scenario.properties
  77             echo "PROJECT_NAME=$GERRIT_PROJECT" >> $WORK_DIRECTORY/scenario.properties
  78             exit 0
  79         fi
  80     else
  81         echo "Installer type or deploy scenario is not specified. Falling back to programmatically determining them."
  82     fi
  83 }
  84
  85 # This function determines the default scenario for changes coming to releng-xci
  86 # by processing the Gerrit change and using diff to see what changed.
  87 #
  88 # The stuff in releng-xci is for the installer and other common things so the
  89 # determination is based on those.
  90 #
  91 # Pattern
  92 #   releng-xci/installer/<installer_type>/<impacted files>: <scenario>
  93 function determine_default_scenario() {
  94     echo "Processing $GERRIT_PROJECT patchset $GERRIT_REFSPEC"
  95
  96     # get the changeset
  97     cd $WORKSPACE
  98     # We need to set default scenario for changes that mess with installers
  99     INSTALLERS=$(git diff HEAD^..HEAD --name-only -- 'xci/installer' | cut -d "/" -f 3 | uniq)
 100     for CHANGED_INSTALLER in $INSTALLERS; do
 101         case $CHANGED_INSTALLER in
 102             kubespray)
 103                 DEPLOY_SCENARIO[${#DEPLOY_SCENARIO[@]}]='k8-nosdn-nofeature'
 104                 ;;
 105             # Default case (including OSA changes)
 106             *)
 107                 DEPLOY_SCENARIO[${#DEPLOY_SCENARIO[@]}]='os-nosdn-nofeature'
 108                 ;;
 109         esac
 110     done
 111     # For all other changes, we only need to set a default scenario if it's not set already
 112     if git diff HEAD^..HEAD --name-only | grep -q -v 'xci/installer'; then
 113          [[ ${#DEPLOY_SCENARIO[@]} -eq 0 ]] && DEPLOY_SCENARIO[${#DEPLOY_SCENARIO[@]}]='os-nosdn-nofeature'
 114     fi
 115
 116     # extract releng-xci sha
 117     XCI_SHA=$(cd $WORKSPACE && git rev-parse HEAD)
 118
 119     # TODO: we need to fix this so we actually extract the scenario sha by cloning releng-xci-scenarios
 120     # for the determined scenario. it is crucial for promotion...
 121     SCENARIO_SHA=$XCI_SHA
 122 }
 123
 124 # This function determines the impacted scenario by processing the Gerrit
 125 # change and using diff to see what changed. If changed files belong to a scenario
 126 # its name gets recorded for deploying and testing the right scenario.
 127 #
 128 # Pattern
 129 #   <project-repo>/scenarios/<scenario>/<impacted files>: <scenario>
 130 function determine_scenario() {
 131     echo "Processing $GERRIT_PROJECT patchset $GERRIT_REFSPEC"
 132
 133     # remove the clone that is done via jenkins and place releng-xci there so the
 134     # things continue functioning properly
 135     cd $HOME && /bin/rm -rf $WORKSPACE
 136     git clone -q https://gerrit.opnfv.org/gerrit/releng-xci $WORKSPACE && cd $WORKSPACE
 137
 138     # fix the permissions so ssh doesn't complain due to having world-readable keyfiles
 139     chmod -R go-rwx $WORKSPACE/xci/scripts/vm
 140
 141     # clone the project repo and fetch the patchset to process for further processing
 142     git clone -q https://gerrit.opnfv.org/gerrit/$GERRIT_PROJECT $WORK_DIRECTORY/$GERRIT_PROJECT
 143     cd $WORK_DIRECTORY/$GERRIT_PROJECT
 144     git fetch -q https://gerrit.opnfv.org/gerrit/$GERRIT_PROJECT $GERRIT_REFSPEC && git checkout -q FETCH_HEAD
 145
 146     # process the diff to find out what scenario(s) are impacted - there should only be 1
 147     DEPLOY_SCENARIO+=$(git diff HEAD^..HEAD --name-only | grep scenarios | awk -F '[/|/]' '{print $2}' | uniq)
 148
 149     # extract releng-xci sha
 150     XCI_SHA=$(cd $WORKSPACE && git rev-parse HEAD)
 151
 152     # extract scenario sha
 153     SCENARIO_SHA=$(cd $WORK_DIRECTORY/$GERRIT_PROJECT && git rev-parse HEAD)
 154 }
 155
 156 # This function allows developers to specify the specific XCI flavor for the
 157 # impacted scenario by adding the XCI Flavor info about the specific scenario.
 158 # This results in either skipping the real verification
 159 # totally or skipping the determining the installer and scenario programmatically.
 160 # It is important to note that this feature is only available to generic scenarios
 161 # and only single installer/scenario pair is allowed.
 162 # The input in commit message should be placed at the end of the commit message body,
 163 # before the signed-off and change-id lines.
 164 #
 165 # Pattern to be searched in Commit Message
 166 #   xci-flavor:<xci-flavor>
 167 # Examples:
 168 #   xci-flavor:noha
 169 function override_xci_flavor() {
 170     echo "Processing $GERRIT_PROJECT patchset $GERRIT_REFSPEC"
 171
 172     # process commit message for XCI Flavor
 173     if [[ "$GERRIT_CHANGE_COMMIT_MESSAGE" =~ "xci-flavor:" ]]; then
 174         XCI_FLAVOR=$(echo $GERRIT_CHANGE_COMMIT_MESSAGE | awk '/xci-flavor:/' RS=" " | cut -d":" -f2)
 175
 176         if [[ -z "$XCI_FLAVOR" ]]; then
 177             XCI_FLAVOR='mini'
 178             echo "XCI flavor is not specified. The default is specified instead (i.e. mini). Falling back to programmatically determining them."
 179             echo "XCI_FLAVOR=mini" >> $WORK_DIRECTORY/scenario.properties
 180             exit 0
 181         else
 182             echo "Recording the XCI flavor '$XCI_FLAVOR' for downstream jobs"
 183             echo "XCI_FLAVOR=$XCI_FLAVOR" >> $WORK_DIRECTORY/scenario.properties
 184             exit 0
 185         fi
 186     else
 187         XCI_FLAVOR='mini'
 188         echo "XCI flavor is not specified. The default is specified instead (i.e. mini). Falling back to programmatically determining them."
 189         echo "XCI_FLAVOR=mini" >> $WORK_DIRECTORY/scenario.properties
 190         exit 0
 191     fi
 192
 193 }
 194
 195 echo "Determining the impacted scenario"
 196
 197 declare -a DEPLOY_SCENARIO
 198
 199 # ensure GERRIT_TOPIC is set
 200 GERRIT_TOPIC="${GERRIT_TOPIC:-''}"
 201
 202 # this directory is where the temporary clones and files are created
 203 # while extracting the impacted scenario
 204 WORK_DIRECTORY=/tmp/$GERRIT_CHANGE_NUMBER/$DISTRO
 205 /bin/rm -rf $WORK_DIRECTORY && mkdir -p $WORK_DIRECTORY
 206
 207 if [[ $GERRIT_PROJECT == "releng-xci" ]]; then
 208     determine_default_scenario
 209 else
 210     determine_scenario
 211     override_xci_flavor
 212 fi
 213 override_scenario
 214
 215 # ensure single scenario is impacted
 216     if [[ $(IFS=$'\n' echo ${DEPLOY_SCENARIO[@]} | wc -w) != 1 ]]; then
 217     echo "Change impacts multiple scenarios!"
 218     echo "XCI doesn't support testing of changes that impact multiple scenarios currently."
 219     echo "Please split your change into multiple different/dependent changes, each modifying single scenario."
 220     exit 1
 221 fi
 222
 223 # set the installer
 224 case ${DEPLOY_SCENARIO[0]} in
 225     os-*)
 226         INSTALLER_TYPE=osa
 227         ;;
 228     k8-*)
 229         INSTALLER_TYPE=kubespray
 230         ;;
 231     *)
 232         echo "Unable to determine the installer. Exiting!"
 233         exit 1
 234         ;;
 235 esac
 236
 237 # save the installer and scenario names into java properties file
 238 # so they can be injected to downstream jobs via envInject
 239 echo "Recording the installer '$INSTALLER_TYPE' and scenario '${DEPLOY_SCENARIO[0]}' and SHAs for downstream jobs"
 240 echo "INSTALLER_TYPE=$INSTALLER_TYPE" > $WORK_DIRECTORY/scenario.properties
 241 echo "DEPLOY_SCENARIO=$DEPLOY_SCENARIO" >> $WORK_DIRECTORY/scenario.properties
 242 echo "XCI_SHA=$XCI_SHA" >> $WORK_DIRECTORY/scenario.properties
 243 echo "SCENARIO_SHA=$SCENARIO_SHA" >> $WORK_DIRECTORY/scenario.properties
 244 echo "PROJECT_NAME=$GERRIT_PROJECT" >> $WORK_DIRECTORY/scenario.properties
 245
 246 # skip scenario support check if the job is promotion job
 247 if [[ "$JOB_NAME" =~ (os|k8) ]]; then
 248     exit 0
 249 fi
 250
 251 # skip the deployment if the scenario is not supported on this distro
 252 OPNFV_SCENARIO_REQUIREMENTS=$WORKSPACE/xci/opnfv-scenario-requirements.yml
 253 if ! sed -n "/^- scenario: ${DEPLOY_SCENARIO[0]}$/,/^$/p" $OPNFV_SCENARIO_REQUIREMENTS | grep -q $DISTRO; then
 254     echo "# SKIPPED: Scenario ${DEPLOY_SCENARIO[0]} is NOT supported on $DISTRO"
 255     exit 0
 256 fi