blob: cfc525d076f52fa235bea3b97ff9db861c672fce [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.
// -----------------------------------------------------------------------
// 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/installVoltctl.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: Assign perms to fix access problems
// . /bin/sh: 1: /home/jenkins/.volt/config: Permission denied
// -----------------------------------------------------------------------
void fixPerms() {
enter('fixPerms')
sh(label : 'fixperms',
script : """
umask 022
declare volt_dir='~/.volt'
declare volt_cfg='~/.volt/config'
echo
echo "** Fixing perms: \$volt_cfg"
mkdir -p "\$volt_dir"
chmod -R u+w,go-rwx "\$volt_dir"
chmod u=rwx "\$volt_dir"
touch "\$volt_cfg"
/bin/ls -l "\$volt_dir"
""")
leave('fixPerms')
return
}
// -----------------------------------------------------------------------
// -----------------------------------------------------------------------
Boolean process(String branch) {
Boolean ans = true
enter('process')
// This logic seems odd given we branch & tag repositories
// for release so hilight non-frozen until we know for sure.
def released = [
// v1.9.1 - https://github.com/opencord/voltctl/releases/tag/untagged-cd611c39178f25b95a87
'voltha-2.12' : '1.8.45',
'voltha-2.11' : '1.8.45',
// https://github.com/opencord/voltctl/releases/tag/v1.7.6
'voltha-2.10' : '1.7.6',
'voltha-2.9' : '1.7.4',
'voltha-2.8' : '1.6.11',
]
boolean have_released = released.containsKey(branch)
boolean is_release = false
// TODO: Enable with parameter: RELEASE_VOLTHA=
boolean has_binding = binding.hasVariable('WORKSPACE')
// WIP: Probe to find out what is available
print("""
** have_released: ${have_released}
** has_binding: ${has_binding}
""")
// ---------------------------------------------
// Sanity check: released version must be frozen
// ---------------------------------------------
if (is_release && ! released.containsKey(branch)) {
// Fingers crossed: jenkins may rewrite the callstack.
String myname = this.class.getName()
String url = [
'https://docs.voltha.org/master',
'howto/release/installVoltctl.html',
].join('/')
String error = [
myname, 'ERROR:',
"Detected release version=[$branch]",
'but voltctl is not frozen.',
'',
'See Also:', url,
].join(' ')
throw new Exception(error) // groovylint-disable-line ThrowException
}
// --------------------------------
// General answer: latest available
// --------------------------------
if (! have_released) {
url = 'https://api.github.com/repos/opencord/voltctl/releases/latest'
get_version = [
"curl -sSL ${url}",
'jq -r .tag_name',
"sed -e 's/^v//g'",
].join(' | ')
print(" ** RUNNING: ${get_version}")
released[branch] = sh(
script: get_version,
returnStdout: true
).trim()
}
voltctlVersion = released[branch]
println "Installing voltctl version ${voltctlVersion} on branch ${branch}"
// -----------------------------------------------------------------------
// groovy expansion: ${var}
// shell expansion: \${var}
// -----------------------------------------------------------------------
sh(
label : 'Install Voltctl',
returnStdout: false,
script: """#!/bin/bash
# set -eu -o pipefail
bin_voltctl="$WORKSPACE/bin/voltctl"
mkdir -p "$WORKSPACE/bin"
cd "$WORKSPACE" || { echo "ERROR: cd $WORKSPACE failed"; exit 1; }
HOSTOS="\$(uname -s | tr '[:upper:]' '[:lower:]')"
HOSTARCH="\$(uname -m | tr '[:upper:]' '[:lower:]')"
if [ "\$HOSTARCH" == "x86_64" ]; then
HOSTARCH="amd64"
fi
# Retrieve versioned voltctl binary
download_url="https://github.com/opencord/voltctl/releases/download"
vol_ver="v${voltctlVersion}"
vol_name="voltctl-${voltctlVersion}-\${HOSTOS}-\${HOSTARCH}"
curl -o "\$bin_voltctl" -sSL "\${download_url}/\${vol_ver}/\${vol_name}"
chmod u=rwx,go=rx "\$bin_voltctl"
# ---------------------------------------------------------
# /usr/local/bin/voltctl --version != bin/voltctl --version
# Problem when default searchpath has not been modified.
# ---------------------------------------------------------
"\${bin_voltctl}" version --clientonly
voltctl version --clientonly
""")
enter('process')
return(ans)
}
// -----------------------------------------------------------------------
// -----------------------------------------------------------------------
def call(String branch) {
try {
enter('main')
fixPerms()
process(branch)
}
catch (Exception err) { // groovylint-disable-line CatchException
String iam = getIam('main')
println("** ${iam}: EXCEPTION ${err}")
throw err
}
finally {
leave('main')
}
return
}
// [EOF]