Improve usability of Golangci-lint (#3193)

* Run 'make format && make generate' Seems like this hadn't been run in a long while. Signed-off-by: Edu Gómez Escandell <egomez@redhat.com> * Run 'golangci-lint --fix' when using 'make format' Signed-off-by: Edu Gómez Escandell <egomez@redhat.com> * Update golangci-lint version Signed-off-by: Edu Gómez Escandell <egomez@redhat.com> * Remove gofmt Golangci-lint already runs gofmt internally (see ./.golangci.yml) Signed-off-by: Edu Gómez Escandell <egomez@redhat.com> * Remove golint pass This linter has been deprecated since May 9, 2021. Golangci-lint already covers its functionality Signed-off-by: Edu Gómez Escandell <egomez@redhat.com> * Remove goimports Golangci-lint already runs goimports internally (see ./.golangci.yml) Signed-off-by: Edu Gómez Escandell <egomez@redhat.com> * Move govet into golangci-lint This way we don't parse the project twice. Signed-off-by: Edu Gómez Escandell <egomez@redhat.com> * Update README Signed-off-by: Edu Gómez Escandell <egomez@redhat.com> * Run formaters and generators again Signed-off-by: Edu Gómez Escandell <egomez@redhat.com> --------- Signed-off-by: Edu Gómez Escandell <egomez@redhat.com>
kubevirt · May 11, 2024 · 3053513 · 3053513
1 parent 02e7f46
commit 3053513
Show file tree

Hide file tree

Showing 16 changed files with 28 additions and 51 deletions.
diff --git a/.golangci.yml b/.golangci.yml
@@ -8,6 +8,7 @@ linters:
   - ginkgolinter
   - gofmt
   - goimports
+  - govet
   - misspell
   - nakedret
   - unconvert

diff --git a/hack/README.md b/hack/README.md
@@ -59,7 +59,7 @@ The standard workflow is performed inside a helper container to normalize the bu
 - `release-description`: generate a release announcement detailing changes between 2 commits (typically tags).  Expects 'RELREF' and 'PREREF' to be set
 - `test`: execute all tests (_NOTE:_ 'WHAT' is expected to match the go cli pattern for paths e.g. './pkg/...'.  This differs slightly from rest of the 'make' targets)
     - `test-unit`: Run unit tests.
-    - `test-lint`: Run gofmt and golint against src files
+    - `test-lint`: Run golangci-lint against src files
     - `test-functional`: Run functional tests (in tests/ subdirectory).
 - `vet`: lint all CDI packages
 

diff --git a/hack/build/bazel-build-builder.sh b/hack/build/bazel-build-builder.sh
@@ -41,14 +41,13 @@ if ! git diff-index --quiet HEAD~1 hack/build/docker; then
     if [ "${CDI_CONTAINER_BUILDCMD}" = "buildah" ]; then
         (cd ${BUILDER_SPEC} && buildah build ${BUILDAH_PLATFORM_FLAG} --manifest ${BUILDER_MANIFEST} .)
         buildah manifest push --all ${BUILDER_MANIFEST} docker://${BUILDER_MANIFEST}
-        DIGEST=$(podman inspect $(podman images | grep ${UNTAGGED_BUILDER_IMAGE} | grep ${BUILDER_TAG} | awk '{ print $3 }') |  jq '.[]["Digest"]')
+        DIGEST=$(podman inspect $(podman images | grep ${UNTAGGED_BUILDER_IMAGE} | grep ${BUILDER_TAG} | awk '{ print $3 }') | jq '.[]["Digest"]')
     else
         (cd ${BUILDER_SPEC} && docker build --tag ${BUILDER_MANIFEST} .)
         docker push ${BUILDER_MANIFEST}
         DIGEST=$(docker images --digests | grep ${UNTAGGED_BUILDER_IMAGE} | grep ${BUILDER_TAG} | awk '{ print $4 }')
     fi
 
-
     echo "Image: ${BUILDER_MANIFEST}"
     echo "Digest: ${DIGEST}"
 fi
diff --git a/hack/build/bazel-docker.sh b/hack/build/bazel-docker.sh
@@ -107,7 +107,7 @@ volumes="-v ${BUILDER_VOLUME}:/root:rw,z"
 mkdir -p "${HOME}/.docker"
 volumes="$volumes -v ${HOME}/.docker:/root/.docker:ro,z"
 
-if [[ $CDI_CRI = podman* ]] && [[ -f "${XDG_RUNTIME_DIR-}/containers/auth.json" ]]; then
+if [[ $CDI_CRI == podman* ]] && [[ -f "${XDG_RUNTIME_DIR-}/containers/auth.json" ]]; then
     volumes="$volumes --mount type=bind,source=${XDG_RUNTIME_DIR-}/containers/auth.json,target=/root/.docker/config.json,readonly"
 elif [[ -f "${HOME}/.docker/config.json" ]]; then
     volumes="$volumes --mount type=bind,source=${HOME}/.docker/config.json,target=/root/.docker/config.json,readonly"

diff --git a/hack/build/bazel-generate.sh b/hack/build/bazel-generate.sh
@@ -10,11 +10,11 @@ bazel run \
     //:gazelle $@
 
 if [[ "$@" =~ "vendor" ]]; then
-  bazel run \
-      --config=${ARCHITECTURE} \
-      -- @com_github_bazelbuild_buildtools//buildozer 'add clinkopts -lnbd' //$HOME/go/src/kubevirt.io/containerized-data-importer/vendor/libguestfs.org/libnbd/:go_default_library
- 
-  bazel run \
-      --config=${ARCHITECTURE} \
-      -- @com_github_bazelbuild_buildtools//buildozer 'add copts -D_GNU_SOURCE=1' //$HOME/go/src/kubevirt.io/containerized-data-importer/vendor/libguestfs.org/libnbd/:go_default_library
+    bazel run \
+        --config=${ARCHITECTURE} \
+        -- @com_github_bazelbuild_buildtools//buildozer 'add clinkopts -lnbd' //$HOME/go/src/kubevirt.io/containerized-data-importer/vendor/libguestfs.org/libnbd/:go_default_library
+
+    bazel run \
+        --config=${ARCHITECTURE} \
+        -- @com_github_bazelbuild_buildtools//buildozer 'add copts -D_GNU_SOURCE=1' //$HOME/go/src/kubevirt.io/containerized-data-importer/vendor/libguestfs.org/libnbd/:go_default_library
 fi
diff --git a/hack/build/build-go.sh b/hack/build/build-go.sh
@@ -56,7 +56,7 @@ elif [ "${go_opt}" == "build" ]; then
         rm -f ${outLink}
         static_flag=""
         if [ "$tgt" == "tools/cdi-containerimage-server" ]; then
-          static_flag="static"
+            static_flag="static"
         fi
         (
             cd $tgt

diff --git a/hack/build/common.sh b/hack/build/common.sh
@@ -45,8 +45,8 @@ ARCHITECTURE="${BUILD_ARCH:-$(uname -m)}"
 HOST_ARCHITECTURE="$(uname -m)"
 CDI_CRI="$(determine_cri_bin)"
 if [ "${CDI_CRI}" = "docker" ]; then
-   CDI_CONTAINER_BUILDCMD=${CDI_CONTAINER_BUILDCMD:-docker}
+    CDI_CONTAINER_BUILDCMD=${CDI_CONTAINER_BUILDCMD:-docker}
 else
-   CDI_CONTAINER_BUILDCMD=${CDI_CONTAINER_BUILDCMD:-buildah}
+    CDI_CONTAINER_BUILDCMD=${CDI_CONTAINER_BUILDCMD:-buildah}
 fi
 echo "CDI_CRI: ${CDI_CRI}, CDI_CONTAINER_BUILDCMD: ${CDI_CONTAINER_BUILDCMD}"
diff --git a/hack/build/docker/builder/Dockerfile b/hack/build/docker/builder/Dockerfile
@@ -41,10 +41,8 @@ RUN \
 	source /etc/profile.d/gimme.sh && \
 	eval $(go env) && \
 	go install github.com/onsi/ginkgo/v2/ginkgo@v2.12.0 && \
-	go install golang.org/x/tools/cmd/goimports@latest && \
 	go install mvdan.cc/sh/cmd/shfmt@latest && \
 	go install github.com/mattn/goveralls@latest && \
-	go install golang.org/x/lint/golint@latest && \
 	go install github.com/rmohr/go-swagger-utils/swagger-doc@latest && \
 	go install sigs.k8s.io/controller-tools/cmd/controller-gen@v0.14.0 && \
 	go install github.com/securego/gosec/v2/cmd/gosec@latest && \

diff --git a/hack/build/format.sh b/hack/build/format.sh
@@ -21,5 +21,4 @@ source "${script_dir}"/common.sh
 source "${script_dir}"/config.sh
 
 shfmt -i 4 -w ${CDI_DIR}/hack ${CLONER_MAIN}
-goimports -w -local kubevirt.io ${CDI_DIR}/cmd/ ${CDI_DIR}/pkg/ ${CDI_DIR}/tests/
-(cd ${CDI_DIR} && go vet $(go list ./... | grep -v -E "vendor|pkg/client" | sort -u))
+cd ${CDI_DIR} && "${script_dir}/run-linters.sh" --fix
diff --git a/hack/build/rpm-deps.sh b/hack/build/rpm-deps.sh
@@ -158,7 +158,7 @@ bazel run \
     --config=aarch64 \
     //:bazeldnf -- rpmtree \
     --public --nobest \
-    --name cdi_uploadserver_base_aarch64  --arch aarch64\
+    --name cdi_uploadserver_base_aarch64 --arch aarch64 \
     --basesystem centos-stream-release \
     ${bazeldnf_repos} \
     $centos_base \

diff --git a/hack/build/run-lint-checks.sh b/hack/build/run-lint-checks.sh
@@ -20,25 +20,5 @@
 source hack/build/config.sh
 source hack/build/common.sh
 
-LINTABLE=(staging/src/kubevirt.io/containerized-data-importer-api pkg cmd tests tools)
-ec=0
-out="$(gofmt -l -s ${SOURCE_DIRS} | grep ".*\.go")"
-if [[ ${out} ]]; then
-    echo "FAIL: Format errors found in the following files:"
-    echo "${out}"
-    ec=1
-fi
-for p in "${LINTABLE[@]}"; do
-    echo "running golint on directory: ${p}"
-    out="$(golint ${p}/...)"
-    if [[ ${out} ]]; then
-        echo "FAIL: following golint errors found:"
-        echo "${out}"
-        ec=1
-    fi
-done
-
 set -e
 ./hack/build/run-linters.sh
-
-exit ${ec}
diff --git a/hack/build/run-linters.sh b/hack/build/run-linters.sh
@@ -1,7 +1,7 @@
 #!/bin/sh -ex
 
-GOLANGCI_VERSION="${GOLANGCI_VERSION:-v1.54.2}"
+GOLANGCI_VERSION="${GOLANGCI_VERSION:-v1.58.0}"
 
 go install "github.com/golangci/golangci-lint/cmd/golangci-lint@${GOLANGCI_VERSION}"
 
-golangci-lint run --timeout=16m ./...
+golangci-lint run --timeout=16m ./... "$@"
diff --git a/hack/ci/prom_metric_linter.sh b/hack/ci/prom_metric_linter.sh
@@ -63,6 +63,6 @@ errors=$($CDI_CRI run -i "quay.io/kubevirt/prom-metrics-linter:$linter_image_tag
 
 # Check if there were any errors, if yes print and fail
 if [[ $errors != "" ]]; then
-  echo "$errors"
-  exit 1
+    echo "$errors"
+    exit 1
 fi
diff --git a/hack/common-funcs.sh b/hack/common-funcs.sh
@@ -19,14 +19,14 @@
 #
 
 get_latest_release() {
-  curl -s "https://api.github.com/repos/$1/releases/latest" |       # Get latest release from GitHub api
-    grep '"tag_name":' |                                            # Get tag line
-    sed -E 's/.*"([^"]+)".*/\1/'                                    # Pluck JSON value (avoid jq)
+    curl -s "https://api.github.com/repos/$1/releases/latest" | # Get latest release from GitHub api
+        grep '"tag_name":' | # Get tag line
+        sed -E 's/.*"([^"]+)".*/\1/' # Pluck JSON value (avoid jq)
 }
 
 get_previous_y_release() {
-  curl -s "https://api.github.com/repos/$1/releases" |
-    grep '"tag_name":' |
-    sed -E 's/.*"([^"]+)".*/\1/' |
-    sort -V | grep -v rc | grep "$2" -B 100 | grep -v "$2" | tail -n 1 | xargs
+    curl -s "https://api.github.com/repos/$1/releases" |
+        grep '"tag_name":' |
+        sed -E 's/.*"([^"]+)".*/\1/' |
+        sort -V | grep -v rc | grep "$2" -B 100 | grep -v "$2" | tail -n 1 | xargs
 }
diff --git a/hack/fossa.sh b/hack/fossa.sh
@@ -9,4 +9,3 @@ if [[ "${CI:-}" == "true" ]]; then
 fi
 FOSSA_API_KEY="$(cat $FOSSA_TOKEN_FILE)" fossa analyze $FOSSA_OPTS
 FOSSA_API_KEY="$(cat $FOSSA_TOKEN_FILE)" fossa test --timeout=1800
-
diff --git a/pkg/importer/vddk-datasource_arm64.go b/pkg/importer/vddk-datasource_arm64.go
@@ -8,6 +8,7 @@ import (
 	"net/url"
 
 	v1 "k8s.io/api/core/v1"
+
 	"kubevirt.io/containerized-data-importer/pkg/common"
 )