jjb/integration/common-functions.sh

   1 #!/bin/bash
   2
   3 echo "common-functions.sh is being sourced"
   4
   5 BUNDLEFOLDER=$1
   6
   7 # Basic controller configuration settings
   8 export MAVENCONF=/tmp/${BUNDLEFOLDER}/etc/org.ops4j.pax.url.mvn.cfg
   9 export FEATURESCONF=/tmp/${BUNDLEFOLDER}/etc/org.apache.karaf.features.cfg
  10 export CUSTOMPROP=/tmp/${BUNDLEFOLDER}/etc/custom.properties
  11 export LOGCONF=/tmp/${BUNDLEFOLDER}/etc/org.ops4j.pax.logging.cfg
  12 export MEMCONF=/tmp/${BUNDLEFOLDER}/bin/setenv
  13 export CONTROLLERMEM=${CONTROLLERMAXMEM}
  14
  15 # Cluster specific configuration settings
  16 export AKKACONF=/tmp/${BUNDLEFOLDER}/configuration/initial/akka.conf
  17 export MODULESCONF=/tmp/${BUNDLEFOLDER}/configuration/initial/modules.conf
  18 export MODULESHARDSCONF=/tmp/${BUNDLEFOLDER}/configuration/initial/module-shards.conf
  19
  20 function print_common_env() {
  21     cat << EOF
  22 common-functions environment:
  23 MAVENCONF: ${MAVENCONF}
  24 ACTUALFEATURES: ${ACTUALFEATURES}
  25 FEATURESCONF: ${FEATURESCONF}
  26 CUSTOMPROP: ${CUSTOMPROP}
  27 LOGCONF: ${LOGCONF}
  28 MEMCONF: ${MEMCONF}
  29 CONTROLLERMEM: ${CONTROLLERMEM}
  30 AKKACONF: ${AKKACONF}
  31 MODULESCONF: ${MODULESCONF}
  32 MODULESHARDSCONF: ${MODULESHARDSCONF}
  33 SUITES: ${SUITES}
  34
  35 EOF
  36 }
  37 print_common_env
  38
  39 # Setup JAVA_HOME and MAX_MEM Value in ODL startup config file
  40 function set_java_vars() {
  41     local -r java_home=$1
  42     local -r controllermem=$2
  43     local -r memconf=$3
  44
  45     echo "Configure"
  46     echo "    java home: ${java_home}"
  47     echo "    max memory: ${controllermem}"
  48     echo "    memconf: ${memconf}"
  49
  50     # We do not want expressions to expand here.
  51     # shellcheck disable=SC2016
  52     sed -ie 's%^# export JAVA_HOME%export JAVA_HOME=${JAVA_HOME:-'"${java_home}"'}%g' "${memconf}"
  53     sed -ie 's/JAVA_MAX_MEM="2048m"/JAVA_MAX_MEM='"${controllermem}"'/g' "${memconf}"
  54     echo "cat ${memconf}"
  55     cat "${memconf}"
  56
  57     echo "Set Java version"
  58     sudo /usr/sbin/alternatives --install /usr/bin/java java "${java_home}/bin/java" 1
  59     sudo /usr/sbin/alternatives --set java "${java_home}/bin/java"
  60     echo "JDK default version ..."
  61     java -version
  62
  63     echo "Set JAVA_HOME"
  64     export JAVA_HOME="${java_home}"
  65
  66     # shellcheck disable=SC2037
  67     JAVA_RESOLVED=$(readlink -e "${java_home}/bin/java")
  68     echo "Java binary pointed at by JAVA_HOME: ${JAVA_RESOLVED}"
  69 } # set_java_vars()
  70
  71 # shellcheck disable=SC2034
  72 # foo appears unused. Verify it or export it.
  73 function configure_karaf_log() {
  74     local -r karaf_version=$1
  75     local -r controllerdebugmap=$2
  76     local logapi=log4j
  77
  78     # Check what the logging.cfg file is using for the logging api: log4j or log4j2
  79     if grep "log4j2" "${LOGCONF}"; then
  80         logapi=log4j2
  81     fi
  82
  83     echo "Configuring the karaf log... karaf_version: ${karaf_version}, logapi: ${logapi}"
  84     if [ "${logapi}" == "log4j2" ]; then
  85         # FIXME: Make log size limit configurable from build parameter.
  86         # Increase default log file size to 1GB
  87         sed -ie 's/log4j2.appender.rolling.policies.size.size = 64MB/log4j2.appender.rolling.policies.size.size = 1GB/g' "${LOGCONF}"
  88         orgmodule="org.opendaylight.yangtools.yang.parser.repo.YangTextSchemaContextResolver"
  89         orgmodule_="${orgmodule//./_}"
  90         echo "${logapi}.logger.${orgmodule_}.name = WARN" >> "${LOGCONF}"
  91         echo "${logapi}.logger.${orgmodule_}.level = WARN" >> "${LOGCONF}"
  92     else
  93         sed -ie 's/log4j.appender.out.maxBackupIndex=10/log4j.appender.out.maxBackupIndex=1/g' "${LOGCONF}"
  94         # FIXME: Make log size limit configurable from build parameter.
  95         sed -ie 's/log4j.appender.out.maxFileSize=1MB/log4j.appender.out.maxFileSize=30GB/g' "${LOGCONF}"
  96         echo "${logapi}.logger.org.opendaylight.yangtools.yang.parser.repo.YangTextSchemaContextResolver = WARN" >> "${LOGCONF}"
  97     fi
  98
  99     # Add custom logging levels
 100     # CONTROLLERDEBUGMAP is expected to be a key:value map of space separated
 101     # values like "module:level module2:level2" where module is abbreviated and
 102     # does not include "org.opendaylight."
 103     unset IFS
 104     echo "controllerdebugmap: ${controllerdebugmap}"
 105     if [ -n "${controllerdebugmap}" ]; then
 106         for kv in ${controllerdebugmap}; do
 107             module="${kv%%:*}"
 108             level="${kv#*:}"
 109             echo "module: $module, level: $level"
 110             # shellcheck disable=SC2157
 111             if [ -n "${module}" ] && [ -n "${level}" ]; then
 112                 orgmodule="org.opendaylight.${module}"
 113                 if [ "${logapi}" == "log4j2" ]; then
 114                     orgmodule_="${orgmodule//./_}"
 115                     echo "${logapi}.logger.${orgmodule_}.name = ${orgmodule}" >> "${LOGCONF}"
 116                     echo "${logapi}.logger.${orgmodule_}.level = ${level}" >> "${LOGCONF}"
 117                 else
 118                     echo "${logapi}.logger.${orgmodule} = ${level}" >> "${LOGCONF}"
 119                 fi
 120             fi
 121         done
 122     fi
 123
 124     echo "cat ${LOGCONF}"
 125     cat "${LOGCONF}"
 126 } # function configure_karaf_log()
 127
 128 function configure_karaf_log_for_apex() {
 129     # TODO: add the extra steps to this function to do any extra work
 130     # in this apex environment like we do in our standard environment.
 131     # EX: log size, rollover, etc.
 132
 133     # Modify ODL Log Levels, if needed, for new distribution. This will modify
 134     # the control nodes hiera data which will be used during the puppet deploy
 135     # CONTROLLERDEBUGMAP is expected to be a key:value map of space separated
 136     # values like "module:level module2:level2" where module is abbreviated and
 137     # does not include "org.opendaylight."
 138
 139     local -r controller_ip=$1
 140
 141     unset IFS
 142     # shellcheck disable=SC2153
 143     echo "CONTROLLERDEBUGMAP: ${CONTROLLERDEBUGMAP}"
 144     if [ -n "${CONTROLLERDEBUGMAP}" ]; then
 145         logging_config='\"opendaylight::log_levels\": {'
 146         for kv in ${CONTROLLERDEBUGMAP}; do
 147             module="${kv%%:*}"
 148             level="${kv#*:}"
 149             echo "module: $module, level: $level"
 150             # shellcheck disable=SC2157
 151             if [ -n "${module}" ] && [ -n "${level}" ]; then
 152                 orgmodule="org.opendaylight.${module}"
 153                 logging_config="${logging_config} \\\"${orgmodule}\\\": \\\"${level}\\\","
 154             fi
 155         done
 156         # replace the trailing comma with a closing brace followed by trailing comma
 157         logging_config=${logging_config%,}" },"
 158         echo "$logging_config"
 159
 160         # fine a sane line number to inject the custom logging json
 161         lineno=$(ssh "$OPENSTACK_CONTROL_NODE_1_IP" "sudo grep -Fn 'opendaylight::log_mechanism' /etc/puppet/hieradata/service_configs.json" | awk -F: '{print $1}')
 162         # We purposely want these variables to expand client-side
 163         # shellcheck disable=SC2029
 164         ssh "$controller_ip" "sudo sed -i \"${lineno}i ${logging_config}\" /etc/puppet/hieradata/service_configs.json"
 165         ssh "$controller_ip" "sudo cat /etc/puppet/hieradata/service_configs.json"
 166     fi
 167 } # function configure_karaf_log_for_apex()
 168
 169 function configure_odl_features_for_apex() {
 170
 171     # if the environment variable $ACTUALFEATURES is not null, then rewrite
 172     # the puppet config file with the features given in that variable, otherwise
 173     # this function is a noop
 174
 175     local -r controller_ip=$1
 176     local -r config_file=/etc/puppet/hieradata/service_configs.json
 177
 178 cat > /tmp/set_odl_features.sh << EOF
 179 sudo jq '.["opendaylight::extra_features"] |= []' $config_file > tmp.json && mv tmp.json $config_file
 180 for feature in "\${ACTUALFEATURES//,/ }"; do
 181     sudo jq --arg jq_arg \$feature '.["opendaylight::extra_features"] |= . + [\$jq_arg]' $config_file > tmp && mv tmp $config_file;
 182 done
 183 echo "Modified puppet-opendaylight service_configs.json..."
 184 cat $config_file
 185 EOF
 186
 187     echo "Feature configuration script..."
 188     cat /tmp/set_odl_features.sh
 189
 190     if [ -n "${ACTUALFEATURES}" ]; then
 191         scp /tmp/set_odl_features.sh "$controller_ip":/tmp/set_odl_features.sh
 192         ssh "$controller_ip" "sudo bash /tmp/set_odl_features.sh"
 193     fi
 194
 195 } # function configure_odl_features_for_apex()
 196
 197 function get_os_deploy() {
 198     local -r num_systems=${1:-$NUM_OPENSTACK_SYSTEM}
 199     case ${num_systems} in
 200     1)
 201         OPENSTACK_TOPO="1cmb-0ctl-0cmp"
 202         ;;
 203     2)
 204         OPENSTACK_TOPO="1cmb-0ctl-1cmp"
 205         ;;
 206     3|*)
 207         OPENSTACK_TOPO="0cmb-1ctl-2cmp"
 208         ;;
 209     esac
 210     export OPENSTACK_TOPO
 211 }
 212
 213 function get_test_suites() {
 214
 215     #let the caller pick the name of the variable we will assign the suites to
 216     local __suite_list=$1
 217
 218     echo "Locating test plan to use..."
 219     testplan_filepath="${WORKSPACE}/test/csit/testplans/${STREAMTESTPLAN}"
 220     if [ ! -f "${testplan_filepath}" ]; then
 221         testplan_filepath="${WORKSPACE}/test/csit/testplans/${TESTPLAN}"
 222     fi
 223
 224     if [ "${ELASTICSEARCHATTRIBUTE}" != "disabled" ]; then
 225         add_test="integration/test/csit/suites/integration/Create_JVM_Plots.robot"
 226         echo "${add_test}" >> "$testplan_filepath"
 227     fi
 228
 229     echo "Changing the testplan path..."
 230     sed "s:integration:${WORKSPACE}:" "${testplan_filepath}" > testplan.txt
 231     cat testplan.txt
 232
 233     # Use the testplan if specific SUITES are not defined.
 234     if [ -z "${SUITES}" ]; then
 235         suite_list=$(grep -E -v '(^[[:space:]]*#|^[[:space:]]*$)' testplan.txt | tr '\012' ' ')
 236     else
 237         suite_list=""
 238         workpath="${WORKSPACE}/test/csit/suites"
 239         for suite in ${SUITES}; do
 240             fullsuite="${workpath}/${suite}"
 241             if [ -z "${suite_list}" ]; then
 242                 suite_list+=${fullsuite}
 243             else
 244                 suite_list+=" "${fullsuite}
 245             fi
 246         done
 247     fi
 248
 249     eval "$__suite_list='$suite_list'"
 250 }
 251
 252 function run_plan() {
 253     local -r type=$1
 254
 255     case ${type} in
 256     script)
 257         plan=$SCRIPTPLAN
 258         ;;
 259     config|*)
 260         plan=$CONFIGPLAN
 261         ;;
 262     esac
 263
 264     printf "Locating %s plan to use...\\n" "${type}"
 265     plan_filepath="${WORKSPACE}/test/csit/${type}plans/$plan"
 266     if [ ! -f "${plan_filepath}" ]; then
 267         plan_filepath="${WORKSPACE}/test/csit/${type}plans/${STREAMTESTPLAN}"
 268         if [ ! -f "${plan_filepath}" ]; then
 269             plan_filepath="${WORKSPACE}/test/csit/${type}plans/${TESTPLAN}"
 270         fi
 271     fi
 272
 273     if [ -f "${plan_filepath}" ]; then
 274         printf "%s plan exists!!!\\n" "${type}"
 275         printf "Changing the %s plan path...\\n" "${type}"
 276         sed "s:integration:${WORKSPACE}:" "${plan_filepath}" > "${type}plan.txt"
 277         cat "${type}plan.txt"
 278         # shellcheck disable=SC2013
 279         for line in $( grep -E -v '(^[[:space:]]*#|^[[:space:]]*$)' "${type}plan.txt" ); do
 280             printf "Executing %s...\\n" "${line}"
 281             # shellcheck source=${line} disable=SC1091
 282             source "${line}"
 283         done
 284     fi
 285     printf "Finished running %s plans\\n" "${type}"
 286 } # function run_plan()
 287
 288 # Run scripts to support JVM monitoring.
 289 function add_jvm_support()
 290 {
 291     if [ "${ELASTICSEARCHATTRIBUTE}" != "disabled" ]; then
 292         set_elasticsearch_attribute "${ELASTICSEARCHATTRIBUTE}"
 293         set_jvm_common_attribute
 294     fi
 295 } # function add_jvm_support()
 296
 297 #Expected input parameter: long/short/a number
 298 function set_elasticsearch_attribute()
 299 {
 300 short=5000
 301 long=120000
 302 default=$short
 303
 304 case $1 in
 305 short)
 306   period=$short
 307   ;;
 308 long)
 309   period=$long
 310   ;;
 311 *)
 312   # shellcheck disable=SC2166
 313   if [[ "$1" =~ ^[0-9]+$ ]] && [ "$1" -ge $short -a "$1" -le $long ]; then
 314       period=$1
 315   else
 316       period=$default
 317   fi
 318   ;;
 319 esac
 320
 321 cat > "${WORKSPACE}"/org.apache.karaf.decanter.scheduler.simple.cfg <<EOF
 322 period=$period
 323
 324 EOF
 325
 326 echo "Copying config files to ODL Controller folder"
 327
 328 # shellcheck disable=SC2086
 329 for i in $(seq 1 ${NUM_ODL_SYSTEM})
 330 do
 331         CONTROLLERIP=ODL_SYSTEM_${i}_IP
 332         echo "Set Decanter Polling Period to ${!CONTROLLERIP}"
 333         # shellcheck disable=SC2029
 334         ssh "${!CONTROLLERIP}" "mkdir -p \"/tmp/${BUNDLEFOLDER}/etc/opendaylight/karaf/\""
 335         scp "${WORKSPACE}"/org.apache.karaf.decanter.scheduler.simple.cfg "${!CONTROLLERIP}":/tmp/"${BUNDLEFOLDER}"/etc/
 336 done
 337 } #function set_elasticsearch_attribute
 338
 339 function set_jvm_common_attribute()
 340 {
 341 cat > "${WORKSPACE}"/org.apache.karaf.decanter.collector.jmx-local.cfg <<EOF
 342 type=jmx-local
 343 url=local
 344 object.name=java.lang:type=*,name=*
 345
 346 EOF
 347
 348 cat > "${WORKSPACE}"/org.apache.karaf.decanter.collector.jmx-others.cfg <<EOF
 349 type=jmx-local
 350 url=local
 351 object.name=java.lang:type=*
 352
 353 EOF
 354
 355 # shellcheck disable=SC2086
 356 for i in $(seq 1 ${NUM_ODL_SYSTEM})
 357 do
 358     CONTROLLERIP=ODL_SYSTEM_${i}_IP
 359
 360     cat > "${WORKSPACE}"/elasticsearch.yml <<EOF
 361     discovery.zen.ping.multicast.enabled: false
 362
 363 EOF
 364
 365     cat > "${WORKSPACE}"/elasticsearch_startup.sh <<EOF
 366     cd /tmp/elasticsearch/elasticsearch-1.7.5
 367     ls -al
 368
 369     if [ -d "data" ]; then
 370         echo "data directory exists, deleting...."
 371         rm -r data
 372     else
 373         echo "data directory does not exist"
 374     fi
 375
 376     cd /tmp/elasticsearch
 377     ls -al
 378
 379     echo "Starting Elasticsearch node"
 380     sudo /tmp/elasticsearch/elasticsearch-1.7.5/bin/elasticsearch > /dev/null 2>&1 &
 381     ls -al /tmp/elasticsearch/elasticsearch-1.7.5/bin/elasticsearch
 382
 383 EOF
 384     echo "Setup ODL_SYSTEM_IP specific config files for ${!CONTROLLERIP} "
 385     cat "${WORKSPACE}"/org.apache.karaf.decanter.collector.jmx-local.cfg
 386     cat "${WORKSPACE}"/org.apache.karaf.decanter.collector.jmx-others.cfg
 387     cat "${WORKSPACE}"/elasticsearch.yml
 388
 389
 390     echo "Copying config files to ${!CONTROLLERIP}"
 391     scp "${WORKSPACE}"/org.apache.karaf.decanter.collector.jmx-local.cfg "${!CONTROLLERIP}":/tmp/"${BUNDLEFOLDER}"/etc/
 392     scp "${WORKSPACE}"/org.apache.karaf.decanter.collector.jmx-others.cfg "${!CONTROLLERIP}":/tmp/"${BUNDLEFOLDER}"/etc/
 393     scp "${WORKSPACE}"/elasticsearch.yml "${!CONTROLLERIP}":/tmp/
 394
 395     ssh "${!CONTROLLERIP}" "sudo ls -al /tmp/elasticsearch/"
 396     ssh "${!CONTROLLERIP}" "sudo mv /tmp/elasticsearch.yml /tmp/elasticsearch/elasticsearch-1.7.5/config/"
 397     ssh "${!CONTROLLERIP}" "cat /tmp/elasticsearch/elasticsearch-1.7.5/config/elasticsearch.yml"
 398
 399     echo "Copying the elasticsearch_startup script to ${!CONTROLLERIP}"
 400     cat "${WORKSPACE}"/elasticsearch_startup.sh
 401     scp "${WORKSPACE}"/elasticsearch_startup.sh "${!CONTROLLERIP}":/tmp
 402     ssh "${!CONTROLLERIP}" 'bash /tmp/elasticsearch_startup.sh'
 403     ssh "${!CONTROLLERIP}" 'ps aux | grep elasticsearch'
 404 done
 405 } #function set_jvm_common_attribute
 406
 407 # Return elapsed time. Usage:
 408 # - Call first time with no arguments and a new timer is returned.
 409 # - Next call with the first argument as the timer and the elapsed time is returned.
 410 function timer()
 411 {
 412     if [ $# -eq 0 ]; then
 413         # return the current time
 414         printf "%s" "$(date "+%s")"
 415     else
 416         local start_time=$1
 417         end_time=$(date "+%s")
 418
 419         if [ -z "$start_time" ]; then
 420             start_time=$end_time;
 421         fi
 422
 423         delta_time=$((end_time - start_time))
 424         ds=$((delta_time % 60))
 425         dm=$(((delta_time / 60) % 60))
 426         dh=$((delta_time / 3600))
 427         # return the elapsed time
 428         printf "%d:%02d:%02d" $dh $dm $ds
 429     fi
 430 }
 431
 432 # convert commas in csv strings to spaces (ssv)
 433 function csv2ssv() {
 434     local csv=$1
 435     if [ -n "${csv}" ]; then
 436         ssv=$(echo "${csv}" | sed 's/,/ /g' | sed 's/\ \ */\ /g')
 437     fi
 438
 439     echo "${ssv}"
 440 } # csv2ssv
 441
 442 function is_openstack_feature_enabled() {
 443     local feature=$1
 444     for enabled_feature in $(csv2ssv "${ENABLE_OS_SERVICES}"); do
 445         if [ "${enabled_feature}" == "${feature}" ]; then
 446            echo 1
 447            return
 448         fi
 449     done
 450     echo 0
 451 }
 452
 453 SSH="ssh -t -t"
 454
 455 # shellcheck disable=SC2153
 456 function print_job_parameters() {
 457     cat << EOF
 458
 459 Job parameters:
 460 DISTROBRANCH: ${DISTROBRANCH}
 461 DISTROSTREAM: ${DISTROSTREAM}
 462 BUNDLE_URL: ${BUNDLE_URL}
 463 CONTROLLERFEATURES: ${CONTROLLERFEATURES}
 464 CONTROLLERDEBUGMAP: ${CONTROLLERDEBUGMAP}
 465 CONTROLLERMAXMEM: ${CONTROLLERMAXMEM}
 466 SCRIPTPLAN: ${SCRIPTPLAN}
 467 CONFIGPLAN: ${CONFIGPLAN}
 468 STREAMTESTPLAN: ${STREAMTESTPLAN}
 469 TESTPLAN: ${TESTPLAN}
 470 SUITES: ${SUITES}
 471 PATCHREFSPEC: ${PATCHREFSPEC}
 472 OPENSTACK_BRANCH: ${OPENSTACK_BRANCH}
 473 DEVSTACK_HASH: ${DEVSTACK_HASH}
 474 ODL_ML2_DRIVER_REPO: ${ODL_ML2_DRIVER_REPO}
 475 ODL_ML2_BRANCH: ${ODL_ML2_BRANCH}
 476 ODL_ML2_DRIVER_VERSION: ${ODL_ML2_DRIVER_VERSION}
 477 ODL_ML2_PORT_BINDING: ${ODL_ML2_PORT_BINDING}
 478 DEVSTACK_KUBERNETES_PLUGIN_REPO: ${DEVSTACK_KUBERNETES_PLUGIN_REPO}
 479 DEVSTACK_LBAAS_PLUGIN_REPO: ${DEVSTACK_LBAAS_PLUGIN_REPO}
 480 DEVSTACK_NETWORKING_SFC_PLUGIN_REPO: ${DEVSTACK_NETWORKING_SFC_PLUGIN_REPO}
 481 IPSEC_VXLAN_TUNNELS_ENABLED: ${IPSEC_VXLAN_TUNNELS_ENABLED}
 482 PUBLIC_BRIDGE: ${PUBLIC_BRIDGE}
 483 ENABLE_HAPROXY_FOR_NEUTRON: ${ENABLE_HAPROXY_FOR_NEUTRON}
 484 ENABLE_OS_SERVICES: ${ENABLE_OS_SERVICES}
 485 ENABLE_OS_COMPUTE_SERVICES: ${ENABLE_OS_COMPUTE_SERVICES}
 486 ENABLE_OS_NETWORK_SERVICES: ${ENABLE_OS_NETWORK_SERVICES}
 487 ENABLE_OS_PLUGINS: ${ENABLE_OS_PLUGINS}
 488 DISABLE_OS_SERVICES: ${DISABLE_OS_SERVICES}
 489 TENANT_NETWORK_TYPE: ${TENANT_NETWORK_TYPE}
 490 SECURITY_GROUP_MODE: ${SECURITY_GROUP_MODE}
 491 ENABLE_ITM_DIRECT_TUNNELS: ${ENABLE_ITM_DIRECT_TUNNELS}
 492 PUBLIC_PHYSICAL_NETWORK: ${PUBLIC_PHYSICAL_NETWORK}
 493 ENABLE_NETWORKING_L2GW: ${ENABLE_NETWORKING_L2GW}
 494 CREATE_INITIAL_NETWORKS: ${CREATE_INITIAL_NETWORKS}
 495 LBAAS_SERVICE_PROVIDER: ${LBAAS_SERVICE_PROVIDER}
 496 ODL_SFC_DRIVER: ${ODL_SFC_DRIVER}
 497 ODL_SNAT_MODE: ${ODL_SNAT_MODE}
 498 GROUP_ADD_MOD_ENABLED: ${GROUP_ADD_MOD_ENABLED}
 499
 500 EOF
 501 }
 502
 503 function tcpdump_start() {
 504     local -r prefix=$1
 505     local -r ip=$2
 506     local -r filter=$3
 507     filter_=${filter// /_}
 508
 509     printf "node %s, %s_%s__%s: starting tcpdump\\n" "${ip}" "${prefix}" "${ip}" "${filter}"
 510     # $fileter needs to be parsed client-side
 511     # shellcheck disable=SC2029
 512     ssh "${ip}" "nohup sudo /usr/sbin/tcpdump -vvv -ni eth0 ${filter} -w /tmp/tcpdump_${prefix}_${ip}__${filter_}.pcap > /tmp/tcpdump_start.log 2>&1 &"
 513     ${SSH} "${ip}" "ps -ef | grep tcpdump"
 514 }
 515
 516 function tcpdump_stop() {
 517     local -r ip=$1
 518
 519     printf "node %s: stopping tcpdump\\n" "$ip"
 520     ${SSH} "${ip}" "ps -ef | grep tcpdump.sh"
 521     ${SSH} "${ip}" "sudo pkill -f tcpdump"
 522     ${SSH} "${ip}" "sudo xz -9ekvvf /tmp/*.pcap"
 523     ${SSH} "${ip}" "sudo ls -al /tmp/*.pcap"
 524     # copy_logs will copy any *.xz files
 525 }
 526
 527 # Collect the list of files on the hosts
 528 function collect_files() {
 529     local -r ip=$1
 530     local -r folder=$2
 531     finddir=/tmp/finder
 532     ${SSH} "${ip}" "mkdir -p ${finddir}"
 533     ${SSH} "${ip}" "sudo find /etc > ${finddir}/find.etc.txt"
 534     ${SSH} "${ip}" "sudo find /opt/stack > ${finddir}/find.opt.stack.txt"
 535     ${SSH} "${ip}" "sudo find /var > ${finddir}/find2.txt"
 536     ${SSH} "${ip}" "sudo find /var > ${finddir}/find.var.txt"
 537     ${SSH} "${ip}" "sudo tar -cf - -C /tmp finder | xz -T 0 > /tmp/find.tar.xz"
 538     scp "${ip}":/tmp/find.tar.xz "${folder}"
 539     mkdir -p "${finddir}"
 540     rsync --rsync-path="sudo rsync" --list-only -arvhe ssh "${ip}":/etc/ > "${finddir}"/rsync.etc.txt
 541     rsync --rsync-path="sudo rsync" --list-only -arvhe ssh "${ip}":/opt/stack/ > "${finddir}"/rsync.opt.stack.txt
 542     rsync --rsync-path="sudo rsync" --list-only -arvhe ssh "${ip}":/var/ > "${finddir}"/rsync.var.txt
 543     tar -cf - -C /tmp finder | xz -T 0 > /tmp/rsync.tar.xz
 544     cp /tmp/rsync.tar.xz "${folder}"
 545 }
 546
 547 # List of extra services to extract from journalctl
 548 # Add new services on a separate line, in alpha order, add \ at the end
 549 extra_services_cntl=" \
 550     dnsmasq.service \
 551     httpd.service \
 552     libvirtd.service \
 553     openvswitch.service \
 554     ovs-vswitchd.service \
 555     ovsdb-server.service \
 556     rabbitmq-server.service \
 557 "
 558
 559 extra_services_cmp=" \
 560     libvirtd.service \
 561     openvswitch.service \
 562     ovs-vswitchd.service \
 563     ovsdb-server.service \
 564 "
 565
 566 # Collect the logs for the openstack services
 567 # First get all the services started by devstack which would have devstack@ as a prefix
 568 # Next get all the extra services
 569 function collect_openstack_logs() {
 570     local -r ip=${1}
 571     local -r folder=${2}
 572     local -r node_type=${3}
 573     local oslogs="${folder}/oslogs"
 574
 575     printf "collect_openstack_logs for %s node: %s into %s\\n" "${node_type}" "${ip}" "${oslogs}"
 576     rm -rf "${oslogs}"
 577     mkdir -p "${oslogs}"
 578     # There are always some logs in /opt/stack/logs and this also covers the
 579     # pre-queens branches which always use /opt/stack/logs
 580     rsync -avhe ssh "${ip}":/opt/stack/logs/* "${oslogs}" # rsync to prevent copying of symbolic links
 581
 582     # Starting with queens break out the logs from journalctl
 583     if [ "${OPENSTACK_BRANCH}" = "stable/queens" ]; then
 584         cat > "${WORKSPACE}"/collect_openstack_logs.sh << EOF
 585 extra_services_cntl="${extra_services_cntl}"
 586 extra_services_cmp="${extra_services_cmp}"
 587
 588 function extract_from_journal() {
 589     local -r services=\${1}
 590     local -r folder=\${2}
 591     local -r node_type=\${3}
 592     printf "extract_from_journal folder: \${folder}, services: \${services}\\n"
 593     for service in \${services}; do
 594         # strip anything before @ and anything after .
 595         # devstack@g-api.service will end as g-api
 596         service_="\${service#*@}"
 597         service_="\${service_%.*}"
 598         sudo journalctl -u "\${service}" > "\${folder}/\${service_}.log"
 599     done
 600 }
 601
 602 rm -rf /tmp/oslogs
 603 mkdir -p /tmp/oslogs
 604 systemctl list-unit-files --all > /tmp/oslogs/systemctl.units.log 2>&1
 605 svcs=\$(grep devstack@ /tmp/oslogs/systemctl.units.log | awk '{print \$1}')
 606 extract_from_journal "\${svcs}" "/tmp/oslogs"
 607 if [ "\${node_type}" = "control" ]; then
 608     extract_from_journal "\${extra_services_cntl}" "/tmp/oslogs"
 609 else
 610     extract_from_journal "\${extra_services_cmp}" "/tmp/oslogs"
 611 fi
 612 ls -al /tmp/oslogs
 613 EOF
 614 # cat > ${WORKSPACE}/collect_openstack_logs.sh << EOF
 615         printf "collect_openstack_logs for %s node: %s into %s, executing script\\n" "${node_type}" "${ip}" "${oslogs}"
 616         cat "${WORKSPACE}"/collect_openstack_logs.sh
 617         scp "${WORKSPACE}"/collect_openstack_logs.sh "${ip}":/tmp
 618         ${SSH} "${ip}" "bash /tmp/collect_openstack_logs.sh > /tmp/collect_openstack_logs.log 2>&1"
 619         rsync -avhe ssh "${ip}":/tmp/oslogs/* "${oslogs}"
 620         scp "${ip}":/tmp/collect_openstack_logs.log "${oslogs}"
 621     fi # if [ "${OPENSTACK_BRANCH}" = "stable/queens" ]; then
 622 }
 623
 624 function collect_netvirt_logs() {
 625     set +e  # We do not want to create red dot just because something went wrong while fetching logs.
 626
 627     cat > extra_debug.sh << EOF
 628 echo -e "/usr/sbin/lsmod | /usr/bin/grep openvswitch\\n"
 629 /usr/sbin/lsmod | /usr/bin/grep openvswitch
 630 echo -e "\\nsudo grep ct_ /var/log/openvswitch/ovs-vswitchd.log\\n"
 631 sudo grep "Datapath supports" /var/log/openvswitch/ovs-vswitchd.log
 632 echo -e "\\nsudo netstat -punta\\n"
 633 sudo netstat -punta
 634 echo -e "\\nsudo getenforce\\n"
 635 sudo getenforce
 636 echo -e "\\nsudo systemctl status httpd\\n"
 637 sudo systemctl status httpd
 638 echo -e "\\nenv\\n"
 639 env
 640 source /opt/stack/devstack/openrc admin admin
 641 echo -e "\\nenv after openrc\\n"
 642 env
 643 echo -e "\\nsudo du -hs /opt/stack"
 644 sudo du -hs /opt/stack
 645 echo -e "\\nsudo mount"
 646 sudo mount
 647 echo -e "\\ndmesg -T > /tmp/dmesg.log"
 648 dmesg -T > /tmp/dmesg.log
 649 echo -e "\\njournalctl > /tmp/journalctl.log\\n"
 650 sudo journalctl > /tmp/journalctl.log
 651 echo -e "\\novsdb-tool -mm show-log > /tmp/ovsdb-tool.log"
 652 ovsdb-tool -mm show-log > /tmp/ovsdb-tool.log
 653 EOF
 654
 655     # Since this log collection work is happening before the archive build macro which also
 656     # creates the ${WORKSPACE}/archives dir, we have to do it here first.  The mkdir in the
 657     # archives build step will essentially be a noop.
 658     mkdir -p "${WORKSPACE}"/archives
 659
 660     mv /tmp/changes.txt "${WORKSPACE}"/archives
 661     mv /tmp/validations.txt "${WORKSPACE}"/archives
 662     mv "${WORKSPACE}"/rabbit.txt "${WORKSPACE}"/archives
 663     mv "${WORKSPACE}"/haproxy.cfg "${WORKSPACE}"/archives
 664     ssh "${OPENSTACK_HAPROXY_1_IP}" "sudo journalctl -u haproxy > /tmp/haproxy.log"
 665     scp "${OPENSTACK_HAPROXY_1_IP}":/tmp/haproxy.log "${WORKSPACE}"/archives/
 666
 667     sleep 5
 668     # FIXME: Do not create .tar and gzip before copying.
 669     for i in $(seq 1 "${NUM_ODL_SYSTEM}"); do
 670         CONTROLLERIP=ODL_SYSTEM_${i}_IP
 671         echo "collect_logs: for opendaylight controller ip: ${!CONTROLLERIP}"
 672         NODE_FOLDER="odl_${i}"
 673         mkdir -p "${NODE_FOLDER}"
 674         echo "Let's take the karaf thread dump again..."
 675         ssh "${!CONTROLLERIP}" "sudo ps aux" > "${WORKSPACE}"/ps_after.log
 676         pid=$(grep org.apache.karaf.main.Main "${WORKSPACE}"/ps_after.log | grep -v grep | tr -s ' ' | cut -f2 -d' ')
 677         echo "karaf main: org.apache.karaf.main.Main, pid:${pid}"
 678         # $pid needs to be parsed client-side
 679         # shellcheck disable=SC2029
 680         ssh "${!CONTROLLERIP}" "${JAVA_HOME}/bin/jstack -l ${pid}" > "${WORKSPACE}/karaf_${i}_${pid}_threads_after.log" || true
 681         echo "killing karaf process..."
 682         # shellcheck disable=SC2016
 683         ${SSH} "${!CONTROLLERIP}" bash -c 'ps axf | grep karaf | grep -v grep | awk '"'"'{print "kill -9 " $1}'"'"' | sh'
 684         ${SSH} "${!CONTROLLERIP}" "sudo journalctl > /tmp/journalctl.log"
 685         scp "${!CONTROLLERIP}":/tmp/journalctl.log "${NODE_FOLDER}"
 686         ${SSH} "${!CONTROLLERIP}" "dmesg -T > /tmp/dmesg.log"
 687         scp "${!CONTROLLERIP}":/tmp/dmesg.log "${NODE_FOLDER}"
 688         ${SSH} "${!CONTROLLERIP}" "tar -cf - -C /tmp/${BUNDLEFOLDER} etc | xz -T 0 > /tmp/etc.tar.xz"
 689         scp "${!CONTROLLERIP}":/tmp/etc.tar.xz "${NODE_FOLDER}"
 690         ${SSH} "${!CONTROLLERIP}" "cp -r /tmp/${BUNDLEFOLDER}/data/log /tmp/odl_log"
 691         ${SSH} "${!CONTROLLERIP}" "tar -cf /tmp/odl${i}_karaf.log.tar /tmp/odl_log/*"
 692         scp "${!CONTROLLERIP}:/tmp/odl${i}_karaf.log.tar" "${NODE_FOLDER}"
 693         ${SSH} "${!CONTROLLERIP}" "tar -cf /tmp/odl${i}_zrpcd.log.tar /tmp/zrpcd.init.log"
 694         scp "${!CONTROLLERIP}:/tmp/odl${i}_zrpcd.log.tar" "${NODE_FOLDER}"
 695         tar -xvf "${NODE_FOLDER}/odl${i}_karaf.log.tar" -C "${NODE_FOLDER}" --strip-components 2 --transform "s/karaf/odl${i}_karaf/g"
 696         grep "ROBOT MESSAGE\\| ERROR " "${NODE_FOLDER}/odl${i}_karaf.log" > "${NODE_FOLDER}/odl${i}_err.log"
 697         grep "ROBOT MESSAGE\\| ERROR \\| WARN \\|Exception" \
 698             "${NODE_FOLDER}/odl${i}_karaf.log" > "${NODE_FOLDER}/odl${i}_err_warn_exception.log"
 699         # Print ROBOT lines and print Exception lines. For exception lines also print the previous line for context
 700         sed -n -e '/ROBOT MESSAGE/P' -e '$!N;/Exception/P;D' "${NODE_FOLDER}/odl${i}_karaf.log" > "${NODE_FOLDER}/odl${i}_exception.log"
 701         mv "/tmp/odl${i}_exceptions.txt" "${NODE_FOLDER}"
 702         rm "${NODE_FOLDER}/odl${i}_karaf.log.tar"
 703         mv -- *_threads* "${NODE_FOLDER}"
 704         mv ps_* "${NODE_FOLDER}"
 705         mv "${NODE_FOLDER}" "${WORKSPACE}"/archives/
 706     done
 707
 708     print_job_parameters > "${WORKSPACE}"/archives/params.txt
 709
 710     # Control Node
 711     for i in $(seq 1 "${NUM_OPENSTACK_CONTROL_NODES}"); do
 712         OSIP=OPENSTACK_CONTROL_NODE_${i}_IP
 713         if [ "$(is_openstack_feature_enabled n-cpu)" == "1" ]; then
 714             echo "collect_logs: for openstack combo node ip: ${!OSIP}"
 715             NODE_FOLDER="combo_${i}"
 716         else
 717             echo "collect_logs: for openstack control node ip: ${!OSIP}"
 718             NODE_FOLDER="control_${i}"
 719         fi
 720         mkdir -p "${NODE_FOLDER}"
 721         tcpdump_stop "${!OSIP}"
 722         scp extra_debug.sh "${!OSIP}":/tmp
 723         # Capture compute logs if this is a combo node
 724         if [ "$(is_openstack_feature_enabled n-cpu)" == "1" ]; then
 725             scp "${!OSIP}":/etc/nova/nova.conf "${NODE_FOLDER}"
 726             scp "${!OSIP}":/etc/nova/nova-cpu.conf "${NODE_FOLDER}"
 727             scp "${!OSIP}":/etc/openstack/clouds.yaml "${NODE_FOLDER}"
 728             rsync --rsync-path="sudo rsync" -avhe ssh "${!OSIP}":/var/log/nova-agent.log "${NODE_FOLDER}"
 729         fi
 730         ${SSH} "${!OSIP}" "bash /tmp/extra_debug.sh > /tmp/extra_debug.log 2>&1"
 731         scp "${!OSIP}":/etc/dnsmasq.conf "${NODE_FOLDER}"
 732         scp "${!OSIP}":/etc/keystone/keystone.conf "${NODE_FOLDER}"
 733         scp "${!OSIP}":/etc/keystone/keystone-uwsgi-admin.ini "${NODE_FOLDER}"
 734         scp "${!OSIP}":/etc/keystone/keystone-uwsgi-public.ini "${NODE_FOLDER}"
 735         scp "${!OSIP}":/etc/kuryr/kuryr.conf "${NODE_FOLDER}"
 736         scp "${!OSIP}":/etc/neutron/dhcp_agent.ini "${NODE_FOLDER}"
 737         scp "${!OSIP}":/etc/neutron/metadata_agent.ini "${NODE_FOLDER}"
 738         scp "${!OSIP}":/etc/neutron/neutron.conf "${NODE_FOLDER}"
 739         scp "${!OSIP}":/etc/neutron/neutron_lbaas.conf "${NODE_FOLDER}"
 740         scp "${!OSIP}":/etc/neutron/plugins/ml2/ml2_conf.ini "${NODE_FOLDER}"
 741         scp "${!OSIP}":/etc/neutron/services/loadbalancer/haproxy/lbaas_agent.ini "${NODE_FOLDER}"
 742         scp "${!OSIP}":/etc/nova/nova.conf "${NODE_FOLDER}"
 743         scp "${!OSIP}":/etc/nova/nova-api-uwsgi.ini "${NODE_FOLDER}"
 744         scp "${!OSIP}":/etc/nova/nova_cell1.conf "${NODE_FOLDER}"
 745         scp "${!OSIP}":/etc/nova/nova-cpu.conf "${NODE_FOLDER}"
 746         scp "${!OSIP}":/etc/nova/placement-uwsgi.ini "${NODE_FOLDER}"
 747         scp "${!OSIP}":/etc/openstack/clouds.yaml "${NODE_FOLDER}"
 748         scp "${!OSIP}":/opt/stack/devstack/.stackenv "${NODE_FOLDER}"
 749         scp "${!OSIP}":/opt/stack/devstack/nohup.out "${NODE_FOLDER}"/stack.log
 750         scp "${!OSIP}":/opt/stack/devstack/openrc "${NODE_FOLDER}"
 751         scp "${!OSIP}":/opt/stack/requirements/upper-constraints.txt "${NODE_FOLDER}"
 752         scp "${!OSIP}":/opt/stack/tempest/etc/tempest.conf "${NODE_FOLDER}"
 753         scp "${!OSIP}":/tmp/*.xz "${NODE_FOLDER}"
 754         scp "${!OSIP}":/tmp/dmesg.log "${NODE_FOLDER}"
 755         scp "${!OSIP}":/tmp/extra_debug.log "${NODE_FOLDER}"
 756         scp "${!OSIP}":/tmp/get_devstack.sh.txt "${NODE_FOLDER}"
 757         scp "${!OSIP}":/tmp/install_ovs.txt "${NODE_FOLDER}"
 758         scp "${!OSIP}":/tmp/journalctl.log "${NODE_FOLDER}"
 759         scp "${!OSIP}":/tmp/ovsdb-tool.log "${NODE_FOLDER}"
 760         scp "${!OSIP}":/tmp/tcpdump_start.log "${NODE_FOLDER}"
 761         collect_files "${!OSIP}" "${NODE_FOLDER}"
 762         ${SSH} "${!OSIP}" "sudo tar -cf - -C /var/log rabbitmq | xz -T 0 > /tmp/rabbitmq.tar.xz "
 763         scp "${!OSIP}":/tmp/rabbitmq.tar.xz "${NODE_FOLDER}"
 764         rsync --rsync-path="sudo rsync" -avhe ssh "${!OSIP}":/etc/hosts "${NODE_FOLDER}"
 765         rsync --rsync-path="sudo rsync" -avhe ssh "${!OSIP}":/usr/lib/systemd/system/haproxy.service "${NODE_FOLDER}"
 766         rsync --rsync-path="sudo rsync" -avhe ssh "${!OSIP}":/var/log/audit/audit.log "${NODE_FOLDER}"
 767         rsync --rsync-path="sudo rsync" -avhe ssh "${!OSIP}":/var/log/httpd/keystone_access.log "${NODE_FOLDER}"
 768         rsync --rsync-path="sudo rsync" -avhe ssh "${!OSIP}":/var/log/httpd/keystone.log "${NODE_FOLDER}"
 769         rsync --rsync-path="sudo rsync" -avhe ssh "${!OSIP}":/var/log/messages* "${NODE_FOLDER}"
 770         rsync --rsync-path="sudo rsync" -avhe ssh "${!OSIP}":/var/log/openvswitch/ovs-vswitchd.log "${NODE_FOLDER}"
 771         rsync --rsync-path="sudo rsync" -avhe ssh "${!OSIP}":/var/log/openvswitch/ovsdb-server.log "${NODE_FOLDER}"
 772         collect_openstack_logs "${!OSIP}" "${NODE_FOLDER}" "control"
 773         mv "local.conf_control_${!OSIP}" "${NODE_FOLDER}/local.conf"
 774         # qdhcp files are created by robot tests and copied into /tmp/qdhcp during the test
 775         tar -cf - -C /tmp qdhcp | xz -T 0 > /tmp/qdhcp.tar.xz
 776         mv /tmp/qdhcp.tar.xz "${NODE_FOLDER}"
 777         mv "${NODE_FOLDER}" "${WORKSPACE}"/archives/
 778     done
 779
 780     # Compute Nodes
 781     for i in $(seq 1 "${NUM_OPENSTACK_COMPUTE_NODES}"); do
 782         OSIP="OPENSTACK_COMPUTE_NODE_${i}_IP"
 783         echo "collect_logs: for openstack compute node ip: ${!OSIP}"
 784         NODE_FOLDER="compute_${i}"
 785         mkdir -p "${NODE_FOLDER}"
 786         tcpdump_stop "${!OSIP}"
 787         scp extra_debug.sh "${!OSIP}":/tmp
 788         ${SSH} "${!OSIP}" "bash /tmp/extra_debug.sh > /tmp/extra_debug.log 2>&1"
 789         scp "${!OSIP}":/etc/nova/nova.conf "${NODE_FOLDER}"
 790         scp "${!OSIP}":/etc/nova/nova-cpu.conf "${NODE_FOLDER}"
 791         scp "${!OSIP}":/etc/openstack/clouds.yaml "${NODE_FOLDER}"
 792         scp "${!OSIP}":/opt/stack/devstack/.stackenv "${NODE_FOLDER}"
 793         scp "${!OSIP}":/opt/stack/devstack/nohup.out "${NODE_FOLDER}"/stack.log
 794         scp "${!OSIP}":/opt/stack/devstack/openrc "${NODE_FOLDER}"
 795         scp "${!OSIP}":/opt/stack/requirements/upper-constraints.txt "${NODE_FOLDER}"
 796         scp "${!OSIP}":/tmp/*.xz "${NODE_FOLDER}"/
 797         scp "${!OSIP}":/tmp/dmesg.log "${NODE_FOLDER}"
 798         scp "${!OSIP}":/tmp/extra_debug.log "${NODE_FOLDER}"
 799         scp "${!OSIP}":/tmp/get_devstack.sh.txt "${NODE_FOLDER}"
 800         scp "${!OSIP}":/tmp/install_ovs.txt "${NODE_FOLDER}"
 801         scp "${!OSIP}":/tmp/journalctl.log "${NODE_FOLDER}"
 802         scp "${!OSIP}":/tmp/ovsdb-tool.log "${NODE_FOLDER}"
 803         scp "${!OSIP}":/tmp/tcpdump_start.log "${NODE_FOLDER}"
 804         collect_files "${!OSIP}" "${NODE_FOLDER}"
 805         ${SSH} "${!OSIP}" "sudo tar -cf - -C /var/log libvirt | xz -T 0 > /tmp/libvirt.tar.xz "
 806         scp "${!OSIP}":/tmp/libvirt.tar.xz "${NODE_FOLDER}"
 807         rsync --rsync-path="sudo rsync" -avhe ssh "${!OSIP}":/etc/hosts "${NODE_FOLDER}"
 808         rsync --rsync-path="sudo rsync" -avhe ssh "${!OSIP}":/var/log/audit/audit.log "${NODE_FOLDER}"
 809         rsync --rsync-path="sudo rsync" -avhe ssh "${!OSIP}":/var/log/messages* "${NODE_FOLDER}"
 810         rsync --rsync-path="sudo rsync" -avhe ssh "${!OSIP}":/var/log/nova-agent.log "${NODE_FOLDER}"
 811         rsync --rsync-path="sudo rsync" -avhe ssh "${!OSIP}":/var/log/openvswitch/ovs-vswitchd.log "${NODE_FOLDER}"
 812         rsync --rsync-path="sudo rsync" -avhe ssh "${!OSIP}":/var/log/openvswitch/ovsdb-server.log "${NODE_FOLDER}"
 813         collect_openstack_logs "${!OSIP}" "${NODE_FOLDER}" "compute"
 814         mv "local.conf_compute_${!OSIP}" "${NODE_FOLDER}"/local.conf
 815         mv "${NODE_FOLDER}" "${WORKSPACE}"/archives/
 816     done
 817
 818     # Tempest
 819     DEVSTACK_TEMPEST_DIR="/opt/stack/tempest"
 820     TESTREPO=".stestr"
 821     TEMPEST_LOGS_DIR="${WORKSPACE}/archives/tempest"
 822     # Look for tempest test results in the $TESTREPO dir and copy if found
 823     if ${SSH} "${OPENSTACK_CONTROL_NODE_1_IP}" "sudo sh -c '[ -f ${DEVSTACK_TEMPEST_DIR}/${TESTREPO}/0 ]'"; then
 824         ${SSH} "${OPENSTACK_CONTROL_NODE_1_IP}" "for I in \$(sudo ls ${DEVSTACK_TEMPEST_DIR}/${TESTREPO}/ | grep -E '^[0-9]+$'); do sudo sh -c \"${DEVSTACK_TEMPEST_DIR}/.tox/tempest/bin/subunit-1to2 < ${DEVSTACK_TEMPEST_DIR}/${TESTREPO}/\${I} >> ${DEVSTACK_TEMPEST_DIR}/subunit_log.txt\"; done"
 825         ${SSH} "${OPENSTACK_CONTROL_NODE_1_IP}" "sudo sh -c '${DEVSTACK_TEMPEST_DIR}/.tox/tempest/bin/python ${DEVSTACK_TEMPEST_DIR}/.tox/tempest/lib/python2.7/site-packages/os_testr/subunit2html.py ${DEVSTACK_TEMPEST_DIR}/subunit_log.txt ${DEVSTACK_TEMPEST_DIR}/tempest_results.html'"
 826         mkdir -p "${TEMPEST_LOGS_DIR}"
 827         scp "${OPENSTACK_CONTROL_NODE_1_IP}:${DEVSTACK_TEMPEST_DIR}/tempest_results.html" "${TEMPEST_LOGS_DIR}"
 828         scp "${OPENSTACK_CONTROL_NODE_1_IP}:${DEVSTACK_TEMPEST_DIR}/tempest.log" "${TEMPEST_LOGS_DIR}"
 829     else
 830         echo "tempest results not found in ${DEVSTACK_TEMPEST_DIR}/${TESTREPO}/0"
 831     fi
 832 } # collect_netvirt_logs()
 833
 834 # Utility function for joining strings.
 835 function join() {
 836     delim=' '
 837     final=$1; shift
 838
 839     for str in "$@" ; do
 840         final=${final}${delim}${str}
 841     done
 842
 843     echo "${final}"
 844 }
 845
 846 function get_nodes_list() {
 847     # Create the string for nodes
 848     for i in $(seq 1 "${NUM_ODL_SYSTEM}") ; do
 849         CONTROLLERIP=ODL_SYSTEM_${i}_IP
 850         nodes[$i]=${!CONTROLLERIP}
 851     done
 852
 853     nodes_list=$(join "${nodes[@]}")
 854     echo "${nodes_list}"
 855 }
 856
 857 function get_features() {
 858     if [ "${CONTROLLERSCOPE}" == 'all' ]; then
 859         ACTUALFEATURES="odl-integration-compatible-with-all,${CONTROLLERFEATURES}"
 860         # if CONTROLLERMEM still is the default 2G and was not overridden by a
 861         # custom job, then we need to make sure to increase it because "all"
 862         # features can be heavy
 863         if [ "${CONTROLLERMEM}" == "2048m" ]; then
 864             export CONTROLLERMEM="3072m"
 865         fi
 866     else
 867         ACTUALFEATURES="odl-infrautils-ready,${CONTROLLERFEATURES}"
 868     fi
 869
 870     if [ "${ELASTICSEARCHATTRIBUTE}" != "disabled" ]; then
 871         # Add decanter features to allow JVM monitoring
 872         ACTUALFEATURES="${ACTUALFEATURES},decanter-collector-jmx,decanter-appender-elasticsearch-rest"
 873     fi
 874
 875     # Some versions of jenkins job builder result in feature list containing spaces
 876     # and ending in newline. Remove all that.
 877     ACTUALFEATURES=$(echo "${ACTUALFEATURES}" | tr -d '\n \r')
 878     echo "ACTUALFEATURES: ${ACTUALFEATURES}"
 879
 880     # In the case that we want to install features via karaf shell, a space separated list of
 881     # ACTUALFEATURES IS NEEDED
 882     SPACE_SEPARATED_FEATURES=$(echo "${ACTUALFEATURES}" | tr ',' ' ')
 883     echo "SPACE_SEPARATED_FEATURES: ${SPACE_SEPARATED_FEATURES}"
 884
 885     export ACTUALFEATURES
 886     export SPACE_SEPARATED_FEATURES
 887 }
 888
 889 # Create the configuration script to be run on controllers.
 890 function create_configuration_script() {
 891     cat > "${WORKSPACE}"/configuration-script.sh <<EOF
 892 set -x
 893 source /tmp/common-functions.sh ${BUNDLEFOLDER}
 894
 895 echo "Changing to /tmp"
 896 cd /tmp
 897
 898 echo "Downloading the distribution from ${ACTUAL_BUNDLE_URL}"
 899 wget --progress=dot:mega '${ACTUAL_BUNDLE_URL}'
 900
 901 echo "Extracting the new controller..."
 902 unzip -q ${BUNDLE}
 903
 904 echo "Adding external repositories..."
 905 sed -ie "s%org.ops4j.pax.url.mvn.repositories=%org.ops4j.pax.url.mvn.repositories=https://nexus.opendaylight.org/content/repositories/opendaylight.snapshot@id=opendaylight-snapshot@snapshots, https://nexus.opendaylight.org/content/repositories/public@id=opendaylight-mirror, http://repo1.maven.org/maven2@id=central, http://repository.springsource.com/maven/bundles/release@id=spring.ebr.release, http://repository.springsource.com/maven/bundles/external@id=spring.ebr.external, http://zodiac.springsource.com/maven/bundles/release@id=gemini, http://repository.apache.org/content/groups/snapshots-group@id=apache@snapshots@noreleases, https://oss.sonatype.org/content/repositories/snapshots@id=sonatype.snapshots.deploy@snapshots@noreleases, https://oss.sonatype.org/content/repositories/ops4j-snapshots@id=ops4j.sonatype.snapshots.deploy@snapshots@noreleases%g" ${MAVENCONF}
 906 cat ${MAVENCONF}
 907
 908 if [[ "$USEFEATURESBOOT" == "True" ]]; then
 909     echo "Configuring the startup features..."
 910     sed -ie "s/\\(featuresBoot=\\|featuresBoot =\\)/featuresBoot = ${ACTUALFEATURES},/g" ${FEATURESCONF}
 911 fi
 912
 913 FEATURE_TEST_STRING="features-integration-test"
 914 KARAF_VERSION=${KARAF_VERSION:-karaf4}
 915 if [[ "$KARAF_VERSION" == "karaf4" ]]; then
 916     FEATURE_TEST_STRING="features-test"
 917 fi
 918
 919 sed -ie "s%\\(featuresRepositories=\\|featuresRepositories =\\)%featuresRepositories = mvn:org.opendaylight.integration/\${FEATURE_TEST_STRING}/${BUNDLE_VERSION}/xml/features,mvn:org.apache.karaf.decanter/apache-karaf-decanter/1.2.0/xml/features,%g" ${FEATURESCONF}
 920 if [[ ! -z "${REPO_URL}" ]]; then
 921    sed -ie "s%featuresRepositories =%featuresRepositories = ${REPO_URL},%g" ${FEATURESCONF}
 922 fi
 923 cat ${FEATURESCONF}
 924
 925 configure_karaf_log "${KARAF_VERSION}" "${CONTROLLERDEBUGMAP}"
 926
 927 set_java_vars "${JAVA_HOME}" "${CONTROLLERMEM}" "${MEMCONF}"
 928
 929 echo "Listing all open ports on controller system..."
 930 netstat -pnatu
 931
 932 # Copy shard file if exists
 933 if [ -f /tmp/custom_shard_config.txt ]; then
 934     echo "Custom shard config exists!!!"
 935     echo "Copying the shard config..."
 936     cp /tmp/custom_shard_config.txt /tmp/${BUNDLEFOLDER}/bin/
 937 fi
 938
 939 echo "Configuring cluster"
 940 /tmp/${BUNDLEFOLDER}/bin/configure_cluster.sh \$1 ${nodes_list}
 941
 942 echo "Dump akka.conf"
 943 cat ${AKKACONF}
 944
 945 echo "Dump modules.conf"
 946 cat ${MODULESCONF}
 947
 948 echo "Dump module-shards.conf"
 949 cat ${MODULESHARDSCONF}
 950 EOF
 951 # cat > ${WORKSPACE}/configuration-script.sh <<EOF
 952 }
 953
 954 # Create the startup script to be run on controllers.
 955 function create_startup_script() {
 956     cat > "${WORKSPACE}"/startup-script.sh <<EOF
 957 echo "Redirecting karaf console output to karaf_console.log"
 958 export KARAF_REDIRECT="/tmp/${BUNDLEFOLDER}/data/log/karaf_console.log"
 959 mkdir -p /tmp/${BUNDLEFOLDER}/data/log
 960
 961 echo "Starting controller..."
 962 /tmp/${BUNDLEFOLDER}/bin/start
 963 EOF
 964 # cat > ${WORKSPACE}/startup-script.sh <<EOF
 965 }
 966
 967 function create_post_startup_script() {
 968     cat > "${WORKSPACE}"/post-startup-script.sh <<EOF
 969 # wait up to 60s for karaf port 8101 to be opened, polling every 5s
 970 loop_count=0;
 971 until [[ \$loop_count -ge 12 ]]; do
 972     netstat -na | grep ":::8101" && break;
 973     loop_count=\$[\$loop_count+1];
 974     sleep 5;
 975 done
 976
 977 # This workaround is required for Karaf decanter to work proper
 978 # The bundle:refresh command does not fail if the decanter bundles are not present
 979 echo "ssh to karaf console to do bundle refresh of decanter jmx collector"
 980 sshpass -p karaf ssh -o StrictHostKeyChecking=no \
 981                      -o UserKnownHostsFile=/dev/null \
 982                      -o LogLevel=error \
 983                      -p 8101 karaf@localhost \
 984                      "bundle:refresh org.apache.karaf.decanter.collector.jmx && bundle:refresh org.apache.karaf.decanter.api"
 985
 986 if [[ "$USEFEATURESBOOT" != "True" ]]; then
 987
 988     echo "going to feature:install --no-auto-refresh ${SPACE_SEPARATED_FEATURES} one at a time"
 989     for feature in ${SPACE_SEPARATED_FEATURES}; do
 990         sshpass -p karaf ssh -o StrictHostKeyChecking=no \
 991                              -o UserKnownHostsFile=/dev/null \
 992                              -o LogLevel=error \
 993                              -p 8101 karaf@localhost \
 994                              feature:install --no-auto-refresh \$feature;
 995     done
 996
 997     echo "ssh to karaf console to list -i installed features"
 998     sshpass -p karaf ssh -o StrictHostKeyChecking=no \
 999                          -o UserKnownHostsFile=/dev/null \
1000                          -o LogLevel=error \
1001                          -p 8101 karaf@localhost \
1002                          feature:list -i
1003 fi
1004
1005 echo "Waiting up to 3 minutes for controller to come up, checking every 5 seconds..."
1006 for i in {1..36}; do
1007     sleep 5;
1008     grep 'org.opendaylight.infrautils.*System ready' /tmp/${BUNDLEFOLDER}/data/log/karaf.log
1009     if [ \$? -eq 0 ]; then
1010         echo "Controller is UP"
1011         break
1012     fi
1013 done;
1014
1015 # if we ended up not finding ready status in the above loop, we can output some debugs
1016 grep 'org.opendaylight.infrautils.*System ready' /tmp/${BUNDLEFOLDER}/data/log/karaf.log
1017 if [ \$? -ne 0 ]; then
1018     echo "Timeout Controller DOWN"
1019     echo "Dumping first 500K bytes of karaf log..."
1020     head --bytes=500K "/tmp/${BUNDLEFOLDER}/data/log/karaf.log"
1021     echo "Dumping last 500K bytes of karaf log..."
1022     tail --bytes=500K "/tmp/${BUNDLEFOLDER}/data/log/karaf.log"
1023     echo "Listing all open ports on controller system"
1024     netstat -pnatu
1025     exit 1
1026 fi
1027
1028 echo "Listing all open ports on controller system..."
1029 netstat -pnatu
1030
1031 function exit_on_log_file_message {
1032     echo "looking for \"\$1\" in log file"
1033     if grep --quiet "\$1" "/tmp/${BUNDLEFOLDER}/data/log/karaf.log"; then
1034         echo ABORTING: found "\$1"
1035         echo "Dumping first 500K bytes of karaf log..."
1036         head --bytes=500K "/tmp/${BUNDLEFOLDER}/data/log/karaf.log"
1037         echo "Dumping last 500K bytes of karaf log..."
1038         tail --bytes=500K "/tmp/${BUNDLEFOLDER}/data/log/karaf.log"
1039         exit 1
1040     fi
1041 }
1042
1043 exit_on_log_file_message 'BindException: Address already in use'
1044 exit_on_log_file_message 'server is unhealthy'
1045 EOF
1046 # cat > ${WORKSPACE}/post-startup-script.sh <<EOF
1047 }
1048
1049 # Copy over the configuration script and configuration files to each controller
1050 # Execute the configuration script on each controller.
1051 function copy_and_run_configuration_script() {
1052     for i in $(seq 1 "${NUM_ODL_SYSTEM}"); do
1053         CONTROLLERIP="ODL_SYSTEM_${i}_IP"
1054         echo "Configuring member-${i} with IP address ${!CONTROLLERIP}"
1055         scp "${WORKSPACE}"/configuration-script.sh "${!CONTROLLERIP}":/tmp/
1056         # $i needs to be parsed client-side
1057         # shellcheck disable=SC2029
1058         ssh "${!CONTROLLERIP}" "bash /tmp/configuration-script.sh ${i}"
1059     done
1060 }
1061
1062 # Copy over the startup script to each controller and execute it.
1063 function copy_and_run_startup_script() {
1064     for i in $(seq 1 "${NUM_ODL_SYSTEM}"); do
1065         CONTROLLERIP="ODL_SYSTEM_${i}_IP"
1066         echo "Starting member-${i} with IP address ${!CONTROLLERIP}"
1067         scp "${WORKSPACE}"/startup-script.sh "${!CONTROLLERIP}":/tmp/
1068         ssh "${!CONTROLLERIP}" "bash /tmp/startup-script.sh"
1069     done
1070 }
1071
1072 function copy_and_run_post_startup_script() {
1073     seed_index=1
1074     for i in $(seq 1 "${NUM_ODL_SYSTEM}"); do
1075         CONTROLLERIP="ODL_SYSTEM_${i}_IP"
1076         echo "Execute the post startup script on controller ${!CONTROLLERIP}"
1077         scp "${WORKSPACE}"/post-startup-script.sh "${!CONTROLLERIP}":/tmp/
1078         # $seed_index needs to be parsed client-side
1079         # shellcheck disable=SC2029
1080         ssh "${!CONTROLLERIP}" "bash /tmp/post-startup-script.sh $(( seed_index++ ))"
1081         if [ $(( i % NUM_ODL_SYSTEM )) == 0 ]; then
1082             seed_index=1
1083         fi
1084     done
1085 }
1086
1087 function dump_controller_threads() {
1088     for i in $(seq 1 "${NUM_ODL_SYSTEM}"); do
1089         CONTROLLERIP="ODL_SYSTEM_${i}_IP"
1090         echo "Let's take the karaf thread dump"
1091         ssh "${!CONTROLLERIP}" "sudo ps aux" > "${WORKSPACE}"/ps_before.log
1092         pid=$(grep org.apache.karaf.main.Main "${WORKSPACE}"/ps_before.log | grep -v grep | tr -s ' ' | cut -f2 -d' ')
1093         echo "karaf main: org.apache.karaf.main.Main, pid:${pid}"
1094         # $i needs to be parsed client-side
1095         # shellcheck disable=SC2029
1096         ssh "${!CONTROLLERIP}" "${JAVA_HOME}/bin/jstack -l ${pid}" > "${WORKSPACE}/karaf_${i}_${pid}_threads_before.log" || true
1097     done
1098 }
1099
1100 # Function to build OVS from git repo
1101 function build_ovs() {
1102     local -r ip=$1
1103     local -r version=$2
1104     local -r rpm_path="$3"
1105
1106     echo "Building OVS ${version} on ${ip} ..."
1107     cat > "${WORKSPACE}"/build_ovs.sh << EOF
1108 set -ex -o pipefail
1109
1110 echo '---> Building openvswitch version ${version}'
1111
1112 # Install running kernel devel packages
1113 K_VERSION=\$(uname -r)
1114 YUM_OPTS="-y --disablerepo=* --enablerepo=base,updates,extra,C*-base,C*-updates,C*-extras"
1115 # Install centos-release to update vault repos from which to fetch
1116 # kernel devel packages
1117 sudo yum \${YUM_OPTS} install centos-release yum-utils @'Development Tools' rpm-build
1118 sudo yum \${YUM_OPTS} install kernel-{devel,headers}-\${K_VERSION}
1119
1120 TMP=\$(mktemp -d)
1121 pushd \${TMP}
1122
1123 git clone https://github.com/openvswitch/ovs.git
1124 cd ovs
1125
1126 if [ "${version}" = "v2.6.1-nsh" ]; then
1127     git checkout v2.6.1
1128     echo "Will apply nsh patches for OVS version 2.6.1"
1129     git clone https://github.com/yyang13/ovs_nsh_patches.git ../ovs_nsh_patches
1130     git apply ../ovs_nsh_patches/v2.6.1_centos7/*.patch
1131 else
1132     git checkout ${version}
1133 fi
1134
1135 # On early versions of OVS, flake warnings would fail the build.
1136 # Remove it.
1137 sudo pip uninstall -y flake8
1138
1139 # Get rid of sphinx dep as it conflicts with the already
1140 # installed one (via pip). Docs wont be built.
1141 sed -i "/BuildRequires:.*sphinx.*/d" rhel/openvswitch-fedora.spec.in
1142
1143 sed -e 's/@VERSION@/0.0.1/' rhel/openvswitch-fedora.spec.in > /tmp/ovs.spec
1144 sed -e 's/@VERSION@/0.0.1/' rhel/openvswitch-kmod-fedora.spec.in > /tmp/ovs-kmod.spec
1145 sed -e 's/@VERSION@/0.0.1/' rhel/openvswitch-dkms.spec.in > /tmp/ovs-dkms.spec
1146 sudo yum-builddep \${YUM_OPTS} /tmp/ovs.spec /tmp/ovs-kmod.spec /tmp/ovs-dkms.spec
1147 rm /tmp/ovs.spec /tmp/ovs-kmod.spec /tmp/ovs-dkms.spec
1148 ./boot.sh
1149 ./configure --build=x86_64-redhat-linux-gnu --host=x86_64-redhat-linux-gnu --with-linux=/lib/modules/\${K_VERSION}/build --program-prefix= --disable-dependency-tracking --prefix=/usr --exec-prefix=/usr --bindir=/usr/bin --sbindir=/usr/sbin --sysconfdir=/etc --datadir=/usr/share --includedir=/usr/include --libdir=/usr/lib64 --libexecdir=/usr/libexec --localstatedir=/var --sharedstatedir=/var/lib --mandir=/usr/share/man --infodir=/usr/share/info --enable-libcapng --enable-ssl --with-pkidir=/var/lib/openvswitch/pki PYTHON=/usr/bin/python2
1150 make rpm-fedora RPMBUILD_OPT="--without check"
1151 # Build dkms only for now
1152 # make rpm-fedora-kmod RPMBUILD_OPT='-D "kversion \${K_VERSION}"'
1153 rpmbuild -D "_topdir \$(pwd)/rpm/rpmbuild" -bb --without check rhel/openvswitch-dkms.spec
1154
1155 mkdir -p /tmp/ovs_rpms
1156 cp -r rpm/rpmbuild/RPMS/* /tmp/ovs_rpms/
1157
1158 popd
1159 rm -rf \${TMP}
1160 EOF
1161
1162     scp "${WORKSPACE}"/build_ovs.sh "${ip}":/tmp
1163     ${SSH} "${ip}" " bash /tmp/build_ovs.sh >> /tmp/install_ovs.txt 2>&1"
1164     scp -r "${ip}":/tmp/ovs_rpms/* "${rpm_path}/"
1165     ${SSH} "${ip}" "rm -rf /tmp/ovs_rpms"
1166 }
1167
1168 # Install OVS RPMs from yum repo
1169 function install_ovs_from_repo() {
1170     local -r ip=$1
1171     local -r rpm_repo="$2"
1172
1173     echo "Installing OVS from repo ${rpm_repo} on ${ip} ..."
1174     cat > "${WORKSPACE}"/install_ovs.sh << EOF
1175 set -ex -o pipefail
1176
1177 echo '---> Installing openvswitch from ${rpm_repo}'
1178
1179 # We need repoquery from yum-utils.
1180 sudo yum -y install yum-utils
1181
1182 # Get openvswitch packages offered by custom repo.
1183 # dkms package will have priority over kmod.
1184 OVS_REPO_OPTS="--repofrompath=ovs-repo,${rpm_repo} --disablerepo=* --enablerepo=ovs-repo"
1185 OVS_PKGS=\$(repoquery \${OVS_REPO_OPTS} openvswitch)
1186 OVS_SEL_PKG=\$(repoquery \${OVS_REPO_OPTS} openvswitch-selinux-policy)
1187 OVS_DKMS_PKG=\$(repoquery \${OVS_REPO_OPTS} openvswitch-dkms)
1188 OVS_KMOD_PKG=\$(repoquery \${OVS_REPO_OPTS} openvswitch-kmod)
1189 [ -n "\${OVS_SEL_PKG}" ] && OVS_PKGS="\${OVS_PKGS} \${OVS_SEL_PKG}"
1190 [ -n "\${OVS_DKMS_PKG}" ] && OVS_PKGS="\${OVS_PKGS} \${OVS_DKMS_PKG}"
1191 [ -z "\${OVS_DKMS_PKG}" ] && [ -n "\${OVS_KMOD_PKG}" ] && OVS_PKGS="\${OVS_PKGS} \${OVS_KMOD_PKG}"
1192
1193 # Bail with error if custom repo was provided but we could not
1194 # find suitable packages there.
1195 [ -z "\${OVS_PKGS}" ] && echo "No OVS packages found in custom repo." && exit 1
1196
1197 # Install kernel & devel packages for the openvswitch dkms package.
1198 if [ -n "\${OVS_DKMS_PKG}" ]; then
1199     # install centos-release to update vault repos from which to fetch
1200     # kernel devel packages
1201     sudo yum -y install centos-release
1202     K_VERSION=\$(uname -r)
1203     YUM_OPTS="-y --disablerepo=* --enablerepo=base,updates,extra,C*-base,C*-updates,C*-extras"
1204     sudo yum \${YUM_OPTS} install kernel-{headers,devel}-\${K_VERSION} @'Development Tools' python-six
1205 fi
1206
1207 PREV_MOD=\$(sudo modinfo -n openvswitch || echo '')
1208
1209 # Install OVS offered by custom repo.
1210 sudo yum-config-manager --add-repo "${rpm_repo}"
1211 sudo yum -y versionlock delete openvswitch-*
1212 sudo yum -y remove openvswitch-*
1213 sudo yum -y --nogpgcheck install \${OVS_PKGS}
1214 sudo yum -y versionlock add \${OVS_PKGS}
1215
1216 # Most recent OVS versions have some incompatibility with certain versions of iptables
1217 # This below line will overcome that problem.
1218 sudo modprobe openvswitch
1219
1220 # Start OVS and print details
1221 sudo systemctl start openvswitch
1222 sudo systemctl enable openvswitch
1223 sudo ovs-vsctl --retry -t 5 show
1224 sudo modinfo openvswitch
1225
1226 # dkms rpm install can fail silently (probably because the OVS version is
1227 # incompatible with the running kernel), verify module was updated.
1228 NEW_MOD=\$(sudo modinfo -n openvswitch || echo '')
1229 [ "\${PREV_MOD}" != "\${NEW_MOD}" ] || (echo "Kernel module was not updated" && exit 1)
1230 EOF
1231
1232     scp "${WORKSPACE}"/install_ovs.sh "${ip}":/tmp
1233     ${SSH} "${ip}" "bash /tmp/install_ovs.sh >> /tmp/install_ovs.txt 2>&1"
1234 }
1235
1236 # Install OVS RPMS from path
1237 function install_ovs_from_path() {
1238     local -r ip=$1
1239     local -r rpm_path="$2"
1240
1241     echo "Creating OVS RPM repo on ${ip} ..."
1242     ${SSH} "${ip}" "mkdir -p /tmp/ovs_rpms"
1243     scp -r "${rpm_path}"/* "${ip}":/tmp/ovs_rpms
1244     ${SSH} "${ip}" "sudo yum -y install createrepo && createrepo --database /tmp/ovs_rpms"
1245     install_ovs_from_repo "${ip}" file:/tmp/ovs_rpms
1246 }
1247
1248