X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=blobdiff_plain;f=jenkins-init-scripts%2Flf-env.sh;h=da51d4b9fd55629c8fd776e3ae6b8ce05abab6e4;hb=4289661f9299da56de34e5ccfe2a6732eb565889;hp=f0341f345f4e7c5307b0cd1eff9e13ef641f4217;hpb=e0d89dd8e2e6ab0a31b300ef64589cb513e1550c;p=releng%2Fglobal-jjb.git diff --git a/jenkins-init-scripts/lf-env.sh b/jenkins-init-scripts/lf-env.sh index f0341f34..da51d4b9 100644 --- a/jenkins-init-scripts/lf-env.sh +++ b/jenkins-init-scripts/lf-env.sh @@ -1,4 +1,5 @@ #!/usr/bin/no-execute +# shellcheck shell=bash # SPDX-License-Identifier: EPL-1.0 ############################################################################## @@ -9,14 +10,17 @@ # which accompanies this distribution, and is available at # http://www.eclipse.org/legal/epl-v10.html ############################################################################## - +# # A library of functions for LF/Jenkins bash scripts. In the general case, these # functions should only use 'local' variables, and should NOT set # shell/environment variables. If you want to make a variable available, provide # a function that sets the variable: 'function lf_set_foo() {foo=asdf;}'. Any # scripts that need access to the variable can call the 'set' function. This # keeps the name-space pollution to a minimum. - +# +# This script will be installed in ~jenkins by the Jenkins Init Script when the +# build agent boots. When the build starts it should already be installed. +# ################################################################################ # # Name: lf-echo-stderr @@ -86,7 +90,8 @@ function lf-boolean() ################################################################################ # # NAME -# lf-activate-venv [-p|--python python] [package]... +# lf-activate-venv [-p|--python python] [--no-path] +# [--system-site-packages] [package]... # # SYNOPSIS # # shellcheck disable=SC1090 @@ -102,8 +107,13 @@ function lf-boolean() # # DESCRIPTION # This function will create a new Python Virtual Environment (venv) and -# install the specified packages in the new venv. The bin directory from the -# venv will be prepended to the PATH. +# install the specified packages in the new venv. The venv will be installed +# in $lf_venv and by default, the $lf_venv/bin directory will be prepended +# to the PATH. +# +# The 'lf_venv' variable will be set so you can directly execute commands +# in the venv with: $lf_venv/bin/command. Beware that subsequent calls to +# lf-activate-venv() will overwrite 'lf_venv'. # # By default all packages are installed with '--upgrade-strategy eager'. # The venv will always contain pip & virtualenv. @@ -115,9 +125,15 @@ function lf-boolean() # Package Version # jenkins-job-builder $JJB_VERSION # -# If the --python option is specified, that python executable will be used to -# create the venv. The --python option must be in the PATH. The venv will be -# located in '/tmp/venv-####'. +# If the --python flag is specified, the specified python executable will be +# used to create the venv. The --python option must be in the PATH. The venv +# will be located in $lf_venv (/tmp/venv-####). +# +# If the --no-path flag is specified, $lf_venv/bin will not be prepended to +# the PATH. +# +# If the --system-site-packages flag is specified, the --system-site-packages +# flag will be passed to the inital 'pip install' (python3* only). # # RETURN VALUES # OK: 0 @@ -127,38 +143,43 @@ function lf-boolean() function lf-activate-venv() { - local lf_tmp_venv - lf_tmp_venv=$(mktemp -d /tmp/venv-XXXX) + lf_venv=$(mktemp -d /tmp/venv-XXXX) local python=python3 local options - options=$(getopt -o 'p:' -l 'python:' -n "${FUNCNAME[0]}" -- "$@" ) + local set_path=true + local install_args="" + options=$(getopt -o 'n:p:' -l 'no-path,python:,system-site-packages' -n "${FUNCNAME[0]}" -- "$@" ) eval set -- "$options" while true; do case $1 in - -p|--python) python=$2; shift 2 ;; + -n|--no-path) set_path=false ; shift ;; + -p|--python) python=$2 ; shift 2 ;; + --system-site-packages) install_args="--system-site-packages" ; shift ;; --) shift; break ;; *) lf-echo-stderr "${FUNCNAME[0]}(): ERROR: Unknown switch '$1'." ; return 1 ;; esac done - if ! type $python > /dev/null; then + if ! type "$python" > /dev/null; then lf-echo-stderr "${FUNCNAME[0]}(): ERROR: Unknown Python: $python" return 1 fi - echo "${FUNCNAME[0]}(): INFO: Creating '$python' venv ($lf_tmp_venv)" + echo "${FUNCNAME[0]}(): INFO: Creating $python venv at $lf_venv" case $python in - python2*) + python2*) local pkg_list="$*" # For Python2, just create venv and install pip - virtualenv -p $python $lf_tmp_venv || return 1 - $lf_tmp_venv/bin/pip install --upgrade --quiet pip || return 1 + virtualenv -p "$python" "$lf_venv" || return 1 + "$lf_venv/bin/pip" install --upgrade --quiet pip || return 1 if [[ -z $pkg_list ]]; then echo "${FUNCNAME[0]}(): WARNING: No packages to install" return 0 fi echo "${FUNCNAME[0]}(): INFO: Installing: $pkg_list" - $lf_tmp_venv/bin/pip install --upgrade --quiet $pkg_list || return 1 + # $pkg_list is expected to be unquoted + # shellcheck disable=SC2086 + "$lf_venv/bin/pip" install --upgrade --quiet $pkg_list || return 1 ;; python3*) local pkg_list="" @@ -169,14 +190,16 @@ function lf-activate-venv() *) pkg_list+="$arg " ;; esac done - $python -m venv $lf_tmp_venv || return 1 - $lf_tmp_venv/bin/pip install --upgrade --quiet pip virtualenv || return 1 + $python -m venv "$install_args" "$lf_venv" || return 1 + "$lf_venv/bin/pip" install --upgrade --quiet pip virtualenv || return 1 if [[ -z $pkg_list ]]; then echo "${FUNCNAME[0]}(): WARNING: No packages to install" return 0 fi echo "${FUNCNAME[0]}(): INFO: Installing: $pkg_list" - $lf_tmp_venv/bin/pip install --upgrade --quiet --upgrade-strategy eager \ + # $pkg_list is expected to be unquoted + # shellcheck disable=SC2086 + "$lf_venv/bin/pip" install --upgrade --quiet --upgrade-strategy eager \ $pkg_list || return 1 ;; *) @@ -184,9 +207,13 @@ function lf-activate-venv() return 1 ;; esac - echo "${FUNCNAME[0]}(): INFO: Adding $lf_tmp_venv/bin to PATH" - PATH=$lf_tmp_venv/bin:$PATH - return 0 + if $set_path; then + echo "${FUNCNAME[0]}(): INFO: Adding $lf_venv/bin to PATH" + PATH=$lf_venv/bin:$PATH + return 0 + else + echo "${FUNCNAME[0]}(): INFO: Path not set, lf_venv set to: $lf_venv" + fi } # End lf-activate-venv()