Updates logr, zapr, packet logr, bmclib dependencies

joelrebel · joelrebel · commit 2a4ece95ff20 · 2022-01-25T15:17:52.000+01:00
github.com/go-logr/logr v0.4.0 -> v1.2.2 github.com/go-logr/zapr v0.4.0 -> v1.2.2 github.com/bmc-toolbox/bmclib v0.4.14 -> v0.4.16 packethost/pkg/log/logr -> packethost/pkg/log/logr/v2 bmclib updated in this change becuse of the indirect (bmclib v0.4.14) dependency on the on logr v0.4.0. expects PR merge: packethost/pkg#51
diff --git a/cmd/machine.go b/cmd/machine.go
@@ -5,7 +5,7 @@ import (
 	"fmt"
 	"os"
 
-	"github.com/packethost/pkg/log/logr"
+	"github.com/packethost/pkg/log/logr/v2"
 	"github.com/spf13/cobra"
 	v1 "github.com/tinkerbell/pbnj/api/v1"
 	v1Client "github.com/tinkerbell/pbnj/client"
diff --git a/cmd/server.go b/cmd/server.go
@@ -17,7 +17,7 @@ import (
 	grpc_validator "github.com/grpc-ecosystem/go-grpc-middleware/validator"
 	grpc_prometheus "github.com/grpc-ecosystem/go-grpc-prometheus"
 	"github.com/packethost/pkg/grpc/authz"
-	"github.com/packethost/pkg/log/logr"
+	"github.com/packethost/pkg/log/logr/v2"
 	"github.com/spf13/cobra"
 	grpcsvr "github.com/tinkerbell/pbnj/grpc"
 	"github.com/tinkerbell/pbnj/pkg/http"
@@ -97,9 +97,9 @@ var (
 			)
 
 			httpServer := http.NewServer(metricsAddr)
-			httpServer.WithLogger(logger)
+			httpServer.WithLogger(logger.Logger)
 
-			if err := grpcsvr.RunServer(ctx, zaplog.RegisterLogger(logger), grpcServer, port, httpServer, grpcsvr.WithBmcTimeout(bmcTimeout)); err != nil {
+			if err := grpcsvr.RunServer(ctx, zaplog.RegisterLogger(logger.Logger), grpcServer, port, httpServer, grpcsvr.WithBmcTimeout(bmcTimeout)); err != nil {
 				logger.Error(err, "error running server")
 				os.Exit(1)
 			}
diff --git a/go.mod b/go.mod
@@ -3,13 +3,13 @@ module github.com/tinkerbell/pbnj
 go 1.16
 
 require (
-	github.com/bmc-toolbox/bmclib v0.4.14-0.20211027184927-2f9a20e0a479
+	github.com/bmc-toolbox/bmclib v0.4.16-0.20211230160158-5afdbf3b6a65
 	github.com/cristalhq/jwt/v3 v3.0.9
 	github.com/dgrijalva/jwt-go v3.2.0+incompatible
 	github.com/equinix-labs/otel-init-go v0.0.4
 	github.com/fatih/color v1.7.0
-	github.com/go-logr/logr v0.4.0
-	github.com/go-logr/zapr v0.4.0
+	github.com/go-logr/logr v1.2.2
+	github.com/go-logr/zapr v1.2.2
 	github.com/go-test/deep v1.0.7
 	github.com/golang/protobuf v1.5.2
 	github.com/google/go-cmp v0.5.6
@@ -21,7 +21,7 @@ require (
 	github.com/mwitkow/go-proto-validators v0.3.2
 	github.com/onsi/gomega v1.10.4
 	github.com/packethost/pkg/grpc/authz v0.0.0-20210106215246-8e2e62dc8f0c
-	github.com/packethost/pkg/log/logr v0.0.0-20210106215246-8e2e62dc8f0c
+	github.com/packethost/pkg/log/logr/v2 v2.0.0
 	github.com/philippgille/gokv v0.6.0
 	github.com/philippgille/gokv/freecache v0.6.0
 	github.com/pkg/errors v0.9.1
@@ -33,10 +33,12 @@ require (
 	go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc v0.26.1
 	go.opentelemetry.io/otel v1.1.0
 	go.opentelemetry.io/otel/trace v1.1.0
-	go.uber.org/zap v1.16.0
+	go.uber.org/zap v1.19.0
 	goa.design/goa v2.2.5+incompatible
 	golang.org/x/sync v0.0.0-20201207232520-09787c993a3a
 	google.golang.org/grpc v1.41.0
 	google.golang.org/protobuf v1.27.1
 	gopkg.in/yaml.v2 v2.4.0
 )
+
+replace github.com/packethost/pkg/log/logr/v2 v2.0.0 => github.com/joelrebel/pkg/log/logr/v2 v2.0.0
diff --git a/go.sum b/go.sum
diff --git a/grpc/oob/common_test.go b/grpc/oob/common_test.go
@@ -8,7 +8,7 @@ import (
 	"time"
 
 	"github.com/google/go-cmp/cmp"
-	"github.com/packethost/pkg/log/logr"
+	"github.com/packethost/pkg/log/logr/v2"
 	v1 "github.com/tinkerbell/pbnj/api/v1"
 	"github.com/tinkerbell/pbnj/pkg/repository"
 )
@@ -22,12 +22,12 @@ func TestParseAuth(t *testing.T) {
 		"nil Direct Auth": {input: &v1.Authn{Authn: &v1.Authn_DirectAuthn{DirectAuthn: nil}}, want: &repository.Error{Code: v1.Code_value["UNAUTHENTICATED"], Message: "no auth found", Details: nil}},
 		"nil auth":        {input: nil, want: &repository.Error{Code: v1.Code_value["UNAUTHENTICATED"], Message: "no auth found", Details: nil}},
 	}
-	l, _, _ := logr.NewPacketLogr()
+	packetLogr, _, _ := logr.NewPacketLogr()
 	sm := make(chan string)
 	for name, tc := range tests {
 		t.Run(name, func(t *testing.T) {
 			a := Accessory{
-				Log:            l,
+				Log:            packetLogr.Logger,
 				StatusMessages: sm,
 			}
 
@@ -66,14 +66,14 @@ func TestSendStatusMessage(t *testing.T) {
 		"without chan receiver": {runChanReceiver: false, want: nil},
 	}
 
-	l, _, _ := logr.NewPacketLogr()
+	packetLogr, _, _ := logr.NewPacketLogr()
 	sm := make(chan string)
 	for name, tc := range tests {
 		t.Run(name, func(t *testing.T) {
 			var msgs []string
 			done := make(chan bool, 1)
 			a := Accessory{
-				Log:            l,
+				Log:            packetLogr.Logger,
 				StatusMessages: sm,
 			}
 
diff --git a/grpc/rpc/bmc_test.go b/grpc/rpc/bmc_test.go
@@ -11,7 +11,7 @@ import (
 
 	"github.com/google/go-cmp/cmp"
 	"github.com/grpc-ecosystem/go-grpc-middleware/logging/zap/ctxzap"
-	"github.com/packethost/pkg/log/logr"
+	"github.com/packethost/pkg/log/logr/v2"
 	"github.com/philippgille/gokv"
 	"github.com/philippgille/gokv/freecache"
 	v1 "github.com/tinkerbell/pbnj/api/v1"
@@ -39,8 +39,8 @@ func TestMain(m *testing.M) {
 
 func setup() {
 	ctx = context.Background()
-	l, zapLogger, _ := logr.NewPacketLogr()
-	log = zaplog.RegisterLogger(l)
+	packetLogr, zapLogger, _ := logr.NewPacketLogr()
+	logger := zaplog.RegisterLogger(packetLogr.Logger)
 	ctx = ctxzap.ToContext(ctx, zapLogger)
 	f := freecache.NewStore(freecache.DefaultOptions)
 	s := gokv.Store(f)
@@ -52,10 +52,10 @@ func setup() {
 	taskRunner = &taskrunner.Runner{
 		Repository: repo,
 		Ctx:        ctx,
-		Log:        log,
+		Log:        logger,
 	}
 	bmcService = BmcService{
-		Log:                    log,
+		Log:                    logger,
 		TaskRunner:             taskRunner,
 		UnimplementedBMCServer: v1.UnimplementedBMCServer{},
 	}
diff --git a/grpc/rpc/machine_test.go b/grpc/rpc/machine_test.go
@@ -8,7 +8,7 @@ import (
 	"github.com/google/go-cmp/cmp"
 	"github.com/grpc-ecosystem/go-grpc-middleware/logging/zap/ctxzap"
 	"github.com/onsi/gomega"
-	"github.com/packethost/pkg/log/logr"
+	"github.com/packethost/pkg/log/logr/v2"
 	"github.com/philippgille/gokv"
 	"github.com/philippgille/gokv/freecache"
 	v1 "github.com/tinkerbell/pbnj/api/v1"
@@ -62,8 +62,8 @@ func TestDevice(t *testing.T) {
 
 			ctx := context.Background()
 
-			l, zapLogger, _ := logr.NewPacketLogr()
-			logger := zaplog.RegisterLogger(l)
+			packetLogr, zapLogger, _ := logr.NewPacketLogr()
+			logger := zaplog.RegisterLogger(packetLogr.Logger)
 			ctx = ctxzap.ToContext(ctx, zapLogger)
 			f := freecache.NewStore(freecache.DefaultOptions)
 			s := gokv.Store(f)
@@ -166,8 +166,8 @@ func TestPower(t *testing.T) {
 
 			ctx := context.Background()
 
-			l, zapLogger, _ := logr.NewPacketLogr()
-			logger := zaplog.RegisterLogger(l)
+			packetLogr, zapLogger, _ := logr.NewPacketLogr()
+			logger := zaplog.RegisterLogger(packetLogr.Logger)
 			ctx = ctxzap.ToContext(ctx, zapLogger)
 			f := freecache.NewStore(freecache.DefaultOptions)
 			s := gokv.Store(f)
diff --git a/grpc/rpc/task_test.go b/grpc/rpc/task_test.go
@@ -7,7 +7,7 @@ import (
 
 	"github.com/grpc-ecosystem/go-grpc-middleware/logging/zap/ctxzap"
 	"github.com/onsi/gomega"
-	"github.com/packethost/pkg/log/logr"
+	"github.com/packethost/pkg/log/logr/v2"
 	"github.com/philippgille/gokv"
 	"github.com/philippgille/gokv/freecache"
 	"github.com/rs/xid"
@@ -26,8 +26,8 @@ func TestTaskFound(t *testing.T) {
 		Message: "",
 		Details: nil,
 	}
-	l, zapLogger, _ := logr.NewPacketLogr()
-	logger := zaplog.RegisterLogger(l)
+	packetLogr, zapLogger, _ := logr.NewPacketLogr()
+	logger := zaplog.RegisterLogger(packetLogr.Logger)
 	ctx = ctxzap.ToContext(ctx, zapLogger)
 	f := freecache.NewStore(freecache.DefaultOptions)
 	s := gokv.Store(f)
@@ -82,9 +82,8 @@ func TestRecordNotFound(t *testing.T) {
 			g := gomega.NewGomegaWithT(t)
 
 			ctx := context.Background()
-
-			l, zapLogger, _ := logr.NewPacketLogr()
-			logger := zaplog.RegisterLogger(l)
+			packetLogr, zapLogger, _ := logr.NewPacketLogr()
+			logger := zaplog.RegisterLogger(packetLogr.Logger)
 			ctx = ctxzap.ToContext(ctx, zapLogger)
 			f := freecache.NewStore(freecache.DefaultOptions)
 			s := gokv.Store(f)
diff --git a/grpc/server.go b/grpc/server.go
@@ -114,18 +114,18 @@ func RunServer(ctx context.Context, log logging.Logger, grpcServer *grpc.Server,
 	signal.Notify(sigChan, os.Interrupt)
 	go func() {
 		for range sigChan {
-			log.Info("sig received, shutting down PBnJ")
+			log.Info(0, "sig received, shutting down PBnJ")
 			grpcServer.GracefulStop()
 			<-ctx.Done()
 		}
 	}()
 
 	go func() {
 		<-ctx.Done()
-		log.Info("ctx cancelled, shutting down PBnJ")
+		log.Info(0, "ctx cancelled, shutting down PBnJ")
 		grpcServer.GracefulStop()
 	}()
 
-	log.Info("starting PBnJ gRPC server")
+	log.Info(0, "starting PBnJ gRPC server")
 	return grpcServer.Serve(listen)
 }
diff --git a/grpc/server_test.go b/grpc/server_test.go
@@ -11,7 +11,7 @@ import (
 	"time"
 
 	"github.com/grpc-ecosystem/go-grpc-middleware/logging/zap/ctxzap"
-	"github.com/packethost/pkg/log/logr"
+	"github.com/packethost/pkg/log/logr/v2"
 	"github.com/philippgille/gokv"
 	"github.com/philippgille/gokv/freecache"
 	"github.com/tinkerbell/pbnj/grpc/persistence"
@@ -24,8 +24,8 @@ import (
 func TestRunServer(t *testing.T) {
 	ctx := context.Background()
 	ctx, cancel := context.WithTimeout(ctx, 9*time.Second)
-	l, zapLogger, err := logr.NewPacketLogr()
-	log := zaplog.RegisterLogger(l)
+	logger, zapLogger, err := logr.NewPacketLogr()
+	log := zaplog.RegisterLogger(logger.Logger)
 	ctx = ctxzap.ToContext(ctx, zapLogger)
 	if err != nil {
 		t.Fatal(err)
@@ -43,7 +43,7 @@ func TestRunServer(t *testing.T) {
 
 	grpcServer := grpc.NewServer()
 	httpServer := http.NewServer(fmt.Sprintf(":%d", port+1))
-	httpServer.WithLogger(l)
+	httpServer.WithLogger(logger.Logger)
 
 	g := new(errgroup.Group)
 	g.Go(func() error {
@@ -61,8 +61,8 @@ func TestRunServerSignals(t *testing.T) {
 	ctx := context.Background()
 	ctx, cancel := context.WithTimeout(ctx, 3*time.Second)
 	defer cancel()
-	l, zapLogger, err := logr.NewPacketLogr()
-	log := zaplog.RegisterLogger(l)
+	logger, zapLogger, err := logr.NewPacketLogr()
+	log := zaplog.RegisterLogger(logger.Logger)
 	ctx = ctxzap.ToContext(ctx, zapLogger)
 	if err != nil {
 		t.Fatal(err)
@@ -74,7 +74,7 @@ func TestRunServerSignals(t *testing.T) {
 	port := rand.Intn(max-min+1) + min
 	grpcServer := grpc.NewServer()
 	httpServer := http.NewServer(fmt.Sprintf(":%d", port+1))
-	httpServer.WithLogger(l)
+	httpServer.WithLogger(logger.Logger)
 
 	g := new(errgroup.Group)
 	g.Go(func() error {
@@ -105,16 +105,16 @@ func TestRunServerPortInUse(t *testing.T) {
 	ctx := context.Background()
 	ctx, cancel := context.WithTimeout(ctx, 5*time.Second)
 	defer cancel()
-	l, zapLogger, err := logr.NewPacketLogr()
-	log := zaplog.RegisterLogger(l)
+	logger, zapLogger, err := logr.NewPacketLogr()
+	log := zaplog.RegisterLogger(logger.Logger)
 	ctx = ctxzap.ToContext(ctx, zapLogger)
 	if err != nil {
 		t.Fatal(err)
 	}
 
 	grpcServer := grpc.NewServer()
 	httpServer := http.NewServer(fmt.Sprintf(":%d", port+1))
-	httpServer.WithLogger(l)
+	httpServer.WithLogger(logger.Logger)
 
 	err = RunServer(ctx, log, grpcServer, strconv.Itoa(port), httpServer)
 	if err.Error() != "listen tcp :40039: bind: address already in use" {
diff --git a/grpc/taskrunner/taskrunner_test.go b/grpc/taskrunner/taskrunner_test.go
@@ -6,7 +6,7 @@ import (
 	"time"
 
 	"github.com/grpc-ecosystem/go-grpc-middleware/logging/zap/ctxzap"
-	"github.com/packethost/pkg/log/logr"
+	"github.com/packethost/pkg/log/logr/v2"
 	"github.com/philippgille/gokv"
 	"github.com/philippgille/gokv/freecache"
 	"github.com/rs/xid"
@@ -27,8 +27,8 @@ func TestRoundTrip(t *testing.T) {
 	s := gokv.Store(f)
 	defer s.Close()
 	repo := &persistence.GoKV{Store: s, Ctx: ctx}
-	l, zapLogger, _ := logr.NewPacketLogr()
-	logger := zaplog.RegisterLogger(l)
+	packetLogr, zapLogger, _ := logr.NewPacketLogr()
+	logger := zaplog.RegisterLogger(packetLogr.Logger)
 	ctx = ctxzap.ToContext(ctx, zapLogger)
 	runner := Runner{
 		Repository: repo,
diff --git a/pkg/logging/logging.go b/pkg/logging/logging.go
@@ -8,6 +8,6 @@ import (
 
 // Logger represent common interface for logging function.
 type Logger interface {
-	logr.Logger
+	logr.LogSink
 	GetContextLogger(ctx context.Context) logr.Logger
 }
diff --git a/pkg/zaplog/zap.go b/pkg/zaplog/zap.go
@@ -11,7 +11,7 @@ import (
 
 // Logger is a wrapper around zap.SugaredLogger.
 type Logger struct {
-	logr.Logger
+	logr.LogSink
 }
 
 // GetContextLogger get and return a logger from a ctx.
@@ -21,5 +21,5 @@ func (l Logger) GetContextLogger(ctx context.Context) logr.Logger {
 
 // RegisterLogger returns a logr and a zap logger (needed for use in grpc interceptors).
 func RegisterLogger(log logr.Logger) logging.Logger {
-	return Logger{log}
+	return Logger{log.GetSink()}
 }
diff --git a/test/main.go b/test/main.go
@@ -8,7 +8,7 @@ import (
 	"strconv"
 	"time"
 
-	"github.com/packethost/pkg/log/logr"
+	"github.com/packethost/pkg/log/logr/v2"
 	"github.com/tinkerbell/pbnj/cmd"
 	"github.com/tinkerbell/pbnj/test/runner"
 )
@@ -48,7 +48,7 @@ func main() {
 
 	fmt.Println(*logLevel)
 	logger, _, _ := logr.NewPacketLogr(logr.WithLogLevel(*logLevel))
-	runner.RunTests(logger, cfgData)
+	runner.RunTests(logger.Logger, cfgData)
 }
 
 // Returns an int >= min, < max.
