blob: 14057b9a58bcf21871cd5a7aba268b511ba2cb6f [file] [log] [blame]
Joey Armstrong97643b32022-11-14 17:33:27 -05001#!/usr/bin/env groovy
Joey Armstrong379660e2022-12-14 19:21:00 -05002// -----------------------------------------------------------------------
Joey Armstrongaf679da2023-01-31 14:22:41 -05003// Copyright 2021-2023 Open Networking Foundation (ONF) and the ONF Contributors
4//
5// Licensed under the Apache License, Version 2.0 (the "License");
6// you may not use this file except in compliance with the License.
7// You may obtain a copy of the License at
8//
9// http://www.apache.org/licenses/LICENSE-2.0
10//
11// Unless required by applicable law or agreed to in writing, software
12// distributed under the License is distributed on an "AS IS" BASIS,
13// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14// See the License for the specific language governing permissions and
15// limitations under the License.
16// -----------------------------------------------------------------------
Joey Armstrong379660e2022-12-14 19:21:00 -050017// Install the voltctl command by branch name "voltha-xx"
18// -----------------------------------------------------------------------
Joey Armstrong97643b32022-11-14 17:33:27 -050019
Joey Armstrong379660e2022-12-14 19:21:00 -050020// -----------------------------------------------------------------------
21// -----------------------------------------------------------------------
Joey Armstrong97af2192023-09-05 17:06:41 -040022String getIam(String func) {
Joey Armstrong379660e2022-12-14 19:21:00 -050023 // Cannot rely on a stack trace due to jenkins manipulation
24 String src = 'vars/installVoltctl.groovy'
25 String iam = [src, func].join('::')
26 return iam
27}
28
29// -----------------------------------------------------------------------
Joey Armstrong97af2192023-09-05 17:06:41 -040030// Intent: Log progress message
31// -----------------------------------------------------------------------
32void enter(String name) {
33 // Announce ourselves for log usability
34 String iam = getIam(name)
35 println("${iam}: ENTER")
36 return
37}
38
39// -----------------------------------------------------------------------
40// Intent: Log progress message
41// -----------------------------------------------------------------------
42void leave(String name) {
43 // Announce ourselves for log usability
44 String iam = getIam(name)
45 println("${iam}: LEAVE")
46 return
47}
48
49// -----------------------------------------------------------------------
Joey Armstrong379660e2022-12-14 19:21:00 -050050// -----------------------------------------------------------------------
Joey Armstrong97af2192023-09-05 17:06:41 -040051Boolean process(String branch) {
52 Boolean ans = true
53 enter('process')
Joey Armstrong299f1f32022-11-24 08:45:25 -050054
Joey Armstrong97643b32022-11-14 17:33:27 -050055 // This logic seems odd given we branch & tag repositories
56 // for release so hilight non-frozen until we know for sure.
Joey Armstronge0ed0352023-09-05 19:00:50 -040057 def released = [
Joey Armstrong9d35c0f2023-08-25 21:35:54 -040058 // v1.9.1 - https://github.com/opencord/voltctl/releases/tag/untagged-cd611c39178f25b95a87
59 'voltha-2.12' : '1.8.45',
60 'voltha-2.11' : '1.8.45',
61 // https://github.com/opencord/voltctl/releases/tag/v1.7.6
62 'voltha-2.10' : '1.7.6',
63 'voltha-2.9' : '1.7.4',
64 'voltha-2.8' : '1.6.11',
Joey Armstrong97643b32022-11-14 17:33:27 -050065 ]
Matteo Scandolob47a6fd2021-10-27 17:02:49 -070066
Joey Armstrong97643b32022-11-14 17:33:27 -050067 boolean have_released = released.containsKey(branch)
68 boolean is_release = false
69 // TODO: Enable with parameter: RELEASE_VOLTHA=
70 boolean has_binding = binding.hasVariable('WORKSPACE')
Matteo Scandolob47a6fd2021-10-27 17:02:49 -070071
Joey Armstrong97643b32022-11-14 17:33:27 -050072 // WIP: Probe to find out what is available
Joey Armstrong96158a92022-11-25 10:36:06 -050073 print("""
74** have_released: ${have_released}
75** has_binding: ${has_binding}
76""")
Matteo Scandolob47a6fd2021-10-27 17:02:49 -070077
Joey Armstrong97643b32022-11-14 17:33:27 -050078 // ---------------------------------------------
79 // Sanity check: released version must be frozen
80 // ---------------------------------------------
81 if (is_release && ! released.containsKey(branch)) {
Joey Armstrong9d35c0f2023-08-25 21:35:54 -040082 // Fingers crossed: jenkins may rewrite the callstack.
Joey Armstrong97af2192023-09-05 17:06:41 -040083 String myname = this.class.getName()
Joey Armstrong97643b32022-11-14 17:33:27 -050084
Joey Armstrong9d35c0f2023-08-25 21:35:54 -040085 String url = [
86 'https://docs.voltha.org/master',
87 'howto/release/installVoltctl.html',
88 ].join('/')
Joey Armstrong97643b32022-11-14 17:33:27 -050089
Joey Armstrong9d35c0f2023-08-25 21:35:54 -040090 String error = [
Joey Armstrong97af2192023-09-05 17:06:41 -040091 myname, 'ERROR:',
Joey Armstrong9d35c0f2023-08-25 21:35:54 -040092 "Detected release version=[$branch]",
Joey Armstrong97af2192023-09-05 17:06:41 -040093 'but voltctl is not frozen.',
Joey Armstrong9d35c0f2023-08-25 21:35:54 -040094 '',
Joey Armstrong97af2192023-09-05 17:06:41 -040095 'See Also:', url,
Joey Armstrong9d35c0f2023-08-25 21:35:54 -040096 ].join(' ')
Joey Armstrong97af2192023-09-05 17:06:41 -040097 throw new Exception(error) // groovylint-disable-line ThrowException
Joey Armstrong97643b32022-11-14 17:33:27 -050098 }
99
100 // --------------------------------
101 // General answer: latest available
102 // --------------------------------
103 if (! have_released) {
Joey Armstrong9d35c0f2023-08-25 21:35:54 -0400104 url = 'https://api.github.com/repos/opencord/voltctl/releases/latest'
105 get_version = [
106 "curl -sSL ${url}",
Joey Armstrong97af2192023-09-05 17:06:41 -0400107 'jq -r .tag_name',
Joey Armstrong9d35c0f2023-08-25 21:35:54 -0400108 "sed -e 's/^v//g'",
109 ].join(' | ')
110
111 print(" ** RUNNING: ${get_version}")
Joey Armstrong97af2192023-09-05 17:06:41 -0400112 released[branch] = sh(
Joey Armstrong9d35c0f2023-08-25 21:35:54 -0400113 script: get_version,
114 returnStdout: true
115 ).trim()
Joey Armstrong97643b32022-11-14 17:33:27 -0500116 }
117
118 voltctlVersion = released[branch]
119 println "Installing voltctl version ${voltctlVersion} on branch ${branch}"
120
121 // -----------------------------------------------------------------------
122 // groovy expansion: ${var}
123 // shell expansion: \${var}
124 // -----------------------------------------------------------------------
Joey Armstrong97af2192023-09-05 17:06:41 -0400125 sh(
126 label : 'Install Voltctl',
127 returnStdout: false,
128 script: """#!/bin/bash
Joey Armstrong97643b32022-11-14 17:33:27 -0500129
Joey Armstrong97af2192023-09-05 17:06:41 -0400130 # set -eu -o pipefail
Joey Armstrong97643b32022-11-14 17:33:27 -0500131
132 bin_voltctl="$WORKSPACE/bin/voltctl"
133
134 mkdir -p "$WORKSPACE/bin"
135 cd "$WORKSPACE" || { echo "ERROR: cd $WORKSPACE failed"; exit 1; }
136
137 HOSTOS="\$(uname -s | tr '[:upper:]' '[:lower:]')"
138 HOSTARCH="\$(uname -m | tr '[:upper:]' '[:lower:]')"
139 if [ "\$HOSTARCH" == "x86_64" ]; then
Hardik Windlass9658cd22021-10-25 11:13:25 +0000140 HOSTARCH="amd64"
141 fi
Joey Armstrong97643b32022-11-14 17:33:27 -0500142
143 # Retrieve versioned voltctl binary
144 download_url="https://github.com/opencord/voltctl/releases/download"
145 vol_ver="v${voltctlVersion}"
146 vol_name="voltctl-${voltctlVersion}-\${HOSTOS}-\${HOSTARCH}"
Joey Armstrongb2f89812022-11-24 08:09:40 -0500147 curl -o "\$bin_voltctl" -sSL "\${download_url}/\${vol_ver}/\${vol_name}"
Joey Armstrong97643b32022-11-14 17:33:27 -0500148
Joey Armstronga935e712022-11-24 08:03:15 -0500149 chmod u=rwx,go=rx "\$bin_voltctl"
Joey Armstrong97643b32022-11-14 17:33:27 -0500150
Joey Armstrong379660e2022-12-14 19:21:00 -0500151 # ---------------------------------------------------------
152 # /usr/local/bin/voltctl --version != bin/voltctl --version
153 # Problem when default searchpath has not been modified.
154 # ---------------------------------------------------------
Joey Armstronga935e712022-11-24 08:03:15 -0500155 "\${bin_voltctl}" version --clientonly
Hardik Windlass9658cd22021-10-25 11:13:25 +0000156 voltctl version --clientonly
Joey Armstrong97af2192023-09-05 17:06:41 -0400157""")
Joey Armstrong299f1f32022-11-24 08:45:25 -0500158
Roger Luethiff337d82023-09-20 12:09:44 +0200159 leave('process')
Joey Armstrong97af2192023-09-05 17:06:41 -0400160 return(ans)
Hardik Windlass9658cd22021-10-25 11:13:25 +0000161}
Joey Armstrong97643b32022-11-14 17:33:27 -0500162
Joey Armstrong379660e2022-12-14 19:21:00 -0500163// -----------------------------------------------------------------------
164// -----------------------------------------------------------------------
Joey Armstrong97af2192023-09-05 17:06:41 -0400165def call(String branch) {
166 try {
167 enter('main')
Joey Armstrong9d35c0f2023-08-25 21:35:54 -0400168 process(branch)
Joey Armstrong379660e2022-12-14 19:21:00 -0500169 }
Joey Armstrong97af2192023-09-05 17:06:41 -0400170 catch (Exception err) { // groovylint-disable-line CatchException
171 String iam = getIam('main')
Joey Armstrong9d35c0f2023-08-25 21:35:54 -0400172 println("** ${iam}: EXCEPTION ${err}")
173 throw err
Joey Armstrong379660e2022-12-14 19:21:00 -0500174 }
Joey Armstrong97af2192023-09-05 17:06:41 -0400175 finally {
176 leave('main')
Joey Armstrong379660e2022-12-14 19:21:00 -0500177 }
178 return
179}
180
Joey Armstrong97643b32022-11-14 17:33:27 -0500181// [EOF]