chore: enhance golangci-lint with code complexity and other measures (#…

…484)

Co-authored-by: odubajDT <93584209+odubajDT@users.noreply.github.com>
Closes #462

.github/workflows/CI.yaml

@@ -1,11 +1,9 @@
 name: CI
 on:
-  # always execute docker build when something is pushed to main or a maintenance branch
   push:
     branches:
       - 'main'
       - '[0-9]+.[1-9][0-9]*.x'
-  # in addition, execute for pull requests to those branches
   pull_request:
     branches:
       - 'main'
@@ -69,7 +67,6 @@ jobs:
             folder: "operator/"
           - name: "scheduler"
             folder: "scheduler/"
-            # Nothing to test in functions-runtime
     steps:
       - name: Check out code
         uses: actions/checkout@v3
@@ -90,7 +87,6 @@ jobs:
         with:
           flags: ${{ matrix.config.name }}
 
-
   build_image:
     name: Build Docker Image
     needs: prepare_ci_run
@@ -168,7 +164,6 @@ jobs:
     needs: prepare_ci_run
     uses: ./.github/workflows/component-test.yml
 
-
   integration_tests:
     name: Integration Tests
     needs: [ prepare_ci_run, build_image ]

.github/workflows/golangci-lint.yml

@@ -1,5 +1,13 @@
 name: golangci-lint
-on: pull_request
+on:
+  push:
+    branches:
+      - 'main'
+      - '[0-9]+.[1-9][0-9]*.x'
+  pull_request:
+    branches:
+      - 'main'
+      - '[0-9]+.[1-9][0-9]*.x'
 env:
   GOLANGCI_LINT_VERSION: "v1.50.1"
   GO_VERSION: "1.19"
@@ -25,6 +33,7 @@ jobs:
 
       - name: golangci-lint
         uses: golangci/golangci-lint-action@v3
+        continue-on-error: true
         with:
           working-directory: ${{ matrix.config.folder }}
           version: ${{ env.GOLANGCI_LINT_VERSION }}

.golangci.yml

@@ -1,6 +1,7 @@
 run:
   timeout: 5m
   go: '1.19'
+  issue-exit-code: 0
 linters:
   enable:
     - gofmt         # Gofmt checks whether code was gofmt-ed. By default this tool runs with -s option to check for code simplification
@@ -10,6 +11,10 @@ linters:
     - dogsled       # Checks assignments with too many blank identifiers (e.g. x, , , _, := f())
     - nilnil        # Checks that there is no simultaneous return of nil error and an invalid value.
     - noctx         # noctx finds sending http request without context.Context
+    - gocyclo       # measure cyclomatic complexity
+    - gocognit      # measure cognitive complexity
+    - funlen        # limit function length
+    - dupl          # Detect code duplication
 
 issues:
   exclude-rules:
@@ -18,4 +23,16 @@ issues:
       text: '//+kubebuilder'
     - linters:
         - containedctx
+        - gocyclo
+        - gocognit
+        - funlen
       path: _test\.go
+
+linters-settings:
+  gocyclo:
+    min-complexity: 10
+  gocognit:
+    min-complexity: 20
+  funlen:
+    lines: 120
+    statements: 120

operator/Makefile

@@ -83,11 +83,15 @@ vet: ## Run go vet against code.
 
 .PHONY: test
 test: manifests fmt vet generate envtest ## Run tests.
-	go test ./api/... -v
-	go test ./controllers/... -v  -coverprofile cover-pkg.out
-	go test ./webhooks/... -v  -coverprofile cover-main.out
-	cat cover-main.out cover-pkg.out > cover.out
-	rm cover-pkg.out cover-main.out
+	go test ./api/... -v -coverprofile cover-api.out
+	go test ./controllers/... -v -coverprofile cover-pkg.out
+	go test ./webhooks/... -v -coverprofile cover-main.out
+	sed -i '/mode: set/d' cover-api.out
+	sed -i '/mode: set/d' cover-pkg.out
+	sed -i '/mode: set/d' cover-main.out
+	echo "mode: set" > cover.out
+	cat cover-main.out cover-pkg.out cover-api.out >> cover.out
+	rm cover-pkg.out cover-main.out cover-api.out
 
 .PHONY: component-test
 component-test: manifests generate envtest ## Run tests.

scheduler/Makefile

@@ -86,7 +86,10 @@ test: manifests fmt vet envtest## Run tests.
 	go test ./pkg/... -coverprofile cover-pkg.out
 	go test ./cmd/scheduler -coverprofile cover-main.out
 	go test ./test/... -v -ginkgo.skip-file="e2e"
-	cat cover-main.out cover-pkg.out > cover.out
+	sed -i '/mode: set/d' cover-pkg.out
+	sed -i '/mode: set/d' cover-main.out
+	echo "mode: set" > cover.out
+	cat cover-main.out cover-pkg.out >> cover.out
 	rm cover-pkg.out cover-main.out