csit/run-csit.sh

   1 #!/bin/bash -x
   2 #
   3 # Copyright 2016-2017 Huawei Technologies Co., Ltd.
   4 # Modification Copyright 2019-2021 © Samsung Electronics Co., Ltd.
   5 #
   6 # Licensed under the Apache License, Version 2.0 (the "License");
   7 # you may not use this file except in compliance with the License.
   8 # You may obtain a copy of the License at
   9 #
  10 #     http://www.apache.org/licenses/LICENSE-2.0
  11 #
  12 # Unless required by applicable law or agreed to in writing, software
  13 # distributed under the License is distributed on an "AS IS" BASIS,
  14 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15 # See the License for the specific language governing permissions and
  16 # limitations under the License.
  17 #
  18 # $1 project/functionality
  19 # $2 robot options
  20
  21 # Branched from ccsdk/distribution to this repository Feb 23, 2021
  22
  23 #
  24 # functions
  25 #
  26
  27 function on_exit(){
  28     rc=$?
  29     if [[ ${WORKSPACE} ]]; then
  30         if [[ ${WORKDIR} ]]; then
  31             rsync -av "$WORKDIR/" "$WORKSPACE/archives/$TESTPLAN"
  32         fi
  33         # Record list of active docker containers
  34         docker ps --format "{{.Image}}" > "$WORKSPACE/archives/$TESTPLAN/_docker-images.log"
  35
  36         # show memory consumption after all docker instances initialized
  37         docker_stats | tee "$WORKSPACE/archives/$TESTPLAN/_sysinfo-2-after-robot.txt"
  38     fi
  39     # Run teardown script plan if it exists
  40     cd "${TESTPLANDIR}"
  41     TEARDOWN="${TESTPLANDIR}/teardown.sh"
  42     if [ -f "${TEARDOWN}" ]; then
  43         echo "Running teardown script ${TEARDOWN}"
  44         source_safely "${TEARDOWN}"
  45     fi
  46     # TODO: do something with the output
  47      exit $rc
  48 }
  49 # ensure that teardown and other finalizing steps are always executed
  50 trap on_exit EXIT
  51
  52 function docker_stats(){
  53     #General memory details
  54     echo "> top -bn1 | head -3"
  55     top -bn1 | head -3
  56     echo
  57
  58     echo "> free -h"
  59     free -h
  60     echo
  61
  62     #Memory details per Docker
  63     echo "> docker ps"
  64     docker ps
  65     echo
  66
  67     echo "> docker stats --no-stream"
  68     docker stats --no-stream
  69     echo
  70 }
  71
  72 # save current set options
  73 function save_set() {
  74     RUN_CSIT_SAVE_SET="$-"
  75     RUN_CSIT_SHELLOPTS="$SHELLOPTS"
  76 }
  77
  78 # load the saved set options
  79 function load_set() {
  80     _setopts="$-"
  81
  82     # bash shellopts
  83     for i in $(echo "$SHELLOPTS" | tr ':' ' ') ; do
  84         set +o ${i}
  85     done
  86     for i in $(echo "$RUN_CSIT_SHELLOPTS" | tr ':' ' ') ; do
  87         set -o ${i}
  88     done
  89
  90     # other options
  91     for i in $(echo "$_setopts" | sed 's/./& /g') ; do
  92         set +${i}
  93     done
  94     set -${RUN_CSIT_SAVE_SET}
  95 }
  96
  97 # set options for quick bailout when error
  98 function harden_set() {
  99     set -xeo pipefail
 100     set +u # enabled it would probably fail too many often
 101 }
 102
 103 # relax set options so the sourced file will not fail
 104 # the responsibility is shifted to the sourced file...
 105 function relax_set() {
 106     set +e
 107     set +o pipefail
 108 }
 109
 110 # wrapper for sourcing a file
 111 function source_safely() {
 112     [ -z "$1" ] && return 1
 113     relax_set
 114     . "$1"
 115     load_set
 116 }
 117
 118 #
 119 # main
 120 #
 121
 122 # set and save options for quick failure
 123 harden_set && save_set
 124
 125 if [ $# -eq 0 ]
 126 then
 127     echo
 128     echo "Usage: $0 plans/<project>/<functionality> [<robot-options>]"
 129     echo
 130     echo "    <project>, <functionality>, <robot-options>:  "
 131     echo "        The same values as for the '{project}-csit-{functionality}' JJB job template."
 132     echo
 133     exit 1
 134 fi
 135
 136 if [ -z "$WORKSPACE" ]; then
 137     export WORKSPACE=$(git rev-parse --show-toplevel)
 138 fi
 139
 140 if [ -f "${WORKSPACE}/${1}/testplan.txt" ]; then
 141     export TESTPLAN="${1}"
 142 else
 143     echo "testplan not found: ${WORKSPACE}/${TESTPLAN}/testplan.txt"
 144     exit 2
 145 fi
 146
 147 export TESTOPTIONS="${2}"
 148
 149 rm -rf "$WORKSPACE/archives/$TESTPLAN"
 150 mkdir -p "$WORKSPACE/archives/$TESTPLAN"
 151
 152 TESTPLANDIR="${WORKSPACE}/${TESTPLAN}"
 153
 154 # Run installation of prerequired libraries
 155 source_safely "${WORKSPACE}/prepare-csit.sh"
 156
 157 # Activate the virtualenv containing all the required libraries installed by prepare-csit.sh
 158 source_safely "${ROBOT_VENV}/bin/activate"
 159
 160 WORKDIR=$(mktemp -d --suffix=-robot-workdir)
 161 cd "${WORKDIR}"
 162
 163 # Add csit scripts to PATH
 164 export PATH="${PATH}:${WORKSPACE}/docker/scripts:${WORKSPACE}/scripts:${ROBOT_VENV}/bin"
 165 export SCRIPTS="${WORKSPACE}/scripts"
 166 export ROBOT_VARIABLES=
 167
 168 # Sign in to nexus3 docker repo
 169 docker login -u docker -p docker nexus3.onap.org:10001
 170
 171 # Run setup script plan if it exists
 172 cd "${TESTPLANDIR}"
 173 SETUP="${TESTPLANDIR}/setup.sh"
 174 if [ -f "${SETUP}" ]; then
 175     echo "Running setup script ${SETUP}"
 176     source_safely "${SETUP}"
 177 fi
 178
 179 # show memory consumption after all docker instances initialized
 180 docker_stats | tee "$WORKSPACE/archives/$TESTPLAN/_sysinfo-1-after-setup.txt"
 181
 182 # Run test plan
 183 cd "$WORKDIR"
 184 echo "Reading the testplan:"
 185 cat "${TESTPLANDIR}/testplan.txt" | egrep -v '(^[[:space:]]*#|^[[:space:]]*$)' | sed "s|^|${WORKSPACE}/tests/|" > testplan.txt
 186 cat testplan.txt
 187 SUITES=$( xargs -a testplan.txt )
 188
 189 echo ROBOT_VARIABLES="${ROBOT_VARIABLES}"
 190 echo "Starting Robot test suites ${SUITES} ..."
 191 relax_set
 192 python3 -m robot.run -N ${TESTPLAN} -v WORKSPACE:/tmp ${ROBOT_VARIABLES} ${TESTOPTIONS} ${SUITES}
 193 RESULT=$?
 194 load_set
 195 echo "RESULT: $RESULT"
 196 # Note that the final steps are done in on_exit function after this exit!
 197 exit $RESULT