Merge pull request #138 from rollandf/lint

rollandf · web-flow · commit b3cb360b8f10 · 2025-02-19T11:23:11.000+02:00
chore: update golang-ci
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -11,7 +11,7 @@ jobs:
       - name: Set up Go 1.x
         uses: actions/setup-go@v3
         with:
-          go-version: '1.20.x'
+          go-version: '1.23.x'
       - name: checkout
         uses: actions/checkout@v3
       - name: lint
@@ -25,7 +25,7 @@ jobs:
       - name: Set up Go 1.x
         uses: actions/setup-go@v3
         with:
-          go-version: '1.20.x'
+          go-version: '1.23.x'
       - name: checkout
         uses: actions/checkout@v3
       - name: install hwdata -yq
@@ -41,7 +41,7 @@ jobs:
       - name: Set up Go 1.x
         uses: actions/setup-go@v3
         with:
-          go-version: '1.20.x'
+          go-version: '1.23.x'
       - name: checkout
         uses: actions/checkout@v3
       - name: build
diff --git a/.github/workflows/static-scan.yaml b/.github/workflows/static-scan.yaml
@@ -8,7 +8,7 @@ jobs:
       - name: set up Go
         uses: actions/setup-go@v3
         with:
-          go-version: 1.20.x
+          go-version: 1.23.x
       - name: checkout PR
         uses: actions/checkout@v2
       - name: run make lint
@@ -19,7 +19,7 @@ jobs:
       - name: set up Go
         uses: actions/setup-go@v3
         with:
-          go-version: 1.20.x
+          go-version: 1.23.x
       - name: checkout PR
         uses: actions/checkout@v2
       - name: run make hadolint
diff --git a/.golangci.yml b/.golangci.yml
@@ -48,24 +48,21 @@ linters-settings:
     for-loops: false # Report preallocation suggestions on for loops, false by default
 
 linters:
-  # please, do not use `enable-all`: it's deprecated and will be removed soon.
-  # inverted configuration with `enable-all` and `disable` is not scalable during updates of golangci-lint
   disable-all: true
   enable:
     - bodyclose
-    - depguard
     - dogsled
     - dupl
     - errcheck
-    - exportloopref
+    - copyloopvar
     - funlen
     - gochecknoinits
     - goconst
     - gocritic
     - gocognit
     - gofmt
     - goimports
-    - gomnd
+    - mnd
     - goprintffuncname
     - gosec
     - gosimple
@@ -90,9 +87,15 @@ issues:
   exclude-rules:
     - path: _test\.go
       linters:
-        - gomnd
         - goconst
         - dupl
+        - revive
+        - stylecheck
+      text: "should not use dot imports"
+    - path: _test\.go
+      linters:
+        - mnd
+        - goconst
     - text: "Magic number: 1"
       linters:
-        - gomnd
+        - mnd
diff --git a/Makefile b/Makefile
@@ -38,7 +38,7 @@ GOLANGCI_LINT = $(BINDIR)/golangci-lint
 # golangci-lint version should be updated periodically
 # we keep it fixed to avoid it from unexpectedly failing on the project
 # in case of a version bump
-GOLANGCI_LINT_VER = v1.51.2
+GOLANGCI_LINT_VER = v1.62.2
 TIMEOUT = 20
 Q = $(if $(filter 1,$V),,@)
 
diff --git a/go.mod b/go.mod
@@ -1,6 +1,6 @@
 module github.com/Mellanox/k8s-rdma-shared-dev-plugin
 
-go 1.20
+go 1.23
 
 require (
 	github.com/Mellanox/rdmamap v1.1.0
diff --git a/go.sum b/go.sum
@@ -34,6 +34,7 @@ github.com/golang/protobuf v1.5.3 h1:KhyjKVUg7Usr/dYsdSqoFveMYd5ko72D+zANwlG1mmg
 github.com/golang/protobuf v1.5.3/go.mod h1:XVQd3VNwM+JqD3oG2Ue2ip4fOMUkwXdXDdiuN0vRsmY=
 github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
 github.com/google/go-cmp v0.5.9 h1:O2Tfq5qg4qc4AmwVlvv0oLiVAGB7enBSJ2x2DqQFi38=
+github.com/google/go-cmp v0.5.9/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
 github.com/google/uuid v1.3.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
 github.com/googleapis/go-genproto v0.0.0-20200117163144-32f20d992d24 h1:iqmAazjqJalhqqPoTsjnqI2wPlgVbQJ6JNdHsbhA6FA=
 github.com/googleapis/go-genproto v0.0.0-20200117163144-32f20d992d24/go.mod h1:n3cpQtvxv34hfy77yVDNjmbRyujviMdxYliBSkLhpCc=
@@ -78,6 +79,7 @@ github.com/opencontainers/runtime-tools v0.9.1-0.20221107090550-2e043c6bd626 h1:
 github.com/opencontainers/runtime-tools v0.9.1-0.20221107090550-2e043c6bd626/go.mod h1:BRHJJd0E+cx42OybVYSgUvZmU0B8P9gZuRXlZUP7TKI=
 github.com/opencontainers/selinux v1.9.1/go.mod h1:2i0OySw99QjzBBQByd1Gr9gSjvuho1lHsJxIJ3gGbJI=
 github.com/opencontainers/selinux v1.10.0 h1:rAiKF8hTcgLI3w0DHm6i0ylVVcOrlgR1kK99DRLDhyU=
+github.com/opencontainers/selinux v1.10.0/go.mod h1:2i0OySw99QjzBBQByd1Gr9gSjvuho1lHsJxIJ3gGbJI=
 github.com/pkg/errors v0.8.0/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
 github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4=
 github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
diff --git a/pkg/resources/pci_net_device.go b/pkg/resources/pci_net_device.go
@@ -45,7 +45,7 @@ func NewPciNetDevice(dev *ghw.PCIDevice, rds types.RdmaDeviceSpec,
 	}
 
 	linkType := ""
-	if len(ifName) > 0 {
+	if ifName != "" {
 		link, err := nLink.LinkByName(ifName)
 		if err != nil {
 			return nil, err
diff --git a/pkg/resources/resources_manager.go b/pkg/resources/resources_manager.go
@@ -353,27 +353,27 @@ func (rm *resourceManager) GetFilteredDevices(devices []types.PciNetDevice,
 	filteredDevice := devices
 
 	// filter by Vendors list
-	if selector.Vendors != nil && len(selector.Vendors) > 0 {
+	if len(selector.Vendors) > 0 {
 		filteredDevice = NewVendorSelector(selector.Vendors).Filter(filteredDevice)
 	}
 
 	// filter by DeviceIDs list
-	if selector.DeviceIDs != nil && len(selector.DeviceIDs) > 0 {
+	if len(selector.DeviceIDs) > 0 {
 		filteredDevice = NewDeviceSelector(selector.DeviceIDs).Filter(filteredDevice)
 	}
 
 	// filter by Driver list
-	if selector.Drivers != nil && len(selector.Drivers) > 0 {
+	if len(selector.Drivers) > 0 {
 		filteredDevice = NewDriverSelector(selector.Drivers).Filter(filteredDevice)
 	}
 
 	// filter by IfNames list
-	if selector.IfNames != nil && len(selector.IfNames) > 0 {
+	if len(selector.IfNames) > 0 {
 		filteredDevice = NewIfNameSelector(selector.IfNames).Filter(filteredDevice)
 	}
 
 	// filter by LinkType list
-	if selector.LinkTypes != nil && len(selector.LinkTypes) > 0 {
+	if len(selector.LinkTypes) > 0 {
 		filteredDevice = NewLinkTypeSelector(selector.LinkTypes).Filter(filteredDevice)
 	}
 
diff --git a/pkg/resources/resources_manager_test.go b/pkg/resources/resources_manager_test.go
@@ -81,6 +81,7 @@ var _ = Describe("ResourcesManger", func() {
 			Expect(rm.watchMode).To(Equal(false))
 		})
 	})
+	//nolint:dupl
 	Context("ReadConfig", func() {
 		It("Read valid config file with non default periodic update", func() {
 			configData := `{"configList": [{
@@ -505,6 +506,7 @@ var _ = Describe("ResourcesManger", func() {
 			fakeResourceServer.AssertExpectations(testCallsAssertionReporter)
 		})
 	})
+	//nolint:dupl
 	Context("StopAllServers", func() {
 		It("stop valid server", func() {
 			fakeResourceServer := mocks.ResourceServer{}
@@ -532,6 +534,7 @@ var _ = Describe("ResourcesManger", func() {
 			fakeResourceServer.AssertExpectations(testCallsAssertionReporter)
 		})
 	})
+	//nolint:dupl
 	Context("RestartAllServers", func() {
 		It("restart valid server", func() {
 			fakeResourceServer := mocks.ResourceServer{}
diff --git a/pkg/resources/server.go b/pkg/resources/server.go
@@ -295,7 +295,7 @@ func (rs *resourceServer) register() error {
 }
 
 // ListAndWatch lists devices and update that list according to the health status
-func (rs *resourceServer) ListAndWatch(e *pluginapi.Empty, s pluginapi.DevicePlugin_ListAndWatchServer) error {
+func (rs *resourceServer) ListAndWatch(_ *pluginapi.Empty, s pluginapi.DevicePlugin_ListAndWatchServer) error {
 	log.Printf("ListAndWatch called by kubelet for: %s", rs.resourceName)
 	resp := new(pluginapi.ListAndWatchResponse)
 
@@ -366,7 +366,7 @@ func (rs *resourceServer) sendDevices(resp *pluginapi.ListAndWatchResponse,
 }
 
 // Allocate which return list of devices.
-func (rs *resourceServer) Allocate(ctx context.Context, r *pluginapi.AllocateRequest) (
+func (rs *resourceServer) Allocate(_ context.Context, r *pluginapi.AllocateRequest) (
 	*pluginapi.AllocateResponse, error) {
 	log.Println("allocate request:", r)
 
@@ -420,7 +420,7 @@ func (rs *resourceServer) cleanup() error {
 }
 
 // GetInfo get info of plugin
-func (rs *resourceServer) GetInfo(ctx context.Context, rqt *registerapi.InfoRequest) (*registerapi.PluginInfo, error) {
+func (rs *resourceServer) GetInfo(_ context.Context, _ *registerapi.InfoRequest) (*registerapi.PluginInfo, error) {
 	pluginInfoResponse := &registerapi.PluginInfo{
 		Type:              registerapi.DevicePlugin,
 		Name:              rs.resourceName,
@@ -431,7 +431,7 @@ func (rs *resourceServer) GetInfo(ctx context.Context, rqt *registerapi.InfoRequ
 }
 
 // NotifyRegistrationStatus notify for registration status
-func (rs *resourceServer) NotifyRegistrationStatus(ctx context.Context, regstat *registerapi.RegistrationStatus) (
+func (rs *resourceServer) NotifyRegistrationStatus(_ context.Context, regstat *registerapi.RegistrationStatus) (
 	*registerapi.RegistrationStatusResponse, error) {
 	if regstat.PluginRegistered {
 		log.Printf("%s gets registered successfully at Kubelet \n", rs.socketName)
@@ -490,7 +490,7 @@ func (rs *resourceServer) UpdateDevices(devices []types.PciNetDevice) {
 }
 
 func (rs *resourceServer) GetPreferredAllocation(
-	ctx context.Context, req *pluginapi.PreferredAllocationRequest) (*pluginapi.PreferredAllocationResponse, error) {
+	_ context.Context, _ *pluginapi.PreferredAllocationRequest) (*pluginapi.PreferredAllocationResponse, error) {
 	return nil, nil
 }
 
diff --git a/pkg/resources/testing.go b/pkg/resources/testing.go
@@ -54,7 +54,7 @@ func dial(unixSocketPath string, timeout time.Duration) (*grpc.ClientConn, error
 	defer timeoutCancel()
 	go func() {
 		c, err = grpc.DialContext(ctx, unixSocketPath, grpc.WithTransportCredentials(insecure.NewCredentials()),
-			grpc.WithContextDialer(func(ctx context.Context, addr string) (net.Conn, error) {
+			grpc.WithContextDialer(func(_ context.Context, addr string) (net.Conn, error) {
 				return net.Dial("unix", addr)
 			}),
 		)
@@ -128,7 +128,7 @@ func (s *fakeRegistrationServer) registerPlugin() error {
 	return nil
 }
 
-func (s *fakeRegistrationServer) Register(ctx context.Context, r *pluginapi.RegisterRequest) (api *pluginapi.Empty,
+func (s *fakeRegistrationServer) Register(_ context.Context, r *pluginapi.RegisterRequest) (api *pluginapi.Empty,
 	err error) {
 	s.pluginEndpoint = r.Endpoint
 	api = &pluginapi.Empty{}
diff --git a/pkg/utils/testing.go b/pkg/utils/testing.go
@@ -6,6 +6,12 @@ import (
 	"path"
 )
 
+// File and directory permission constants
+const (
+	DirPerm  = 0700 // Default directory permissions
+	FilePerm = 0600 // Default file permissions
+)
+
 // FakeFilesystem allows to setup isolated fake files structure used for the tests.
 type FakeFilesystem struct {
 	RootDir  string
@@ -26,13 +32,13 @@ func (fs *FakeFilesystem) Use() func() {
 	fs.RootDir = tmpDir
 
 	for _, dir := range fs.Dirs {
-		osErr := os.MkdirAll(path.Join(fs.RootDir, dir), 0700)
+		osErr := os.MkdirAll(path.Join(fs.RootDir, dir), DirPerm)
 		if osErr != nil {
 			panic(fmt.Errorf("error creating fake directory: %s", osErr.Error()))
 		}
 	}
 	for filename, body := range fs.Files {
-		ioErr := os.WriteFile(path.Join(fs.RootDir, filename), body, 0600)
+		ioErr := os.WriteFile(path.Join(fs.RootDir, filename), body, FilePerm)
 		if ioErr != nil {
 			panic(fmt.Errorf("error creating fake file: %s", ioErr.Error()))
 		}
@@ -43,7 +49,7 @@ func (fs *FakeFilesystem) Use() func() {
 			panic(fmt.Errorf("error creating fake symlink: %s", osErr.Error()))
 		}
 	}
-	err = os.MkdirAll(path.Join(fs.RootDir, "usr/share/hwdata"), 0700)
+	err = os.MkdirAll(path.Join(fs.RootDir, "usr/share/hwdata"), DirPerm)
 	if err != nil {
 		panic(fmt.Errorf("error creating fake directory: %s", err.Error()))
 	}
@@ -55,7 +61,7 @@ func (fs *FakeFilesystem) Use() func() {
 	if err != nil {
 		panic(fmt.Errorf("error reading file: %s", err.Error()))
 	}
-	err = os.WriteFile(path.Join(fs.RootDir, "usr/share/hwdata/pci.ids"), pciData, 0600)
+	err = os.WriteFile(path.Join(fs.RootDir, "usr/share/hwdata/pci.ids"), pciData, FilePerm)
 	if err != nil {
 		panic(fmt.Errorf("error creating fake file: %s", err.Error()))
 	}

Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@ func NewPciNetDevice(dev *ghw.PCIDevice, rds types.RdmaDeviceSpec,`
`45`	`45`	`}`
`46`	`46`
`47`	`47`	`linkType := ""`
`48`		`- if len(ifName) > 0 {`
	`48`	`+ if ifName != "" {`
`49`	`49`	`link, err := nLink.LinkByName(ifName)`
`50`	`50`	`if err != nil {`
`51`	`51`	`return nil, err`
Original file line number	Diff line number	Diff line change
`@@ -353,27 +353,27 @@ func (rm *resourceManager) GetFilteredDevices(devices []types.PciNetDevice,`
`353`	`353`	`filteredDevice := devices`
`354`	`354`
`355`	`355`	`// filter by Vendors list`
`356`		`- if selector.Vendors != nil && len(selector.Vendors) > 0 {`
	`356`	`+ if len(selector.Vendors) > 0 {`
`357`	`357`	`filteredDevice = NewVendorSelector(selector.Vendors).Filter(filteredDevice)`
`358`	`358`	`}`
`359`	`359`
`360`	`360`	`// filter by DeviceIDs list`
`361`		`- if selector.DeviceIDs != nil && len(selector.DeviceIDs) > 0 {`
	`361`	`+ if len(selector.DeviceIDs) > 0 {`
`362`	`362`	`filteredDevice = NewDeviceSelector(selector.DeviceIDs).Filter(filteredDevice)`
`363`	`363`	`}`
`364`	`364`
`365`	`365`	`// filter by Driver list`
`366`		`- if selector.Drivers != nil && len(selector.Drivers) > 0 {`
	`366`	`+ if len(selector.Drivers) > 0 {`
`367`	`367`	`filteredDevice = NewDriverSelector(selector.Drivers).Filter(filteredDevice)`
`368`	`368`	`}`
`369`	`369`
`370`	`370`	`// filter by IfNames list`
`371`		`- if selector.IfNames != nil && len(selector.IfNames) > 0 {`
	`371`	`+ if len(selector.IfNames) > 0 {`
`372`	`372`	`filteredDevice = NewIfNameSelector(selector.IfNames).Filter(filteredDevice)`
`373`	`373`	`}`
`374`	`374`
`375`	`375`	`// filter by LinkType list`
`376`		`- if selector.LinkTypes != nil && len(selector.LinkTypes) > 0 {`
	`376`	`+ if len(selector.LinkTypes) > 0 {`
`377`	`377`	`filteredDevice = NewLinkTypeSelector(selector.LinkTypes).Filter(filteredDevice)`
`378`	`378`	`}`
`379`	`379`
Original file line number	Diff line number	Diff line change
`@@ -295,7 +295,7 @@ func (rs *resourceServer) register() error {`
`295`	`295`	`}`
`296`	`296`
`297`	`297`	`// ListAndWatch lists devices and update that list according to the health status`
`298`		`-func (rs resourceServer) ListAndWatch(e pluginapi.Empty, s pluginapi.DevicePlugin_ListAndWatchServer) error {`
	`298`	`+func (rs resourceServer) ListAndWatch(_ pluginapi.Empty, s pluginapi.DevicePlugin_ListAndWatchServer) error {`
`299`	`299`	`log.Printf("ListAndWatch called by kubelet for: %s", rs.resourceName)`
`300`	`300`	`resp := new(pluginapi.ListAndWatchResponse)`
`301`	`301`
`@@ -366,7 +366,7 @@ func (rs resourceServer) sendDevices(resp pluginapi.ListAndWatchResponse,`
`366`	`366`	`}`
`367`	`367`
`368`	`368`	`// Allocate which return list of devices.`
`369`		`-func (rs resourceServer) Allocate(ctx context.Context, r pluginapi.AllocateRequest) (`
	`369`	`+func (rs resourceServer) Allocate(_ context.Context, r pluginapi.AllocateRequest) (`
`370`	`370`	`*pluginapi.AllocateResponse, error) {`
`371`	`371`	`log.Println("allocate request:", r)`
`372`	`372`
`@@ -420,7 +420,7 @@ func (rs *resourceServer) cleanup() error {`
`420`	`420`	`}`
`421`	`421`
`422`	`422`	`// GetInfo get info of plugin`
`423`		`-func (rs resourceServer) GetInfo(ctx context.Context, rqt registerapi.InfoRequest) (*registerapi.PluginInfo, error) {`
	`423`	`+func (rs resourceServer) GetInfo(_ context.Context, _ registerapi.InfoRequest) (*registerapi.PluginInfo, error) {`
`424`	`424`	`pluginInfoResponse := &registerapi.PluginInfo{`
`425`	`425`	`Type: registerapi.DevicePlugin,`
`426`	`426`	`Name: rs.resourceName,`
`@@ -431,7 +431,7 @@ func (rs resourceServer) GetInfo(ctx context.Context, rqt registerapi.InfoRequ`
`431`	`431`	`}`
`432`	`432`
`433`	`433`	`// NotifyRegistrationStatus notify for registration status`
`434`		`-func (rs resourceServer) NotifyRegistrationStatus(ctx context.Context, regstat registerapi.RegistrationStatus) (`
	`434`	`+func (rs resourceServer) NotifyRegistrationStatus(_ context.Context, regstat registerapi.RegistrationStatus) (`
`435`	`435`	`*registerapi.RegistrationStatusResponse, error) {`
`436`	`436`	`if regstat.PluginRegistered {`
`437`	`437`	`log.Printf("%s gets registered successfully at Kubelet \n", rs.socketName)`
`@@ -490,7 +490,7 @@ func (rs *resourceServer) UpdateDevices(devices []types.PciNetDevice) {`
`490`	`490`	`}`
`491`	`491`
`492`	`492`	`func (rs *resourceServer) GetPreferredAllocation(`
`493`		`- ctx context.Context, req pluginapi.PreferredAllocationRequest) (pluginapi.PreferredAllocationResponse, error) {`
	`493`	`+ _ context.Context, _ pluginapi.PreferredAllocationRequest) (pluginapi.PreferredAllocationResponse, error) {`
`494`	`494`	`return nil, nil`
`495`	`495`	`}`
`496`	`496`