Skip to content

chore(logger): move logger to internal #1979

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 7, 2025
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
5 changes: 3 additions & 2 deletions cmd/kepler/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import (
"github.com/alecthomas/kingpin/v2"
"github.com/oklog/run"
"github.com/sustainable-computing-io/kepler/internal/config"
"github.com/sustainable-computing-io/kepler/internal/logger"
"github.com/sustainable-computing-io/kepler/internal/version"
)

Expand All @@ -22,7 +23,7 @@ func main() {
if err != nil {
os.Exit(1)
}
logger := setupLogger(cfg.Log.Level, cfg.Log.Format)
logger := logger.New(cfg.Log.Level, cfg.Log.Format)
logVersionInfo(logger)
printConfigInfo(logger, cfg)

Expand Down Expand Up @@ -110,7 +111,7 @@ func parseArgsAndConfig() (*config.Config, error) {
updateConfig := config.RegisterFlags(app)
kingpin.MustParse(app.Parse(os.Args[1:]))

logger := setupLogger("info", "text")
logger := logger.New("info", "text")
cfg := config.DefaultConfig()
if *configFile != "" {
logger.Info("Loading configuration file", "path", *configFile)
Expand Down
4 changes: 2 additions & 2 deletions cmd/kepler/logger.go → internal/logger/logger.go
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// SPDX-FileCopyrightText: 2025 The Kepler Authors
// SPDX-License-Identifier: Apache-2.0

package main
package logger

import (
"fmt"
Expand All @@ -11,7 +11,7 @@ import (
"strings"
)

func setupLogger(level, format string) *slog.Logger {
func New(level, format string) *slog.Logger {
logLevel := parseLogLevel(level)
return slog.New(handlerForFormat(format, logLevel))
}
Expand Down
53 changes: 50 additions & 3 deletions cmd/kepler/logger_test.go → internal/logger/logger_test.go
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
// SPDX-FileCopyrightText: 2025 The Kepler Authors
// SPDX-License-Identifier: Apache-2.0

package main
package logger

import (
"bytes"
"encoding/json"
"log/slog"
"os"
"strings"
"testing"
Expand Down Expand Up @@ -65,7 +66,7 @@ func TestSetupLogger(t *testing.T) {
t.Run(tt.name, func(t *testing.T) {
if tt.expectPanic {
assert.Panics(t, func() {
_ = setupLogger(tt.format, tt.logLevel)
_ = New(tt.logLevel, tt.format)
}, "Expected setupLogger to panic with invalid format")
//
return
Expand All @@ -77,7 +78,7 @@ func TestSetupLogger(t *testing.T) {
r, w, _ := os.Pipe()
os.Stdout = w

logger := setupLogger(tt.logLevel, tt.format)
logger := New(tt.logLevel, tt.format)
logger.Info("test message", "key", "value")

// Restore stdout
Expand Down Expand Up @@ -120,3 +121,49 @@ func TestSetupLogger(t *testing.T) {
})
}
}

func TestParseLogLevel(t *testing.T) {
tests := []struct {
name string
level string
expected slog.Level
}{
{
name: "debug level",
level: "debug",
expected: slog.LevelDebug,
},
{
name: "info level",
level: "info",
expected: slog.LevelInfo,
},
{
name: "warn level",
level: "warn",
expected: slog.LevelWarn,
},
{
name: "error level",
level: "error",
expected: slog.LevelError,
},
{
name: "invalid level defaults to info",
level: "invalid",
expected: slog.LevelInfo,
},
{
name: "empty level defaults to info",
level: "",
expected: slog.LevelInfo,
},
}

for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
result := parseLogLevel(tt.level)
assert.Equal(t, tt.expected, result, "parseLogLevel(%q) = %v, want %v", tt.level, result, tt.expected)
})
}
}