feat(kubernetes): let a node group log the guest serial console - #3637

packages/apps/kubernetes-nodes/tests/serial_console_log_test.yaml (1)

37-53: 🩺 Stability & Availability | 🔵 Trivial | ⚡ Quick win

Assert the hash-stability contract directly.

These tests verify only that logSerialConsole is absent. They do not verify that unset and false produce the same rendered bytes or KubevirtMachineTemplate.metadata.name. A whitespace-only change can still change the content hash and roll worker VMs while these assertions pass. Add a regression check for the rendered output or template name.

This follows the PR objective that unset and false values preserve identical output.

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@packages/apps/kubernetes-nodes/tests/serial_console_log_test.yaml` around
lines 37 - 53, Extend the default and explicitly disabled cases in the serial
console Helm tests to assert the hash-stability contract directly: verify that
unset and false render identical output or produce the same
KubevirtMachineTemplate.metadata.name, while retaining the existing absence
assertions.

hack/e2e-chainsaw/_lib/run-kubernetes.sh (1)

709-717: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low value

Quote ${pods} in the truncation count.

pods already holds one Pod name per line, so wc -l returns the same total when the expansion is quoted. Quoting removes the pathname expansion that shellcheck reports at line 714 and keeps the shell lint gate clean.

♻️ Proposed fix

       printf 'capture stopped after %s Pods; %s matched in total\n' \
-        "${max_pods}" "$(printf '%s\n' ${pods} | wc -l | tr -d ' ')" \
+        "${max_pods}" "$(printf '%s\n' "${pods}" | wc -l | tr -d ' ')" \
         >"${report_dir}/COLLECTION-TRUNCATED.txt"

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@hack/e2e-chainsaw/_lib/run-kubernetes.sh` around lines 709 - 717, Update the
truncation count in the loop around the pod collection to quote the `${pods}`
expansion passed to `printf`, preserving its one-Pod-per-line content while
preventing pathname expansion and satisfying shell lint.

Source: Linters/SAST tools

hack/e2e-chainsaw/_lib/run-kubernetes.sh (2)

1774-1775: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low value

Declare attach_rc as local.

run_kubernetes_test declares its other variables with local. attach_rc leaks into the global scope. The value is reset to 0 before each use, so behavior does not change today.

♻️ Proposed change

-  attach_rc=0
+  local attach_rc=0
   cozy_assert_guest_console_attached || attach_rc=$?

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@hack/e2e-chainsaw/_lib/run-kubernetes.sh` around lines 1774 - 1775, Declare
attach_rc as a local variable in run_kubernetes_test before assigning it,
matching the function’s existing local variable declarations and preventing it
from leaking into global scope.

---

726-728: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low value

Quote ${pods} in the truncation count.

Shellcheck flags line 727 (SC2086). Pod names cannot contain glob characters, so the current form is safe today. Quoting removes the warning and keeps the count identical, because command substitution already stripped the trailing newline.

♻️ Proposed change

       printf 'capture stopped after %s Pods; %s matched in total\n' \
-        "${max_pods}" "$(printf '%s\n' ${pods} | wc -l | tr -d ' ')" \
+        "${max_pods}" "$(printf '%s\n' "${pods}" | wc -l | tr -d ' ')" \
         >"${report_dir}/COLLECTION-TRUNCATED.txt"

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@hack/e2e-chainsaw/_lib/run-kubernetes.sh` around lines 726 - 728, Quote the
${pods} expansion in the truncation-count command substitution within the
COLLECTION-TRUNCATED report generation, preserving the existing wc -l and
whitespace-trimming behavior while eliminating ShellCheck SC2086.

Source: Linters/SAST tools

hack/run-kubernetes-serial-console_test.bats (1)

30-46: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low value

Optional: add a wedge-read failure case to the mock.

The *initContainerStatuses* branch always returns 0, so cozy_report_guest_console_wedge is never exercised on its read-failure path. That path returns 0 and prints nothing, which means a broken read is silently reported as "no wedge". A dedicated variable, for example kubectl_wedge_rc, would pin that behaviour.

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@hack/run-kubernetes-serial-console_test.bats` around lines 30 - 46, Extend
the *initContainerStatuses* branch of the mock kubectl handler to honor a
dedicated kubectl_wedge_rc return code before printing kubectl_wedge_rows.
Default it to success so existing tests remain unchanged, while allowing tests
to simulate wedge-read failures and verify cozy_report_guest_console_wedge’s
failure behavior.

hack/e2e-chainsaw/_lib/run-kubernetes.sh (1)

754-756: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low value

Quote the expansion in the total-Pod count.

${pods} is unquoted inside printf, so the shell applies pathname expansion in addition to word splitting. A Pod name is unlikely to contain a glob character, but the count is what the truncation marker reports, so make it deterministic. Quoting also clears the SC2086 hint.

♻️ Proposed fix

       printf 'capture stopped after %s Pods; %s matched in total\n' \
-        "${max_pods}" "$(printf '%s\n' ${pods} | wc -l | tr -d ' ')" \
+        "${max_pods}" "$(printf '%s\n' "${pods}" | wc -l | tr -d ' ')" \
         >"${report_dir}/COLLECTION-TRUNCATED.txt"

The count stays the same, because command substitution already stripped the trailing newline from pods.

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@hack/e2e-chainsaw/_lib/run-kubernetes.sh` around lines 754 - 756, Update the
total-Pod count in the truncation report within the collection logic to quote
the pods expansion passed to printf, preventing pathname expansion while
preserving the existing line count and report output.

Source: Linters/SAST tools

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

hack/e2e-chainsaw/_lib/run-kubernetes.sh (1)

766-772: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low value

Quote ${pods} in the truncation count.

Shellcheck flags line 769 (SC2086). Pod names cannot contain glob characters, so the current form works, but the quoted form gives the same count and removes the warning.

♻️ Proposed fix

       printf 'capture stopped after %s Pods; %s matched in total\n' \
-        "${max_pods}" "$(printf '%s\n' ${pods} | wc -l | tr -d ' ')" \
+        "${max_pods}" "$(printf '%s\n' "${pods}" | wc -l | tr -d ' ')" \
         >"${report_dir}/COLLECTION-TRUNCATED.txt"

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@hack/e2e-chainsaw/_lib/run-kubernetes.sh` around lines 766 - 772, Update the
truncation count in the pod-collection logic around the break condition to quote
the `${pods}` expansion when passing it to `printf`, preserving the existing
line count while resolving the shellcheck SC2086 warning.

Source: Linters/SAST tools

hack/e2e-chainsaw/_lib/run-kubernetes.sh (1)

782-784: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low value

Quote ${pods} in the truncation count.

${pods} is already newline-separated, so word splitting is not needed here. Quoting keeps the count correct and clears SC2086.

♻️ Proposed change

       printf 'capture stopped after %s Pods; %s matched in total\n' \
-        "${max_pods}" "$(printf '%s\n' ${pods} | wc -l | tr -d ' ')" \
+        "${max_pods}" "$(printf '%s\n' "${pods}" | wc -l | tr -d ' ')" \
         >"${report_dir}/COLLECTION-TRUNCATED.txt"

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@hack/e2e-chainsaw/_lib/run-kubernetes.sh` around lines 782 - 784, Quote the
pods expansion in the truncation-count command within the collection reporting
block, while preserving the existing newline count and whitespace trimming
behavior. Update the printf invocation that feeds wc so it uses the already
newline-separated pods value without word splitting.

Source: Linters/SAST tools