Add goerr113 linter check

hj-johannes-lee · hj-johannes-lee · commit 4bc70ac54438 · 2021-09-03T11:02:14.000+03:00
Add goerr113 lintercheck
Fix the usage of fmt.Errorf() by wrapping errors
Fix the usage of errors.New()
diff --git a/.golangci.yml b/.golangci.yml
@@ -16,6 +16,7 @@ linters:
     - goconst
     - gocyclo
     - godot
+    - goerr113
     - gofmt
     - goimports
     - gomodguard
diff --git a/cmd/fpga_crihook/main.go b/cmd/fpga_crihook/main.go
@@ -16,7 +16,6 @@ package main
 
 import (
 	"encoding/json"
-	"fmt"
 	"io"
 	"os"
 	"path/filepath"
@@ -207,20 +206,20 @@ func getStdin(reader io.Reader) (*Stdin, error) {
 
 	// Check if device plugin annotation is set
 	if stdinJ.Annotations.ComIntelFpgaMode == "" {
-		return nil, fmt.Errorf("annotation %s is not set", annotationName)
+		return nil, errors.Errorf("annotation %s is not set", annotationName)
 	}
 
 	// Check if device plugin annotation is set
 	if stdinJ.Annotations.ComIntelFpgaMode != annotationValue {
-		return nil, fmt.Errorf("annotation %s has incorrect value '%s'", annotationName, stdinJ.Annotations.ComIntelFpgaMode)
+		return nil, errors.Errorf("annotation %s has incorrect value '%s'", annotationName, stdinJ.Annotations.ComIntelFpgaMode)
 	}
 
 	if stdinJ.Bundle == "" {
 		return nil, errors.New("'bundle' field is not set in the stdin JSON")
 	}
 
 	if _, err := os.Stat(stdinJ.Bundle); err != nil {
-		return nil, fmt.Errorf("bundle directory %s: stat error: %+v", stdinJ.Bundle, err)
+		return nil, errors.Wrapf(err, "bundle directory: %s", stdinJ.Bundle)
 	}
 
 	return &stdinJ, nil
diff --git a/cmd/fpga_plugin/fpga_plugin.go b/cmd/fpga_plugin/fpga_plugin.go
@@ -190,7 +190,7 @@ func newDevicePlugin(mode string, rootPath string) (*devicePlugin, error) {
 	if _, err = os.Stat(sysfsPathOPAE); os.IsNotExist(err) {
 		sysfsPathDFL := path.Join(rootPath, sysfsDirectoryDFL)
 		if _, err = os.Stat(sysfsPathDFL); os.IsNotExist(err) {
-			return nil, fmt.Errorf("kernel driver is not loaded: neither %s nor %s sysfs entry exists", sysfsPathOPAE, sysfsPathDFL)
+			return nil, errors.Errorf("kernel driver is not loaded: neither %s nor %s sysfs entry exists", sysfsPathOPAE, sysfsPathDFL)
 		}
 		dp, err = newDevicePluginDFL(sysfsPathDFL, devfsPath, mode)
 	} else {
diff --git a/cmd/fpga_plugin/fpga_plugin_test.go b/cmd/fpga_plugin/fpga_plugin_test.go
@@ -16,7 +16,6 @@ package main
 
 import (
 	"flag"
-	"fmt"
 	"os"
 	"path"
 	"testing"
@@ -61,11 +60,11 @@ func createTestDirs(devfs, sysfs string, devfsDirs, sysfsDirs []string, sysfsFil
 func validateDevTree(expectedDevTreeKeys map[string][]string, devTree dpapi.DeviceTree) error {
 	for resource, devices := range expectedDevTreeKeys {
 		if _, ok := devTree[resource]; !ok {
-			return fmt.Errorf("device tree: resource %s missing", resource)
+			return errors.Errorf("device tree: resource %s missing", resource)
 		}
 		for _, device := range devices {
 			if _, ok := devTree[resource][device]; !ok {
-				return fmt.Errorf("device tree resource %s: device %s missing", resource, device)
+				return errors.Errorf("device tree resource %s: device %s missing", resource, device)
 			}
 		}
 	}
diff --git a/cmd/fpga_plugin/mode.go b/cmd/fpga_plugin/mode.go
@@ -2,8 +2,8 @@ package main
 
 import (
 	"context"
-	"fmt"
 
+	"github.com/pkg/errors"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/client-go/kubernetes"
 	"k8s.io/client-go/rest"
@@ -15,7 +15,7 @@ func getModeOverrideFromCluster(nodeName, kubeConfig, master, mode string) (stri
 	var err error
 
 	if len(nodeName) == 0 {
-		return mode, fmt.Errorf("node name is not set")
+		return mode, errors.New("node name is not set")
 	}
 
 	if len(kubeConfig) == 0 {
diff --git a/cmd/fpga_tool/fpga_tool.go b/cmd/fpga_tool/fpga_tool.go
@@ -140,7 +140,7 @@ func installBitstream(fname string, dryRun, force, quiet bool) (err error) {
 	dst, err := os.OpenFile(installPath, flags, 0644)
 	if err != nil {
 		if os.IsExist(err) {
-			return fmt.Errorf("destination file %q already exist. Use --force to overwrite it", installPath)
+			return errors.Wrapf(err, "destination file %q already exist. Use --force to overwrite it", installPath)
 		}
 		return errors.Wrap(err, "can't create destination file")
 	}
diff --git a/cmd/qat_plugin/kerneldrv/kerneldrv_test.go b/cmd/qat_plugin/kerneldrv/kerneldrv_test.go
@@ -34,6 +34,8 @@ import (
 	fakeexec "k8s.io/utils/exec/testing"
 )
 
+var errFake = errors.New("fake error")
+
 const (
 	adfCtlOutput = `Checking status of all devices.
 There is 3 QAT acceleration device(s) in the system:
@@ -92,7 +94,7 @@ func TestGetOnlineDevices(t *testing.T) {
 		},
 		{
 			name:        "adf_ctl fails to run",
-			adfCtlError: errors.New("fake error"),
+			adfCtlError: errFake,
 			expectedErr: true,
 		},
 	}
diff --git a/pkg/deviceplugin/server_test.go b/pkg/deviceplugin/server_test.go
@@ -35,6 +35,10 @@ import (
 	"github.com/pkg/errors"
 )
 
+var (
+	errFake = errors.New("Fake error")
+)
+
 const (
 	devicePluginPath = "/tmp/"
 	kubeletSocket    = devicePluginPath + "kubelet-test.sock"
@@ -338,7 +342,7 @@ func TestAllocate(t *testing.T) {
 				},
 			},
 			postAllocate: func(resp *pluginapi.AllocateResponse) error {
-				return fmt.Errorf("Fake error for %s", "dev1")
+				return fmt.Errorf("%w for %q", errFake, "dev1")
 			},
 			expectedErr: true,
 		},
@@ -380,7 +384,7 @@ func (s *listAndWatchServerStub) Send(resp *pluginapi.ListAndWatchResponse) erro
 	s.sendCounter = s.sendCounter + 1
 	if s.generateErr == s.sendCounter {
 		klog.V(4).Info("listAndWatchServerStub::Send returns error")
-		return fmt.Errorf("Fake error")
+		return errFake
 	}
 
 	klog.V(4).Info("listAndWatchServerStub::Send", resp.Devices)
diff --git a/pkg/fpgacontroller/fpgacontroller_test.go b/pkg/fpgacontroller/fpgacontroller_test.go
@@ -31,8 +31,9 @@ import (
 )
 
 var (
-	logger = ctrl.Log.WithName("test")
-	scheme = runtime.NewScheme()
+	errClient = errors.New("client error")
+	logger    = ctrl.Log.WithName("test")
+	scheme    = runtime.NewScheme()
 )
 
 func init() {
@@ -51,7 +52,7 @@ func TestAcceleratorFunctionReconcile(t *testing.T) {
 		},
 		{
 			name:        "client error",
-			getError:    errors.New("client error"),
+			getError:    errClient,
 			expectedErr: true,
 		},
 		{
@@ -102,7 +103,7 @@ func TestFpgaRegionReconcile(t *testing.T) {
 		},
 		{
 			name:        "client error",
-			getError:    errors.New("client error"),
+			getError:    errClient,
 			expectedErr: true,
 		},
 		{
diff --git a/pkg/idxd/plugin_test.go b/pkg/idxd/plugin_test.go
@@ -15,6 +15,7 @@
 package idxd
 
 import (
+	"errors"
 	"flag"
 	"fmt"
 	"os"
@@ -25,6 +26,10 @@ import (
 	pluginapi "k8s.io/kubelet/pkg/apis/deviceplugin/v1beta1"
 )
 
+var (
+	errUnitTest = errors.New("unit test error")
+)
+
 const (
 	dsaMajor int = 375
 )
@@ -239,16 +244,16 @@ func checkDeviceTree(deviceTree dpapi.DeviceTree, expectedResult map[string]int,
 		for key := range deviceTree {
 			val, ok := expectedResult[key]
 			if !ok {
-				return fmt.Errorf("unexpected device type: %s", key)
+				return fmt.Errorf("%w: unexpected device type: %s", errUnitTest, key)
 			}
 			numberDev := len(deviceTree[key])
 			if numberDev != val {
-				return fmt.Errorf("%s: unexpected number of devices: %d, expected: %d", key, numberDev, val)
+				return fmt.Errorf("%w: %s: unexpected number of devices: %d, expected: %d", errUnitTest, key, numberDev, val)
 			}
 			delete(expectedResult, key)
 		}
 		if len(expectedResult) > 0 {
-			return fmt.Errorf("missing expected result(s): %+v", expectedResult)
+			return fmt.Errorf("%w: missing expected result(s): %+v", errUnitTest, expectedResult)
 		}
 	}
 	return nil
diff --git a/test/e2e/utils/utils.go b/test/e2e/utils/utils.go
@@ -79,7 +79,7 @@ func WaitForPodFailure(f *framework.Framework, name string, timeout time.Duratio
 			case v1.PodFailed:
 				return true, nil
 			case v1.PodSucceeded:
-				return true, fmt.Errorf("pod %q successed with reason: %q, message: %q", name, pod.Status.Reason, pod.Status.Message)
+				return true, errors.Errorf("pod %q successed with reason: %q, message: %q", name, pod.Status.Reason, pod.Status.Message)
 			default:
 				return false, nil
 			}

Original file line number	Diff line number	Diff line change
`@@ -190,7 +190,7 @@ func newDevicePlugin(mode string, rootPath string) (*devicePlugin, error) {`
`190`	`190`	`if _, err = os.Stat(sysfsPathOPAE); os.IsNotExist(err) {`
`191`	`191`	`sysfsPathDFL := path.Join(rootPath, sysfsDirectoryDFL)`
`192`	`192`	`if _, err = os.Stat(sysfsPathDFL); os.IsNotExist(err) {`
`193`		`- return nil, fmt.Errorf("kernel driver is not loaded: neither %s nor %s sysfs entry exists", sysfsPathOPAE, sysfsPathDFL)`
	`193`	`+ return nil, errors.Errorf("kernel driver is not loaded: neither %s nor %s sysfs entry exists", sysfsPathOPAE, sysfsPathDFL)`
`194`	`194`	`}`
`195`	`195`	`dp, err = newDevicePluginDFL(sysfsPathDFL, devfsPath, mode)`
`196`	`196`	`} else {`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,6 @@ package main`
`16`	`16`
`17`	`17`	`import (`
`18`	`18`	`"flag"`
`19`		`- "fmt"`
`20`	`19`	`"os"`
`21`	`20`	`"path"`
`22`	`21`	`"testing"`
`@@ -61,11 +60,11 @@ func createTestDirs(devfs, sysfs string, devfsDirs, sysfsDirs []string, sysfsFil`
`61`	`60`	`func validateDevTree(expectedDevTreeKeys map[string][]string, devTree dpapi.DeviceTree) error {`
`62`	`61`	`for resource, devices := range expectedDevTreeKeys {`
`63`	`62`	`if _, ok := devTree[resource]; !ok {`
`64`		`- return fmt.Errorf("device tree: resource %s missing", resource)`
	`63`	`+ return errors.Errorf("device tree: resource %s missing", resource)`
`65`	`64`	`}`
`66`	`65`	`for _, device := range devices {`
`67`	`66`	`if _, ok := devTree[resource][device]; !ok {`
`68`		`- return fmt.Errorf("device tree resource %s: device %s missing", resource, device)`
	`67`	`+ return errors.Errorf("device tree resource %s: device %s missing", resource, device)`
`69`	`68`	`}`
`70`	`69`	`}`
`71`	`70`	`}`
Original file line number	Diff line number	Diff line change
`@@ -140,7 +140,7 @@ func installBitstream(fname string, dryRun, force, quiet bool) (err error) {`
`140`	`140`	`dst, err := os.OpenFile(installPath, flags, 0644)`
`141`	`141`	`if err != nil {`
`142`	`142`	`if os.IsExist(err) {`
`143`		`- return fmt.Errorf("destination file %q already exist. Use --force to overwrite it", installPath)`
	`143`	`+ return errors.Wrapf(err, "destination file %q already exist. Use --force to overwrite it", installPath)`
`144`	`144`	`}`
`145`	`145`	`return errors.Wrap(err, "can't create destination file")`
`146`	`146`	`}`
Original file line number	Diff line number	Diff line change
`@@ -34,6 +34,8 @@ import (`
`34`	`34`	`fakeexec "k8s.io/utils/exec/testing"`
`35`	`35`	`)`
`36`	`36`
	`37`	`+var errFake = errors.New("fake error")`
	`38`	`+`
`37`	`39`	`const (`
`38`	`40`	adfCtlOutput = `Checking status of all devices.
`39`	`41`	`There is 3 QAT acceleration device(s) in the system:`
`@@ -92,7 +94,7 @@ func TestGetOnlineDevices(t *testing.T) {`
`92`	`94`	`},`
`93`	`95`	`{`
`94`	`96`	`name: "adf_ctl fails to run",`
`95`		`- adfCtlError: errors.New("fake error"),`
	`97`	`+ adfCtlError: errFake,`
`96`	`98`	`expectedErr: true,`
`97`	`99`	`},`
`98`	`100`	`}`
Original file line number	Diff line number	Diff line change
`@@ -31,8 +31,9 @@ import (`
`31`	`31`	`)`
`32`	`32`
`33`	`33`	`var (`
`34`		`- logger = ctrl.Log.WithName("test")`
`35`		`- scheme = runtime.NewScheme()`
	`34`	`+ errClient = errors.New("client error")`
	`35`	`+ logger = ctrl.Log.WithName("test")`
	`36`	`+ scheme = runtime.NewScheme()`
`36`	`37`	`)`
`37`	`38`
`38`	`39`	`func init() {`
`@@ -51,7 +52,7 @@ func TestAcceleratorFunctionReconcile(t *testing.T) {`
`51`	`52`	`},`
`52`	`53`	`{`
`53`	`54`	`name: "client error",`
`54`		`- getError: errors.New("client error"),`
	`55`	`+ getError: errClient,`
`55`	`56`	`expectedErr: true,`
`56`	`57`	`},`
`57`	`58`	`{`
`@@ -102,7 +103,7 @@ func TestFpgaRegionReconcile(t *testing.T) {`
`102`	`103`	`},`
`103`	`104`	`{`
`104`	`105`	`name: "client error",`
`105`		`- getError: errors.New("client error"),`
	`106`	`+ getError: errClient,`
`106`	`107`	`expectedErr: true,`
`107`	`108`	`},`
`108`	`109`	`{`
Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,7 @@`
`15`	`15`	`package idxd`
`16`	`16`
`17`	`17`	`import (`
	`18`	`+ "errors"`
`18`	`19`	`"flag"`
`19`	`20`	`"fmt"`
`20`	`21`	`"os"`
`@@ -25,6 +26,10 @@ import (`
`25`	`26`	`pluginapi "k8s.io/kubelet/pkg/apis/deviceplugin/v1beta1"`
`26`	`27`	`)`
`27`	`28`
	`29`	`+var (`
	`30`	`+ errUnitTest = errors.New("unit test error")`
	`31`	`+)`
	`32`	`+`
`28`	`33`	`const (`
`29`	`34`	`dsaMajor int = 375`
`30`	`35`	`)`
`@@ -239,16 +244,16 @@ func checkDeviceTree(deviceTree dpapi.DeviceTree, expectedResult map[string]int,`
`239`	`244`	`for key := range deviceTree {`
`240`	`245`	`val, ok := expectedResult[key]`
`241`	`246`	`if !ok {`
`242`		`- return fmt.Errorf("unexpected device type: %s", key)`
	`247`	`+ return fmt.Errorf("%w: unexpected device type: %s", errUnitTest, key)`
`243`	`248`	`}`
`244`	`249`	`numberDev := len(deviceTree[key])`
`245`	`250`	`if numberDev != val {`
`246`		`- return fmt.Errorf("%s: unexpected number of devices: %d, expected: %d", key, numberDev, val)`
	`251`	`+ return fmt.Errorf("%w: %s: unexpected number of devices: %d, expected: %d", errUnitTest, key, numberDev, val)`
`247`	`252`	`}`
`248`	`253`	`delete(expectedResult, key)`
`249`	`254`	`}`
`250`	`255`	`if len(expectedResult) > 0 {`
`251`		`- return fmt.Errorf("missing expected result(s): %+v", expectedResult)`
	`256`	`+ return fmt.Errorf("%w: missing expected result(s): %+v", errUnitTest, expectedResult)`
`252`	`257`	`}`
`253`	`258`	`}`
`254`	`259`	`return nil`