summaryrefslogtreecommitdiffstats
path: root/jjb/xci/xci-set-scenario.sh
blob: ccea16f870c01d39e0d9e2ae9a094fe19e6e31a8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
#!/bin/bash
# SPDX-license-identifier: Apache-2.0
##############################################################################
# Copyright (c) 2018 SUSE and others.
# All rights reserved. This program and the accompanying materials
# are made available under the terms of the Apache License, Version 2.0
# which accompanies this distribution, and is available at
# http://www.apache.org/licenses/LICENSE-2.0
##############################################################################
set -o pipefail
set -x

#----------------------------------------------------------------------
# This script is used by CI and executed by Jenkins jobs.
# You are not supposed to use this script manually if you don't know
# what you are doing.
#----------------------------------------------------------------------

# This function allows developers to specify the impacted scenario by adding
# the info about installer and scenario into the commit message or using
# the topic branch names. This results in either skipping the real verification
# totally or skipping the determining the installer and scenario programmatically.
# It is important to note that this feature is only available to generic scenarios
# and only single installer/scenario pair is allowed.
# The input in commit message should be placed at the end of the commit message body,
# before the signed-off and change-id lines.
#
# Pattern to be searched in Commit Message
#   deploy-scenario:<scenario-name>
#   installer-type:<installer-type>
# Examples:
#   deploy-scenario:os-odl-nofeature
#   installer-type:osa
#
#   deploy-scenario:k8-nosdn-nofeature
#   installer-type:kubespray
#
# Patterns to be searched in topic branch name
#   skip-verify
#   skip-deployment
#   force-verify
function override_scenario() {
    echo "Processing $GERRIT_PROJECT patchset $GERRIT_REFSPEC"

    # ensure the metadata we record is consistent for all types of patches including skipped ones
    # extract releng-xci sha
    XCI_SHA=$(cd $WORKSPACE && git rev-parse HEAD)

    # extract scenario sha which is same as releng-xci sha for generic scenarios
    SCENARIO_SHA=$XCI_SHA

    # process topic branch names
    if [[ "$GERRIT_TOPIC" =~ skip-verify|skip-deployment|force-verify ]]; then
        [[ "$GERRIT_TOPIC" =~ force-verify ]] && echo "Forcing CI verification using default scenario and installer!"
        [[ "$GERRIT_TOPIC" =~ skip-verify|skip-deployment ]] && echo "Skipping verification!"
        echo "INSTALLER_TYPE=osa" >> $WORK_DIRECTORY/scenario.properties
        echo "DEPLOY_SCENARIO=os-nosdn-nofeature" >> $WORK_DIRECTORY/scenario.properties
        echo "XCI_SHA=$XCI_SHA" >> $WORK_DIRECTORY/scenario.properties
        echo "SCENARIO_SHA=$SCENARIO_SHA" >> $WORK_DIRECTORY/scenario.properties
        echo "PROJECT_NAME=$GERRIT_PROJECT" >> $WORK_DIRECTORY/scenario.properties
        log_scenario_properties
        exit 0
    fi

    # process commit message
    if [[ "$GERRIT_CHANGE_COMMIT_MESSAGE" =~ "installer-type:" && "$GERRIT_CHANGE_COMMIT_MESSAGE" =~ "deploy-scenario:" ]]; then
        INSTALLER_TYPE=$(echo $GERRIT_CHANGE_COMMIT_MESSAGE | awk '/installer-type:/' RS=" " | cut -d":" -f2)
        DEPLOY_SCENARIO=$(echo $GERRIT_CHANGE_COMMIT_MESSAGE | awk '/deploy-scenario:/' RS=" " | cut -d":" -f2)

        if [[ -z "$INSTALLER_TYPE" || -z "$DEPLOY_SCENARIO" ]]; then
            echo "Installer type or deploy scenario is not specified. Falling back to programmatically determining them."
        else
            echo "Recording the installer '$INSTALLER_TYPE' and scenario '$DEPLOY_SCENARIO' for downstream jobs"
            echo "INSTALLER_TYPE=$INSTALLER_TYPE" >> $WORK_DIRECTORY/scenario.properties
            echo "DEPLOY_SCENARIO=$DEPLOY_SCENARIO" >> $WORK_DIRECTORY/scenario.properties
            echo "XCI_SHA=$XCI_SHA" >> $WORK_DIRECTORY/scenario.properties
            echo "SCENARIO_SHA=$SCENARIO_SHA" >> $WORK_DIRECTORY/scenario.properties
            echo "PROJECT_NAME=$GERRIT_PROJECT" >> $WORK_DIRECTORY/scenario.properties
            log_scenario_properties
            exit 0
        fi
    else
        echo "Installer type or deploy scenario is not specified. Falling back to programmatically determining them."
    fi
}

# This function determines the default scenario for changes coming to releng-xci
# by processing the Gerrit change and using diff to see what changed.
#
# The stuff in releng-xci is for the installer and other common things so the
# determination is based on those.
#
# Pattern
#   releng-xci/installer/<installer_type>/<impacted files>: <scenario>
function determine_default_scenario() {
    echo "Processing $GERRIT_PROJECT patchset $GERRIT_REFSPEC"

    # get the changeset
    cd $WORKSPACE
    # We need to set default scenario for changes that mess with installers
    INSTALLERS=$(git diff HEAD^..HEAD --name-only -- 'xci/installer' | cut -d "/" -f 3 | uniq)
    for CHANGED_INSTALLER in $INSTALLERS; do
        case $CHANGED_INSTALLER in
            kubespray)
                DEPLOY_SCENARIO[${#DEPLOY_SCENARIO[@]}]='k8-nosdn-nofeature'
                ;;
            # Default case (including OSA changes)
            *)
                DEPLOY_SCENARIO[${#DEPLOY_SCENARIO[@]}]='os-nosdn-nofeature'
                ;;
        esac
    done
    # For all other changes, we only need to set a default scenario if it's not set already
    if git diff HEAD^..HEAD --name-only | grep -q -v 'xci/installer'; then
         [[ ${#DEPLOY_SCENARIO[@]} -eq 0 ]] && DEPLOY_SCENARIO[${#DEPLOY_SCENARIO[@]}]='os-nosdn-nofeature'
    fi

    # extract releng-xci sha
    XCI_SHA=$(cd $WORKSPACE && git rev-parse HEAD)

    # TODO: we need to fix this so we actually extract the scenario sha by cloning releng-xci-scenarios
    # for the determined scenario. it is crucial for promotion...
    SCENARIO_SHA=$XCI_SHA
}

# This function determines the impacted scenario by processing the Gerrit
# change and using diff to see what changed. If changed files belong to a scenario
# its name gets recorded for deploying and testing the right scenario.
#
# Pattern
#   <project-repo>/scenarios/<scenario>/<impacted files>: <scenario>
function determine_scenario() {
    echo "Processing $GERRIT_PROJECT patchset $GERRIT_REFSPEC"

    # remove the clone that is done via jenkins and place releng-xci there so the
    # things continue functioning properly
    cd $HOME && /bin/rm -rf $WORKSPACE
    git clone -q https://gerrit.opnfv.org/gerrit/releng-xci $WORKSPACE && cd $WORKSPACE

    # fix the permissions so ssh doesn't complain due to having world-readable keyfiles
    chmod -R go-rwx $WORKSPACE/xci/scripts/vm

    # clone the project repo and fetch the patchset to process for further processing
    git clone -q https://gerrit.opnfv.org/gerrit/$GERRIT_PROJECT $WORK_DIRECTORY/$GERRIT_PROJECT
    cd $WORK_DIRECTORY/$GERRIT_PROJECT
    git fetch -q https://gerrit.opnfv.org/gerrit/$GERRIT_PROJECT $GERRIT_REFSPEC && git checkout -q FETCH_HEAD

    # process the diff to find out what scenario(s) are impacted - there should only be 1
    DEPLOY_SCENARIO+=$(git diff HEAD^..HEAD --name-only | grep scenarios | awk -F '[/|/]' '{print $2}' | uniq)

    # extract releng-xci sha
    XCI_SHA=$(cd $WORKSPACE && git rev-parse HEAD)

    # extract scenario sha
    SCENARIO_SHA=$(cd $WORK_DIRECTORY/$GERRIT_PROJECT && git rev-parse HEAD)
}

# This function allows developers to specify the specific XCI flavor for the
# impacted scenario by adding the XCI Flavor info about the specific scenario.
# This results in either skipping the real verification
# totally or skipping the determining the installer and scenario programmatically.
# It is important to note that this feature is only available to generic scenarios
# and only single installer/scenario pair is allowed.
# The input in commit message should be placed at the end of the commit message body,
# before the signed-off and change-id lines.
#
# Pattern to be searched in Commit Message
#   xci-flavor:<xci-flavor>
# Examples:
#   xci-flavor:noha
function override_xci_flavor() {
    echo "Processing $GERRIT_PROJECT patchset $GERRIT_REFSPEC"

    # process commit message for XCI Flavor
    if [[ "$GERRIT_CHANGE_COMMIT_MESSAGE" =~ "xci-flavor:" ]]; then
        XCI_FLAVOR=$(echo $GERRIT_CHANGE_COMMIT_MESSAGE | awk '/xci-flavor:/' RS=" " | cut -d":" -f2)

        if [[ -z "$XCI_FLAVOR" ]]; then
            XCI_FLAVOR='mini'
            echo "XCI flavor is not specified. The default is specified instead (i.e. mini). Falling back to programmatically determining them."
            echo "XCI_FLAVOR=mini" >> $WORK_DIRECTORY/scenario.properties
        else
            echo "Recording the XCI flavor '$XCI_FLAVOR' for downstream jobs"
            echo "XCI_FLAVOR=$XCI_FLAVOR" >> $WORK_DIRECTORY/scenario.properties
        fi
    else
        XCI_FLAVOR='mini'
        echo "XCI flavor is not specified. The default is specified instead (i.e. mini). Falling back to programmatically determining them."
        echo "XCI_FLAVOR=mini" >> $WORK_DIRECTORY/scenario.properties
    fi

}

function log_scenario_properties() {
    echo "Processing $GERRIT_PROJECT patchset $GERRIT_REFSPEC"
    echo "-------------------------------------------------------------------------"
    cat $WORK_DIRECTORY/scenario.properties
    echo "-------------------------------------------------------------------------"
}

echo "Determining the impacted scenario"

declare -a DEPLOY_SCENARIO

# ensure GERRIT_TOPIC is set
GERRIT_TOPIC="${GERRIT_TOPIC:-''}"

# this directory is where the temporary clones and files are created
# while extracting the impacted scenario
WORK_DIRECTORY=/tmp/$GERRIT_CHANGE_NUMBER/$DISTRO
/bin/rm -rf $WORK_DIRECTORY && mkdir -p $WORK_DIRECTORY

if [[ $GERRIT_PROJECT == "releng-xci" ]]; then
    determine_default_scenario
else
    determine_scenario
fi
override_xci_flavor
override_scenario

# ensure single scenario is impacted
    if [[ $(IFS=$'\n' echo ${DEPLOY_SCENARIO[@]} | wc -w) != 1 ]]; then
    echo "Change impacts multiple scenarios!"
    echo "XCI doesn't support testing of changes that impact multiple scenarios currently."
    echo "Please split your change into multiple different/dependent changes, each modifying single scenario."
    exit 1
fi

# set the installer
case ${DEPLOY_SCENARIO[0]} in
    os-*)
        INSTALLER_TYPE=osa
        ;;
    k8-*)
        INSTALLER_TYPE=kubespray
        ;;
    *)
        echo "Unable to determine the installer. Exiting!"
        exit 1
        ;;
esac

# save the installer and scenario names into java properties file
# so they can be injected to downstream jobs via envInject
echo "Recording the installer '$INSTALLER_TYPE' and scenario '${DEPLOY_SCENARIO[0]}' and SHAs for downstream jobs"
echo "INSTALLER_TYPE=$INSTALLER_TYPE" >> $WORK_DIRECTORY/scenario.properties
echo "DEPLOY_SCENARIO=$DEPLOY_SCENARIO" >> $WORK_DIRECTORY/scenario.properties
echo "XCI_SHA=$XCI_SHA" >> $WORK_DIRECTORY/scenario.properties
echo "SCENARIO_SHA=$SCENARIO_SHA" >> $WORK_DIRECTORY/scenario.properties
echo "PROJECT_NAME=$GERRIT_PROJECT" >> $WORK_DIRECTORY/scenario.properties

# log scenario.properties to console to ease the troubleshooting when needed
log_scenario_properties

# skip scenario support check if the job is promotion job
if [[ "$JOB_NAME" =~ (os|k8) ]]; then
    exit 0
fi

# skip the deployment if the scenario is not supported on this distro
OPNFV_SCENARIO_REQUIREMENTS=$WORKSPACE/xci/opnfv-scenario-requirements.yml
if ! sed -n "/^- scenario: ${DEPLOY_SCENARIO[0]}$/,/^$/p" $OPNFV_SCENARIO_REQUIREMENTS | grep -q $DISTRO; then
    echo "# SKIPPED: Scenario ${DEPLOY_SCENARIO[0]} is NOT supported on $DISTRO"
    exit 0
fi