feat: util/log support to set writer and add log-to-stderr flag for k…

…usion compile
KusionStack · Jun 28, 2022 · ec64064 · ec64064
1 parent fd58099
commit ec64064
Show file tree

Hide file tree

Showing 7 changed files with 72 additions and 2 deletions.
diff --git a/go.sum b/go.sum
@@ -1351,8 +1351,6 @@ kusionstack.io/kcl-plugin v0.4.1-alpha2 h1:m43JJhpJSjl/Q3FqghJf5dRIwdXsrJeKxrHhg
 kusionstack.io/kcl-plugin v0.4.1-alpha2/go.mod h1:VgB7qXVbDGWFOh/qb/yXf75+UrliP5EPXOQUDqBCdAQ=
 kusionstack.io/kclvm-go v0.4.2-alpha.9 h1:c4mDJFlKuP3CbGTtEkFEQidxcsJpGHNCDBtv7eexlH8=
 kusionstack.io/kclvm-go v0.4.2-alpha.9/go.mod h1:LKGVud6Ch0dLLACwPqZQyU4E+NkLAXzveJFQWVb5Pbk=
-kusionstack.io/kclvm-go v0.4.2-alpha4 h1:HL8dElxruBHcPbPl3MsfoojFhfeHDH/GHeUryuekrho=
-kusionstack.io/kclvm-go v0.4.2-alpha4/go.mod h1:LKGVud6Ch0dLLACwPqZQyU4E+NkLAXzveJFQWVb5Pbk=
 rsc.io/binaryregexp v0.2.0/go.mod h1:qTv7/COck+e2FymRvadv62gMdZztPaShugOCi3I+8D8=
 rsc.io/quote/v3 v3.1.0/go.mod h1:yEA65RcK8LyAZtP9Kv3t0HmxON59tX3rD+tICJqUlj0=
 rsc.io/sampler v1.3.0/go.mod h1:T1hPZKmBbMNahiBKFy5HrXp6adAjACjK9JXDnKaTXpA=

diff --git a/pkg/kusionctl/cmd/compile/compile.go b/pkg/kusionctl/cmd/compile/compile.go
@@ -70,6 +70,8 @@ func NewCmdCompile() *cobra.Command {
 		i18n.T("Specify the override option"))
 	cmd.Flags().StringSliceVarP(&o.Overrides, "overrides", "O", []string{},
 		i18n.T("Specify the configuration override path and value"))
+	cmd.Flags().BoolVarP(&o.LogToStderr, "log-to-stderr", "s", false,
+		i18n.T("log to standard error instead of files"))
 
 	return cmd
 }
diff --git a/pkg/kusionctl/cmd/compile/options.go b/pkg/kusionctl/cmd/compile/options.go
@@ -7,6 +7,7 @@ import (
 	"path/filepath"
 
 	"kusionstack.io/kusion/pkg/compile"
+	"kusionstack.io/kusion/pkg/log"
 	"kusionstack.io/kusion/pkg/projectstack"
 )
 
@@ -20,6 +21,7 @@ type CompileOptions struct {
 	DisableNone bool
 	OverrideAST bool
 	Overrides   []string
+	LogToStderr bool
 }
 
 func NewCompileOptions() *CompileOptions {
@@ -32,6 +34,9 @@ func NewCompileOptions() *CompileOptions {
 func (o *CompileOptions) Complete(args []string) {
 	o.Filenames = args
 	o.PreSet(projectstack.IsStack)
+	if o.LogToStderr {
+		log.SetOutput(os.Stderr)
+	}
 }
 
 func (o *CompileOptions) Validate() error {

diff --git a/pkg/log/log.go b/pkg/log/log.go
@@ -2,6 +2,7 @@ package log
 
 import (
 	"fmt"
+	"io"
 	"os"
 	"strings"
 )
@@ -98,3 +99,7 @@ func GetLogger() Logger {
 func With(args ...interface{}) Logger {
 	return log.With(args...)
 }
+
+func SetOutput(out io.Writer) {
+	log.SetOutput(out)
+}
diff --git a/pkg/log/log_test.go b/pkg/log/log_test.go
@@ -1,12 +1,14 @@
 package log
 
 import (
+	"os"
 	"testing"
 
 	"github.com/stretchr/testify/assert"
 )
 
 func Test_zapLogger(t *testing.T) {
+	SetOutput(os.Stderr)
 	t.Run("log debug", func(t *testing.T) {
 		Debug("foo")
 	})

diff --git a/pkg/log/types.go b/pkg/log/types.go
@@ -1,5 +1,7 @@
 package log
 
+import "io"
+
 type Level uint8
 
 const (
@@ -26,4 +28,5 @@ type Logger interface {
 	SetLevel(level Level)
 	GetLogDir() LogDir
 	With(args ...interface{}) Logger
+	SetOutput(out io.Writer)
 }
diff --git a/pkg/log/zap.go b/pkg/log/zap.go
@@ -1,6 +1,8 @@
 package log
 
 import (
+	"fmt"
+	"io"
 	"os"
 	"path/filepath"
 	"time"
@@ -28,6 +30,7 @@ type zapLogger struct {
 	debugLevel    zap.AtomicLevel
 	defaultLevel  zap.AtomicLevel
 	errorLevel    zap.AtomicLevel
+	out           io.Writer
 }
 
 func TimeEncoder(t time.Time, enc zapcore.PrimitiveArrayEncoder) {
@@ -72,50 +75,98 @@ func newZapLogger() (Logger, error) {
 }
 
 func (l *zapLogger) Debug(args ...interface{}) {
+	if l.out != nil {
+		l.out.Write([]byte(fmt.Sprint(args...)))
+		return
+	}
 	l.sugaredLogger.Debug(args...)
 }
 
 func (l *zapLogger) Debugf(format string, args ...interface{}) {
+	if l.out != nil {
+		l.out.Write([]byte(fmt.Sprintf(format, args...)))
+		return
+	}
 	l.sugaredLogger.Debugf(format, args...)
 }
 
 func (l *zapLogger) Infof(format string, args ...interface{}) {
+	if l.out != nil {
+		l.out.Write([]byte(fmt.Sprintf(format, args...)))
+		return
+	}
 	l.sugaredLogger.Infof(format, args...)
 }
 
 func (l *zapLogger) Info(args ...interface{}) {
+	if l.out != nil {
+		l.out.Write([]byte(fmt.Sprint(args...)))
+		return
+	}
 	l.sugaredLogger.Info(args...)
 }
 
 func (l *zapLogger) Warnf(format string, args ...interface{}) {
+	if l.out != nil {
+		l.out.Write([]byte(fmt.Sprintf(format, args...)))
+		return
+	}
 	l.sugaredLogger.Warnf(format, args...)
 }
 
 func (l *zapLogger) Warn(args ...interface{}) {
+	if l.out != nil {
+		l.out.Write([]byte(fmt.Sprint(args...)))
+		return
+	}
 	l.sugaredLogger.Warn(args...)
 }
 
 func (l *zapLogger) Errorf(format string, args ...interface{}) {
+	if l.out != nil {
+		l.out.Write([]byte(fmt.Sprintf(format, args...)))
+		return
+	}
 	l.sugaredLogger.Errorf(format, args...)
 }
 
 func (l *zapLogger) Error(args ...interface{}) {
+	if l.out != nil {
+		l.out.Write([]byte(fmt.Sprint(args...)))
+		return
+	}
 	l.sugaredLogger.Error(args...)
 }
 
 func (l *zapLogger) Panicf(format string, args ...interface{}) {
+	if l.out != nil {
+		l.out.Write([]byte(fmt.Sprintf(format, args...)))
+		return
+	}
 	l.sugaredLogger.Panicf(format, args...)
 }
 
 func (l *zapLogger) Panic(args ...interface{}) {
+	if l.out != nil {
+		l.out.Write([]byte(fmt.Sprint(args...)))
+		return
+	}
 	l.sugaredLogger.Panic(args...)
 }
 
 func (l *zapLogger) Fatalf(format string, args ...interface{}) {
+	if l.out != nil {
+		l.out.Write([]byte(fmt.Sprintf(format, args...)))
+		return
+	}
 	l.sugaredLogger.Fatalf(format, args...)
 }
 
 func (l *zapLogger) Fatal(args ...interface{}) {
+	if l.out != nil {
+		l.out.Write([]byte(fmt.Sprint(args...)))
+		return
+	}
 	l.sugaredLogger.Fatal(args...)
 }
 
@@ -140,6 +191,10 @@ func (l *zapLogger) With(args ...interface{}) Logger {
 	return &zapLogger{sugaredLogger: curLogger, defaultLevel: l.defaultLevel, debugLevel: l.debugLevel, errorLevel: l.errorLevel}
 }
 
+func (l *zapLogger) SetOutput(output io.Writer) {
+	l.out = output
+}
+
 func getZapLevel(level Level) zapcore.Level {
 	switch level {
 	case INFO: