From ebf68732e277ab06175df8a0fcde46dc7a730321 Mon Sep 17 00:00:00 2001
From: Gwenael Lambrouin <gwenael.lambrouin@orange.com>
Date: Mon, 13 Dec 2021 14:33:07 +0100
Subject: nfvbenchvm: add 2 debug features to build-image.sh

- The new option -t (enable debug traces) allows to show in the build
  log the commands run in the shell scripts, including the commands
  defined in the disk image builder elements.

- The new option -d (debug) instructs disk-image-create to drop the
  developer in a shell inside the chroot in case an error occurs.  This
  makes troubleshooting of the image possible (inspect files, run
  commands, ...)

Change-Id: I5f76e7dec64fc4c86b1515f6b81a16e11e03eadf
Signed-off-by: Gwenael Lambrouin <gwenael.lambrouin@orange.com>
---
 nfvbenchvm/dib/build-image.sh                      | 81 +++++++++++++++-------
 .../nfvbenchvm/finalise.d/51-add-cpu-isolation     |  4 ++
 .../nfvbenchvm/finalise.d/52-change-resolution     |  4 ++
 .../nfvbenchvm/finalise.d/53-boot-from-new-kernel  |  4 ++
 .../nfvbenchvm/post-install.d/01-update-kernel     |  4 ++
 .../nfvbenchvm/post-install.d/02-pip-package       |  4 ++
 .../nfvbenchvm/post-install.d/03-copy-rc-local     |  4 ++
 .../post-install.d/04-add-execute-attribute        |  4 ++
 .../nfvbenchvm/post-install.d/52-nfvbench-script   |  4 ++
 .../nfvbenchvm/post-install.d/53-sshd-script       |  4 ++
 .../elements/nfvbenchvm/post-install.d/99-cleanup  |  4 ++
 11 files changed, 97 insertions(+), 24 deletions(-)

diff --git a/nfvbenchvm/dib/build-image.sh b/nfvbenchvm/dib/build-image.sh
index 3423140..445807b 100755
--- a/nfvbenchvm/dib/build-image.sh
+++ b/nfvbenchvm/dib/build-image.sh
@@ -9,37 +9,65 @@
 # Stop on error (see https://wizardzines.com/comics/bash-errors/)
 set -euo pipefail
 
-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
-}
-
+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
@@ -47,15 +75,10 @@ while getopts ":hglv" opt; do
     esac
 done
 
-set -e
-
-# 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__
+# ----------------------------------------------------------------------------
+# Configure and start the nfvbenchvm image build
+# ----------------------------------------------------------------------------
 
 function build_image {
     # if image exists skip building
@@ -76,7 +99,6 @@ 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
@@ -117,6 +139,13 @@ function build_image {
         # 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 centos nfvbenchvm
     fi
@@ -139,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
diff --git a/nfvbenchvm/dib/elements/nfvbenchvm/finalise.d/51-add-cpu-isolation b/nfvbenchvm/dib/elements/nfvbenchvm/finalise.d/51-add-cpu-isolation
index 14cb913..e9cf3c5 100755
--- a/nfvbenchvm/dib/elements/nfvbenchvm/finalise.d/51-add-cpu-isolation
+++ b/nfvbenchvm/dib/elements/nfvbenchvm/finalise.d/51-add-cpu-isolation
@@ -1,5 +1,9 @@
 #!/bin/bash
 
+if [ ${DIB_DEBUG_TRACE:-1} -gt 0 ]; then
+    set -x
+fi
+
 # Stop on error
 set -euo pipefail
 
diff --git a/nfvbenchvm/dib/elements/nfvbenchvm/finalise.d/52-change-resolution b/nfvbenchvm/dib/elements/nfvbenchvm/finalise.d/52-change-resolution
index cc9f136..d01b907 100755
--- a/nfvbenchvm/dib/elements/nfvbenchvm/finalise.d/52-change-resolution
+++ b/nfvbenchvm/dib/elements/nfvbenchvm/finalise.d/52-change-resolution
@@ -1,5 +1,9 @@
 #!/bin/bash
 
+if [ ${DIB_DEBUG_TRACE:-1} -gt 0 ]; then
+    set -x
+fi
+
 # Stop on error
 set -euo pipefail
 
diff --git a/nfvbenchvm/dib/elements/nfvbenchvm/finalise.d/53-boot-from-new-kernel b/nfvbenchvm/dib/elements/nfvbenchvm/finalise.d/53-boot-from-new-kernel
index 4728bca..e461801 100755
--- a/nfvbenchvm/dib/elements/nfvbenchvm/finalise.d/53-boot-from-new-kernel
+++ b/nfvbenchvm/dib/elements/nfvbenchvm/finalise.d/53-boot-from-new-kernel
@@ -1,5 +1,9 @@
 #!/bin/bash
 
+if [ ${DIB_DEBUG_TRACE:-1} -gt 0 ]; then
+    set -x
+fi
+
 # Stop on error
 set -euo pipefail
 
diff --git a/nfvbenchvm/dib/elements/nfvbenchvm/post-install.d/01-update-kernel b/nfvbenchvm/dib/elements/nfvbenchvm/post-install.d/01-update-kernel
index 7f5c342..0c32b5f 100755
--- a/nfvbenchvm/dib/elements/nfvbenchvm/post-install.d/01-update-kernel
+++ b/nfvbenchvm/dib/elements/nfvbenchvm/post-install.d/01-update-kernel
@@ -1,5 +1,9 @@
 #!/bin/bash
 
+if [ ${DIB_DEBUG_TRACE:-1} -gt 0 ]; then
+    set -x
+fi
+
 # Stop on error
 set -euo pipefail
 
diff --git a/nfvbenchvm/dib/elements/nfvbenchvm/post-install.d/02-pip-package b/nfvbenchvm/dib/elements/nfvbenchvm/post-install.d/02-pip-package
index d175473..ee7c5f2 100755
--- a/nfvbenchvm/dib/elements/nfvbenchvm/post-install.d/02-pip-package
+++ b/nfvbenchvm/dib/elements/nfvbenchvm/post-install.d/02-pip-package
@@ -1,5 +1,9 @@
 #!/bin/bash
 
+if [ ${DIB_DEBUG_TRACE:-1} -gt 0 ]; then
+    set -x
+fi
+
 # Stop on error
 set -euo pipefail
 
diff --git a/nfvbenchvm/dib/elements/nfvbenchvm/post-install.d/03-copy-rc-local b/nfvbenchvm/dib/elements/nfvbenchvm/post-install.d/03-copy-rc-local
index 24facec..4a8e66b 100755
--- a/nfvbenchvm/dib/elements/nfvbenchvm/post-install.d/03-copy-rc-local
+++ b/nfvbenchvm/dib/elements/nfvbenchvm/post-install.d/03-copy-rc-local
@@ -1,5 +1,9 @@
 #!/bin/bash
 
+if [ ${DIB_DEBUG_TRACE:-1} -gt 0 ]; then
+    set -x
+fi
+
 # Stop on error
 set -euo pipefail
 
diff --git a/nfvbenchvm/dib/elements/nfvbenchvm/post-install.d/04-add-execute-attribute b/nfvbenchvm/dib/elements/nfvbenchvm/post-install.d/04-add-execute-attribute
index c96740f..52aed8a 100755
--- a/nfvbenchvm/dib/elements/nfvbenchvm/post-install.d/04-add-execute-attribute
+++ b/nfvbenchvm/dib/elements/nfvbenchvm/post-install.d/04-add-execute-attribute
@@ -1,5 +1,9 @@
 #!/bin/bash
 
+if [ ${DIB_DEBUG_TRACE:-1} -gt 0 ]; then
+    set -x
+fi
+
 # Stop on error
 set -euo pipefail
 
diff --git a/nfvbenchvm/dib/elements/nfvbenchvm/post-install.d/52-nfvbench-script b/nfvbenchvm/dib/elements/nfvbenchvm/post-install.d/52-nfvbench-script
index 782d9b6..2182c83 100755
--- a/nfvbenchvm/dib/elements/nfvbenchvm/post-install.d/52-nfvbench-script
+++ b/nfvbenchvm/dib/elements/nfvbenchvm/post-install.d/52-nfvbench-script
@@ -1,5 +1,9 @@
 #!/bin/bash
 
+if [ ${DIB_DEBUG_TRACE:-1} -gt 0 ]; then
+    set -x
+fi
+
 # Make sure the disk image build fails if nfvbench installation fails
 set -euo pipefail
 
diff --git a/nfvbenchvm/dib/elements/nfvbenchvm/post-install.d/53-sshd-script b/nfvbenchvm/dib/elements/nfvbenchvm/post-install.d/53-sshd-script
index c735506..0c7dfd5 100755
--- a/nfvbenchvm/dib/elements/nfvbenchvm/post-install.d/53-sshd-script
+++ b/nfvbenchvm/dib/elements/nfvbenchvm/post-install.d/53-sshd-script
@@ -1,5 +1,9 @@
 #!/bin/bash
 
+if [ ${DIB_DEBUG_TRACE:-1} -gt 0 ]; then
+    set -x
+fi
+
 # Stop on error
 set -euo pipefail
 
diff --git a/nfvbenchvm/dib/elements/nfvbenchvm/post-install.d/99-cleanup b/nfvbenchvm/dib/elements/nfvbenchvm/post-install.d/99-cleanup
index 80dc3c0..dbb7342 100755
--- a/nfvbenchvm/dib/elements/nfvbenchvm/post-install.d/99-cleanup
+++ b/nfvbenchvm/dib/elements/nfvbenchvm/post-install.d/99-cleanup
@@ -1,5 +1,9 @@
 #!/bin/bash
 
+if [ ${DIB_DEBUG_TRACE:-1} -gt 0 ]; then
+    set -x
+fi
+
 # Stop on error
 set -euo pipefail
 
-- 
cgit 1.2.3-korg