nfvbenchvm: add 2 debug features to build-image.sh

[nfvbench.git] / nfvbenchvm / dib / build-image.sh

diff --git a/nfvbenchvm/dib/build-image.sh b/nfvbenchvm/dib/build-image.sh
index e4b468a..445807b 100755 (executable)
--- a/nfvbenchvm/dib/build-image.sh
+++ b/nfvbenchvm/dib/build-image.sh
@@ -3,39 +3,71 @@
 # 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
 __prefix__=""
+
+# Artifact URL
+gs_url=artifacts.opnfv.org/nfvbench/images
+
+# image version number
+__version__=0.15
+loopvm_image_name=nfvbenchvm_centos-$__version__
+generator_image_name=nfvbenchvm_centos-generator-$__version__
+
+
 # ----------------------------------------------------------------------------
 # 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)
+
+    -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 ":lgvtdh" opt; do
     case $opt in
-        h)
-            usage
-            exit 0
+        l)
+            loopvm_only=1
             ;;
         g)
             generator_only=1
             ;;
-        l)
-            loopvm_only=1
-            ;;
         v)
             verify_only=1
             ;;
+        t)
+            set -x
+            export DIB_DEBUG_TRACE=1
+            ;;
+        d)
+            DEBUG=yes
+            ;;
+        h)
+            usage
+            exit 0
+            ;;
         ?)
             usage
             exit 1
@@ -43,43 +75,37 @@ while getopts ":hglv" opt; do
     esac
 done
 
-set -e
 
-# Artifact URL
-gs_url=artifacts.opnfv.org/nfvbench/images
-
-# image version number
-__version__=0.13
-loopvm_image_name=nfvbenchvm_centos-$__version__
-generator_image_name=nfvbenchvm_centos-generator-$__version__
+# ----------------------------------------------------------------------------
+# Configure and start the nfvbenchvm image build
+# ----------------------------------------------------------------------------
 
 function build_image {
     # if image exists skip building
     echo "Checking if image exists in google storage..."
     if  command -v gsutil >/dev/null; then
-        if gsutil -q stat gs://$gs_url/$1.qcow2; then
-            echo "Image already exists at http://$gs_url/$1.qcow2"
-            echo "Build is skipped"
-            exit 0
-        fi
-        echo "Image does not exist in google storage, starting build..."
-        echo
+       if gsutil -q stat gs://$gs_url/$1.qcow2; then
+           echo "Image already exists at http://$gs_url/$1.qcow2"
+           echo "Build is skipped"
+           exit 0
+       fi
+       echo "Image does not exist in google storage, starting build..."
+       echo
     else
-        echo "Cannot check image availability in OPNFV artifact repository (gsutil not available)"
+       echo "Cannot check image availability in OPNFV artifact repository (gsutil not available)"
     fi
 
     # check if image is already built locally
     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 +136,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,6 +168,10 @@ function build_image {
 }
 
 
+# ----------------------------------------------------------------------------
+# Main program
+# ----------------------------------------------------------------------------
+
 if [ ! $generator_only -eq 1 ] && [ ! $loopvm_only -eq 1 ]; then
    echo "Build loop VM image"
    build_image $loopvm_image_name
@@ -146,4 +186,4 @@ else
        echo "Build generator image"
        build_image $generator_image_name
     fi
-fi
\ No newline at end of file
+fi