move to klog, and refactoring around error handling

Krish Chowdhary · Krish Chowdhary · commit 397b37ba8328 · 2021-02-25T17:27:31.000-05:00
diff --git a/cmd/csi-adapter/cmd.go b/cmd/csi-adapter/cmd.go
@@ -20,9 +20,9 @@ import (
 	"flag"
 	"os"
 
-	_ "github.com/golang/glog"
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
+	_ "k8s.io/klog/v2"
 )
 
 var Version string
@@ -51,7 +51,7 @@ func init() {
 	Version = "v0.0.1"
 
 	viper.AutomaticEnv()
-	// parse the go default flagset to get flags for glog and other packages in future
+	// parse the go default flagset to get flags for klog and other packages in future
 	driverCmd.PersistentFlags().AddGoFlagSet(flag.CommandLine)
 	// defaulting this to true so that logs are printed to console
 	_ = flag.Set("logtostderr", "true")
@@ -71,7 +71,7 @@ func init() {
 	_ = driverCmd.PersistentFlags().MarkHidden("stderrthreshold")
 	_ = driverCmd.PersistentFlags().MarkHidden("vmodule")
 
-	// suppress the incorrect prefix in glog output
+	// suppress the incorrect prefix in klog output
 	_ = flag.CommandLine.Parse([]string{})
 	_ = viper.BindPFlags(driverCmd.PersistentFlags())
 }
diff --git a/cmd/csi-adapter/driver.go b/cmd/csi-adapter/driver.go
@@ -19,17 +19,15 @@ package main
 import (
 	"os"
 
-	"github.com/golang/glog"
 	csicommon "github.com/kubernetes-csi/drivers/pkg/csi-common"
-	"k8s.io/klog"
+	"k8s.io/klog/v2"
 
-	"github.com/kubernetes-sigs/container-object-storage-interface-csi-adapter/pkg/controller"
-	id "github.com/kubernetes-sigs/container-object-storage-interface-csi-adapter/pkg/identity"
-	"github.com/kubernetes-sigs/container-object-storage-interface-csi-adapter/pkg/node"
+	"sigs.k8s.io/container-object-storage-interface-csi-adapter/pkg/controller"
+	id "sigs.k8s.io/container-object-storage-interface-csi-adapter/pkg/identity"
+	"sigs.k8s.io/container-object-storage-interface-csi-adapter/pkg/node"
 )
 
 func driver(args []string) error {
-
 	if protocol == "unix" {
 		if err := os.RemoveAll(listen); err != nil {
 			klog.Fatalf("could not prepare socket: %v", err)
@@ -40,7 +38,7 @@ func driver(args []string) error {
 	if err != nil {
 		return err
 	}
-	glog.V(5).Infof("identity server prepared")
+	klog.InfoS("identity server prepared")
 
 	nodeServer := node.NewNodeServerOrDie(identity, nodeID, dataRoot, volumeLimit)
 	controllerServer, err := controller.NewControllerServer()
diff --git a/cmd/csi-adapter/main.go b/cmd/csi-adapter/main.go
@@ -21,7 +21,7 @@ import (
 	"os/signal"
 	"syscall"
 
-	"github.com/golang/glog"
+	"k8s.io/klog/v2"
 )
 
 func main() {
@@ -30,7 +30,7 @@ func main() {
 
 	go func() {
 		s := <-sigs
-		glog.Infof("Exiting on signal %s %#v", s.String(), s)
+		klog.InfoS("Exiting on signal", "signal", s.String(), "value", s)
 	}()
 
 	if err := Execute(); err != nil {
diff --git a/go.mod b/go.mod
@@ -1,20 +1,20 @@
-module github.com/kubernetes-sigs/container-object-storage-interface-csi-adapter
+module sigs.k8s.io/container-object-storage-interface-csi-adapter
 
 go 1.15
 
 require (
 	github.com/container-storage-interface/spec v1.3.0
 	github.com/emicklei/go-restful v2.14.2+incompatible // indirect
 	github.com/go-logr/logr v0.2.1 // indirect
-	github.com/golang/glog v0.0.0-20160126235308-23def4e6c14b
 	github.com/google/gofuzz v1.2.0 // indirect
 	github.com/kubernetes-csi/csi-lib-utils v0.8.1 // indirect
 	github.com/kubernetes-csi/drivers v1.0.2
-	github.com/kubernetes-sigs/container-object-storage-interface-api v0.0.0-20210126191231-321ababeabd5
+	github.com/kubernetes-sigs/container-object-storage-interface-api v0.0.0-20210126191231-321ababeabd5 // indirect
 	github.com/magiconair/properties v1.8.4 // indirect
 	github.com/mailru/easyjson v0.7.6 // indirect
 	github.com/mitchellh/mapstructure v1.3.3 // indirect
 	github.com/pelletier/go-toml v1.8.1 // indirect
+	github.com/pkg/errors v0.9.1
 	github.com/spf13/afero v1.4.0 // indirect
 	github.com/spf13/cast v1.3.1 // indirect
 	github.com/spf13/cobra v1.1.1
@@ -31,7 +31,8 @@ require (
 	k8s.io/api v0.19.4
 	k8s.io/apimachinery v0.19.4
 	k8s.io/client-go v0.19.4
-	k8s.io/klog v1.0.0
-	k8s.io/klog/v2 v2.3.0 // indirect
+	k8s.io/klog v1.0.0 // indirect
+	k8s.io/klog/v2 v2.3.0
 	k8s.io/utils v0.0.0-20200912215256-4140de9c8800
+	sigs.k8s.io/container-object-storage-interface-api v0.0.0-20210225042325-7c26b4fc1ed9
 )
diff --git a/go.sum b/go.sum
@@ -884,6 +884,8 @@ 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=
 sigs.k8s.io/apiserver-network-proxy/konnectivity-client v0.0.7/go.mod h1:PHgbrJT7lCHcxMU+mDHEm+nx46H4zuuHZkDP6icnhu0=
+sigs.k8s.io/container-object-storage-interface-api v0.0.0-20210225042325-7c26b4fc1ed9 h1:ZjGviVPvDVxOhCF7+dsbAk5GPfUpEnM0DtR5yH7S6ww=
+sigs.k8s.io/container-object-storage-interface-api v0.0.0-20210225042325-7c26b4fc1ed9/go.mod h1:4V9ty4CWneFEQJbr+yQPjkCdUH3EKfjXM4AQXLY4Sa8=
 sigs.k8s.io/controller-runtime v0.6.3 h1:SBbr+inLPEKhvlJtrvDcwIpm+uhDvp63Bl72xYJtoOE=
 sigs.k8s.io/controller-runtime v0.6.3/go.mod h1:WlZNXcM0++oyaQt4B7C2lEE5JYRs8vJUzRP4N4JpdAY=
 sigs.k8s.io/structured-merge-diff/v3 v3.0.0-20200116222232-67a7b8c61874/go.mod h1:PlARxl6Hbt/+BC80dRLi1qAmnMqwqDg62YvvVkZjemw=
diff --git a/pkg/node/client.go b/pkg/node/client.go
@@ -5,14 +5,15 @@ import (
 	"encoding/json"
 	"fmt"
 
+	"github.com/pkg/errors"
 	v1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/client-go/kubernetes"
 	"k8s.io/client-go/rest"
-	"k8s.io/klog"
+	"k8s.io/klog/v2"
 
-	"github.com/kubernetes-sigs/container-object-storage-interface-api/apis/objectstorage.k8s.io/v1alpha1"
-	cs "github.com/kubernetes-sigs/container-object-storage-interface-api/clientset/typed/objectstorage.k8s.io/v1alpha1"
+	"sigs.k8s.io/container-object-storage-interface-api/apis/objectstorage.k8s.io/v1alpha1"
+	cs "sigs.k8s.io/container-object-storage-interface-api/clientset/typed/objectstorage.k8s.io/v1alpha1"
 )
 
 type NodeClient struct {
@@ -57,20 +58,19 @@ func (n *NodeClient) getBAR(ctx context.Context, barName, barNs string) (*v1alph
 	klog.Infof("getting bucketAccessRequest %q", fmt.Sprintf("%s/%s", barNs, barName))
 	bar, err := n.cosiClient.BucketAccessRequests(barNs).Get(ctx, barName, metav1.GetOptions{})
 	if err != nil {
-		return nil, logErr(getError("bucketAccessRequest", fmt.Sprintf("%s/%s", barNs, barName), err))
+		return nil, errors.Wrap(err, "get bucketAccessRequest failed")
 	}
-	// TODO: need to enable validation after resolving status issue - Krish
 	if bar == nil {
-		return nil, logErr(fmt.Errorf("bucketAccessRequest is nil %q", fmt.Sprintf("%s/%s", barNs, barName)))
+		return nil, fmt.Errorf("bucketAccessRequest is nil %q", fmt.Sprintf("%s/%s", barNs, barName))
 	}
 	if !bar.Status.AccessGranted {
-		return nil, logErr(fmt.Errorf("bucketAccessRequest does not grant access %q", fmt.Sprintf("%s/%s", barNs, barName)))
+		return nil, fmt.Errorf("bucketAccessRequest does not grant access %q", fmt.Sprintf("%s/%s", barNs, barName))
 	}
 	if len(bar.Spec.BucketRequestName) == 0 {
-		return nil, logErr(fmt.Errorf("bucketAccessRequest.Spec.BucketRequestName unset"))
+		return nil, fmt.Errorf("bucketAccessRequest.Spec.BucketRequestName unset")
 	}
 	if len(bar.Spec.BucketAccessName) == 0 {
-		return nil, logErr(fmt.Errorf("bucketAccessRequest.Spec.BucketAccessName unset"))
+		return nil, fmt.Errorf("bucketAccessRequest.Spec.BucketAccessName unset")
 	}
 	return bar, nil
 }
@@ -81,7 +81,6 @@ func (n *NodeClient) getBA(ctx context.Context, baName string) (*v1alpha1.Bucket
 	if err != nil {
 		return nil, logErr(getError("bucketAccess", baName, err))
 	}
-	// TODO: need to enable validation after resolving status issue - Krish
 	if ba == nil {
 		return nil, logErr(fmt.Errorf("bucketAccess is nil %q", fmt.Sprintf("%s", baName)))
 	}
@@ -100,7 +99,6 @@ func (n *NodeClient) getBR(ctx context.Context, brName, brNs string) (*v1alpha1.
 	if err != nil {
 		return nil, logErr(getError("bucketRequest", fmt.Sprintf("%s/%s", brNs, brName), err))
 	}
-	// TODO: need to enable validation after resolving status issue - Krish
 	if br == nil {
 		return nil, logErr(fmt.Errorf("bucketRequest is nil %q", fmt.Sprintf("%s/%s", brNs, brName)))
 	}
@@ -120,7 +118,6 @@ func (n *NodeClient) getB(ctx context.Context, bName string) (*v1alpha1.Bucket,
 	if err != nil {
 		return nil, logErr(getError("bucket", bName, err))
 	}
-	// TODO: need to enable validation after resolving status issue - Krish
 	if bkt == nil {
 		return nil, logErr(fmt.Errorf("bucket is nil %q", fmt.Sprintf("%s", bName)))
 	}
diff --git a/pkg/node/node.go b/pkg/node/node.go
@@ -9,7 +9,7 @@ import (
 	"google.golang.org/grpc/codes"
 	"google.golang.org/grpc/status"
 	v1 "k8s.io/api/core/v1"
-	"k8s.io/klog"
+	klog "k8s.io/klog/v2"
 )
 
 var _ csi.NodeServer = &NodeServer{}
diff --git a/pkg/node/provisioner.go b/pkg/node/provisioner.go
@@ -8,7 +8,7 @@ import (
 
 	"google.golang.org/grpc/codes"
 	"google.golang.org/grpc/status"
-	"k8s.io/klog"
+	"k8s.io/klog/v2"
 	"k8s.io/utils/mount"
 )
 

Original file line number	Diff line number	Diff line change
`@@ -5,14 +5,15 @@ import (`
`5`	`5`	`"encoding/json"`
`6`	`6`	`"fmt"`
`7`	`7`
	`8`	`+ "github.com/pkg/errors"`
`8`	`9`	`v1 "k8s.io/api/core/v1"`
`9`	`10`	`metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"`
`10`	`11`	`"k8s.io/client-go/kubernetes"`
`11`	`12`	`"k8s.io/client-go/rest"`
`12`		`- "k8s.io/klog"`
	`13`	`+ "k8s.io/klog/v2"`
`13`	`14`
`14`		`- "github.com/kubernetes-sigs/container-object-storage-interface-api/apis/objectstorage.k8s.io/v1alpha1"`
`15`		`- cs "github.com/kubernetes-sigs/container-object-storage-interface-api/clientset/typed/objectstorage.k8s.io/v1alpha1"`
	`15`	`+ "sigs.k8s.io/container-object-storage-interface-api/apis/objectstorage.k8s.io/v1alpha1"`
	`16`	`+ cs "sigs.k8s.io/container-object-storage-interface-api/clientset/typed/objectstorage.k8s.io/v1alpha1"`
`16`	`17`	`)`
`17`	`18`
`18`	`19`	`type NodeClient struct {`
`@@ -57,20 +58,19 @@ func (n NodeClient) getBAR(ctx context.Context, barName, barNs string) (v1alph`
`57`	`58`	`klog.Infof("getting bucketAccessRequest %q", fmt.Sprintf("%s/%s", barNs, barName))`
`58`	`59`	`bar, err := n.cosiClient.BucketAccessRequests(barNs).Get(ctx, barName, metav1.GetOptions{})`
`59`	`60`	`if err != nil {`
`60`		`- return nil, logErr(getError("bucketAccessRequest", fmt.Sprintf("%s/%s", barNs, barName), err))`
	`61`	`+ return nil, errors.Wrap(err, "get bucketAccessRequest failed")`
`61`	`62`	`}`
`62`		`- // TODO: need to enable validation after resolving status issue - Krish`
`63`	`63`	`if bar == nil {`
`64`		`- return nil, logErr(fmt.Errorf("bucketAccessRequest is nil %q", fmt.Sprintf("%s/%s", barNs, barName)))`
	`64`	`+ return nil, fmt.Errorf("bucketAccessRequest is nil %q", fmt.Sprintf("%s/%s", barNs, barName))`
`65`	`65`	`}`
`66`	`66`	`if !bar.Status.AccessGranted {`
`67`		`- return nil, logErr(fmt.Errorf("bucketAccessRequest does not grant access %q", fmt.Sprintf("%s/%s", barNs, barName)))`
	`67`	`+ return nil, fmt.Errorf("bucketAccessRequest does not grant access %q", fmt.Sprintf("%s/%s", barNs, barName))`
`68`	`68`	`}`
`69`	`69`	`if len(bar.Spec.BucketRequestName) == 0 {`
`70`		`- return nil, logErr(fmt.Errorf("bucketAccessRequest.Spec.BucketRequestName unset"))`
	`70`	`+ return nil, fmt.Errorf("bucketAccessRequest.Spec.BucketRequestName unset")`
`71`	`71`	`}`
`72`	`72`	`if len(bar.Spec.BucketAccessName) == 0 {`
`73`		`- return nil, logErr(fmt.Errorf("bucketAccessRequest.Spec.BucketAccessName unset"))`
	`73`	`+ return nil, fmt.Errorf("bucketAccessRequest.Spec.BucketAccessName unset")`
`74`	`74`	`}`
`75`	`75`	`return bar, nil`
`76`	`76`	`}`
`@@ -81,7 +81,6 @@ func (n NodeClient) getBA(ctx context.Context, baName string) (v1alpha1.Bucket`
`81`	`81`	`if err != nil {`
`82`	`82`	`return nil, logErr(getError("bucketAccess", baName, err))`
`83`	`83`	`}`
`84`		`- // TODO: need to enable validation after resolving status issue - Krish`
`85`	`84`	`if ba == nil {`
`86`	`85`	`return nil, logErr(fmt.Errorf("bucketAccess is nil %q", fmt.Sprintf("%s", baName)))`
`87`	`86`	`}`
`@@ -100,7 +99,6 @@ func (n NodeClient) getBR(ctx context.Context, brName, brNs string) (v1alpha1.`
`100`	`99`	`if err != nil {`
`101`	`100`	`return nil, logErr(getError("bucketRequest", fmt.Sprintf("%s/%s", brNs, brName), err))`
`102`	`101`	`}`
`103`		`- // TODO: need to enable validation after resolving status issue - Krish`
`104`	`102`	`if br == nil {`
`105`	`103`	`return nil, logErr(fmt.Errorf("bucketRequest is nil %q", fmt.Sprintf("%s/%s", brNs, brName)))`
`106`	`104`	`}`
`@@ -120,7 +118,6 @@ func (n NodeClient) getB(ctx context.Context, bName string) (v1alpha1.Bucket,`
`120`	`118`	`if err != nil {`
`121`	`119`	`return nil, logErr(getError("bucket", bName, err))`
`122`	`120`	`}`
`123`		`- // TODO: need to enable validation after resolving status issue - Krish`
`124`	`121`	`if bkt == nil {`
`125`	`122`	`return nil, logErr(fmt.Errorf("bucket is nil %q", fmt.Sprintf("%s", bName)))`
`126`	`123`	`}`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ import (`
`9`	`9`	`"google.golang.org/grpc/codes"`
`10`	`10`	`"google.golang.org/grpc/status"`
`11`	`11`	`v1 "k8s.io/api/core/v1"`
`12`		`- "k8s.io/klog"`
	`12`	`+ klog "k8s.io/klog/v2"`
`13`	`13`	`)`
`14`	`14`
`15`	`15`	`var _ csi.NodeServer = &NodeServer{}`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@ import (`
`8`	`8`
`9`	`9`	`"google.golang.org/grpc/codes"`
`10`	`10`	`"google.golang.org/grpc/status"`
`11`		`- "k8s.io/klog"`
	`11`	`+ "k8s.io/klog/v2"`
`12`	`12`	`"k8s.io/utils/mount"`
`13`	`13`	`)`
`14`	`14`