Merge pull request #592 from lemeurherve/golden-file-tags

chore: introduce golden file testing of tags

Author: lemeurherve

Makefile

@@ -63,7 +63,10 @@ every-build: check-reqs
 	@set -x; $(bake_base_cli) linux
 
 show:
-	@$(bake_cli) linux --print
+	@$(bake_base_cli) --progress=quiet linux --print | jq
+
+tags:
+	@make show | jq -r '.target[].tags[]' | LC_ALL=C sort
 
 list: check-reqs
 	@set -x; make --silent show | jq -r '.target | path(.. | select(.platforms[] | contains("linux/$(ARCH)"))?) | add'

tests/golden/expected_tags.txt

@@ -0,0 +1,34 @@
+docker.io/jenkins/ssh-agent:alpine
+docker.io/jenkins/ssh-agent:alpine-jdk17
+docker.io/jenkins/ssh-agent:alpine-jdk21
+docker.io/jenkins/ssh-agent:alpine-jdk25
+docker.io/jenkins/ssh-agent:alpine3.23
+docker.io/jenkins/ssh-agent:alpine3.23-jdk17
+docker.io/jenkins/ssh-agent:alpine3.23-jdk21
+docker.io/jenkins/ssh-agent:alpine3.23-jdk25
+docker.io/jenkins/ssh-agent:debian-jdk17
+docker.io/jenkins/ssh-agent:debian-jdk21
+docker.io/jenkins/ssh-agent:debian-jdk25
+docker.io/jenkins/ssh-agent:jdk17
+docker.io/jenkins/ssh-agent:jdk21
+docker.io/jenkins/ssh-agent:jdk25
+docker.io/jenkins/ssh-agent:latest
+docker.io/jenkins/ssh-agent:latest-alpine-jdk17
+docker.io/jenkins/ssh-agent:latest-alpine-jdk21
+docker.io/jenkins/ssh-agent:latest-alpine-jdk25
+docker.io/jenkins/ssh-agent:latest-alpine3.23
+docker.io/jenkins/ssh-agent:latest-alpine3.23-jdk17
+docker.io/jenkins/ssh-agent:latest-alpine3.23-jdk21
+docker.io/jenkins/ssh-agent:latest-alpine3.23-jdk25
+docker.io/jenkins/ssh-agent:latest-debian-jdk17
+docker.io/jenkins/ssh-agent:latest-debian-jdk21
+docker.io/jenkins/ssh-agent:latest-debian-jdk25
+docker.io/jenkins/ssh-agent:latest-jdk17
+docker.io/jenkins/ssh-agent:latest-jdk21
+docker.io/jenkins/ssh-agent:latest-jdk25
+docker.io/jenkins/ssh-agent:latest-trixie-jdk17
+docker.io/jenkins/ssh-agent:latest-trixie-jdk21
+docker.io/jenkins/ssh-agent:latest-trixie-jdk25
+docker.io/jenkins/ssh-agent:trixie-jdk17
+docker.io/jenkins/ssh-agent:trixie-jdk21
+docker.io/jenkins/ssh-agent:trixie-jdk25

tests/tags.bats

@@ -0,0 +1,9 @@
+#!/usr/bin/env bats
+
+load test_helpers
+
+SUT_DESCRIPTION="tags"
+
+@test "[${SUT_DESCRIPTION}] Default tags unchanged" {
+  assert_matches_golden expected_tags make --silent tags
+}

tests/test_helpers.bash

@@ -23,6 +23,26 @@ function assert_run_cmd_output_equal {
     assert_output "${expected_output}"
 }
 
+# Assert that golden file $1 matches the output of a command $2
+assert_matches_golden() {
+    local golden="$1"
+    shift
+    local golden_path="tests/golden/${golden}.txt"
+
+    if [[ ! -f "${golden_path}" ]]; then
+        echo "Golden file '${golden_path}' does not exist"
+        return 1
+    fi
+
+    # Run the command passed as arguments and capture its output
+    local output
+    output="$(mktemp)"
+    "$@" > "${output}"
+
+    # Compare with golden file
+    diff -u "${golden_path}" <(cat "${output}")
+}
+
 function get_sut_image {
     test -n "${IMAGE:?"[sut_image] Please set the variable 'IMAGE' to the name of the image to test in 'docker-bake.hcl'."}"
     ## Retrieve the SUT image name from buildx

tests/update-golden-file.sh

@@ -0,0 +1,76 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+# This script runs a specified command, captures its output,
+# and compares it against a "golden file" representing the expected output.
+# If the output differs, the script shows a diff and allows the user to update the golden file.
+# If the output matches, it reports that the golden file is up-to-date.
+#
+# Usage:
+#   ./update-golden-file.sh <test-name> <command...>
+#
+# Arguments:
+#   <test-name>    Name of the test, used to determine the golden file path.
+#                  The corresponding golden file will be stored as:
+#                     golden/<test-name>.txt
+#
+#   <command...>   Command to run, whose stdout will be compared to the golden file.
+#                  This can include arguments, e.g.:
+#                     ./update-golden-file.sh expected_tags make tags
+#
+# Notes:
+#   - Requires Bash 4+ for `BASH_SOURCE` handling.
+#   - The script is safe to run from any directory; golden files are always relative to the script's own location.
+
+if [[ $# -lt 2 ]]; then
+  echo "Usage: $0 <test-name> <command...>"
+  echo "Example:"
+  echo "  $0 expected_tags make tags"
+  exit 1
+fi
+
+name="$1"
+shift
+
+# Ensure golden folder is always relative to this script
+script_dir="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+golden_file="${name}.txt"
+golden_path="${script_dir}/golden/${golden_file}"
+tmp="$(mktemp)"
+
+echo
+echo "Golden file path:"
+echo "  ${golden_path}"
+echo
+echo "Running command:"
+echo "  $*"
+echo
+
+"$@" > "${tmp}"
+
+action="create"
+if [[ -f "${golden_path}" ]]; then
+    if diff -u "${golden_path}" "${tmp}" > /dev/null; then
+        echo "Golden file '${golden_file}' is already up-to-date."
+        rm "${tmp}"
+        exit 0
+    fi
+    echo "Diff against existing golden file '${golden_file}':"
+    diff -u "${golden_path}" "${tmp}" || true
+    action="update"
+else
+    echo "Golden file '${golden_file}' does not exist yet."
+fi
+
+echo
+echo "Golden file to ${action}: '${golden_file}'"
+read -rp "Proceed? [y/N] " answer
+
+if [[ "${answer}" =~ ^[Yy]$ ]]; then
+    mkdir -p "$(dirname "${golden_path}")"
+    mv "${tmp}" "${golden_path}"
+    echo "Golden file '${golden_file}' ${action}d."
+else
+    rm "${tmp}"
+    echo "Aborted. Golden file '${golden_file}' unchanged."
+fi