oai-ci-vm-tool 18.8 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
#!/bin/bash
#/*
# * Licensed to the OpenAirInterface (OAI) Software Alliance under one or more
# * contributor license agreements.  See the NOTICE file distributed with
# * this work for additional information regarding copyright ownership.
# * The OpenAirInterface Software Alliance licenses this file to You under
# * the OAI Public License, Version 1.1  (the "License"); you may not use this file
# * except in compliance with the License.
# * You may obtain a copy of the License at
# *
# *      http://www.openairinterface.org/?page_id=698
# *
# * Unless required by applicable law or agreed to in writing, software
# * distributed under the License is distributed on an "AS IS" BASIS,
# * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# * See the License for the specific language governing permissions and
# * limitations under the License.
# *-------------------------------------------------------------------------------
# * For more information about the OpenAirInterface (OAI) Software Alliance:
# *      contact@openairinterface.org
# */

23

24 25 26 27 28
function top_usage {
    echo "OAI CI VM script"
    echo "   Original Author: Raphael Defosseux"
    echo "   Requirements:"
    echo "     -- uvtool uvtool-libvirt apt-cacher"
29
    echo "     -- $VM_OSREL image already synced"
30 31 32
    echo ""
    echo "Usage:"
    echo "------"
33
    echo "    oai-ci-vm-tool (-h|--help) { `for i in "${COMMANDS_NAME[@]}"; do echo -n $i,;done` ..." }
34 35 36 37
    echo ""
}

function variant_usage {
38 39 40 41 42 43 44 45 46 47 48 49 50 51

    for (( i=0 ; i<${#VARIANTS_LONG[@]} ; i++ )) 
    do        
    	unset BUILD_OPTIONS
    	unset VARIANT_INFO
    	check_set_variant "${VARIANTS_SHORT[$i]}"
        printf  "    --variant %-15s OR -%-3s" "${VARIANTS_LONG[$i]}" "${VARIANTS_SHORT[$i]}"
        if [ "$BUILD_OPTIONS" = "" ]
        then
        	echo -n "    ( test "
        else
        	echo -n "    ( build and test "
        fi
        echo "$VARIANT_INFO )"
52 53 54 55 56 57 58
        if [ "$1" = "full" ]
        then        
            printf  "               VM_NAME=%-15s          ARCHIVES_LOC=%-15s\n" "$VM_NAME" "$ARCHIVES_LOC"
            printf  "               VM_MEMORY=%-15s        VM_CPU=%-15s\n" "$VM_MEMORY" "$VM_CPU"       
            printf  "               NB_PATTERN_FILES=%-15s BUILD_OPTIONS=%-15s\n" "$NB_PATTERN_FILES" "\"$BUILD_OPTIONS\""
            printf  "               LOG_PATTERN=%-15s      EXPERIMENTAL=%-15s\n\n\n" "$LOG_PATTERN"  "$EXPERIMENTAL"
        fi
59 60 61 62
    done    
}

function setvar_usage {
63 64 65
	declare -A HELP_VAR
	HELP_VAR["VM_OSREL"]="OS release to use in virtual machines"
	HELP_VAR["RUN_EXPERIMENTAL"]="Enforce execution of variants with EXPERIMENTAL variable set to \"true\"" 
66
    echo "--setvar_<varname> <value> where varname is one of:"
67
	for i in ${AUTHORIZED_VAR[@]}; do printf "%20s :     %s\n" "$i" "${HELP_VAR[$i]}" ;done
68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85
}

# functions variant__v<n>__<variant name> are used to define build or test variants
# The only thing to do to define a new variant is to add a function which name
# match this template. Note that "_" character in function <varriant name> part
# will be replaced by "-" character in  build_variant_arrays function, this is
# for compatibility reasons  

function variant__v1__enb_usrp {
    NB_PATTERN_FILES=9
    BUILD_OPTIONS="--eNB -w USRP --mu"
}
    
function variant__v2__basic_sim {
    NB_PATTERN_FILES=13
    BUILD_OPTIONS="--eNB --UE"
    VM_MEMORY=8192
    RUN_OPTIONS="complex"
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
function variant__v3__phy_sim {
    NB_PATTERN_FILES=3
    BUILD_OPTIONS="--phy_simulators"
    RUN_OPTIONS="./run_exec_autotests.bash -g \"01510*\" -q -np -b"
}

function variant__v4__cppcheck {
    VM_MEMORY=4096
    LOG_PATTERN=cppcheck.xml
    NB_PATTERN_FILES=1
    BUILD_OPTIONS="--enable=warning --force --xml --xml-version=2 --suppressions-list=ci-scripts/cppcheck_suppressions.list -I common/utils -j4"
}

function variant__v7__enb_ethernet {
    VM_MEMORY=4096
    ARCHIVES_LOC=enb_eth
    NB_PATTERN_FILES=8
    BUILD_OPTIONS="--eNB"
}
function variant__v8__ue_ethernet {
    VM_MEMORY=4096
    ARCHIVES_LOC=ue_eth
    NB_PATTERN_FILES=12
    BUILD_OPTIONS="--UE"
}

function variant__v10__flexran_rtc {
    ARCHIVES_LOC=flexran
    NB_PATTERN_FILES=1
    BUILD_OPTIONS="cmake . && make -j2"
    VARIANT_INFO="non-OSA"
}
function variant__v20__l1_sim {
    ARCHIVES_LOC=l1_sim
    RUN_OPTIONS="complex"
123
    EXPERIMENTAL="true"
124 125 126 127
}
    
function variant__v21__rf_sim {
    RUN_OPTIONS="complex"
128
    EXPERIMENTAL="true"
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
}

function variant__v22__l2_sim {
    RUN_OPTIONS="complex"
}

# Following function lists all variant__v<n>__<variant name> functions
# and set the VARIANTS_SHORT and VARIANTS_LONG arrays from
# the function names
function build_variant_arrays {
    VARIANTS=`declare -F`
    VARIANTS=${VARIANTS//"declare -f "}
    for i in $VARIANTS
    do
    	if [ `expr match "$i" 'variant__v'` -eq 10 ]
    	then
    	   IDX1=`expr match "$i" 'variant__v[0-9]\+__'`
    	   VARIANTS_SHORT+=(${i:9:$((IDX1-11))})
    	   LONGNAME=${i:$IDX1}
           VARIANTS_LONG+=(${LONGNAME//"_"/"-"})
    	fi
    done
}

# check that the passed argument is a valid variant, set
# default values for variant related variables and then execute
# the corresponding variant__v<n>__<variant name> function
function check_set_variant {
    for (( i=0 ; i<${#VARIANTS_SHORT[@]} ; i++ )) 
    do  
    	if [ "$1" = "${VARIANTS_SHORT[$i]}" ] || [ "$1" = "${VARIANTS_LONG[$i]}" ]
    	then
            VM_NAME=ci-${VARIANTS_LONG[$i]}
            LOG_PATTERN=.$ASN1VER.txt
            ARCHIVES_LOC=${VARIANTS_LONG[$i]//"-"/"_"}  
            VM_MEMORY=2048
            VM_CPU=4
166
            EXPERIMENTAL=""
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
            NBARGS=$[$NBARGS+$VARIANT_OPTID]   
            variant__${VARIANTS_SHORT[$i]}__${VARIANTS_LONG[$i]//"-"/"_"}
            return 0
        fi
    done   
    echo "$1" is not a valid variant
    variant_usage
    exit 1
    
}

function check_command_options {
	GIVEN_OPTIONS=$1
	declare -a MANDATORY_OPTIONS=("${!2}")
	if [ ${MANDATORY_OPTIONS[1]} -eq 0 ]
	then
		MANDATORY_OPTIONS[1]=${MANDATORY_OPTIONS[0]}
	fi
	OPTIONAL_OPTIONS=$3
	if [ $(($GIVEN_OPTIONS & ${MANDATORY_OPTIONS[0]} )) -ne ${MANDATORY_OPTIONS[0]} ] && [ $(($GIVEN_OPTIONS & ${MANDATORY_OPTIONS[1]} )) -ne ${MANDATORY_OPTIONS[1]} ]
    then
        echo "Syntax Error: missing option(s) for $4 command"
        $4_usage
        exit 1
    fi	
    
    if [ $(($GIVEN_OPTIONS | ${MANDATORY_OPTIONS[0]} | ${MANDATORY_OPTIONS[1]} | $OPTIONAL_OPTIONS )) -ne  $(( ${MANDATORY_OPTIONS[0]} | ${MANDATORY_OPTIONS[1]} | $OPTIONAL_OPTIONS )) ] 
    then
        echo "Syntax Error: unknown option(s) for $4 command"
        $4_usage
        exit 1
    fi	 
}

function check_ipv4addr {
    local  ipaddr=$1
    local  stat=1

    if [[ $ipaddr =~ ^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3} ]]
    then
        OIFS=$IFS
        IFS='.'
        ipaddr=($ipaddr)
        IFS=$OIFS
        [[ ${ipaddr[0]} -le 255 && ${ipaddr[1]} -le 255 \
            && ${ipaddr[2]} -le 255 && ${ipaddr[3]} -le 255 ]]
        stat=$?
    fi
    if [ $stat -ne 0 ]
    then
    	echo $ipaddr " is not a valid ip V4 address"
    	exit 1
    fi
}

function check_setvar {
223
    for i in ${AUTHORIZED_VAR[@]}
224 225 226
    do
    	if [ "$1" = "$i" ]
    	then
227 228
    	   echo "Setting $1 to $2..."
    	   export "$1"="$2"
229 230 231 232 233 234 235 236
    	   return 0
    	fi
    done
    echo " $1 is not a variable you can set"
    setvar_usage
    exit 1
}	

237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254
MY_DIR=$(dirname $(readlink -f $0))
. $MY_DIR/createVM.sh
. $MY_DIR/buildOnVM.sh
. $MY_DIR/waitBuildOnVM.sh
. $MY_DIR/destroyAllRunningVM.sh
. $MY_DIR/runTestOnVM.sh
. $MY_DIR/reportBuildLocally.sh
. $MY_DIR/reportTestLocally.sh

if [ $# -lt 1 ]
then
    echo "Syntax Error: too few arguments"
    echo ""
    top_usage
    exit 1
fi

VM_TEMPLATE=ci-
255 256


257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290
# look for default ASN1 release in cmake directives
# It will be the release used when building
ASN1VEROPT=( `grep "add_list2_option(RRC_ASN1_VERSION" cmake_targets/CMakeLists.txt` )
ASN1VER=${ASN1VEROPT[1]//\"}
unset ASN1VEROPT

# variable to identify and store the command (build, create ...)
# command index in the COMMAND and COMMANDS_NAME arrays 
HELP_CMD=0
CREATE_CMD=1
BUILD_CMD=2
WAIT_CMD=3
DESTROY_CMD=4
TEST_CMD=5
REPORT_BUILD_CMD=6
REPORT_TEST_CMD=7

COMMANDS_NAME=(help create build wait destroy test report-build report-test)

#COMMAND will be used to save the command entered as argument
declare -A COMMAND
for i in "${COMMANDS_NAME[@]}"
do 
	COMMAND[$i]=0
done

# build the variant arrays
declare -a VARIANTS_SHORT
declare -a VARIANTS_LONG
build_variant_arrays

#variables to process options, for each option we define a variable to store
# its value and a bit mask, used to check allowed options depending on 
# the command
291
JOB_NAME=XX
292
JOB_NAME_OPTID=1
293
BUILD_ID=XX
294 295
BUILD_ID_OPTID=2
JENKINS_WKSP_OPTID=4
296
KEEP_VM_ALIVE=0
297
KEEP_VM_ALIVE_OPTID=8
298 299
RUN_OPTIONS="none"
DAEMON=0
300 301 302 303 304 305 306 307 308 309 310
DAEMON_OPTID=$((2**4))
GITURL_OPTID=$((2**5))
PU_OPTID=$((2**6))
MR_OPTID=$((2**7))
VARIANT_OPTID=$((2**8))
SB_OPTID=$((2**10))
SC_OPTID=$((2**11))
TB_OPTID=$((2**12))
TC_OPTID=$((2**13))
BR_OPTID=$((2**14))
CO_OPTID=$((2**15))
311 312
MR_TRIG=0
PU_TRIG=0
313 314
EPC_IPADDR=""
EPC_IPADDR_OPTID=$((2**16))
315

316
# list of variables that can be set via the --setvar option
317 318
AUTHORIZED_VAR=("VM_OSREL RUN_EXPERIMENTAL")

319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352

#variables to set which OS VM should use
#if [ -f "/etc/os-release" ]
#then
#    source /etc/os-release
#    VM_OS="$NAME"
#    VM_OSREL="$VERSION_CODENAME"
#    VM_ARCHI=`uname -m`	
#else
    VM_OS="ubuntu"
    VM_OSREL="xenial"
    VM_ARCHI="x86_64"		
#fi


# variant option, ie the test variant which will be run triggers the
# variables listed below, used to configure the VM and to define what this
# VM will do. The variant can be specified by the --variant option or by a 
# -V<xx> option.
VM_NAME=""
VM_MEMORY=0
VM_CPU=0
ARCHIVES_LOC=""
LOG_PATTERN=""
NB_PATTERN_FILES=0
BUILD_OPTIONS=""
RUN_OPTIONS=""



# NARGS is used to check that only valid options are used for the given command
# It is a bit mask, each bit set to 1 specifies the corresponding option 
# has been entered on the command line. MANDATORY_OPTMASK and ALLOWED_OPTMASK define
# respectively the mandatory and optional parameters of the entered command
353
NBARGS=0
354 355
MANDATORY_OPTMASK=(0 0)   # some command have two sets of mandatory options
ALLOWED_OPTMASK=0
356 357 358 359

while [[ $# -gt 0 ]]
do
key="$1"
360 361 362
if [ "$(type -t $funcname)" != 'function' ]; then
    funcname=do_it_normal
fi
363
case $key in
364 365 366 367 368 369 370
    --debug)
    set -v
    set -x
    shift
    ;;
    -h|--help|help)
    COMMAND["help"]=1
371 372 373 374 375
    if [ "$2" != "" ] && [ "$(type -t $2_usage)" = 'function' ]
    then
         $2_usage "full"
         exit 0
    fi
376 377 378
    shift
    ;;
    create)
379 380 381 382
    COMMAND[$key]=1
    # For create, mandatory options: jn, id. Optional: variant
    MANDATORY_OPTMASK[0]=$(($JOB_NAME_OPTID + $BUILD_ID_OPTID ))
    ALLOWED_OPTMASK=$(($VARIANT_OPTID))
383 384 385 386 387
    # It is implied to keep the VM when creating it
    KEEP_VM_ALIVE=1
    shift
    ;;
    build)
388 389 390 391
    COMMAND[$key]=1
    # For build, mandatory options: jn, id, ws. Optional: variant, k, D
    MANDATORY_OPTMASK[0]=$(($JOB_NAME_OPTID + $BUILD_ID_OPTID + $JENKINS_WKSP_OPTID))
    ALLOWED_OPTMASK=$(($KEEP_VM_ALIVE_OPTID + $DAEMON_OPTID + $VARIANT_OPTID))
392 393 394
    shift
    ;;
    wait)
395 396 397 398
    # For test, mandatory options: jn, id, ws. Optional: variant, k     	
    COMMAND[$key]=1
    MANDATORY_OPTMASK[0]=$(($JOB_NAME_OPTID + $BUILD_ID_OPTID + $JENKINS_WKSP_OPTID)) 
    ALLOWED_OPTMASK=$(($KEEP_VM_ALIVE_OPTID + $VARIANT_OPTID))  
399 400
    shift
    ;;
401 402 403 404 405
    test) 	
    COMMAND[$key]=1
    # For test, mandatory options: jn, id, ws. Optional: variant, k, epc 
    MANDATORY_OPTMASK[0]=$(($JOB_NAME_OPTID + $BUILD_ID_OPTID + $JENKINS_WKSP_OPTID)) 
    ALLOWED_OPTMASK=$(($KEEP_VM_ALIVE_OPTID + $VARIANT_OPTID + $EPC_IPADDR_OPTID))
406 407 408
    shift
    ;;
    destroy)
409 410 411 412
    COMMAND[$key]=1
    # For destroy, mandatory options: jn, id. 
    MANDATORY_OPTMASK[0]=$(($JOB_NAME_OPTID + $BUILD_ID_OPTID)) 
    ALLOWED_OPTMASK=0   
413 414 415
    shift
    ;;
    report-build)
416 417 418 419 420 421 422
    COMMAND[$key]=1
    # For report-build, mandatory options: jn, id, ws, gu, pu, br,co.
    #                                  or: jn, id, ws, gu, mr, sb, sc, tb, tc.
    MANDATORY_OPTMASK[0]=$(($JOB_NAME_OPTID + $BUILD_ID_OPTID + $JENKINS_WKSP_OPTID + $GITURL_OPTID + $PU_OPTID + $BR_OPTID + $CO_OPTID))
    MANDATORY_OPTMASK[1]=$(($JOB_NAME_OPTID + $BUILD_ID_OPTID + $JENKINS_WKSP_OPTID))
    MANDATORY_OPTMASK[1]+=$(($GITURL_OPTID + $MR_OPTID + $SB_OPTID + $SC_OPTID))  
    MANDATORY_OPTMASK[1]+=$(($GITURL_OPTID + $TB_OPTID + $TC_OPTID))     
423 424
    shift
    ;;
425 426 427 428 429 430 431 432 433
    report-test) 
    COMMAND[$key]=1
    # For report-test, mandatory options: jn, id, ws, gu, pu, br,co.
    #                                 or: jn, id, ws, gu, mr, sb, sc, tb, tc.
    MANDATORY_OPTMASK[0]=$(($JOB_NAME_OPTID + $BUILD_ID_OPTID + $JENKINS_WKSP_OPTID))
    MANDATORY_OPTMASK[0]+=$(($GITURL_OPTID + $PU_OPTID + $BR_OPTID + $CO_OPTID))
    MANDATORY_OPTMASK[1]=$(($JOB_NAME_OPTID + $BUILD_ID_OPTID + $JENKINS_WKSP_OPTID))
    MANDATORY_OPTMASK[1]+=$(($GITURL_OPTID + $MR_OPTID + $SB_OPTID + $SC_OPTID))  
    MANDATORY_OPTMASK[1]+=$(($GITURL_OPTID + $TB_OPTID + $TC_OPTID))   
434 435 436 437
    shift
    ;;
    -jn|--job-name)
    JOB_NAME="$2"
438
    NBARGS=$[$NBARGS+$JOB_NAME_OPTID]
439 440 441 442 443
    shift
    shift
    ;;
    -id|--build-id)
    BUILD_ID="$2"
444
    NBARGS=$[$NBARGS+$BUILD_ID_OPTID]
445 446 447 448 449
    shift
    shift
    ;;
    -ws|--workspace)
    JENKINS_WKSP="$2"
450
    NBARGS=$[$NBARGS+$JENKINS_WKSP_OPTID]
451 452 453 454 455
    shift
    shift
    ;;
    -k|--keep-vm-alive)
    KEEP_VM_ALIVE=1
456
    NBARGS=$[$NBARGS+$KEEP_VM_ALIVE_OPTID]
457 458 459 460
    shift
    ;;
    -D|--daemon)
    DAEMON=1
461
    NBARGS=$[$NBARGS+$DAEMON_OPTID]
462 463 464 465
    shift
    ;;
    -gu|--git-url)
    GIT_URL="$2"
466
    NBARGS=$[$NBARGS+$GITURL_OPTID]
467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492
    shift
    shift
    ;;
    --trigger)
    TRIG="$2"
    case $TRIG in
        merge-request)
        MR_TRIG=1
        ;;
        push)
        PU_TRIG=1
        ;;
        *)
        echo ""
        echo "Syntax Error: Invalid Trigger option -> $TRIG"
        echo ""
        trigger_usage
        exit
        ;;
    esac
    NBARGS=$[$NBARGS+64]
    shift
    shift
    ;;
    -mr)
    MR_TRIG=1
493
    NBARGS=$[$NBARGS+$MR_OPTID]
494 495 496 497
    shift
    ;;
    -pu)
    PU_TRIG=1
498
    NBARGS=$[$NBARGS+$PU_OPTID]
499 500 501 502
    shift
    ;;
    -sb|--src-branch)
    SOURCE_BRANCH="$2"
503
    NBARGS=$[$NBARGS+$SB_OPTID]
504 505 506 507 508
    shift
    shift
    ;;
    -sc|--src-commit)
    SOURCE_COMMIT_ID="$2"
509
    NBARGS=$[$NBARGS+$SC_OPTID]
510 511 512 513 514
    shift
    shift
    ;;
    -tb|--target-branch)
    TARGET_BRANCH="$2"
515
    NBARGS=$[$NBARGS+$TB_OPTID]
516 517 518 519 520
    shift
    shift
    ;;
    -tc|--target-commit)
    TARGET_COMMIT_ID="$2"
521
    NBARGS=$[$NBARGS+$TC_OPTID]
522 523 524 525 526
    shift
    shift
    ;;
    -br|--branch)
    SOURCE_BRANCH="$2"
527
    NBARGS=$[$NBARGS+$BR_OPTID]
528 529 530 531 532
    shift
    shift
    ;;
    -co|--commit)
    SOURCE_COMMIT_ID="$2"
533
    NBARGS=$[$NBARGS+$CO_OPTID]
534 535 536
    shift
    shift
    ;;
537 538 539 540 541 542
    --epc)
    check_ipv4addr "$2"
    check_ipv4addr "$3"
    EPC_IPADDR="$2"
    EPC_TUN_IPADDR="$3"
    NBARGS=$[$NBARGS+$EPC_IPADDR_OPTID]
543 544 545 546
    shift
    shift
    shift
    ;;
547 548
    --setvar_*)
    check_setvar "${key:9}" "$2"
549
    shift
550 551
    shift
    ;;
552 553
    -v[0-9] | -v[0-9][0-9])
    check_set_variant ${key//"-"} 
554 555
    shift
    ;;
556
    --variant)
557 558
    variant="$2" 
    check_set_variant ${2}
559 560 561 562 563 564 565 566 567 568 569
    shift
    shift
    ;;
    *)
    echo "Syntax Error: unknown option: $key"
    echo ""
    top_usage
    exit 1
esac
done

570 571 572 573 574 575 576 577 578
i=0
for (( COUNT=1 ; COUNT<${#COMMAND[@]} ; COUNT++ )) 
do    
   if [ ${COMMAND[${COMMANDS_NAME[$COUNT]}]} -eq 1 ]
   then
   	   COMMAND_KEY[$i]=${COMMANDS_NAME[$COUNT]} 
      (( i++ ))	   
   fi
done
579

580
if [ ${COMMAND["help"]} -eq 1 ]
581
then
582
    if [ ${#COMMAND_KEY[@]} -ne 1 ]
583
    then
584 585 586 587 588 589
       top_usage
    else
       USAGE_KEY=`echo ${COMMAND_KEY[0]} | sed -e "s#-#_#g"`
       ${USAGE_KEY[0]}_usage
    fi 
    exit 0
590
else
591
    if [ ${#COMMAND_KEY[@]} -gt 1 ]
592
    then
593
        echo "Syntax Error, too many commands:  ${COMMAND_KEY[@]}" 
594 595 596
        top_usage
        exit 1
    fi
597 598

    if [ -z "${COMMAND_KEY[0]}" ]
599
    then
600 601
        echo "Syntax Error: no command, specify one of: ${COMMANDS_NAME[@]}"
        top_usage
602 603
        exit 1
    fi
604 605

    check_command_options $NBARGS MANDATORY_OPTMASK[@] $ALLOWED_OPTMASK ${COMMAND_KEY[0]}
606 607
fi

608
if [ ${COMMAND[${COMMANDS_NAME[$REPORT_BUILD_CMD]}]} -ne 1 ]  && [ ${COMMAND[${COMMANDS_NAME[$REPORT_TEST_CMD]}]} -ne 1 ]
609
then
610 611 612 613 614 615 616 617
    # Checking uvt-kvm is installed
    UVT_KVM_PATH=`which uvt-kvm | grep -c uvt-kvm`
    if [ $UVT_KVM_PATH -eq 0 ]
    then
        echo "Error: uvt-kvm is not installed"
        top_usage
        exit 1
    fi
618 619 620 621 622 623 624 625
fi

if [ "$JOB_NAME" == "XX" ] || [ "$BUILD_ID" == "XX" ]
then
    VM_TEMPLATE=ci-
else
    VM_TEMPLATE=${JOB_NAME}-b${BUILD_ID}-
fi
626 627 628 629 630
# set default variant
if [ "$VM_NAME" = "" ]
then
	check_set_variant "v1"
fi
631 632 633 634 635
VM_NAME=`echo $VM_NAME | sed -e "s#ci-#$VM_TEMPLATE#"`
VM_CMDS=${VM_NAME}_cmds.txt
ARCHIVES_LOC=${JENKINS_WKSP}/archives/${ARCHIVES_LOC}

STATUS=0
636
if [ ${COMMAND[${COMMANDS_NAME[$CREATE_CMD]}]} -eq 1 ]
637
then
638
    if [[ "$BUILD_OPTIONS" = "" ]]
639
    then
640
        echo "$VM_NAME is not a build variant"
641 642 643 644
        exit 0
    else
        create_vm
    fi
645
fi
646
if [ ${COMMAND[${COMMANDS_NAME[$BUILD_CMD]}]} -eq 1 ]
647
then
648
    if [[  "$BUILD_OPTIONS" = "" ]]
649
    then
650
        echo " $VM_NAME is not a build variant"
651 652 653 654
        exit 0
    else
        build_on_vm
    fi
655 656 657 658 659
    if [ $DAEMON -eq 0 ] && [ $STATUS -eq 0 ]
    then
        check_on_vm_build
    fi
fi
660
if [ ${COMMAND[${COMMANDS_NAME[$WAIT_CMD]}]} -eq 1 ]
661
then
662
    if [[  "$BUILD_OPTIONS" = "" ]]
663
    then
664
        echo "$VM_NAME is not a build variant"
665 666 667 668
        exit 0
    else
        wait_on_vm_build
    fi
669 670 671 672 673
    if [ $STATUS -eq 0 ]
    then
        check_on_vm_build
    fi
fi
674
if [ ${COMMAND[${COMMANDS_NAME[$TEST_CMD]}]} -eq 1 ]
675
then
676 677 678
    # variant with EXPERIMENTAL variable set to true won't run and will be
    # considered OK, except if --setvar_RUN_EXPERIMENTAL option has been set to true
    if [ "$EXPERIMENTAL" = "true" ] && [ "$RUN_EXPERIMENTAL" != "true" ]
679
    then
680
        echo "Currently $VM_NAME Testing is not implemented / enabled"
681
        echo "Comment out these lines in ./ci-scripts/oai-ci-vm-tool if you want to run it"
682
        echo " or use option --setvar_RUN_EXPERIMENTAL=true to test it"
683 684 685 686 687
        echo "STATUS seems OK"
        exit $STATUS
    fi
    # end to comment out for L1-simulator
    # Comment out or delete the following lines if you want to run RF-simulator in your branch and/or merge request
688 689 690 691 692 693 694
#    if [[ $VM_NAME =~ .*-rf-sim.* ]]
#    then
#        echo "Currently RF-Simulator Testing is not implemented / enabled"
#        echo "Comment out these lines in ./ci-scripts/oai-ci-vm-tool if you want to run it"
#        echo "STATUS seems OK"
#    exit $STATUS
#    fi
695
    # end to comment out for RF-simulator
696 697 698
    ARCHIVES_LOC=${ARCHIVES_LOC}/test
    run_test_on_vm
fi
699
if [ ${COMMAND[${COMMANDS_NAME[$DESTROY_CMD]}]} -eq 1 ]
700 701 702
then
    destroy_vm
fi
703
if [ ${COMMAND[${COMMANDS_NAME[$REPORT_BUILD_CMD]}]} -eq 1 ]
704 705 706
then
    report_build
fi
707
if [ ${COMMAND[${COMMANDS_NAME[$REPORT_TEST_CMD]}]} -eq 1 ]
708 709 710 711 712 713 714 715 716 717 718 719
then
    report_test
fi

# Did command pass or fail?
if [ $STATUS -eq 0 ]
then
    echo "STATUS seems OK"
else
    echo "STATUS failed?"
fi
exit $STATUS