feat: add cache expectations (#68)

* feat: add cache expectations

* fix code according to lint on go 1.22

* feat: upgrade golangci-lint to v2

* fix lint

* fix: format by gofumpt

Author: zoumo

.github/workflows/ci.yaml

@@ -12,29 +12,21 @@ on:
       - release-*
 
 env:
-  GO_VERSION: '1.19'
+  GO_VERSION: '1.23'
 
 jobs:
 
   Test:
     name: Unit Test
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-        with:
-          submodules: true
-      - name: Fetch History
-        run: git fetch --prune --unshallow
-      - name: Setup Go
-        uses: actions/setup-go@v3
+      - uses: actions/checkout@v4
+      - name: Set up Go
+        uses: actions/setup-go@v5
         with:
           go-version: ${{ env.GO_VERSION }}
-      - name: Cache Go Dependencies
-        uses: actions/cache@v4
-        with:
-          path: ~/go/pkg/mod
-          key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
-          restore-keys: ${{ runner.os }}-go-
+          check-latest: true
+          cache-dependency-path: "**/*.sum"
       - name: Run Unit Tests
         run: |
           make test
@@ -45,19 +37,18 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
+        uses: actions/checkout@v4
       - name: Set up Go
-        uses: actions/setup-go@v4
+        uses: actions/setup-go@v5
         with:
           go-version: ${{ env.GO_VERSION }}
-          cache: false
+          check-latest: true
+          cache-dependency-path: "**/*.sum"
       - name: golangci-lint
-        uses: golangci/golangci-lint-action@v3
+        uses: golangci/golangci-lint-action@v7
         with:
           # Optional: version of golangci-lint to use in form of v1.2 or v1.2.3 or `latest` to use the latest version
-          version: v1.53
+          version: v2.0.2
           args: --timeout=30m
 
   LicenseCheck:
@@ -66,9 +57,7 @@ jobs:
     env:
       TERM: xterm
     steps:
-      - uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
+      - uses: actions/checkout@v4
       - uses: apache/skywalking-eyes@main
 
   # The TruffleHog OSS Github Action can be used to scan a range of commits for leaked credentials. The action will fail if any results are found.

.golangci.yaml

@@ -1,105 +1,90 @@
-# Copyright 2023 The KusionStack Authors
-# 
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-# 
-#     http://www.apache.org/licenses/LICENSE-2.0
-# 
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-linters-settings:
-  govet:
-    shadow: true
-  golint:
-    min-confidence: 0
-  gocyclo:
-    min-complexity: 15
-  maligned:
-    suggest-new: true
-  dupl:
-    threshold: 100
-  misspell:
-    locale: US
-  lll:
-    line-length: 140
-  goimports:
-    local-prefixes: kusionstack.io/kube-utils
-  gocritic:
-    enabled-tags:
-      - diagnostic
-      - experimental
-      - opinionated
-      - performance
-      - style
-    disabled-checks:
-      - dupImport # https://github.com/go-critic/go-critic/issues/845
-      - ifElseChain
-      - octalLiteral
-      - wrapperFunc
-  funlen:
-    lines: 100
-    statements: 50
+version: "2"
 linters:
-  disable-all: true
+  default: standard
   enable:
-    ## for bug
     - bodyclose
-    - errcheck
-    - govet
-    - ineffassign
-    - exportloopref
-    - staticcheck
-    - typecheck
-
-    ## for complexity
-    # - gocyclo
+    - copyloopvar
+    - ginkgolinter
+    - testifylint
+    - misspell
     - nakedret
-    - gosimple
-
-    ## for format
-    - gofmt
-    - goimports
-
-    ## for style
     - unconvert
-    # - goconst
-    - misspell
     - unparam
-    # - revive
     - whitespace
-    # - goerr113
-
-    ## for unused
-    - unused
-    - unparam
+  settings:
+    dupl:
+      threshold: 100
+    funlen:
+      lines: 100
+      statements: 50
+    gocritic:
+      disabled-checks:
+        - dupImport
+        - ifElseChain
+        - octalLiteral
+        - wrapperFunc
+      enabled-tags:
+        - diagnostic
+        - experimental
+        - opinionated
+        - performance
+        - style
+    gocyclo:
+      min-complexity: 15
+    govet:
+      enable:
+        - shadow
+    misspell:
+      locale: US
+    revive:
+      confidence: 0.1
+      enable-all-rules: true
+    staticcheck:
+      checks:
+       - "-QF1008"
+  exclusions:
+    generated: lax
+    presets:
+      - comments
+      - common-false-positives
+      - legacy
+      - std-error-handling
+    rules:
+      - linters:
+          - dupl
+          - errcheck
+          - gocyclo
+          - gosec
+          - unparam
+        path: _test.go
+      - linters:
+          - govet
+        text: declaration of "err" shadows declaration at line
+    paths:
+      - third_party$
+      - builtin$
+      - examples$
+formatters:
+  enable:
+    - gofumpt # drop in replacement for gofmt
+    - gci # format imports
+  settings:
+    gci:
+      custom-order: true
+      sections:
+        - standard
+        - blank
+        - dot
+        - default
+        - localmodule
+    gofumpt:
+      extra-rules: true
+  exclusions:
+    generated: lax
+    paths:
+      - third_party$
+      - builtin$
+      - examples$
 
 run:
-  deadline: 10m
-  # default is true. Enables skipping of directories:
-  #   vendor$, third_party$, testdata$, examples$, Godeps$, builtin$
-  skip-dirs-use-default: true
-
-issues:
-  exclude-use-default: true
-  exclude-rules:
-    - path: _test.go
-      linters:
-        - errcheck
-        - unparam
-        - gocyclo
-        - dupl
-        - gosec
-
-    # enable shadow declaration for err
-    - linters:
-        - govet
-      text: declaration of "err" shadows declaration at line
-
-    # - linters:
-    #     - govet
-    #   text: composite literal uses unkeyed fields
+  allow-parallel-runners: true

Makefile

@@ -1,28 +1,38 @@
 # ENVTEST_K8S_VERSION refers to the version of kubebuilder assets to be downloaded by envtest binary.
 ENVTEST_K8S_VERSION = 1.24.1
 
-.PHONY: fmt
-fmt: ## Run go fmt against code.
-	go fmt ./...
-
-.PHONY: vet
-vet: ## Run go vet against code.
-	go vet ./...
+# Setting SHELL to bash allows bash commands to be executed by recipes.
+# Options are set to exit when a recipe line exits non-zero or a piped command fails.
+SHELL = /usr/bin/env bash -o pipefail
+.SHELLFLAGS = -ec
 
 .PHONY: test
-test: fmt vet envtest ## Run tests.
+test: envtest ## Run tests.
 	KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(LOCALBIN) -p path)" go test ./... -coverprofile cover.out
 
+.PHONY: lint
+lint: golangci
+	$(GOLANGCI) run 
+
 ##@ Build Dependencies
 
 ## Location to install dependencies to
 LOCALBIN ?= $(shell pwd)/bin
 $(LOCALBIN):
 	mkdir -p $(LOCALBIN)
 
+
 ENVTEST ?= $(LOCALBIN)/setup-envtest
+GOLANGCI ?= $(LOCALBIN)/golangci-lint
 
 .PHONY: envtest
 envtest: $(ENVTEST) ## Download envtest-setup locally if necessary.
 $(ENVTEST): $(LOCALBIN)
 	test -s $(LOCALBIN)/setup-envtest || GOBIN=$(LOCALBIN) go install sigs.k8s.io/controller-runtime/tools/[email protected]
+
+GOLANGCI_VERSION ?= v2.0.2
+
+.PHONY: golangci
+golangci: $(GOLANGCI)
+$(GOLANGCI): $(LOCALBIN)
+	@test -s $(LOCALBIN)/golangci-lint || GOBIN=$(LOCALBIN) go install github.com/golangci/golangci-lint/v2/cmd/golangci-lint@$(GOLANGCI_VERSION)

cache/cache.go

@@ -174,7 +174,7 @@ func (ip *cacheSupportDisableDeepCopy) objectTypeForListObject(list client.Objec
 		// http://knowyourmeme.com/memes/this-is-fine
 		elemType := reflect.Indirect(reflect.ValueOf(itemsPtr)).Type().Elem()
 		if elemType.Kind() != reflect.Ptr {
-			elemType = reflect.PtrTo(elemType)
+			elemType = reflect.PointerTo(elemType)
 		}
 
 		cacheTypeValue := reflect.Zero(elemType)
@@ -262,7 +262,7 @@ const allNamespacesNamespace = "__all_namespaces"
 
 // KeyToNamespacedKey prefixes the given index key with a namespace
 // for use in field selector indexes.
-func KeyToNamespacedKey(ns string, baseKey string) string {
+func KeyToNamespacedKey(ns, baseKey string) string {
 	if ns != "" {
 		return ns + "/" + baseKey
 	}
@@ -286,8 +286,7 @@ type ObjectWithoutDeepCopy struct {
 
 var DisableDeepCopy = &disableDeepCopyListOption{}
 
-type disableDeepCopyListOption struct {
-}
+type disableDeepCopyListOption struct{}
 
 func (o *disableDeepCopyListOption) ApplyToList(*client.ListOptions) {
 }