ci: add code check (#138)

Author: Ambition9186

.github/workflows/lint.yml

@@ -0,0 +1,35 @@
+name: lint
+on: [push, pull_request]
+jobs:
+  bcs-bscp:
+    name: bcs-bscp
+    runs-on: ubuntu-latest
+    steps:
+      # 拉取代码
+      - name: checkout
+        uses: actions/checkout@v3
+
+      # 设置 Go 环境
+      - name: setup go
+        uses: actions/setup-go@v3
+        with:
+          go-version-file: go.mod
+      
+      # 检查 Go 模块依赖是否整理
+      - name: go mod tidy check
+        uses: katexochen/go-tidy-check@v2
+        with:
+          modules: .
+      
+      # 运行代码风格检查 (golangci-lint)
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v3
+        with:
+          version: v1.62.0
+          args: --timeout=30m
+          working-directory: .
+
+      # 编译项目
+      - name: build go project
+        run: |
+          make build_bscp && make build_frontend

.github/workflows/pr-lint.yml

@@ -0,0 +1,16 @@
+name: pr-lint
+on: [pull_request]
+jobs:
+  PR-format-check:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check PR naming convention
+        run: |
+          title="${{ github.event.pull_request.title }}"
+          pattern="^(feat|fix|docs|style|refactor|perf|test|chore|revert|build|ci): .*"
+          if [[ ! $title =~ $pattern ]]; then
+            echo "PR title does not match naming convention. Example: 'feat: 添加新功能'.\
+            You can refer to this address for details:\
+            https://github.com/TencentBlueKing/bk-bscp/tree/master/docs/specification/commit-spec.md"
+            exit 1
+          fi

.golangci.yml

@@ -1,9 +1,10 @@
 run:
   timeout: 10m
-  skip-dirs:
+issues:
+  exclude-dirs-use-default: true
+  exclude-dirs:
     - .*/third_party/*
-    - test/*
-  skip-files:
+  exclude-files:
     - .*\.docs\.go$
     - .*\.gen\.go$
     - .*\.pb\.go$
@@ -16,10 +17,9 @@ run:
     - test/benchmark/run/template.go
     - test/mock/repo/service/node.go
     - pkg/version/version.go
-issues:
   max-issues-per-linter: 0
   max-same-issues: 0
-  exclude-use-default: false
+  # exclude-use-default: false
 linters:
   disable-all: true
   enable:
@@ -45,6 +45,8 @@ linters:
     - unconvert
     - unparam
 linters-settings:
+  staticcheck:
+    checks: ["all", "-SA1006", "-SA1019"]
   errcheck:
     exclude-functions:
       - (*os.File).Close
@@ -53,6 +55,9 @@ linters-settings:
       - github.com/go-chi/render.Render
       - io.Copy
       - os.RemoveAll
+      - fmt.Fprint
+      - fmt.Fprintf
+      - fmt.Fprintln
   lll:
     line-length: 120
   funlen:
@@ -61,7 +66,10 @@ linters-settings:
   gocyclo:
     min-complexity: 30
   govet:
-    check-shadowing: true
+    enable:
+      - shadow
+    disable:
+      - printf
   goimports:
     local-prefixes: github.com/TencentBlueKing/bk-bscp
   gci:

cmd/api-server/service/middleware.go

@@ -21,8 +21,8 @@ import (
 
 	"github.com/TencentBlueKing/bk-bscp/pkg/kit"
 	"github.com/TencentBlueKing/bk-bscp/pkg/metrics"
-	"github.com/TencentBlueKing/bk-bscp/pkg/rest"
 	pbcs "github.com/TencentBlueKing/bk-bscp/pkg/protocol/config-server"
+	"github.com/TencentBlueKing/bk-bscp/pkg/rest"
 )
 
 // CheckDefaultTmplSpace create default template space if not existent

cmd/api-server/service/released_kv.go

@@ -26,15 +26,15 @@ import (
 	"github.com/xuri/excelize/v2"
 	"gopkg.in/yaml.v3"
 
-	"github.com/TencentBlueKing/bk-bscp/pkg/criteria/constant"
+	"github.com/TencentBlueKing/bk-bscp/internal/criteria/constant"
 	"github.com/TencentBlueKing/bk-bscp/pkg/dal/table"
 	"github.com/TencentBlueKing/bk-bscp/pkg/i18n"
 	"github.com/TencentBlueKing/bk-bscp/pkg/kit"
 	"github.com/TencentBlueKing/bk-bscp/pkg/logs"
-	"github.com/TencentBlueKing/bk-bscp/pkg/rest"
 	pbcs "github.com/TencentBlueKing/bk-bscp/pkg/protocol/config-server"
 	pbkv "github.com/TencentBlueKing/bk-bscp/pkg/protocol/core/kv"
 	pbrkv "github.com/TencentBlueKing/bk-bscp/pkg/protocol/core/released-kv"
+	"github.com/TencentBlueKing/bk-bscp/pkg/rest"
 )
 
 // Exporter The Exporter interface defines methods for exporting files.
@@ -164,11 +164,11 @@ func (m *kvService) Export(w http.ResponseWriter, r *http.Request) {
 	var exporter Exporter
 
 	switch format {
-	case "yaml":
+	case constant.YamlFormat:
 		exporter = &YAMLExporter{OutData: outData}
 		w.Header().Set("Content-Disposition", "attachment; filename=output.yaml")
 		w.Header().Set("Content-Type", "application/x-yaml")
-	case "json":
+	case constant.JsonFormat:
 		exporter = &JSONExporter{OutData: outData}
 		w.Header().Set("Content-Type", "application/json")
 		w.Header().Set("Content-Disposition", "attachment; filename=output.json")

cmd/api-server/service/variable.go

@@ -24,6 +24,7 @@ import (
 	"github.com/go-chi/render"
 	"gopkg.in/yaml.v3"
 
+	"github.com/TencentBlueKing/bk-bscp/internal/criteria/constant"
 	"github.com/TencentBlueKing/bk-bscp/pkg/dal/table"
 	"github.com/TencentBlueKing/bk-bscp/pkg/kit"
 	"github.com/TencentBlueKing/bk-bscp/pkg/logs"
@@ -69,11 +70,11 @@ func (s *variableService) ExportGlobalVariables(w http.ResponseWriter, r *http.R
 
 	outData := variablesToOutData(vs)
 	switch format {
-	case "yaml":
+	case constant.YamlFormat:
 		exporter = &YAMLVariableExporter{OutData: outData}
 		w.Header().Set("Content-Disposition", fmt.Sprintf("attachment; filename=%d_global_variable.yaml", kt.BizID))
 		w.Header().Set("Content-Type", "application/x-yaml")
-	case "json":
+	case constant.JsonFormat:
 		exporter = &JSONVariableExporter{OutData: outData}
 		w.Header().Set("Content-Type", "application/json")
 		w.Header().Set("Content-Disposition", fmt.Sprintf("attachment; filename=%d_global_variable.json", kt.BizID))
@@ -124,12 +125,12 @@ func (s *variableService) ExportAppVariables(w http.ResponseWriter, r *http.Requ
 
 	outData := variablesToOutData(vars.Details)
 	switch format {
-	case "yaml":
+	case constant.YamlFormat:
 		exporter = &YAMLVariableExporter{OutData: outData}
 		w.Header().Set("Content-Disposition", fmt.Sprintf("attachment; filename=%d_%s_variable.yaml",
 			kt.BizID, app.Spec.Name))
 		w.Header().Set("Content-Type", "application/x-yaml")
-	case "json":
+	case constant.JsonFormat:
 		exporter = &JSONVariableExporter{OutData: outData}
 		w.Header().Set("Content-Type", "application/json")
 		w.Header().Set("Content-Disposition", fmt.Sprintf("attachment; filename=%d_%s_variable.json",
@@ -193,12 +194,12 @@ func (s *variableService) ExportReleasedAppVariables(w http.ResponseWriter, r *h
 
 	outData := variablesToOutData(vars.Details)
 	switch format {
-	case "yaml":
+	case constant.YamlFormat:
 		exporter = &YAMLVariableExporter{OutData: outData}
 		w.Header().Set("Content-Disposition", fmt.Sprintf("attachment; filename=%d_%s_%s_variable.yaml",
 			kt.BizID, app.Spec.Name, rel.Spec.Name))
 		w.Header().Set("Content-Type", "application/x-yaml")
-	case "json":
+	case constant.JsonFormat:
 		exporter = &JSONVariableExporter{OutData: outData}
 		w.Header().Set("Content-Type", "application/json")
 		w.Header().Set("Content-Disposition", fmt.Sprintf("attachment; filename=%d_%s_%s_variable.json",

cmd/cache-service/service/cache/client/released_kv.go

@@ -22,10 +22,10 @@ import (
 	"github.com/TencentBlueKing/bk-bscp/pkg/criteria/errf"
 	"github.com/TencentBlueKing/bk-bscp/pkg/kit"
 	"github.com/TencentBlueKing/bk-bscp/pkg/logs"
+	pbds "github.com/TencentBlueKing/bk-bscp/pkg/protocol/data-service"
 	"github.com/TencentBlueKing/bk-bscp/pkg/runtime/jsoni"
 	"github.com/TencentBlueKing/bk-bscp/pkg/tools"
 	"github.com/TencentBlueKing/bk-bscp/pkg/types"
-	pbds "github.com/TencentBlueKing/bk-bscp/pkg/protocol/data-service"
 )
 
 // GetReleasedKv get released kv from cache.

cmd/cache-service/service/cache/event/update_last_consumed_time.go

@@ -63,8 +63,8 @@ func (cm *ClientMetric) getLastConsumedTimeList(kt *kit.Kit, key string, listLen
 			continue
 		}
 		appIDs := parseAndFilterJSON(list)
-		if err := cm.op.BatchUpdateLastConsumedTime(kt, appIDs); err != nil {
-			logs.Errorf("batch upsert client metrics failed, rid: %s, err: %s", kt.Rid, err.Error())
+		if errB := cm.op.BatchUpdateLastConsumedTime(kt, appIDs); errB != nil {
+			logs.Errorf("batch upsert client metrics failed, rid: %s, err: %s", kt.Rid, errB.Error())
 			continue
 		}
 

cmd/config-server/service/credential.go

@@ -20,10 +20,10 @@ import (
 	"github.com/TencentBlueKing/bk-bscp/pkg/iam/meta"
 	"github.com/TencentBlueKing/bk-bscp/pkg/kit"
 	"github.com/TencentBlueKing/bk-bscp/pkg/logs"
-	"github.com/TencentBlueKing/bk-bscp/pkg/tools"
 	pbcs "github.com/TencentBlueKing/bk-bscp/pkg/protocol/config-server"
 	pbcredential "github.com/TencentBlueKing/bk-bscp/pkg/protocol/core/credential"
 	pbds "github.com/TencentBlueKing/bk-bscp/pkg/protocol/data-service"
+	"github.com/TencentBlueKing/bk-bscp/pkg/tools"
 )
 
 // CreateCredentials create a credential

cmd/config-server/service/kv.go

@@ -28,6 +28,7 @@ import (
 	"golang.org/x/sync/errgroup"
 	"gopkg.in/yaml.v3"
 
+	cs "github.com/TencentBlueKing/bk-bscp/internal/criteria/constant"
 	"github.com/TencentBlueKing/bk-bscp/pkg/criteria/constant"
 	"github.com/TencentBlueKing/bk-bscp/pkg/criteria/errf"
 	"github.com/TencentBlueKing/bk-bscp/pkg/dal/table"
@@ -496,14 +497,14 @@ func (s *Service) ImportKvs(ctx context.Context, req *pbcs.ImportKvsReq) (*pbcs.
 	// format：text、json、yaml
 	var kvMap map[string]interface{}
 	switch req.Format {
-	case "json":
+	case cs.JsonFormat:
 		if !json.Valid([]byte(req.GetData())) {
 			return nil, errors.New(i18n.T(grpcKit, "not legal JSON data"))
 		}
 		if err := json.Unmarshal([]byte(req.GetData()), &kvMap); err != nil {
 			return nil, errors.New(i18n.T(grpcKit, "json format error, err: %v", err))
 		}
-	case "yaml":
+	case cs.YamlFormat:
 		if err := yaml.Unmarshal([]byte(req.GetData()), &kvMap); err != nil {
 			return nil, errors.New(i18n.T(grpcKit, "yaml format error, err: %v", err))
 		}