Skip to content
Merged
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
2 changes: 1 addition & 1 deletion cmd/info/version.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
package info

var Version = "0.0.56"
var Version = "0.0.57"
15 changes: 14 additions & 1 deletion cmd/logs/logs.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ import (

var validLogLevels = []string{"debug", "info", "warn", "error"}

var validLogTargets = []string{"main", "metrics", "docker"}

var LogsCmd = &cobra.Command{
Use: "logs",
Short: "Retrieve workspace logs",
Expand All @@ -23,6 +25,7 @@ func execute(cmd *cobra.Command, args []string) error {
follow, _ := cmd.Flags().GetBool("follow")
tail, _ := cmd.Flags().GetInt("tail")
level, _ := cmd.Flags().GetString("level")
target, _ := cmd.Flags().GetString("target")

if level != "" && !slices.Contains(validLogLevels, level) {
styles.PrintErrorWithOptions(cmd.ErrOrStderr(), "Invalid log level. Must be one of:", [][]string{
Expand All @@ -34,7 +37,16 @@ func execute(cmd *cobra.Command, args []string) error {
return fmt.Errorf("invalid log level")
}

reader, err := logger.NewReader(tail, level)
if !slices.Contains(validLogTargets, target) {
styles.PrintErrorWithOptions(cmd.ErrOrStderr(), "Invalid log target. Must be one of:", [][]string{
{"main", "Combined workspace log"},
{"metrics", "Metrics exporter log"},
{"docker", "In-container Docker daemon log"},
})
return fmt.Errorf("invalid log target")
}

reader, err := logger.NewReader(tail, level, target)
if err != nil {
styles.PrintError(cmd.ErrOrStderr(), fmt.Sprintf("Failed to initialize log reader: %s", err))
return err
Expand All @@ -58,4 +70,5 @@ func init() {
LogsCmd.Flags().BoolP("follow", "f", false, "Follow log output in real-time")
LogsCmd.Flags().IntP("tail", "t", 0, "Number of lines to show from the end (0 for all)")
LogsCmd.Flags().StringP("level", "l", "", "Filter by log level (debug|info|warn|error)")
LogsCmd.Flags().String("target", "main", "Log target to read (main|metrics|docker)")
}
97 changes: 97 additions & 0 deletions cmd/logs/logs_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
package logs

import (
"bytes"
"os"
"path/filepath"
"strings"
"testing"

"github.com/spf13/cobra"
"gotest.tools/v3/assert"
)

func executeLogs(args ...string) (string, error) {
buffer := new(bytes.Buffer)

LogsCmd.Flags().Set("target", "main")
LogsCmd.Flags().Set("tail", "0")
LogsCmd.Flags().Set("level", "")
LogsCmd.Flags().Set("follow", "false")

cmd := &cobra.Command{}
cmd.AddCommand(LogsCmd)
cmd.SetOut(buffer)
cmd.SetErr(buffer)
cmd.SetArgs(append([]string{"logs"}, args...))

err := cmd.Execute()

return buffer.String(), err
}

func _seedLogs(t *testing.T) {
t.Helper()

tempDir := t.TempDir()

files := map[string]string{
"workspace.log": "main marker",
"metrics.log": "metrics marker",
"dockerd.log": "docker marker",
}

for name, content := range files {
assert.NilError(t, os.WriteFile(filepath.Join(tempDir, name), []byte(content+"\n"), 0644))
}

t.Setenv("WS_LOGGING_DIR", tempDir)
t.Setenv("WS_LOGGING_MAIN_FILE", "workspace.log")
t.Setenv("WS_LOGGING_METRICS_FILE", "metrics.log")
t.Setenv("WS_LOGGING_DOCKER_FILE", "dockerd.log")
}

func TestLogsDefaultTargetIsMain(t *testing.T) {
assert.Equal(t, "main", LogsCmd.Flags().Lookup("target").DefValue)
}

func TestLogsNoShortTargetAlias(t *testing.T) {
assert.Assert(t, LogsCmd.Flags().ShorthandLookup("T") == nil)
}

func TestLogsValidTargets(t *testing.T) {
tests := []struct {
target string
marker string
}{
{"main", "main marker"},
{"metrics", "metrics marker"},
{"docker", "docker marker"},
}

for _, tt := range tests {
t.Run(tt.target, func(t *testing.T) {
_seedLogs(t)

out, err := executeLogs("--target=" + tt.target)
assert.NilError(t, err)
assert.Assert(t, strings.Contains(out, tt.marker))
})
}
}

func TestLogsInvalidTargetRejected(t *testing.T) {
out, err := executeLogs("--target=garbage")

assert.ErrorContains(t, err, "invalid log target")
assert.Assert(t, strings.Contains(out, "Invalid log target"))
}

func TestLogsTargetComposesWithTailAndLevel(t *testing.T) {
_seedLogs(t)

out, err := executeLogs("--target=metrics", "--tail=5", "--level=info")

assert.NilError(t, err)
assert.Assert(t, strings.Contains(out, "metrics marker"))
}
8 changes: 6 additions & 2 deletions internals/logger/logger.go
Original file line number Diff line number Diff line change
Expand Up @@ -71,10 +71,14 @@ func Log(writer io.Writer, level, message string, indent int, withStamp bool) {
fmt.Fprintln(writer, strings.Join(parts, " "))
}

func NewReader(tailLines int, levelFilter string) (*Reader, error) {
func NewReader(tailLines int, levelFilter, target string) (*Reader, error) {
if target == "" {
target = "main"
}

logPath := filepath.Join(
config.MustResolve("logging", "dir"),
config.MustResolve("logging", "main_file"),
config.MustResolve("logging", target+"_file"),
)

if _, err := os.Stat(logPath); os.IsNotExist(err) {
Expand Down
74 changes: 73 additions & 1 deletion internals/logger/logger_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ Plain text error message`

for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
reader, err := NewReader(100, tt.levelFilter)
reader, err := NewReader(100, tt.levelFilter, "main")
assert.NilError(t, err)

var buf bytes.Buffer
Expand All @@ -110,3 +110,75 @@ Plain text error message`
})
}
}

func TestReaderTargets(t *testing.T) {
tempDir := t.TempDir()

files := map[string]string{
"workspace.log": "main marker line",
"metrics.log": "metrics marker line",
"dockerd.log": "docker marker line",
}

for name, content := range files {
assert.NilError(t, os.WriteFile(filepath.Join(tempDir, name), []byte(content+"\n"), 0644))
}

t.Setenv("WS_LOGGING_DIR", tempDir)
t.Setenv("WS_LOGGING_MAIN_FILE", "workspace.log")
t.Setenv("WS_LOGGING_METRICS_FILE", "metrics.log")
t.Setenv("WS_LOGGING_DOCKER_FILE", "dockerd.log")

tests := []struct {
name string
target string
expected string
}{
{"main", "main", "main marker line"},
{"metrics", "metrics", "metrics marker line"},
{"docker", "docker", "docker marker line"},
{"empty defaults to main", "", "main marker line"},
}

for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
reader, err := NewReader(0, "", tt.target)
assert.NilError(t, err)

var buf bytes.Buffer
err = reader.ReadLogs(&buf)
assert.NilError(t, err)

assert.Equal(t, tt.expected, strings.TrimSpace(buf.String()))
})
}
}

func TestReaderTargetMissingFile(t *testing.T) {
tempDir := t.TempDir()

t.Setenv("WS_LOGGING_DIR", tempDir)
t.Setenv("WS_LOGGING_METRICS_FILE", "metrics.log")

_, err := NewReader(0, "", "metrics")

assert.ErrorContains(t, err, "log file not found")
}

func TestReaderEmptyFile(t *testing.T) {
tempDir := t.TempDir()

assert.NilError(t, os.WriteFile(filepath.Join(tempDir, "metrics.log"), []byte{}, 0644))

t.Setenv("WS_LOGGING_DIR", tempDir)
t.Setenv("WS_LOGGING_METRICS_FILE", "metrics.log")

reader, err := NewReader(0, "", "metrics")
assert.NilError(t, err)

var buf bytes.Buffer
err = reader.ReadLogs(&buf)
assert.NilError(t, err)

assert.Equal(t, "", buf.String())
}
Loading