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