From 43ccea9544c77ca206b2bd34b4ba9f7ca613ef38 Mon Sep 17 00:00:00 2001
From: Lars Erik Wik <lars.erik.wik@northern.tech>
Date: Tue, 30 Sep 2025 16:54:15 +0200
Subject: [PATCH 1/3] prepare-results: documented script

Ticket: ENT-12600
Signed-off-by: Lars Erik Wik <lars.erik.wik@northern.tech>
---
 build-scripts/prepare-results | 15 +++++++++++++--
 1 file changed, 13 insertions(+), 2 deletions(-)

diff --git a/build-scripts/prepare-results b/build-scripts/prepare-results
index d68ed3d05..17e833d8a 100755
--- a/build-scripts/prepare-results
+++ b/build-scripts/prepare-results
@@ -1,16 +1,25 @@
 #!/bin/sh
 
-. "$(dirname "$0")"/functions
-. detect-environment
+# Prepare build artifacts and test results for collection/archival.
+# This script collects built packages and test results from various locations
+# and copies them to a single output directory ($OUTDIR) for easy retrieval.
+
+# Source required configuration and utility files
+. "$(dirname "$0")"/functions # $OUTDIR, $BASEDIR
+. detect-environment          # $PACKAGING
 . compile-options
 . version
 
 set -x
 
+# Create output directory if it doesn't exist
 mkdir -p "$OUTDIR"
 
+# Collect built packages from each CFEngine edition directory
+# Iterates through community, nova (enterprise agent), and nova-hub directories
 for dir in cfengine-community cfengine-nova cfengine-nova-hub; do
     if [ -d "$BASEDIR"/$dir ]; then
+        # Copy packages based on platform-specific packaging format
         case "$PACKAGING" in
         rpm)
             cp "$BASEDIR"/$dir/RPMS/*/*.rpm "$OUTDIR"
@@ -45,6 +54,8 @@ for dir in cfengine-community cfengine-nova cfengine-nova-hub; do
     fi
 done
 
+# Collect test results from each tested project
+# projects_to_test returns the list of projects that should be tested (defined in functions) based on $PROJECT (community/nova) and $ROLE (agent/hub)
 for project in $(projects_to_test); do
     if [ -f "$BASEDIR"/"$project"/tests/acceptance/summary.log ]; then
         cp "$BASEDIR"/"$project"/tests/acceptance/summary.log "$OUTDIR"/"$project"-summary.log

From 33487ab243e8e3825d062fdc934c8634225985be Mon Sep 17 00:00:00 2001
From: Lars Erik Wik <lars.erik.wik@northern.tech>
Date: Tue, 30 Sep 2025 16:54:57 +0200
Subject: [PATCH 2/3] prepare-results: decreased verbosity of script

Signed-off-by: Lars Erik Wik <lars.erik.wik@northern.tech>
---
 build-scripts/prepare-results | 2 --
 1 file changed, 2 deletions(-)

diff --git a/build-scripts/prepare-results b/build-scripts/prepare-results
index 17e833d8a..81223855c 100755
--- a/build-scripts/prepare-results
+++ b/build-scripts/prepare-results
@@ -10,8 +10,6 @@
 . compile-options
 . version
 
-set -x
-
 # Create output directory if it doesn't exist
 mkdir -p "$OUTDIR"
 

From 507eef2b30ae5a86e909a020d4b45c42433c2008 Mon Sep 17 00:00:00 2001
From: Lars Erik Wik <lars.erik.wik@northern.tech>
Date: Tue, 30 Sep 2025 16:58:05 +0200
Subject: [PATCH 3/3] prepare-results: added log messages to aid debugging

Signed-off-by: Lars Erik Wik <lars.erik.wik@northern.tech>
---
 build-scripts/prepare-results | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

diff --git a/build-scripts/prepare-results b/build-scripts/prepare-results
index 81223855c..3903a6fe9 100755
--- a/build-scripts/prepare-results
+++ b/build-scripts/prepare-results
@@ -10,6 +10,10 @@
 . compile-options
 . version
 
+log_debug "--- Preparing build results and test artifacts ---"
+log_debug "Output directory: $OUTDIR"
+log_debug "Packaging format: $PACKAGING"
+
 # Create output directory if it doesn't exist
 mkdir -p "$OUTDIR"
 
@@ -17,6 +21,7 @@ mkdir -p "$OUTDIR"
 # Iterates through community, nova (enterprise agent), and nova-hub directories
 for dir in cfengine-community cfengine-nova cfengine-nova-hub; do
     if [ -d "$BASEDIR"/$dir ]; then
+        log_debug "Collecting packages from $dir"
         # Copy packages based on platform-specific packaging format
         case "$PACKAGING" in
         rpm)
@@ -44,7 +49,7 @@ for dir in cfengine-community cfengine-nova cfengine-nova-hub; do
             cp "$HOME"/lppdir/out/*.bff "$OUTDIR"
             ;;
         *)
-            echo "Unknown packaging system: $PACKAGING"
+            log_error "Unknown packaging system: $PACKAGING"
             exit 1
             ;;
         esac
@@ -56,8 +61,11 @@ done
 # projects_to_test returns the list of projects that should be tested (defined in functions) based on $PROJECT (community/nova) and $ROLE (agent/hub)
 for project in $(projects_to_test); do
     if [ -f "$BASEDIR"/"$project"/tests/acceptance/summary.log ]; then
+        log_debug "Collecting test results from $project"
         cp "$BASEDIR"/"$project"/tests/acceptance/summary.log "$OUTDIR"/"$project"-summary.log
         cp "$BASEDIR"/"$project"/tests/acceptance/test.log "$OUTDIR"/"$project"-test.log
         cp "$BASEDIR"/"$project"/tests/acceptance/test.xml "$OUTDIR"/"$project"-test.xml
     fi
 done
+
+log_debug "--- Build results preparation complete ---"