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 errexit
  11 set -o pipefail
  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_generic_scenario() {
  43     echo "Processing $GERRIT_PROJECT patchset $GERRIT_REFSPEC"
  44
  45     # process topic branch names
  46     if [[ "$GERRIT_TOPIC" =~ skip-verify|skip-deployment ]]; then
  47         # skip the real verification
  48         echo "Skipping verify!"
  49         echo "INSTALLER_TYPE=osa" > $WORK_DIRECTORY/scenario.properties
  50         echo "DEPLOY_SCENARIO=os-nosdn-nofeature" >> $WORK_DIRECTORY/scenario.properties
  51         exit 0
  52     elif [[ "$GERRIT_TOPIC" =~ 'force-verify' ]]; then
  53         # Run the deployment with default installer and scenario when multiple things change
  54         # and we want to force that.
  55         echo "Recording the installer 'osa' and scenario 'os-nosdn-nofeature' for downstream jobs"
  56         echo "Forcing CI verification of default scenario and installer!"
  57         echo "INSTALLER_TYPE=osa" > $WORK_DIRECTORY/scenario.properties
  58         echo "DEPLOY_SCENARIO=os-nosdn-nofeature" >> $WORK_DIRECTORY/scenario.properties
  59         exit 0
  60     fi
  61
  62     # process commit message
  63     if [[ "$GERRIT_CHANGE_COMMIT_MESSAGE" =~ "installer-type:" && "$GERRIT_CHANGE_COMMIT_MESSAGE" =~ "deploy-scenario:" ]]; then
  64         INSTALLER_TYPE=$(echo $GERRIT_CHANGE_COMMIT_MESSAGE | awk '/installer-type:/' RS=" " | cut -d":" -f2)
  65         DEPLOY_SCENARIO=$(echo $GERRIT_CHANGE_COMMIT_MESSAGE | awk '/deploy-scenario:/' RS=" " | cut -d":" -f2)
  66
  67         if [[ -z "$INSTALLER_TYPE" || -z "$DEPLOY_SCENARIO" ]]; then
  68             echo "Installer type or deploy scenario is not specified. Falling back to programmatically determining them."
  69         else
  70             echo "Recording the installer '$INSTALLER_TYPE' and scenario '$DEPLOY_SCENARIO' for downstream jobs"
  71             echo "INSTALLER_TYPE=$INSTALLER_TYPE" > $WORK_DIRECTORY/scenario.properties
  72             echo "DEPLOY_SCENARIO=$DEPLOY_SCENARIO" >> $WORK_DIRECTORY/scenario.properties
  73             exit 0
  74         fi
  75     else
  76         echo "Installer type or deploy scenario is not specified. Falling back to programmatically determining them."
  77     fi
  78 }
  79
  80 # This function determines the impacted generic scenario by processing the
  81 # change and using diff to see what changed. If changed files belong to a scenario
  82 # its name gets recorded for deploying and testing the right scenario.
  83 #
  84 # Pattern to be searched in Changeset
  85 #   releng-xci/scenarios/<scenario>/<impacted files>: <scenario>
  86 #   releng-xci/xci/installer/osa/<impacted files>: os-nosdn-nofeature
  87 #   releng-xci/xci/installer/kubespray/<impacted files>: k8-nosdn-nofeature
  88 #   the rest: os-nosdn-nofeature
  89 function determine_generic_scenario() {
  90     echo "Processing $GERRIT_PROJECT patchset $GERRIT_REFSPEC"
  91
  92     # get the changeset
  93     cd $WORKSPACE
  94     CHANGESET=$(git diff HEAD^..HEAD --name-only)
  95     for CHANGED_FILE in $CHANGESET; do
  96         case $CHANGED_FILE in
  97             *k8-nosdn*|*kubespray*)
  98                 [[ ${DEPLOY_SCENARIO[@]} =~ "k8-nosdn-nofeature" ]] || DEPLOY_SCENARIO[${#DEPLOY_SCENARIO[@]}]='k8-nosdn-nofeature'
  99                 ;;
 100             *os-odl*)
 101                 [[ ${DEPLOY_SCENARIO[@]} =~ "os-odl-nofeature" ]] || DEPLOY_SCENARIO[${#DEPLOY_SCENARIO[@]}]='os-odl-nofeature'
 102                 ;;
 103             *os-nosdn*|*osa*)
 104                 [[ ${DEPLOY_SCENARIO[@]} =~ "os-nosdn-nofeature" ]] || DEPLOY_SCENARIO[${#DEPLOY_SCENARIO[@]}]='os-nosdn-nofeature'
 105                 ;;
 106             *)
 107                 [[ ${DEPLOY_SCENARIO[@]} =~ "os-nosdn-nofeature" ]] || DEPLOY_SCENARIO[${#DEPLOY_SCENARIO[@]}]='os-nosdn-nofeature'
 108                 ;;
 109             esac
 110     done
 111 }
 112
 113 # This function determines the impacted external scenario by processing the Gerrit
 114 # change and using diff to see what changed. If changed files belong to a scenario
 115 # its name gets recorded for deploying and testing the right scenario.
 116 #
 117 # Pattern
 118 #   <project-repo>/scenarios/<scenario>/<impacted files>: <scenario>
 119 function determine_external_scenario() {
 120     echo "Processing $GERRIT_PROJECT patchset $GERRIT_REFSPEC"
 121
 122     # remove the clone that is done via jenkins and place releng-xci there so the
 123     # things continue functioning properly
 124     cd $HOME && /bin/rm -rf $WORKSPACE
 125     git clone -q https://gerrit.opnfv.org/gerrit/releng-xci $WORKSPACE && cd $WORKSPACE
 126
 127     # fix the permissions so ssh doesn't complain due to having world-readable keyfiles
 128     chmod -R go-rwx $WORKSPACE/xci/scripts/vm
 129
 130     # clone the project repo and fetch the patchset to process for further processing
 131     git clone -q https://gerrit.opnfv.org/gerrit/$GERRIT_PROJECT $WORK_DIRECTORY/$GERRIT_PROJECT
 132     cd $WORK_DIRECTORY/$GERRIT_PROJECT
 133     git fetch -q https://gerrit.opnfv.org/gerrit/$GERRIT_PROJECT $GERRIT_REFSPEC && git checkout -q FETCH_HEAD
 134
 135     # process the diff to find out what scenario(s) are impacted - there should only be 1
 136     DEPLOY_SCENARIO+=$(git diff HEAD^..HEAD --name-only | grep scenarios | awk -F '[/|/]' '{print $2}' | uniq)
 137 }
 138
 139 echo "Determining the impacted scenario"
 140
 141 declare -a DEPLOY_SCENARIO
 142
 143 # ensure GERRIT_TOPIC is set
 144 GERRIT_TOPIC="${GERRIT_TOPIC:-''}"
 145
 146 # this directory is where the temporary clones and files are created
 147 # while extracting the impacted scenario
 148 WORK_DIRECTORY=/tmp/$GERRIT_CHANGE_NUMBER/$DISTRO
 149 /bin/rm -rf $WORK_DIRECTORY && mkdir -p $WORK_DIRECTORY
 150
 151 if [[ $GERRIT_PROJECT == "releng-xci" ]]; then
 152     override_generic_scenario
 153     determine_generic_scenario
 154 else
 155     determine_external_scenario
 156 fi
 157
 158 # ensure single scenario is impacted
 159     if [[ $(IFS=$'\n' echo ${DEPLOY_SCENARIO[@]} | wc -w) != 1 ]]; then
 160     echo "Change impacts multiple scenarios!"
 161     echo "XCI doesn't support testing of changes that impact multiple scenarios currently."
 162     echo "Please split your change into multiple different/dependent changes, each modifying single scenario."
 163     exit 1
 164 fi
 165
 166 # set the installer
 167 case ${DEPLOY_SCENARIO[0]} in
 168     os-*)
 169         INSTALLER_TYPE=osa
 170         ;;
 171     k8-*)
 172         INSTALLER_TYPE=kubespray
 173         ;;
 174     *)
 175         echo "Unable to determine the installer. Exiting!"
 176         exit 1
 177         ;;
 178 esac
 179
 180 # save the installer and scenario names into java properties file
 181 # so they can be injected to downstream jobs via envInject
 182 echo "Recording the installer '$INSTALLER_TYPE' and scenario '${DEPLOY_SCENARIO[0]}' for downstream jobs"
 183 echo "INSTALLER_TYPE=$INSTALLER_TYPE" > $WORK_DIRECTORY/scenario.properties
 184 echo "DEPLOY_SCENARIO=$DEPLOY_SCENARIO" >> $WORK_DIRECTORY/scenario.properties
 185
 186 # skip the deployment if the scenario is not supported on this distro
 187 OPNFV_SCENARIO_REQUIREMENTS=$WORKSPACE/xci/opnfv-scenario-requirements.yml
 188 if ! sed -n "/^- scenario: ${DEPLOY_SCENARIO[0]}$/,/^$/p" $OPNFV_SCENARIO_REQUIREMENTS | grep -q $DISTRO; then
 189     echo "# SKIPPED: Scenario ${DEPLOY_SCENARIO[0]} is NOT supported on $DISTRO"
 190     exit 0
 191 fi