From 46cc580f775e2392dffd472d2dee34ec6956a333 Mon Sep 17 00:00:00 2001 From: Carlos Eduardo Arango Gutierrez Date: Wed, 13 Mar 2024 13:51:12 +0100 Subject: [PATCH] Add golanci-lint config file and address lints Signed-off-by: Carlos Eduardo Arango Gutierrez --- .github/workflows/golang.yml | 2 -- .github/workflows/images.yml | 14 +++++++----- .golangci.yml | 35 +++++++++++++++++++++++++++++ api/spec/v1/helpers.go | 7 +++--- api/spec/v1/spec_test.go | 3 ++- cmd/nvidia-k8s-vgpu-dm/main.go | 2 +- cmd/nvidia-vgpu-dm/apply/apply.go | 2 +- cmd/nvidia-vgpu-dm/assert/assert.go | 3 ++- go.mod | 2 +- go.sum | 7 ++++++ pkg/types/types_test.go | 3 ++- pkg/types/vgpu_config.go | 2 +- 12 files changed, 64 insertions(+), 18 deletions(-) create mode 100644 .golangci.yml diff --git a/.github/workflows/golang.yml b/.github/workflows/golang.yml index 60b0df27..5b90579c 100644 --- a/.github/workflows/golang.yml +++ b/.github/workflows/golang.yml @@ -45,8 +45,6 @@ jobs: version: latest args: -v --timeout 5m skip-cache: true - - name: Check golang modules - run: make check-vendor test: name: Unit test runs-on: ubuntu-latest diff --git a/.github/workflows/images.yml b/.github/workflows/images.yml index fcdc2dc7..d1642821 100644 --- a/.github/workflows/images.yml +++ b/.github/workflows/images.yml @@ -49,11 +49,17 @@ jobs: REPO_FULL_NAME="${{ github.event.pull_request.head.repo.full_name }}" echo "${REPO_FULL_NAME}" echo "LABEL_IMAGE_SOURCE=https://github.com/${REPO_FULL_NAME}" >> $GITHUB_ENV + + GENERATE_ARTIFACTS="false" if [[ "${{ github.actor }}" == "dependabot[bot]" ]]; then - echo "PUSH_ON_BUILD=false" >> $GITHUB_ENV - else - echo "PUSH_ON_BUILD=true" >> $GITHUB_ENV + GENERATE_ARTIFACTS="false" + elif [[ "${{ github.event_name }}" == "pull_request" && "${{ github.event.pull_request.head.repo.full_name }}" == "${{ github.repository }}" ]]; then + GENERATE_ARTIFACTS="true" + elif [[ "${{ github.event_name }}" == "push" ]]; then + GENERATE_ARTIFACTS="true" fi + echo "PUSH_ON_BUILD=${GENERATE_ARTIFACTS}" >> $GITHUB_ENV + echo "BUILD_MULTI_ARCH_IMAGES=${GENERATE_ARTIFACTS}" >> $GITHUB_ENV - name: Set up Docker Buildx uses: docker/setup-buildx-action@v3 @@ -69,8 +75,6 @@ jobs: env: IMAGE_NAME: ghcr.io/${LOWERCASE_REPO_OWNER}/vgpu-device-manager VERSION: ${COMMIT_SHORT_SHA} - # TODO: For now we only build single-arch images to speed up development. - BUILD_MULTI_ARCH_IMAGES: "false" run: | echo "${VERSION}" make -f deployments/container/Makefile build-${{ matrix.dist }} diff --git a/.golangci.yml b/.golangci.yml new file mode 100644 index 00000000..ba65561b --- /dev/null +++ b/.golangci.yml @@ -0,0 +1,35 @@ +run: + deadline: 10m + +linters: + enable: + - contextcheck + - errcheck + - gocritic + - gofmt + - goimports + - gosec + - gosimple + - govet + - ineffassign + - misspell + - staticcheck + - unconvert + disable: [] + +linters-settings: + goimports: + local-prefixes: github.com/NVIDIA/vgpu-device-manager + +issues: + exclude-rules: + # We disable the memory aliasing checks in tests + - path: ".*_test.go" + linters: + - gosec + text: "G601: Implicit memory aliasing in for loop" + # We create world-readable files in tests. + - path: ".*_test.go" + linters: + - gosec + text: "G306: Expect WriteFile permissions to be 0600 or less" diff --git a/api/spec/v1/helpers.go b/api/spec/v1/helpers.go index c8d9d038..4af5dd07 100644 --- a/api/spec/v1/helpers.go +++ b/api/spec/v1/helpers.go @@ -48,8 +48,7 @@ func (vs *VGPUConfigSpec) MatchesDeviceFilter(deviceID types.DeviceID) bool { // MatchesAllDevices checks a 'VGPUConfigSpec' to see if it matches on 'all' devices. func (vs *VGPUConfigSpec) MatchesAllDevices() bool { - switch devices := vs.Devices.(type) { - case string: + if devices, ok := vs.Devices.(string); ok { return devices == "all" } return false @@ -57,13 +56,13 @@ func (vs *VGPUConfigSpec) MatchesAllDevices() bool { // MatchesDevices checks a 'VGPUConfigSpec' to see if it matches on a device at the specified 'index'. func (vs *VGPUConfigSpec) MatchesDevices(index int) bool { - switch devices := vs.Devices.(type) { - case []int: + if devices, ok := vs.Devices.([]int); ok { for _, d := range devices { if index == d { return true } } } + return vs.MatchesAllDevices() } diff --git a/api/spec/v1/spec_test.go b/api/spec/v1/spec_test.go index c6070ef8..1fbbd7de 100644 --- a/api/spec/v1/spec_test.go +++ b/api/spec/v1/spec_test.go @@ -17,9 +17,10 @@ package v1 import ( + "testing" + "github.com/stretchr/testify/require" "sigs.k8s.io/yaml" - "testing" ) func TestSpec(t *testing.T) { diff --git a/cmd/nvidia-k8s-vgpu-dm/main.go b/cmd/nvidia-k8s-vgpu-dm/main.go index 6caa4a33..85893856 100644 --- a/cmd/nvidia-k8s-vgpu-dm/main.go +++ b/cmd/nvidia-k8s-vgpu-dm/main.go @@ -268,7 +268,7 @@ func updateConfig(clientset *kubernetes.Clientset, selectedConfig string) error log.Info("Asserting that the requested configuration is present in the configuration file") err := assertValidConfig(selectedConfig) if err != nil { - return fmt.Errorf("Unable to validate the selected vGPU configuration") + return fmt.Errorf("unable to validate the selected vGPU configuration") } log.Info("Checking if the selected vGPU device configuration is currently applied or not") diff --git a/cmd/nvidia-vgpu-dm/apply/apply.go b/cmd/nvidia-vgpu-dm/apply/apply.go index 81d2567c..cc6a88c7 100644 --- a/cmd/nvidia-vgpu-dm/apply/apply.go +++ b/cmd/nvidia-vgpu-dm/apply/apply.go @@ -94,7 +94,7 @@ func (c *Context) ApplyVGPUConfig() error { func applyWrapper(c *cli.Context, f *Flags) error { err := CheckFlags(f) if err != nil { - cli.ShowSubcommandHelp(c) + _ = cli.ShowSubcommandHelp(c) return err } diff --git a/cmd/nvidia-vgpu-dm/assert/assert.go b/cmd/nvidia-vgpu-dm/assert/assert.go index 686e51bc..f0c05b3f 100644 --- a/cmd/nvidia-vgpu-dm/assert/assert.go +++ b/cmd/nvidia-vgpu-dm/assert/assert.go @@ -93,7 +93,7 @@ func BuildCommand() *cli.Command { func assertWrapper(c *cli.Context, f *Flags) error { err := CheckFlags(f) if err != nil { - cli.ShowSubcommandHelp(c) + _ = cli.ShowSubcommandHelp(c) return err } @@ -217,6 +217,7 @@ func WalkSelectedVGPUConfigForEachGPU(vgpuConfig v1.VGPUConfigSpecSlice, f func( log.Debugf(" GPU %v: %v", i, deviceID) + // nolint: gosec err = f(&vc, i, deviceID) if err != nil { return err diff --git a/go.mod b/go.mod index 4c15bd38..bed17f38 100644 --- a/go.mod +++ b/go.mod @@ -1,6 +1,6 @@ module github.com/NVIDIA/vgpu-device-manager -go 1.20 +go 1.21 require ( github.com/NVIDIA/go-nvlib v0.1.0 diff --git a/go.sum b/go.sum index 2dd0688f..999f950b 100644 --- a/go.sum +++ b/go.sum @@ -17,6 +17,7 @@ github.com/go-openapi/jsonreference v0.20.2/go.mod h1:Bl1zwGIM8/wsvqjsOQLJ/SH+En github.com/go-openapi/swag v0.22.3 h1:yMBqmnQ0gyZvEb/+KzuWZOXgllrXT4SADYbvDaXHv/g= github.com/go-openapi/swag v0.22.3/go.mod h1:UzaqsxGiab7freDnrUUra0MwWfN/q7tE4j+VcZ0yl14= github.com/go-task/slim-sprig v0.0.0-20230315185526-52ccab3ef572 h1:tfuBGBXKqDEevZMzYi5KSi8KkcZtzBcTgAUUtapy0OI= +github.com/go-task/slim-sprig v0.0.0-20230315185526-52ccab3ef572/go.mod h1:9Pwr4B2jHnOSGXyyzV8ROjYa2ojvAY6HCGYYfMoC3Ls= github.com/gogo/protobuf v1.3.2 h1:Ov1cvc58UF3b5XjBnZv7+opcTcQFZebYjWzi34vdm4Q= github.com/gogo/protobuf v1.3.2/go.mod h1:P1XiOD3dCwIKUDQYPy72D8LYyHL2YPYrpS2s69NZV8Q= github.com/golang/protobuf v1.3.1/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U= @@ -33,6 +34,7 @@ github.com/google/gofuzz v1.0.0/go.mod h1:dBl0BpW6vV/+mYPU4Po3pmUjxk6FQPldtuIdl/ github.com/google/gofuzz v1.2.0 h1:xRy4A+RhZaiKjJ1bPfwQ8sedCA+YS2YcCHW6ec7JMi0= github.com/google/gofuzz v1.2.0/go.mod h1:dBl0BpW6vV/+mYPU4Po3pmUjxk6FQPldtuIdl/M65Eg= github.com/google/pprof v0.0.0-20210720184732-4bb14d4b1be1 h1:K6RDEckDVWvDI9JAJYCmNdQXq6neHJOYx3V6jnqNEec= +github.com/google/pprof v0.0.0-20210720184732-4bb14d4b1be1/go.mod h1:kpwsk12EmLew5upagYY7GY0pfYCcupk39gWOCRROcvE= github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0= github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= github.com/imdario/mergo v0.3.6 h1:xTNEAn+kxVO7dTZGu0CegyqKZmoWFI0rF8UxjlB2d28= @@ -45,6 +47,7 @@ github.com/kisielk/errcheck v1.5.0/go.mod h1:pFxgyoBC7bSaBwPgfKdkLd5X25qrDl4LWUI github.com/kisielk/gotool v1.0.0/go.mod h1:XhKaO+MFFWcvkIS/tQcRk01m1F5IRFswLeQ+oQHNcck= github.com/kr/pretty v0.2.1/go.mod h1:ipq/a2n7PKx3OHsz4KJII5eveXtPO4qwEXGdVfWzfnI= github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE= +github.com/kr/pretty v0.3.1/go.mod h1:hoEshYVHaxMs3cyo3Yncou5ZscifuDolrwPKZanG3xk= github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ= github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI= github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY= @@ -59,10 +62,13 @@ github.com/modern-go/reflect2 v1.0.2/go.mod h1:yWuevngMOJpCy52FWWMvUC8ws7m/LJsjY github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 h1:C3w9PqII01/Oq1c1nUAm88MOHcQC9l5mIlSMApZMrHA= github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822/go.mod h1:+n7T8mK8HuQTcFwEeznm/DIxMOiR9yIdICNftLE1DvQ= github.com/onsi/ginkgo/v2 v2.13.0 h1:0jY9lJquiL8fcf3M4LAXN5aMlS/b2BV86HFFPCPMgE4= +github.com/onsi/ginkgo/v2 v2.13.0/go.mod h1:TE309ZR8s5FsKKpuB1YAQYBzCaAfUgatB/xlT/ETL/o= github.com/onsi/gomega v1.29.0 h1:KIA/t2t5UBzoirT4H9tsML45GEbo3ouUnBHsCfD2tVg= +github.com/onsi/gomega v1.29.0/go.mod h1:9sxs+SwGrKI0+PWe4Fxa9tFQQBG5xSsSbMXOI8PPpoQ= github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= github.com/rogpeppe/go-internal v1.10.0 h1:TMyTOH3F/DB16zRVcYyreMH6GnZZrwQVAoYjRBZyWFQ= +github.com/rogpeppe/go-internal v1.10.0/go.mod h1:UQnix2H7Ngw/k4C5ijL5+65zddjncjaFoBhdsK/akog= github.com/russross/blackfriday/v2 v2.1.0 h1:JIOH55/0cWyOuilr9/qlrm0BSXldqnqwMsf35Ld67mk= github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM= github.com/sirupsen/logrus v1.8.1 h1:dJKuHgqk1NNQlqoA6BTlM1Wf9DOH3NBjQyu0h9+AZZE= @@ -122,6 +128,7 @@ golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtn golang.org/x/tools v0.0.0-20200619180055-7c47624df98f/go.mod h1:EkVYQZoAsY45+roYkvgYkIh4xh/qjgUK9TdY2XT94GE= golang.org/x/tools v0.0.0-20210106214847-113979e3529a/go.mod h1:emZCQorbCU4vsT4fOWvOPXz4eW1wZW4PmDk9uLelYpA= golang.org/x/tools v0.16.1 h1:TLyB3WofjdOEepBHAU20JdNC1Zbg87elYofWYAY5oZA= +golang.org/x/tools v0.16.1/go.mod h1:kYVVN6I1mBNoB1OX+noeBjbRk4IUEPa7JJ+TJMEooJ0= golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= diff --git a/pkg/types/types_test.go b/pkg/types/types_test.go index bdace122..1c492598 100644 --- a/pkg/types/types_test.go +++ b/pkg/types/types_test.go @@ -17,8 +17,9 @@ package types import ( - "github.com/stretchr/testify/require" "testing" + + "github.com/stretchr/testify/require" ) func TestParseVGPUType(t *testing.T) { diff --git a/pkg/types/vgpu_config.go b/pkg/types/vgpu_config.go index 28c38bb2..67ba3589 100644 --- a/pkg/types/vgpu_config.go +++ b/pkg/types/vgpu_config.go @@ -46,7 +46,7 @@ func (v VGPUConfig) AssertValid() error { return fmt.Errorf("cannot mix time-sliced and MIG-backed vGPU devices on the same GPU") } migBacked = true - } else { + } else if vgpuType.G <= 0 { if idx > 0 && migBacked { return fmt.Errorf("cannot mix time-sliced and MIG-backed vGPU devices on the same GPU") }