Merge pull request #29079 from mvanhorn/fix-quadlet-verify-stderr-logging

fix: quadlet generator emits diagnostics to stderr under systemd-analyze verify

cmd/quadlet/main.go

@@ -71,10 +71,10 @@ func Logf(format string, a ...any) {
 	s := fmt.Sprintf(format, a...)
 	line := fmt.Sprintf("quadlet-generator[%d]: %s", os.Getpid(), s)
 
-	if !logToKmsg(line) || dryRunFlag {
-		fmt.Fprintf(os.Stderr, "%s\n", line)
-		os.Stderr.Sync()
-	}
+	_ = logToKmsg(line)
+
+	fmt.Fprintf(os.Stderr, "%s\n", line)
+	os.Stderr.Sync()
 }
 
 var debugEnabled = false

cmd/quadlet/main_test.go

@@ -3,11 +3,126 @@
 package main
 
 import (
+	"fmt"
+	"io"
+	"os"
 	"testing"
 
 	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
 )
 
+func TestLogfWritesToStderrWhenKmsgUnavailable(t *testing.T) {
+	restoreLogGlobals(t)
+	noKmsg = true
+	kmsgFile = nil
+	dryRunFlag = false
+
+	stderr := captureStderr(t, func() {
+		Logf("kmsg unavailable")
+	})
+
+	assert.Equal(t, expectedLogLine("kmsg unavailable")+"\n", stderr)
+}
+
+func TestLogfWritesToStderrWhenKmsgSucceeds(t *testing.T) {
+	restoreLogGlobals(t)
+	noKmsg = false
+	dryRunFlag = false
+
+	tmpFile, err := os.CreateTemp(t.TempDir(), "kmsg")
+	require.NoError(t, err)
+	t.Cleanup(func() {
+		tmpFile.Close()
+	})
+	kmsgFile = tmpFile
+
+	stderr := captureStderr(t, func() {
+		Logf("kmsg succeeds")
+	})
+
+	line := expectedLogLine("kmsg succeeds")
+	assert.Equal(t, line+"\n", stderr)
+
+	_, err = tmpFile.Seek(0, io.SeekStart)
+	require.NoError(t, err)
+	kmsg, err := io.ReadAll(tmpFile)
+	require.NoError(t, err)
+	assert.Equal(t, line, string(kmsg))
+}
+
+func TestLogfWritesToStderrInDryRun(t *testing.T) {
+	restoreLogGlobals(t)
+	noKmsg = true
+	kmsgFile = nil
+	dryRunFlag = true
+
+	stderr := captureStderr(t, func() {
+		Logf("dry run")
+	})
+
+	assert.Equal(t, expectedLogLine("dry run")+"\n", stderr)
+}
+
+func TestLogfWritesToStderrWhenKmsgWriteFails(t *testing.T) {
+	restoreLogGlobals(t)
+	noKmsg = false
+	dryRunFlag = false
+
+	tmpFile, err := os.CreateTemp(t.TempDir(), "kmsg")
+	require.NoError(t, err)
+	require.NoError(t, tmpFile.Close())
+	kmsgFile = tmpFile
+
+	stderr := captureStderr(t, func() {
+		Logf("kmsg write failure")
+	})
+
+	assert.Equal(t, expectedLogLine("kmsg write failure")+"\n", stderr)
+	assert.Nil(t, kmsgFile)
+}
+
+func restoreLogGlobals(t *testing.T) {
+	t.Helper()
+
+	oldNoKmsg := noKmsg
+	oldKmsgFile := kmsgFile
+	oldDryRunFlag := dryRunFlag
+
+	t.Cleanup(func() {
+		noKmsg = oldNoKmsg
+		kmsgFile = oldKmsgFile
+		dryRunFlag = oldDryRunFlag
+	})
+}
+
+func captureStderr(t *testing.T, f func()) string {
+	t.Helper()
+
+	oldStderr := os.Stderr
+	reader, writer, err := os.Pipe()
+	require.NoError(t, err)
+
+	os.Stderr = writer
+	defer func() {
+		os.Stderr = oldStderr
+	}()
+
+	f()
+	require.NoError(t, writer.Close())
+	os.Stderr = oldStderr
+
+	output, err := io.ReadAll(reader)
+	require.NoError(t, err)
+	require.NoError(t, reader.Close())
+
+	return string(output)
+}
+
+func expectedLogLine(message string) string {
+	return fmt.Sprintf("quadlet-generator[%d]: %s", os.Getpid(), message)
+}
+
 func TestIsUnambiguousName(t *testing.T) {
 	tests := []struct {
 		input string