X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?a=blobdiff_plain;f=nfvbenchvm%2Fdib%2Fbuild-image.sh;h=c5d24da91b6a9559c5fc49b2e4025a9a50099d03;hb=65df9717730bd34e10f5f231f6869792ecab6e92;hp=6339f010ec3ff8bdc282f8b851d2c47db8beef1b;hpb=0cec91164afeb9c24c113e110dc123cd615119a7;p=nfvbench.git

diff --git a/nfvbenchvm/dib/build-image.sh b/nfvbenchvm/dib/build-image.sh
index 6339f01..c5d24da 100755
--- a/nfvbenchvm/dib/build-image.sh
+++ b/nfvbenchvm/dib/build-image.sh
@@ -3,39 +3,80 @@
 # A shell script to build the VPP VM image or NFVbench+TRex VM image using diskinage-builder
 #
 # The following packages must be installed prior to using this script:
-# sudo apt-get -y install python-virtualenv qemu-utils kpartx
+# Ubuntu: sudo apt-get -y install python3 python3-venv qemu-utils kpartx
+# CentOS: sudo yum install -y python3 qemu-img kpartx
 
-usage() {
-    echo "Usage: $0 [-l] [-g] [-v]"
-    echo "   -l    build NFVbench loop VM image"
-    echo "   -g    build NFVbench generator image"
-    echo "   -v    verify only (build but do not push to google storage)"
-    exit 1
-}
+# Stop on error (see https://wizardzines.com/comics/bash-errors/)
+set -euo pipefail
 
+DEBUG=no
 verify_only=0
-generator_only=0
-loopvm_only=0
+build_generator=0
+build_loopvm=0
 __prefix__=""
+
+# Artifact URL
+gs_url=artifacts.opnfv.org/nfvbench/images
+
+# image version number
+__loopvm_version__=0.16
+__generator_version__=0.15
+loopvm_image_name=nfvbenchvm_centos-$__loopvm_version__
+generator_image_name=nfvbenchvm_centos-generator-$__generator_version__
+
+# Default values for nfvbenchvm dib element variables
+export DIB_NFVBENCH_CODE_ORIGIN=opnfv-gerrit
+
+
 # ----------------------------------------------------------------------------
 # Parse command line options and configure the script
 # ----------------------------------------------------------------------------
 
-while getopts ":hglv" opt; do
+usage() {
+    cat <<EOF
+$(basename $0) - build NFVbench VM images
+Usage:
+    $(basename $0) [OPTIONS]
+
+OPTIONS
+    -l: build NFVbench loop VM image
+    -g: build NFVbench generator image
+    -v: verify only (build but do not push to google storage)
+    -s: use local nfvbench code instead of cloning from OPNFV gerrit
+        (only relevant for NFVbench generator image)
+
+    -t: enable debug trace (set -x + DIB_DEBUG_TRACE=1)
+    -d: start debug shell in image chroot in case of build error
+    -h: show this help message
+EOF
+    exit 1
+}
+
+while getopts ":lgvstdh" opt; do
     case $opt in
-        h)
-            usage
-            exit 0
+        l)
+            build_loopvm=1
             ;;
         g)
-            generator_only=1
-            ;;
-        l)
-            loopvm_only=1
+            build_generator=1
             ;;
         v)
             verify_only=1
             ;;
+        s)
+            export DIB_NFVBENCH_CODE_ORIGIN=static
+            ;;
+        t)
+            set -x
+            export DIB_DEBUG_TRACE=1
+            ;;
+        d)
+            DEBUG=yes
+            ;;
+        h)
+            usage
+            exit 0
+            ;;
         ?)
             usage
             exit 1
@@ -43,15 +84,46 @@ while getopts ":hglv" opt; do
     esac
 done
 
-set -e
 
-# Artifact URL
-gs_url=artifacts.opnfv.org/nfvbench/images
+# Build all VM images if the image to build is not specified on the CLI
+if [[ $build_generator -eq 0 ]] && [[ $build_loopvm -eq 0 ]]; then
+    build_generator=1
+    build_loopvm=1
+fi
 
-# image version number
-__version__=0.15
-loopvm_image_name=nfvbenchvm_centos-$__version__
-generator_image_name=nfvbenchvm_centos-generator-$__version__
+if [[ "${DIB_NFVBENCH_CODE_ORIGIN}" == "static" ]] && [[ $build_generator -eq 0 ]]; then
+    echo "Error: option -s is only relevant to the build of the generator image"
+    exit 1
+fi
+
+
+# ----------------------------------------------------------------------------
+# Copy local nfvbench code to elements/nfvbenchvm/static/opt/nfvbench
+# ----------------------------------------------------------------------------
+
+function copy_local_nfvbench_code_to_static_dir {
+    echo "Copy local nfvbench code to elements/nfvbenchvm/static/opt"
+    # Create elements/nfvbenchvm/static/opt/ directory if it does not exist and
+    # move there
+    pushd $(dirname $0)/elements/nfvbenchvm/static
+    [ -d opt ] || mkdir opt
+    cd opt
+
+    # Remove nfvbench code if it is already there
+    [ -d nfvbench ] && rm -rf nfvbench
+
+    # Use git to "copy" the local nfvbench code.
+    # This will include all the committed changes of the current branch.
+    git clone ../../../../../.. nfvbench
+
+    # Go back to the current directory when this function was called
+    popd
+}
+
+
+# ----------------------------------------------------------------------------
+# Configure and start the nfvbenchvm image build
+# ----------------------------------------------------------------------------
 
 function build_image {
     # if image exists skip building
@@ -72,14 +144,13 @@ function build_image {
     if [ -f $1.qcow2 ]; then
         echo "Image $1.qcow2 already exists locally"
     else
-
         # install diskimage-builder
         if [ -d dib-venv ]; then
            . dib-venv/bin/activate
         else
-           virtualenv dib-venv
+           python3 -m venv dib-venv
            . dib-venv/bin/activate
-           pip install diskimage-builder
+           pip install diskimage-builder==3.16.0
         fi
 
         # Add nfvbenchvm_centos elements directory to the DIB elements path
@@ -110,8 +181,18 @@ function build_image {
            export TREX_VER=$(awk '/ENV TREX_VER/ {print $3}' ../../docker/Dockerfile | sed 's/"//g' | sed 's/\r//g')
         fi
 
+        # Specify CentOS version
+        export DIB_RELEASE=7
+
+        # Debug on error: if an error occurs during the build, disk-image-create
+        # will drop us in a Bash inside the chroot, and we will be able to inspect
+        # the current state of the image.
+        if [[ "${DEBUG}" == "yes" ]]; then
+            export break=after-error
+        fi
+
         echo "Building $1.qcow2..."
-        time disk-image-create -o $1 centos7 nfvbenchvm
+        time disk-image-create -o $1 centos nfvbenchvm
     fi
 
     ls -l $1.qcow2
@@ -132,18 +213,35 @@ function build_image {
 }
 
 
-if [ ! $generator_only -eq 1 ] && [ ! $loopvm_only -eq 1 ]; then
-   echo "Build loop VM image"
-   build_image $loopvm_image_name
-   echo "Build generator image"
-   build_image $generator_image_name
-else
-    if [ $loopvm_only -eq 1 ]; then
-       echo "Build loop VM image"
-       build_image $loopvm_image_name
-    fi
-    if [ $generator_only -eq 1 ]; then
-       echo "Build generator image"
-       build_image $generator_image_name
+# ----------------------------------------------------------------------------
+# Main program
+# ----------------------------------------------------------------------------
+
+if [ $build_loopvm -eq 1 ]; then
+    echo "Build loop VM image"
+    build_image $loopvm_image_name
+fi
+
+if [ $build_generator -eq 1 ]; then
+    echo "Build generator image"
+
+    if [[ "${DIB_NFVBENCH_CODE_ORIGIN}" == "static" ]]; then
+        echo "Use local nfvbench code"
+        copy_local_nfvbench_code_to_static_dir
+
+        # Append nfvbench version number to the image name:
+        # during development, this is useful to distinguish the development
+        # images from the latest published image.
+        #
+        # To avoid confusion, we use the same versioning as nfvbench (see
+        # nfvbench/__init__.py), although "git describe" would give us a better
+        # number with respect to uniqueness.  So we will typically get something
+        # like "5.0.4.dev31" where "5.0.4" is the latest annotated tag ("5.0.3")
+        # plus one and where dev31 indicates the number of commits (31) since
+        # that tag.
+        nfvbench_version=$(python -c 'import pbr.version; print(pbr.version.VersionInfo("nfvbench").version_string_with_vcs())')
+        generator_image_name="${generator_image_name}-${nfvbench_version}"
     fi
-fi
\ No newline at end of file
+
+    build_image $generator_image_name
+fi