Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions cmd/quadlet/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -70,10 +70,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)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This function returns a bool value; should it be like this?:

Suggested change
logToKmsg(line)
_ :=logToKmsg(line)


fmt.Fprintf(os.Stderr, "%s\n", line)
os.Stderr.Sync()
}

var debugEnabled = false
Expand Down
115 changes: 115 additions & 0 deletions cmd/quadlet/main_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down