enhance: [2.4] format the sdk code (#34699)

- issue: #31293
- pr: #34033

Signed-off-by: SimFG <bang.fu@zilliz.com>

Makefile

@@ -143,6 +143,8 @@ lint-fix: getdeps
 	@$(INSTALL_PATH)/gofumpt -l -w internal/
 	@$(INSTALL_PATH)/gofumpt -l -w cmd/
 	@$(INSTALL_PATH)/gofumpt -l -w pkg/
+	@$(INSTALL_PATH)/gofumpt -l -w client/
+	@$(INSTALL_PATH)/gofumpt -l -w tests/go_client/
 	@$(INSTALL_PATH)/gofumpt -l -w tests/integration/
 	@echo "Running gci fix"
 	@$(INSTALL_PATH)/gci write cmd/ --skip-generated -s standard -s default -s "prefix(github.com/milvus-io)" --custom-order
@@ -155,9 +157,14 @@ lint-fix: getdeps
 #TODO: Check code specifications by golangci-lint
 static-check: getdeps
 	@echo "Running $@ check"
+	@echo "Start check core packages"
 	@source $(PWD)/scripts/setenv.sh && GO111MODULE=on $(INSTALL_PATH)/golangci-lint run --build-tags dynamic,test --timeout=30m --config $(PWD)/.golangci.yml
+	@echo "Start check pkg package"
 	@source $(PWD)/scripts/setenv.sh && cd pkg && GO111MODULE=on $(INSTALL_PATH)/golangci-lint run --build-tags dynamic,test --timeout=30m --config $(PWD)/.golangci.yml
+	@echo "Start check client package"
 	@source $(PWD)/scripts/setenv.sh && cd client && GO111MODULE=on $(INSTALL_PATH)/golangci-lint run --timeout=30m --config $(PWD)/client/.golangci.yml
+	@echo "Start check go_client e2e package"
+	@source $(PWD)/scripts/setenv.sh && cd tests/go_client && GO111MODULE=on $(INSTALL_PATH)/golangci-lint run --timeout=30m --config $(PWD)/client/.golangci.yml
 
 verifiers: build-cpp getdeps cppcheck fmt static-check
 

client/.golangci.yml

@@ -0,0 +1,172 @@
+run:
+  go: "1.21"
+  skip-dirs:
+    - build
+    - configs
+    - deployments
+    - docs
+    - scripts
+    - internal/core
+    - cmake_build
+  skip-files:
+    - partial_search_test.go
+
+linters:
+  disable-all: true
+  enable:
+    - gosimple
+    - govet
+    - ineffassign
+    - staticcheck
+    - decorder
+    - depguard
+    - gofmt
+    - goimports
+    - gosec
+    - revive
+    - unconvert
+    - misspell
+    - typecheck
+    - durationcheck
+    - forbidigo
+    - gci
+    - whitespace
+    - gofumpt
+    - gocritic
+
+linters-settings:
+  gci:
+    sections:
+      - standard
+      - default
+      - prefix(github.com/milvus-io)
+    custom-order: true
+  gofumpt:
+    lang-version: "1.18"
+    module-path: github.com/milvus-io
+  goimports:
+    local-prefixes: github.com/milvus-io
+  revive:
+    rules:
+      - name: unused-parameter
+        disabled: true
+      - name: var-naming
+        severity: warning
+        disabled: false
+        arguments:
+          - ["ID"] # Allow list
+      - name: context-as-argument
+        severity: warning
+        disabled: false
+        arguments:
+          - allowTypesBefore: "*testing.T"
+      - name: datarace
+        severity: warning
+        disabled: false
+      - name: duplicated-imports
+        severity: warning
+        disabled: false
+      - name: waitgroup-by-value
+        severity: warning
+        disabled: false
+      - name: indent-error-flow
+        severity: warning
+        disabled: false
+        arguments:
+          - "preserveScope"
+      - name: range-val-in-closure
+        severity: warning
+        disabled: false
+      - name: range-val-address
+        severity: warning
+        disabled: false
+      - name: string-of-int
+        severity: warning
+        disabled: false
+  misspell:
+    locale: US
+  gocritic:
+    enabled-checks:
+      - ruleguard
+    settings:
+      ruleguard:
+        failOnError: true
+        rules: "ruleguard/rules.go"
+  depguard:
+    rules:
+      main:
+        deny:
+          - pkg: "errors"
+            desc: not allowed, use github.com/cockroachdb/errors
+          - pkg: "github.com/pkg/errors"
+            desc: not allowed, use github.com/cockroachdb/errors
+          - pkg: "github.com/pingcap/errors"
+            desc: not allowed, use github.com/cockroachdb/errors
+          - pkg: "golang.org/x/xerrors"
+            desc: not allowed, use github.com/cockroachdb/errors
+          - pkg: "github.com/go-errors/errors"
+            desc: not allowed, use github.com/cockroachdb/errors
+          - pkg: "io/ioutil"
+            desc: ioutil is deprecated after 1.16, 1.17, use os and io package instead
+          - pkg: "github.com/tikv/client-go/rawkv"
+            desc: not allowed, use github.com/tikv/client-go/v2/txnkv
+          - pkg: "github.com/tikv/client-go/v2/rawkv"
+            desc: not allowed, use github.com/tikv/client-go/v2/txnkv
+  forbidigo:
+    forbid:
+      - '^time\.Tick$'
+      - 'return merr\.Err[a-zA-Z]+'
+      - 'merr\.Wrap\w+\(\)\.Error\(\)'
+      - '\.(ErrorCode|Reason) = '
+      - 'Reason:\s+\w+\.Error\(\)'
+      - 'errors.New\((.+)\.GetReason\(\)\)'
+      - 'commonpb\.Status\{[\s\n]*ErrorCode:[\s\n]*.+[\s\S\n]*?\}'
+      - 'os\.Open\(.+\)'
+      - 'os\.ReadFile\(.+\)'
+      - 'os\.WriteFile\(.+\)'
+      - "runtime.NumCPU"
+      - "runtime.GOMAXPROCS(0)"
+      #- 'fmt\.Print.*' WIP
+
+issues:
+  exclude-use-default: false
+  exclude-rules:
+    - path: .+_test\.go
+      linters:
+        - forbidigo
+  exclude:
+    - should have a package comment
+    - should have comment
+    - should be of the form
+    - should not use dot imports
+    - which can be annoying to use
+    # Binds to all network interfaces
+    - G102
+    # Use of unsafe calls should be audited
+    - G103
+    # Errors unhandled
+    - G104
+    # file/folder Permission
+    - G301
+    - G302
+    # Potential file inclusion via variable
+    - G304
+    # Deferring unsafe method like *os.File Close
+    - G307
+    # TLS MinVersion too low
+    - G402
+    # Use of weak random number generator math/rand
+    - G404
+    # Unused parameters
+    - SA1019
+    # defer return errors
+    - SA5001
+
+  # Maximum issues count per one linter. Set to 0 to disable. Default is 50.
+  max-issues-per-linter: 0
+  # Maximum count of issues with the same text. Set to 0 to disable. Default is 3.
+  max-same-issues: 0
+
+service:
+  # use the fixed version to not introduce new linters unexpectedly
+  golangci-lint-version: 1.55.2

client/column/sparse.go

@@ -22,6 +22,7 @@ import (
 	"math"
 
 	"github.com/cockroachdb/errors"
+
 	"github.com/milvus-io/milvus-proto/go-api/v2/schemapb"
 	"github.com/milvus-io/milvus/client/v2/entity"
 )

client/column/sparse_test.go

@@ -21,9 +21,10 @@ import (
 	"math/rand"
 	"testing"
 
-	"github.com/milvus-io/milvus/client/v2/entity"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
+
+	"github.com/milvus-io/milvus/client/v2/entity"
 )
 
 func TestColumnSparseEmbedding(t *testing.T) {

client/database_test.go

@@ -5,11 +5,12 @@ import (
 	"fmt"
 	"testing"
 
+	mock "github.com/stretchr/testify/mock"
+	"github.com/stretchr/testify/suite"
+
 	"github.com/milvus-io/milvus-proto/go-api/v2/commonpb"
 	"github.com/milvus-io/milvus-proto/go-api/v2/milvuspb"
 	"github.com/milvus-io/milvus/pkg/util/merr"
-	mock "github.com/stretchr/testify/mock"
-	"github.com/stretchr/testify/suite"
 )
 
 type DatabaseSuite struct {

client/index.go

@@ -21,12 +21,13 @@ import (
 	"fmt"
 	"time"
 
+	"google.golang.org/grpc"
+
 	"github.com/milvus-io/milvus-proto/go-api/v2/commonpb"
 	"github.com/milvus-io/milvus-proto/go-api/v2/milvuspb"
 	"github.com/milvus-io/milvus/client/v2/entity"
 	"github.com/milvus-io/milvus/client/v2/index"
 	"github.com/milvus-io/milvus/pkg/util/merr"
-	"google.golang.org/grpc"
 )
 
 type CreateIndexTask struct {

client/index_test.go

@@ -22,14 +22,15 @@ import (
 	"testing"
 	"time"
 
+	"github.com/stretchr/testify/mock"
+	"github.com/stretchr/testify/suite"
+	"go.uber.org/atomic"
+
 	"github.com/milvus-io/milvus-proto/go-api/v2/commonpb"
 	"github.com/milvus-io/milvus-proto/go-api/v2/milvuspb"
 	"github.com/milvus-io/milvus/client/v2/entity"
 	"github.com/milvus-io/milvus/client/v2/index"
 	"github.com/milvus-io/milvus/pkg/util/merr"
-	"github.com/stretchr/testify/mock"
-	"github.com/stretchr/testify/suite"
-	"go.uber.org/atomic"
 )
 
 type IndexSuite struct {

client/maintenance_test.go

@@ -22,13 +22,14 @@ import (
 	"testing"
 	"time"
 
+	"github.com/stretchr/testify/mock"
+	"github.com/stretchr/testify/suite"
+	"go.uber.org/atomic"
+
 	"github.com/milvus-io/milvus-proto/go-api/v2/commonpb"
 	"github.com/milvus-io/milvus-proto/go-api/v2/milvuspb"
 	"github.com/milvus-io/milvus-proto/go-api/v2/schemapb"
 	"github.com/milvus-io/milvus/pkg/util/merr"
-	"github.com/stretchr/testify/mock"
-	"github.com/stretchr/testify/suite"
-	"go.uber.org/atomic"
 )
 
 type MaintenanceSuite struct {

client/partition.go

@@ -19,9 +19,10 @@ package client
 import (
 	"context"
 
+	"google.golang.org/grpc"
+
 	"github.com/milvus-io/milvus-proto/go-api/v2/milvuspb"
 	"github.com/milvus-io/milvus/pkg/util/merr"
-	"google.golang.org/grpc"
 )
 
 // CreatePartition is the API for creating a partition for a collection.

client/partition_test.go

@@ -21,11 +21,12 @@ import (
 	"fmt"
 	"testing"
 
+	"github.com/stretchr/testify/mock"
+	"github.com/stretchr/testify/suite"
+
 	"github.com/milvus-io/milvus-proto/go-api/v2/commonpb"
 	"github.com/milvus-io/milvus-proto/go-api/v2/milvuspb"
 	"github.com/milvus-io/milvus/pkg/util/merr"
-	"github.com/stretchr/testify/mock"
-	"github.com/stretchr/testify/suite"
 )
 
 type PartitionSuite struct {

client/read.go

@@ -19,9 +19,9 @@ package client
 import (
 	"context"
 
+	"github.com/cockroachdb/errors"
 	"google.golang.org/grpc"
 
-	"github.com/cockroachdb/errors"
 	"github.com/milvus-io/milvus-proto/go-api/v2/milvuspb"
 	"github.com/milvus-io/milvus-proto/go-api/v2/schemapb"
 	"github.com/milvus-io/milvus/client/v2/column"

client/read_options.go

@@ -21,6 +21,7 @@ import (
 	"strconv"
 
 	"github.com/golang/protobuf/proto"
+
 	"github.com/milvus-io/milvus-proto/go-api/v2/commonpb"
 	"github.com/milvus-io/milvus-proto/go-api/v2/milvuspb"
 	"github.com/milvus-io/milvus/client/v2/entity"

client/read_test.go

@@ -6,13 +6,14 @@ import (
 	"math/rand"
 	"testing"
 
+	"github.com/samber/lo"
+	"github.com/stretchr/testify/mock"
+	"github.com/stretchr/testify/suite"
+
 	"github.com/milvus-io/milvus-proto/go-api/v2/milvuspb"
 	"github.com/milvus-io/milvus-proto/go-api/v2/schemapb"
 	"github.com/milvus-io/milvus/client/v2/entity"
 	"github.com/milvus-io/milvus/pkg/util/merr"
-	"github.com/samber/lo"
-	"github.com/stretchr/testify/mock"
-	"github.com/stretchr/testify/suite"
 )
 
 type ReadSuite struct {

client/write_test.go

@@ -22,12 +22,13 @@ import (
 	"math/rand"
 	"testing"
 
-	"github.com/milvus-io/milvus-proto/go-api/v2/milvuspb"
-	"github.com/milvus-io/milvus/client/v2/entity"
-	"github.com/milvus-io/milvus/pkg/util/merr"
 	"github.com/samber/lo"
 	"github.com/stretchr/testify/mock"
 	"github.com/stretchr/testify/suite"
+
+	"github.com/milvus-io/milvus-proto/go-api/v2/milvuspb"
+	"github.com/milvus-io/milvus/client/v2/entity"
+	"github.com/milvus-io/milvus/pkg/util/merr"
 )
 
 type WriteSuite struct {

internal/datacoord/compaction_task_clustering_test.go

@@ -19,6 +19,7 @@ package datacoord
 import (
 	"context"
 	"fmt"
+
 	"github.com/milvus-io/milvus-proto/go-api/v2/commonpb"
 	"github.com/milvus-io/milvus-proto/go-api/v2/schemapb"
 	"github.com/milvus-io/milvus/internal/metastore/kv/datacoord"

tests/go_client/.golangci.yml

@@ -0,0 +1,11 @@
+include:
+  - "../../.golangci.yml"
+
+linters-settings:
+  gocritic:
+  enabled-checks:
+    - ruleguard
+  settings:
+    ruleguard:
+      failOnError: true
+      rules: "ruleguard/rules.go"