From 2596142ad71754937813a54c1c45ca8bfa524088 Mon Sep 17 00:00:00 2001
From: Bogdan Dobrelya <bdobreli@redhat.com>
Date: Wed, 10 Jul 2019 19:41:12 +0200
Subject: [PATCH] Better debug for container-puppet tool

In debug mode, provide details about files changed by puppet and files
rsynced to the config data paths. Control the script verbosity by the
env var DEBUG as well.

Change-Id: I336a29d5bffb4dae15711519609081e1aed03f2c
Signed-off-by: Bogdan Dobrelya <bdobreli@redhat.com>
---
 common/container-puppet.py | 26 +++++++++++++++++++++-----
 1 file changed, 21 insertions(+), 5 deletions(-)

diff --git a/common/container-puppet.py b/common/container-puppet.py
index febe1a5e97..91266c2b5e 100755
--- a/common/container-puppet.py
+++ b/common/container-puppet.py
@@ -268,7 +268,8 @@ if not os.path.exists(sh_script):
     with open(sh_script, 'w') as script_file:
         os.chmod(script_file.name, 0o755)
         script_file.write("""#!/bin/bash
-        set -ex
+        set -e
+        [ "$DEBUG" = "false" ] || set -x
         mkdir -p /etc/puppet
         cp -dR /tmp/puppet-etc/* /etc/puppet
         rm -Rf /etc/puppet/ssl # not in use and causes permission errors
@@ -300,6 +301,9 @@ if not os.path.exists(sh_script):
         # $::deployment_type in puppet-tripleo
         export FACTER_deployment_type=containers
         export FACTER_uuid=$(cat /sys/class/dmi/id/product_uuid | tr '[:upper:]' '[:lower:]')
+        echo 'Running puppet'
+        # FIXME(bogdando): stdout may be falling behind of the logged syslog messages
+        set -x
         /usr/bin/puppet apply --summarize \
                 --detailed-exitcodes \
                 --color=false \
@@ -309,11 +313,15 @@ if not os.path.exists(sh_script):
                 /etc/config.pp \
                 2>&1 | logger -s -t puppet-user
         rc=${PIPESTATUS[0]}
+        [ "$DEBUG" = "false" ] && set +x
         set -e
         if [ $rc -ne 2 -a $rc -ne 0 ]; then
             exit $rc
         fi
 
+        verbosity=""
+        [ "$DEBUG" = "false" ] || verbosity="-v"
+
         # Disables archiving
         if [ -z "$NO_ARCHIVE" ]; then
             archivedirs=("/etc" "/root" "/opt" "/var/lib/ironic/tftpboot" "/var/lib/ironic/httpboot" "/var/www" "/var/spool/cron" "/var/lib/nova/.ssh")
@@ -339,16 +347,23 @@ if not os.path.exists(sh_script):
                     exclude_files+=" --exclude=$p"
                 fi
             done
-            rsync -a -R --delay-updates --delete-after $exclude_files $rsync_srcs /var/lib/config-data/${NAME}
+            echo "Rsyncing config files from ${rsync_srcs} into /var/lib/config-data/${NAME}"
+            rsync -a $verbosity -R --delay-updates --delete-after $exclude_files $rsync_srcs /var/lib/config-data/${NAME}
 
 
             # Also make a copy of files modified during puppet run
             # This is useful for debugging
             echo "Gathering files modified after $(stat -c '%y' $origin_of_time)"
             mkdir -p /var/lib/config-data/puppet-generated/${NAME}
-            rsync -a -R -0 --delay-updates --delete-after $exclude_files \
-                          --files-from=<(find $rsync_srcs -newer $origin_of_time -not -path '/etc/puppet*' -print0) \
-                          / /var/lib/config-data/puppet-generated/${NAME}
+            exec 5>&1
+            exec 1>/tmp/files_from
+            find $rsync_srcs -newer $origin_of_time -not -path '/etc/puppet*' -print0
+            exec 1>&5
+            echo "Files modified during puppet run:"
+            cat /tmp/files_from | sort | xargs -0 printf "%s\n"
+            echo "Rsyncing the modified files into /var/lib/config-data/puppet-generated/${NAME}"
+            rsync -a $verbosity -R -0 --delay-updates --delete-after $exclude_files \
+                --files-from=/tmp/files_from / /var/lib/config-data/puppet-generated/${NAME}
 
             # Write a checksum of the config-data dir, this is used as a
             # salt to trigger container restart when the config changes
@@ -411,6 +426,7 @@ def mp_puppet_config(*args):
                 '--env', 'NO_ARCHIVE=%s' % os.environ.get('NO_ARCHIVE', ''),
                 '--env', 'STEP=%s' % os.environ.get('STEP', '6'),
                 '--env', 'NET_HOST=%s' % os.environ.get('NET_HOST', 'false'),
+                '--env', 'DEBUG=%s' % os.environ.get('DEBUG', 'false'),
                 '--volume', '/etc/localtime:/etc/localtime:ro',
                 '--volume', '%s:/etc/config.pp:ro' % tmp_man.name,
                 '--volume', '/etc/puppet/:/tmp/puppet-etc/:ro',