2 # shellcheck shell=bash
4 # SPDX-License-Identifier: EPL-1.0
5 ##############################################################################
6 # Copyright (c) 2019 The Linux Foundation and others.
8 # All rights reserved. This program and the accompanying materials
9 # are made available under the terms of the Eclipse Public License v1.0
10 # which accompanies this distribution, and is available at
11 # http://www.eclipse.org/legal/epl-v10.html
12 ##############################################################################
14 # A library of functions for LF/Jenkins bash scripts. In the general case, these
15 # functions should only use 'local' variables, and should NOT set
16 # shell/environment variables. If you want to make a variable available, provide
17 # a function that sets the variable: 'function lf_set_foo() {foo=asdf;}'. Any
18 # scripts that need access to the variable can call the 'set' function. This
19 # keeps the name-space pollution to a minimum.
21 # This script will be installed in ~jenkins by the Jenkins Init Script when the
22 # build agent boots. When the build starts it should already be installed.
24 ################################################################################
32 # lf-echo-stderr "this entire" "string will be sent to stderr"
35 # This function will echo all command line aruments to 'stderr'
40 ################################################################################
46 ################################################################################
52 # # shellcheck disable=SC1090
55 # if lf-boolean $VAR; then
60 # This function will return a BOOLEAN (true or false) based upon the value
61 # of VAR. The value of VAR will be mapped to lower case. If VAR maps to
62 # "true", return true(0). If VAR maps to "false", return false(1). Any
63 # other values will return false(2) and an error message.
69 ################################################################################
72 if (( $# != 1 )); then
73 echo "ERROR: ${FUNCNAME[0]}() line: ${BASH_LINENO[0]} : Missing Required Argument"
77 bool=$(echo "$1" | tr '[:upper:]' '[:lower:]')
82 lf-echo-stderr "ERROR: ${FUNCNAME[0]}() line:{BASH_LINENO[0]} : A boolean cannot be a empty string" >&2
86 lf-echo-stderr "ERROR: ${FUNCNAME[0]}() line: ${BASH_LINENO[0]} : Invalid value for a boolean: '$bool'"
92 ################################################################################
95 # lf-activate-venv [-p|--python python] [--no-path]
96 # [--system-site-packages] [package]...
99 # # shellcheck disable=SC1090
102 # lf-activate-venv tox tox-pyenv
104 # lf-activate-venv jenkins-job-builder
106 # lf-activate-venv lftools
108 # lf-activate-venv --python 3.6 git-review
111 # This function will create a new Python Virtual Environment (venv) and
112 # install the specified packages in the new venv. The venv will be installed
113 # in $lf_venv and by default, the $lf_venv/bin directory will be prepended
116 # The 'lf_venv' variable will be set so you can directly execute commands
117 # in the venv with: $lf_venv/bin/command. Beware that subsequent calls to
118 # lf-activate-venv() will overwrite 'lf_venv'.
120 # By default all packages are installed with '--upgrade-strategy eager'.
121 # The venv will always contain pip & virtualenv.
123 # Some packages have a default version. If one of those packages is specified,
124 # the 'version' specifier will be added for the install. If the version is
125 # specified on the command line that version will be used.
126 # The following packages have default versions:
128 # jenkins-job-builder $JJB_VERSION
130 # If the --python flag is specified, the specified python executable will be
131 # used to create the venv. The --python option must be in the PATH. The venv
132 # will be located in $lf_venv (/tmp/venv-####).
134 # If the --no-path flag is specified, $lf_venv/bin will not be prepended to
137 # If the --system-site-packages flag is specified, the --system-site-packages
138 # flag will be passed to the inital 'pip install' (python3* only).
144 ################################################################################
146 lf-activate-venv () {
147 lf_venv=$(mktemp -d /tmp/venv-XXXX)
151 local install_args=""
152 options=$(getopt -o 'n:p:' -l 'no-path,python:,system-site-packages' -n "${FUNCNAME[0]}" -- "$@" )
153 eval set -- "$options"
156 -n|--no-path) set_path=false ; shift ;;
157 -p|--python) python=$2 ; shift 2 ;;
158 --system-site-packages) install_args="--system-site-packages" ; shift ;;
160 *) lf-echo-stderr "${FUNCNAME[0]}(): ERROR: Unknown switch '$1'." ; return 1 ;;
163 if ! type "$python" > /dev/null; then
164 lf-echo-stderr "${FUNCNAME[0]}(): ERROR: Unknown Python: $python"
168 echo "${FUNCNAME[0]}(): INFO: Creating $python venv at $lf_venv"
173 # For Python2, just create venv and install pip
174 virtualenv -p "$python" "$lf_venv" || return 1
175 "$lf_venv/bin/pip" install --upgrade --quiet pip || return 1
176 if [[ -z $pkg_list ]]; then
177 echo "${FUNCNAME[0]}(): WARNING: No packages to install"
180 echo "${FUNCNAME[0]}(): INFO: Installing: $pkg_list"
181 # $pkg_list is expected to be unquoted
182 # shellcheck disable=SC2086
183 "$lf_venv/bin/pip" install --upgrade --quiet $pkg_list || return 1
187 # Add version specifier for some packages
190 jenkins-job-builder) pkg_list+="jenkins-job-builder==${JJB_VERSION:-2.8.0} " ;;
191 *) pkg_list+="$arg " ;;
194 $python -m venv "$install_args" "$lf_venv" || return 1
195 "$lf_venv/bin/pip" install --upgrade --quiet pip virtualenv || return 1
196 if [[ -z $pkg_list ]]; then
197 echo "${FUNCNAME[0]}(): WARNING: No packages to install"
200 echo "${FUNCNAME[0]}(): INFO: Installing: $pkg_list"
201 # $pkg_list is expected to be unquoted
202 # shellcheck disable=SC2086
203 "$lf_venv/bin/pip" install --upgrade --quiet --upgrade-strategy eager \
204 $pkg_list || return 1
207 lf-echo-stderr "${FUNCNAME[0]}(): ERROR: No support for: $python"
212 echo "${FUNCNAME[0]}(): INFO: Adding $lf_venv/bin to PATH"
213 PATH=$lf_venv/bin:$PATH
216 echo "${FUNCNAME[0]}(): INFO: Path not set, lf_venv set to: $lf_venv"
219 } # End lf-activate-venv
221 ################################################################################
224 # lf-git-validate-jira-urls
227 # # shellcheck disable=SC1090
230 # lf-git-validate-jira-urls
233 # Check for JIRA URLS in the commit message
239 ################################################################################
241 lf-git-validate-jira-urls () {
242 echo "Checking for JIRA URLs in commit message..."
243 # if JIRA_URL is not defined, nothing to do
244 if [[ -v JIRA_URL ]]; then
245 base_url=$(echo "$JIRA_URL" | awk -F'/' '{print $3}')
246 jira_link=$(git rev-list --format=%B --max-count=1 HEAD | grep -io "http[s]*://$base_url/" || true)
247 if [[ -n $jira_link ]]; then
248 lf-echo-stderr "${FUNCNAME[0]}(): ERROR: JIRA URL found in commit message"
249 lf-echo-stderr 'Add jira references as: Issue: <JIRAKEY>-<ISSUE#>, instead of URLs'
253 echo "${FUNCNAME[0]}(): WARNING: JIRA_URL not set, continuing anyway"
258 ################################################################################
264 # # shellcheck disable=SC1090
270 # Check for JJB YAML files containing non-printable ascii characters. This
271 # function must be run from the top of the global-jjb repo.
277 ################################################################################
279 lf-jjb-check-ascii () {
280 if [[ ! -d "jjb" ]]; then
281 lf-echo-stderr "${FUNCNAME[0]}(): ERROR: missing jjb directory"
282 lf-echo-stderr "This function can only be run from top of global-jjb directory"
285 if LC_ALL=C grep -I -r '[^[:print:][:space:]]' jjb/; then
286 lf-echo-stderr "${FUNCNAME[0]}(): ERROR: Found YAML files containing non-printable characters."
289 echo "${FUNCNAME[0]}(): INFO: All JJB YAML files contain only printable ASCII characters"
293 ################################################################################
294 # Functions that assign Variables
295 ################################################################################
297 # These variables are shell (local) variables and need to be lower-case so
298 # Shellcheck knows they are shell variables and will check for
301 lf-set-maven-options () {
302 # Disable 'unused-variable' check
303 # shellcheck disable=SC2034
304 maven_options="--show-version --batch-mode -Djenkins \
305 -Dorg.slf4j.simpleLogger.log.org.apache.maven.cli.transfer.Slf4jMavenTransferListener=warn \
306 -Dmaven.repo.local=/tmp/r -Dorg.ops4j.pax.url.mvn.localRepository=/tmp/r"