Import jjb test bash functions from vpp repo.

- Also move get_gerrit_refspec() from docker/scripts/lib_common.sh
  into sandbox_test_functions.sh

Change-Id: I8f4a1648da678361c7ab364724f488571c91f0b7
Signed-off-by: Dave Wallace <dwallacelf@gmail.com>

2 files changed, 118 insertions, 17 deletions

diff --git a/docker/scripts/lib_common.sh b/docker/scripts/lib_common.sh
index 17dcc144a..3449bf398 100644
--- a/docker/scripts/lib_common.sh
+++ b/docker/scripts/lib_common.sh
@@ -124,23 +124,6 @@ remove_pyc_files_and_pycache_dirs() {
          -print -exec rm -rf {} \; 2>/dev/null || true
 }
 
-# Get the refspec for the specified project branch at HEAD
-#
-# Arguments:
-#   $1 - branch
-#   $2 - project (Optional: defaults to 'vpp')
-get_gerrit_refspec() {
-    local branch=${1:-"master"}
-    local project=${2:-"vpp"}
-    local query="$(ssh -p 29418 gerrit.fd.io gerrit query status:merged project:$project branch:$branch limit:1 --format=JSON --current-patch-set | tr ',' '\n' | grep refs | cut -d'"' -f4)"
-
-    if [ -z "$query" ] ; then
-        echo "ERROR: Invalid project ($1) or branch ($2)"
-    else
-        echo "$query"
-    fi
-}
-
 # Well-known filename variables
 export APT_DEBIAN_DOCKER_GPGFILE="docker.linux.debian.gpg"
 export APT_UBUNTU_DOCKER_GPGFILE="docker.linux.ubuntu.gpg"
diff --git a/extras/bash/sandbox_test_functions.sh b/extras/bash/sandbox_test_functions.sh
new file mode 100644
index 000000000..afccf9a21
--- /dev/null
+++ b/extras/bash/sandbox_test_functions.sh
@@ -0,0 +1,118 @@
+# Copyright (c) 2021 Cisco and/or its affiliates.
+# 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.
+
+# bash function to set up jenkins sandbox environment
+#
+# See LF Sandbox documentation:
+#   https://docs.releng.linuxfoundation.org/en/latest/jenkins-sandbox.html
+#
+# Prerequisites:
+#   1. Create jenkins sandbox token and add it to your local jenkins.ini file
+#      Either specify the location of the init file in $JENKINS_INI or
+#      JENKINS_INI will be initialized to either
+#         ~/.config/jenkins_jobs/jenkins.ini
+#         $WS_ROOT/jenkins.ini
+#   2. Clone ci-management workspace from gerrit.fd.io
+#   3. export WS_ROOT=<local ci-management workspace>
+jjb-sandbox-env()
+{
+    local jjb_version=${JJB_VERSION:-"3.5.0"}
+
+    if [ -z "$WS_ROOT" ] ; then
+        echo "ERROR: WS_ROOT is not set!"
+        return
+    elif [ ! -d "$WS_ROOT/jjb" ] ; then
+        echo "ERROR: WS_ROOT is not set to a ci-management workspace:"
+        echo "       '$WS_ROOT'"
+        return
+    fi
+
+    if [ -n "$(declare -f deactivate)" ]; then
+        echo "Deactivating Python Virtualenv!"
+        deactivate
+    fi
+
+    if [ -z "$JENKINS_INI" ] ; then
+        local user_jenkins_ini="/home/$USER/.config/jenkins_jobs/jenkins.ini"
+        if [ -f "$user_jenkins_ini" ] ; then
+            export JENKINS_INI=$user_jenkins_ini
+        elif [ -f "$WS_ROOT/jenkins.ini" ] ; then
+            export JENKINS_INI="$WS_ROOT/jenkins.ini"
+        else
+            echo "ERROR: Unable to find 'jenkins.ini'!"
+            return
+        fi
+        echo "Exporting JENKINS_INI=$JENKINS_INI"
+    elif [ ! -f "$JENKINS_INI" ] ; then
+        echo "ERROR: file specified in JENKINS_INI ($JENKINS_INI) not found!"
+        return
+    fi
+
+    if [ -n "$(declare -f deactivate)" ]; then
+        echo "Deactivating Python Virtualenv!"
+        deactivate
+    fi
+    cd $WS_ROOT
+    git submodule update --init --recursive
+
+    local VENV_DIR=$WS_ROOT/venv
+    rm -rf $VENV_DIR \
+       && python3 -m venv $VENV_DIR \
+       && source $VENV_DIR/bin/activate \
+       && pip3 install wheel \
+       && pip3 install jenkins-job-builder==$jjb_version
+
+    alias jjsb='jenkins-jobs --conf $JENKINS_INI'
+    function jjsb-test() {
+        if [ -z "$(which jenkins-jobs 2>&1)" ] ; then
+            echo "jenkins-jobs not found!  Run jjb-sandbox-env to activate."
+            return
+        fi
+        if [ -z "$1" ] ; then
+            echo "Usage: $FUNCNAME <jenkins-job-name>"
+            return
+        fi
+        which jenkins-jobs \
+            && jenkins-jobs --conf $JENKINS_INI test $WS_ROOT/jjb $@
+    }
+    function jjsb-update() {
+        if [ -z "$(which jenkins-jobs 2>&1)" ] ; then
+            echo "jenkins-jobs not found!  Run jjb-sandbox-env to activate."
+            return
+        fi
+        if [ -z "$1" ] ; then
+            echo "Usage: $FUNCNAME <jenkins-job-name>"
+            return
+        fi
+        which jenkins-jobs \
+            && jenkins-jobs --conf $JENKINS_INI update $WS_ROOT/jjb $@
+    }
+    jenkins-jobs --version
+}
+
+# Get the refspec for the specified project branch at HEAD
+#
+# Arguments:
+#   $1 - branch
+#   $2 - project (Optional: defaults to 'vpp')
+get_gerrit_refspec() {
+    local branch=${1:-"master"}
+    local project=${2:-"vpp"}
+    local query="$(ssh -p 29418 gerrit.fd.io gerrit query status:merged project:$project branch:$branch limit:1 --format=JSON --current-patch-set | tr ',' '\n' | grep refs | cut -d'"' -f4)"
+
+    if [ -z "$query" ] ; then
+        echo "ERROR: Invalid project ($1) or branch ($2)"
+    else
+        echo "$query"
+    fi
+}