[VOL-5170] - Test debugging openolt-adapter-sanity-test-voltha
jjb/pipeline/voltha/voltha-2.12/bbsim-tests.groovy
--------------------------------------------------
o More debugging added around Create K8s Cluster, port forwarding failure.
o sh(label:'foo') more shell commands.
o Replace inlined pgrep/pkill commands with vars/p{grep,kill} scripts calls.
o Refactor port-forward cleanup logic into a named function.
o job post() routines augmented to call port cleanup function.
vars/pkill_port_forward.groovy
------------------------------
o Common port-forward script logic to display and kill procs if running.
Change-Id: Icc9d9dcbafd376926b95265bf2574b0dfd53baa8
diff --git a/vars/pkill_port_forward.groovy b/vars/pkill_port_forward.groovy
new file mode 100644
index 0000000..8b2be6f
--- /dev/null
+++ b/vars/pkill_port_forward.groovy
@@ -0,0 +1,149 @@
+#!/usr/bin/env groovy
+// -----------------------------------------------------------------------
+// Copyright 2023 Open Networking Foundation (ONF) and the ONF Contributors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// -----------------------------------------------------------------------
+// Install the voltctl command by branch name "voltha-xx"
+// -----------------------------------------------------------------------
+
+// -----------------------------------------------------------------------
+// -----------------------------------------------------------------------
+String getIam(String func) {
+ // Cannot rely on a stack trace due to jenkins manipulation
+ String src = 'vars/pkill_port_forward.groovy'
+ String iam = [src, func].join('::')
+ return iam
+}
+
+// -----------------------------------------------------------------------
+// Intent: Log progress message
+// -----------------------------------------------------------------------
+void enter(String name) {
+ // Announce ourselves for log usability
+ String iam = getIam(name)
+ println("${iam}: ENTER")
+ return
+}
+
+// -----------------------------------------------------------------------
+// Intent: Log progress message
+// -----------------------------------------------------------------------
+void leave(String name) {
+ // Announce ourselves for log usability
+ String iam = getIam(name)
+ println("${iam}: LEAVE")
+ return
+}
+
+// -----------------------------------------------------------------------
+// Intent: Terminate a process by name.
+// -----------------------------------------------------------------------
+// Note: Due to an exception casting GString to java.lang.string:
+// - Used for parameterized construction of a command line with args
+// - Passed to jenkins sh("${cmd}")
+// - Command line invoked is currently hardcoded.
+// -----------------------------------------------------------------------
+Boolean process(String proc, Map args) {
+ Boolean ans = true
+ String iam = getIam('process')
+
+ println("** ${iam}: args passed: ${args}")
+
+ String cmd = [
+ 'pkill',
+ '--uid', '$(id -u)', // no stray signals
+ '--list-full',
+ '--full', // hmmm: conditional use (?)
+ "'${proc}",
+ ]
+
+ if (args['banner']) {
+ print("""
+** -----------------------------------------------------------------------
+** Running: $cmd
+** -----------------------------------------------------------------------
+""")
+ }
+
+ if (args['show_procs']) {
+ sh(
+ label : 'Display port forwarding (pre-pgrep-pkill)',
+ script : """
+pgrep --uid \$(uid -u) --list-full --full 'port-forw'
+""")
+ }
+
+ sh(
+ label : 'Display port forwarding',
+ // script : ${cmd}.toString(), -> Exception
+ script : """
+echo -e "\n** ${iam} [DEBUG]: pgrep-pkill check"
+if [[ \$(pgrep --count 'port-forw') -gt 0 ]]; then
+ pkill --uid \$(uid -u) --echo --list-full --full 'port-forw'
+fi
+""")
+
+ return(ans)
+}
+
+// -----------------------------------------------------------------------
+// Install: Display a list of port-forwarding processes.
+// -----------------------------------------------------------------------
+// groovylint-disable-next-line None, UnusedMethodParameter
+Boolean call\
+(
+ String proc, // name of process or arguments to terminate
+ Map args=[:],
+ Boolean filler = true // Groovy, why special case list comma handling (?)
+) {
+ Boolean ans = true
+
+ try {
+ enter('main')
+
+ // Assign defaults
+ ['banner', 'show_procs'].each{ key->
+ if (!args.containsKey(key)) {
+ args[key] = true
+ }
+ }
+
+ process(proc, args)
+ }
+ catch (Exception err) { // groovylint-disable-line CatchException
+ ans = false
+ println("** ${iam}: EXCEPTION ${err}")
+ throw err
+ }
+ finally {
+ enter('main')
+ }
+
+ return(ans)
+}
+
+/* groovylint-disable */
+
+// [SEE ALSO]
+// -----------------------------------------------------------------------
+// o String cmd = [ ... ].join('') -- GString cannot cast to java.String
+// o https://stackoverflow.com/questions/60304068/artifactory-in-jenkins-pipeline-org-codehaus-groovy-runtime-gstringimpl-cannot
+// -----------------------------------------------------------------------
+// [TODO] - Combine pkill_proc and pkill_proc
+// - Usage: do_proc(pkill=true, pkill=true, args='proc-forward', cmd='kubectl'
+// o When kill == grep == true: display procs, terminate, recheck: fatal if procs detected
+// o cmd && args (or command containing args) (or list of patterns passed)
+// - pass arg --full to match entire command line.
+// -----------------------------------------------------------------------
+// [EOF]