bug 39795650 - preserve DCR parser diagnostics

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 441ffc4e-56a7-490d-9689-12c392813b15

Author: mthompson83

build/linux/installer/scripts/dcr-config-parser.rb

@@ -48,7 +48,14 @@
                               .map { |stream| stream["stream"] }
 
   logs_and_events_only = streams.none? { |stream| !logs_and_events_streams.include?(stream) }
-  File.write(output_path, "#{logs_and_events_only}\n")
+  begin
+    File.write(output_path, "#{logs_and_events_only}\n")
+  rescue StandardError => e
+    ConfigParseErrorLogger.logError(
+      "Failed to write DCR parser output file '#{output_path}': #{e}"
+    )
+    exit 1
+  end
 rescue StandardError => e
   ConfigParseErrorLogger.logError("Exception while parsing dcr: #{e}")
   exit 1

build/linux/installer/scripts/dcr-config-parser_test.rb

@@ -165,6 +165,23 @@ def test_requires_caller_owned_output_path
     assert_includes stderr, "Output file path is required"
   end
 
+  def test_reports_output_file_write_failure_separately
+    write_dcr(["CONTAINERINSIGHTS_CONTAINERLOGV2"])
+    unavailable_output = File.join(@sandbox, "missing", "result")
+
+    _, stderr, status = Open3.capture3(
+      RbConfig.ruby,
+      @parser,
+      unavailable_output,
+      chdir: @sandbox
+    )
+
+    refute status.success?
+    assert_includes stderr, "Failed to write DCR parser output file"
+    assert_includes stderr, unavailable_output
+    refute_includes stderr, "Exception while parsing dcr"
+  end
+
   def test_caller_owns_all_applicability_decisions
     write_dcr(["CONTAINERINSIGHTS_CONTAINERLOGV2"])
     bypass_environments = [

kubernetes/linux/main.sh

@@ -203,37 +203,89 @@ gracefulShutdown() {
 
 DCR_OUTPUT_FILE=""
 DCR_VALUE=""
+DCR_ERROR=""
 
 cleanupDcrOutput() {
+      local cleanupoutput
+      local cleanupstatus
+
       if [ -n "${DCR_OUTPUT_FILE}" ]; then
-           rm -f -- "${DCR_OUTPUT_FILE}"
+           cleanupoutput=$(rm -f -- "${DCR_OUTPUT_FILE}" 2>&1)
+           cleanupstatus=$?
+           if [ $cleanupstatus -ne 0 ]; then
+                 if [ -n "${DCR_ERROR}" ]; then
+                       DCR_ERROR="${DCR_ERROR}
+Failed to remove DCR parser output file '${DCR_OUTPUT_FILE}': ${cleanupoutput}"
+                 else
+                       DCR_ERROR="Failed to remove DCR parser output file '${DCR_OUTPUT_FILE}': ${cleanupoutput}"
+                 fi
+                 return 1
+           fi
            DCR_OUTPUT_FILE=""
       fi
+      return 0
 }
 
 parseDcrConfig() {
       local parserstatus
+      local parseroutput
+      local mktempstatus
+      local mktempoutput
       local outputsize
+      local outputsizeerror
       local expectedsize
 
-      cleanupDcrOutput
-      DCR_OUTPUT_FILE=$(mktemp "${TMPDIR:-/tmp}/dcr_env_var.XXXXXX") || return 1
-      ruby /opt/dcr-config-parser.rb "${DCR_OUTPUT_FILE}"
+      DCR_ERROR=""
+      DCR_VALUE=""
+      if ! cleanupDcrOutput; then
+           return 1
+      fi
+      mktempoutput=$(mktemp "${TMPDIR:-/tmp}/dcr_env_var.XXXXXX" 2>&1)
+      mktempstatus=$?
+      if [ $mktempstatus -ne 0 ]; then
+           DCR_ERROR="Failed to create DCR parser output file: ${mktempoutput}"
+           return 1
+      fi
+      if [ ! -f "${mktempoutput}" ]; then
+           DCR_ERROR="Failed to create DCR parser output file: unexpected mktemp output '${mktempoutput}'"
+           return 1
+      fi
+      DCR_OUTPUT_FILE="${mktempoutput}"
+      parseroutput=$(ruby /opt/dcr-config-parser.rb "${DCR_OUTPUT_FILE}" 2>&1)
       parserstatus=$?
+      if [ $parserstatus -ne 0 ]; then
+           DCR_ERROR="${parseroutput//config::error::/}"
+      fi
       if [ $parserstatus -eq 0 ]; then
-           DCR_VALUE=""
-           IFS= read -r DCR_VALUE < "${DCR_OUTPUT_FILE}"
-           outputsize=$(wc -c < "${DCR_OUTPUT_FILE}")
-           case "${DCR_VALUE}" in
-                 true) expectedsize=5 ;;
-                 false) expectedsize=6 ;;
-                 *) expectedsize=-1 ;;
-           esac
-           if [ "${outputsize}" -ne "${expectedsize}" ]; then
+           if ! { IFS= read -r DCR_VALUE < "${DCR_OUTPUT_FILE}"; } 2>/dev/null; then
+                DCR_ERROR="DCR parser output file is empty or unreadable: '${DCR_OUTPUT_FILE}'"
                 parserstatus=1
+           else
+                outputsizeerror=$({ wc -c < "${DCR_OUTPUT_FILE}"; } 2>&1)
+                if [ $? -ne 0 ]; then
+                     DCR_ERROR="Failed to inspect DCR parser output file '${DCR_OUTPUT_FILE}': ${outputsizeerror}"
+                     parserstatus=1
+                else
+                     outputsize="${outputsizeerror//[[:space:]]/}"
+                     if [[ -z "${outputsize}" || "${outputsize}" == *[!0-9]* ]]; then
+                          DCR_ERROR="Failed to inspect DCR parser output file '${DCR_OUTPUT_FILE}': ${outputsizeerror}"
+                          parserstatus=1
+                     else
+                          case "${DCR_VALUE}" in
+                                true) expectedsize=5 ;;
+                                false) expectedsize=6 ;;
+                                *) expectedsize=-1 ;;
+                          esac
+                          if [ "${outputsize}" -ne "${expectedsize}" ]; then
+                               parserstatus=1
+                          fi
+                     fi
+                fi
            fi
       fi
-      cleanupDcrOutput
+      if ! cleanupDcrOutput; then
+           parserstatus=1
+      fi
       return $parserstatus
 }
 
@@ -1291,9 +1343,13 @@ fi
 
 if [ "${DCR_REQUIRED}" == "true" ]; then
       dcrwaitsecs=0
-      until parseDcrConfig > /dev/null 2>&1; do
+      until parseDcrConfig; do
             if [ $((dcrwaitsecs % 30)) -eq 0 ]; then
-                  echo "Required DCR is not available; waiting before retry"
+                  if [ -n "${DCR_ERROR}" ]; then
+                        printf '%s\n' "${DCR_ERROR}"
+                  else
+                        echo "Required DCR is not available; waiting before retry"
+                  fi
             fi
             sleep 5
             dcrwaitsecs=$((dcrwaitsecs + 5))

kubernetes/linux/main_test.rb

@@ -56,10 +56,21 @@ def run_onboarding(info: nil, error: nil, live_process: true)
     Open3.capture3(bash_path, "-c", script, chdir: @sandbox)
   end
 
-  def run_dcr_parser(parser_status: 0, parser_value: "true", write_output: true)
+  def run_dcr_parser(
+    parser_status: 0,
+    parser_value: "true",
+    parser_error: "",
+    write_output: true,
+    create_tmp_dir: true,
+    remove_status: 0,
+    remove_output_after_write: false,
+    initial_dcr_value: ""
+  )
     bin_dir = File.join(@sandbox, "bin")
     tmp_dir = File.join(@sandbox, "tmp")
-    FileUtils.mkdir_p([bin_dir, tmp_dir])
+    error_capture = File.join(@sandbox, "dcr-error")
+    FileUtils.mkdir_p(bin_dir)
+    FileUtils.mkdir_p(tmp_dir) if create_tmp_dir
     parser = File.join(bin_dir, "ruby")
     File.write(
       parser,
@@ -69,17 +80,33 @@ def run_dcr_parser(parser_status: 0, parser_value: "true", write_output: true)
         if [ "${WRITE_OUTPUT}" == "true" ]; then
           printf '%s\\n' "${PARSER_VALUE}" > "$output"
         fi
+        if [ "${REMOVE_OUTPUT_AFTER_WRITE}" == "true" ]; then
+          rm -f -- "$output"
+        fi
+        printf '%s' "${PARSER_ERROR}" >&2
         exit "${PARSER_STATUS}"
       SH
     )
     FileUtils.chmod(0o755, parser)
+    remove_stub = if remove_status != 0
+                    <<~SH
+                      rm() {
+                        echo "mock removal failure" >&2
+                        return "${REMOVE_STATUS}"
+                      }
+                    SH
+                  else
+                    ""
+                  end
     script = <<~SH
       #{function_source("cleanupDcrOutput")}
       #{function_source("parseDcrConfig")}
+      #{remove_stub}
       DCR_OUTPUT_FILE=""
-      DCR_VALUE=""
+      DCR_VALUE="${INITIAL_DCR_VALUE}"
       parseDcrConfig
       status=$?
+      printf '%s' "$DCR_ERROR" > "#{shell_path(error_capture)}"
       printf '%s\\n' "$DCR_VALUE"
       printf '%s\\n' "$DCR_OUTPUT_FILE"
       exit "$status"
@@ -90,13 +117,19 @@ def run_dcr_parser(parser_status: 0, parser_value: "true", write_output: true)
         "TMPDIR" => shell_path(tmp_dir),
         "PARSER_STATUS" => parser_status.to_s,
         "PARSER_VALUE" => parser_value,
+        "PARSER_ERROR" => parser_error,
         "WRITE_OUTPUT" => write_output.to_s,
+        "REMOVE_STATUS" => remove_status.to_s,
+        "REMOVE_OUTPUT_AFTER_WRITE" => remove_output_after_write.to_s,
+        "INITIAL_DCR_VALUE" => initial_dcr_value,
       },
       bash_path,
       "-c",
       script,
       chdir: @sandbox
-    ).then { |stdout, stderr, status| [stdout.lines.map(&:chomp), stderr, status, tmp_dir] }
+    ).then do |stdout, stderr, status|
+      [stdout.lines.map(&:chomp), stderr, status, tmp_dir, File.read(error_capture)]
+    end
   end
 
   def run_set_global_env_var(env_path)
@@ -238,6 +271,68 @@ def test_parse_dcr_config_propagates_parser_failure_and_removes_temporary_output
     assert_empty Dir.glob(File.join(tmp_dir, "dcr_env_var.*"))
   end
 
+  def test_parse_dcr_config_preserves_parser_diagnostic
+    _, _, status, _, diagnostic = run_dcr_parser(
+      parser_status: 23,
+      parser_error: "Failed to write DCR parser output file"
+    )
+
+    refute status.success?
+    assert_equal "Failed to write DCR parser output file", diagnostic
+  end
+
+  def test_parse_dcr_config_removes_telemetry_error_marker_from_startup_diagnostic
+    _, _, status, _, diagnostic = run_dcr_parser(
+      parser_status: 23,
+      parser_error: "config::error::Failed to write DCR parser output file"
+    )
+
+    refute status.success?
+    assert_includes diagnostic, "Failed to write DCR parser output file"
+    refute_includes diagnostic, "config::error::"
+  end
+
+  def test_parse_dcr_config_clears_stale_value_before_failure
+    output, _, status, = run_dcr_parser(
+      parser_status: 23,
+      initial_dcr_value: "true"
+    )
+
+    refute status.success?
+    assert_equal "", output.first
+  end
+
+  def test_parse_dcr_config_captures_temporary_file_creation_error
+    _, stderr, status, _, diagnostic = run_dcr_parser(create_tmp_dir: false)
+
+    refute status.success?
+    assert_empty stderr
+    assert_includes diagnostic, "Failed to create DCR parser output file"
+    assert_includes diagnostic, "dcr_env_var.XXXXXX"
+    assert_includes diagnostic, "No such file or directory"
+  end
+
+  def test_parse_dcr_config_captures_temporary_file_cleanup_error
+    _, stderr, status, _, diagnostic = run_dcr_parser(remove_status: 17)
+
+    refute status.success?, "stderr=#{stderr.inspect} diagnostic=#{diagnostic.inspect}"
+    assert_empty stderr
+    assert_includes diagnostic, "Failed to remove DCR parser output file"
+    assert_includes diagnostic, "mock removal failure"
+  end
+
+  def test_parse_dcr_config_captures_output_open_error_without_stderr
+    _, stderr, status, _, diagnostic = run_dcr_parser(remove_output_after_write: true)
+
+    refute status.success?
+    assert_empty stderr
+    assert_includes diagnostic, "empty or unreadable"
+  end
+
+  def test_dcr_wait_does_not_redirect_the_function_to_dev_null
+    refute_match(/until parseDcrConfig\s*>\s*\/dev\/null/, File.read(MAIN_PATH))
+  end
+
   def test_set_global_env_var_fails_when_state_cannot_be_written
     _, _, status = run_set_global_env_var(File.join(@sandbox, "missing", "env_vars"))