blob: 4604bca7b28a370d9f1423412fbee5febf720bb4 [file] [log] [blame]
#!/usr/bin/env groovy
// -----------------------------------------------------------------------
// Copyright 2021-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.
// -----------------------------------------------------------------------
// -----------------------------------------------------------------------
// -----------------------------------------------------------------------
String getIam(String func) {
// Cannot rely on a stack trace due to jenkins manipulation
String src = 'vars/waitForAdapters.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
}
// -----------------------------------------------------------------------
// -----------------------------------------------------------------------
def getAdapters() {
String adapters = ''
try {
adapters = sh(
script: 'voltctl adapter list --format "{{gosince .LastCommunication}}"',
returnStdout: true,
).trim()
}
catch (err) {
// in some older versions of voltctl the command results in
// ERROR: Unexpected error while attempting to format results
// as table : template: output:1: function "gosince" not defined
// if that's the case we won't be able to check the timestamp so
// it's useless to wait
println("voltctl can't parse LastCommunication, skip waiting")
adapters = 'SKIP' // why not just retry a few times (?)
}
leave("returned $adapters")
return adapters
}
// -----------------------------------------------------------------------
// Intent: Interrogate adapter states to determine if we should continue
// looping waiting for adapter to start. Passed values must all be
// Integral, Valid and within range to assert we are done waiting.
// Function will return incomplete at the first sign of an invalid value.
// -----------------------------------------------------------------------
// NOTE: list.find{} was replaced with a for loop to simplify
// early loop termination and return.
// -----------------------------------------------------------------------
// RETURN: scalar
// 'DOUBLE-DIGIT' - value exceeds 0-5sec response window.
// 'NON-NUMERIC' - garbage in the stream (letter, symbol, ctrl)
// 'NULL' - empty or null string detected
// 'VALID' - succes, all adapters are functional
// 'SIX-NINE' - detected a single numeric digit between 6 and 9.
// -----------------------------------------------------------------------
def getAdaptersState(String adapters0)
{
String iam = getIam('getAdaptersState')
Boolean debug = true // for now
def adapters = adapters0.split('\n')
String ans = null
def found = []
for(i=0; i<adapters.size(); i++) {
String elapsed = adapters[i]
if (debug) {
println("** ${iam} Checking elapsed[$i]: $elapsed")
}
if (! elapsed) { // empty string or null
ans = 'NULL'
break
}
Integer size = elapsed.length()
if (size > 2) { // 463765h58m52(s)
// higlander: there can be only one
ans = 'DOUBLE-DIGIT'
break
}
if (elapsed.endsWith('s')) {
// safer than replaceAll('s'): ssss1s => 1
elapsed = elapsed.substring(0, size-1)
}
// Line noise guard: 'a', 'f', '#', '!'
if (! elapsed.isInteger()) {
ans = 'NON-NUMERIC'
break
}
// Is value in range:
// discard negative integers as just plain wonky.
// HMMM(?): zero/no latency response is kinda odd to include imho.
Integer val = elapsed.toInteger()
if (5 >= val && val >= 0) {
found.add(elapsed)
}
else {
ans = 'SIX-NINE'
break
}
} // for()
// Declare success IFF all values are:
// o integral
// o valid
// o within range
if (ans == null) {
Integer got = found.size()
Integer exp = adapters.size()
ans = (! exp) ? 'NO-ADAPTERS'
: (got == exp) ? 'VALID'
: 'CONTINUE'
}
if (debug) {
leave("return: [$ans]")
}
return ans
} // getAdaptersState
// -----------------------------------------------------------------------
// Intent: Poll until adapter status is known.
// -----------------------------------------------------------------------
def process(Map config) {
String iam = getIam('process')
enter('process')
def defaultConfig = [
volthaNamespace : 'voltha',
stackName : 'voltha',
adaptersToWait : 2,
]
def cfg = defaultConfig + config
if (cfg.adaptersToWait == 0) {
//no need to wait
println "No need to wait for adapters to be registered"
return
}
println("** ${iam}: Wait for adapters to be registered")
// guarantee that at least the specified number of adapters are registered with VOLTHA before proceeding
sh(label : 'waitForAdapters: loop until adapter list',
script : """
# set +x
adapters=\$(voltctl adapter list -q | wc -l)
while [[ \$adapters -lt ${cfg.adaptersToWait} ]]; do
sleep 5
adapters=\$(voltctl adapter list -q | wc -l)
done
cat << EOM
** -----------------------------------------------------------------------
** ${iam}: Available adapters:
** -----------------------------------------------------------------------
EOM
voltctl adapter list -q
""")
// NOTE that we need to wait for LastCommunication to be equal or shorter that 5s
// as that means the core can talk to the adapters
// if voltctl can't read LastCommunication we skip this check
println("** ${iam}: Wait for adapter LastCommunication")
Integer countdown = 60 * 10
while (true) {
sleep 1
def adapters = getAdapters()
// Why are we not failing hard on this condition ?
// Adapters in an unknown state == testing: roll the dice
if (adapters == 'SKIP') { break }
def state = getAdaptersState(adapters)
if (state == 'VALID') { break } // IFF
// ----------------------------------------------------------
// Excessive timeout but unsure where startup time boundry is
// [TODO] profile for a baseline
// [TODO] groovy.transform.TimedInterrupt
// ----------------------------------------------------------
countdown -= 1
if (1 > countdown) {
throw new Exception('ERROR: Timed out waiting on adapter startup')
}
}
println("** ${iam}: Tearing down port forwarding")
Map pkpfArgs =\
[
'banner' : true, // display banner for logging
'show_procs' : true, // display procs under consideration
'filler' : true // fix conditional trailing comma
]
// [TODO] 'kubectl.*port-forward'
pkill_port_forward('port-forward', pkpfArgs)
leave('process')
return
}
// -----------------------------------------------------------------------
// -----------------------------------------------------------------------
def call(Map config=[:])
{
try {
enter('main')
process(config)
}
catch (Exception err) { // groovylint-disable-line CatchException
String iam = getIam('process')
println("** ${iam}: EXCEPTION ${err}")
throw err
}
finally {
leave('main')
}
return
}
// [EOF]