chore: update workflow

.github/workflows/main.yml

@@ -1,7 +1,6 @@
 name: Test & Build
 
 on:
-  workflow_call:
   push:
     branches:
     - main
@@ -17,12 +16,15 @@ jobs:
     - uses: actions/checkout@v3
     - uses: actions/setup-go@v3
       with:
-        go-version: 1.19
-    - uses: golangci/golangci-lint-action@v3
-      with:
-        version: latest
-        args: --timeout=5m
-        # skip cache because of flaky behaviors
-        skip-build-cache: true
-        skip-pkg-cache: true
+        go-version: stable
     - run: make test
+
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-go@v3
+        with:
+          go-version-file: ./go.mod
+          check-latest: true
+      - run: make lint

.golangci.yml

@@ -0,0 +1,211 @@
+run:
+  deadline: 6m
+
+  skip-files:
+  - "zz_generated\\..+\\.go$"
+
+  skip-dirs:
+    - vendor$
+
+output:
+  # colored-line-number|line-number|json|tab|checkstyle|code-climate, default is "colored-line-number"
+  format: colored-line-number
+
+linters-settings:
+  errcheck:
+    # report about not checking of errors in type assetions: `a := b.(MyStruct)`;
+    # default is false: such cases aren't reported by default.
+    check-type-assertions: false
+
+    # report about assignment of errors to blank identifier: `num, _ := strconv.Atoi(numStr)`;
+    # default is false: such cases aren't reported by default.
+    check-blank: false
+
+    # [deprecated] comma-separated list of pairs of the form pkg:regex
+    # the regex is used to ignore names within pkg. (default "fmt:.*").
+    # see https://github.com/kisielk/errcheck#the-deprecated-method for details
+    ignore: fmt:.*,io/ioutil:^Read.*
+
+  govet:
+    # report about shadowed variables
+    check-shadowing: false
+
+  golint:
+    # minimal confidence for issues, default is 0.8
+    min-confidence: 0.8
+
+  gofmt:
+    # simplify code: gofmt with `-s` option, true by default
+    simplify: true
+
+  goimports:
+    # put imports beginning with prefix after 3rd-party packages;
+    # it's a comma-separated list of prefixes
+    local-prefixes: github.com/crossplane/provider-template
+
+  gocyclo:
+    # minimal code complexity to report, 30 by default (but we recommend 10-20)
+    min-complexity: 10
+
+  maligned:
+    # print struct with more effective memory layout or not, false by default
+    suggest-new: true
+
+  dupl:
+    # tokens count to trigger issue, 150 by default
+    threshold: 100
+
+  goconst:
+    # minimal length of string constant, 3 by default
+    min-len: 3
+    # minimal occurrences count to trigger, 3 by default
+    min-occurrences: 5
+
+  lll:
+    # tab width in spaces. Default to 1.
+    tab-width: 1
+
+  unused:
+    # treat code as a program (not a library) and report unused exported identifiers; default is false.
+    # XXX: if you enable this setting, unused will report a lot of false-positives in text editors:
+    # if it's called for subdir of a project it can't find funcs usages. All text editor integrations
+    # with golangci-lint call it on a directory with the changed file.
+    check-exported: false
+
+  unparam:
+    # Inspect exported functions, default is false. Set to true if no external program/library imports your code.
+    # XXX: if you enable this setting, unparam will report a lot of false-positives in text editors:
+    # if it's called for subdir of a project it can't find external interfaces. All text editor integrations
+    # with golangci-lint call it on a directory with the changed file.
+    check-exported: false
+
+  nakedret:
+    # make an issue if func has more lines of code than this setting and it has naked returns; default is 30
+    max-func-lines: 30
+
+  prealloc:
+    # XXX: we don't recommend using this linter before doing performance profiling.
+    # For most programs usage of prealloc will be a premature optimization.
+
+    # Report preallocation suggestions only on simple loops that have no returns/breaks/continues/gotos in them.
+    # True by default.
+    simple: true
+    range-loops: true # Report preallocation suggestions on range loops, true by default
+    for-loops: false # Report preallocation suggestions on for loops, false by default
+
+  gocritic:
+    # Enable multiple checks by tags, run `GL_DEBUG=gocritic golangci-lint` run to see all tags and checks.
+    # Empty list by default. See https://github.com/go-critic/go-critic#usage -> section "Tags".
+    enabled-tags:
+      - performance
+
+    settings: # settings passed to gocritic
+      captLocal: # must be valid enabled check name
+        paramsOnly: true
+      rangeValCopy:
+        sizeThreshold: 32
+
+  revive:
+    severity: warning
+    confidence: 0.8
+
+
+linters:
+  enable:
+    - megacheck
+    - govet
+    - gocyclo
+    - gocritic
+    - goconst
+    - goimports
+    - gofmt  # We enable this as well as goimports for its simplify mode.
+    - prealloc
+    - revive
+    - unconvert
+    - misspell
+    - nakedret
+    - exportloopref
+    - gosec
+
+  disable:
+    - scopelint
+    - errcheck
+
+  presets:
+    - bugs
+    - unused
+  fast: false
+
+
+issues:
+  exclude:
+    - "G103: Use of unsafe calls should be audited"
+
+  # Excluding configuration per-path and per-linter
+  exclude-rules:
+    # Exclude some linters from running on tests files.
+    - path: _test(ing)?\.go
+      linters:
+        - gocyclo
+        - errcheck
+        - dupl
+        - gosec
+        - unparam
+        - deadcode
+
+    # Ease some gocritic warnings on test files.
+    - path: _test\.go
+      text: "(unnamedResult|exitAfterDefer)"
+      linters:
+        - gocritic
+
+    # These are performance optimisations rather than style issues per se.
+    # They warn when function arguments or range values copy a lot of memory
+    # rather than using a pointer.
+    - text: "(hugeParam|rangeValCopy):"
+      linters:
+      - gocritic
+
+    # This "TestMain should call os.Exit to set exit code" warning is not clever
+    # enough to notice that we call a helper method that calls os.Exit.
+    - text: "SA3000:"
+      linters:
+      - staticcheck
+
+    - text: "k8s.io/api/core/v1"
+      linters:
+      - goimports
+
+    # This is a "potential hardcoded credentials" warning. It's triggered by
+    # any variable with 'secret' in the same, and thus hits a lot of false
+    # positives in Kubernetes land where a Secret is an object type.
+    - text: "G101:"
+      linters:
+      - gosec
+      - gas
+
+    # This is an 'errors unhandled' warning that duplicates errcheck.
+    - text: "G104:"
+      linters:
+      - gosec
+      - gas
+
+  # Independently from option `exclude` we use default exclude patterns,
+  # it can be disabled by this option. To list all
+  # excluded by default patterns execute `golangci-lint run --help`.
+  # Default value for this option is true.
+  exclude-use-default: false
+
+  # Show only new issues: if there are unstaged changes or untracked files,
+  # only those changes are analyzed, else only changes in HEAD~ are analyzed.
+  # It's a super-useful option for integration of golangci-lint into existing
+  # large codebase. It's not practical to fix all existing issues at the moment
+  # of integration: much better don't allow issues in new code.
+  # Default is false.
+  new: false
+
+  # Maximum issues count per one linter. Set to 0 to disable. Default is 50.
+  max-per-linter: 0
+
+  # Maximum count of issues with the same text. Set to 0 to disable. Default is 3.
+  max-same-issues: 0

Makefile

@@ -10,11 +10,18 @@ IMAGE_TAG_BASE ?= ghcr.io/ionos-cloud/uptrends-operator/operator
 
 IMG ?= $(IMAGE_TAG_BASE):v$(VERSION)
 
+# GO related variables.
+GO ?= go
+GO_RUN_TOOLS ?= $(GO) run -modfile ./tools/go.mod
+GO_TEST = $(GO_RUN_TOOLS) gotest.tools/gotestsum --format pkgname
+GO_RELEASER ?= $(GO_RUN_TOOLS) github.com/goreleaser/goreleaser
+
 ##@ Development
 
+.PHONY: generate
 generate:
-	@go generate ./...
-	@go run cmd/manifest/manifest.go --file manifests/crd/bases/operators.ionos-cloud.github.io_uptrends.yaml \
+	$(GO) generate ./...
+	$(GO) run cmd/manifest/manifest.go --file manifests/crd/bases/operators.ionos-cloud.github.io_uptrends.yaml \
 		--file manifests/install/service_account.yaml \
 		--file manifests/install/cluster_role.yaml \
 		--file manifests/install/cluster_role_binding.yaml \
@@ -25,22 +32,19 @@ generate:
 
 .PHONY: fmt
 fmt: ## Run go fmt against code.
-	go run mvdan.cc/gofumpt -w .
+	$(GO_RUN_TOOLS) mvdan.cc/gofumpt -w .
 
 .PHONY: vet
 vet: ## Run go vet against code.
-	go vet ./...
+	$(GO) vet ./...
 
-.PHONY: build
-build:
-	@goreleaser build --rm-dist --snapshot
+.PHONY: lint
+lint: ## Run lint.
+	$(GO_RUN_TOOLS) github.com/golangci/golangci-lint/cmd/golangci-lint run --timeout 5m -c .golangci.yml
 
-.PHONY: vendor
-vendor: export GOPRIVATE=github.com/ionos-cloud
-vendor:
-	@go mod tidy
-	@go mod vendor
-	@go get -u ./...
+.PHONY: build
+build: ## Build manager binary.
+	$(GO_RELEASER) build --rm-dist --snapshot
 
 ##@ Deployment
 
@@ -66,5 +70,6 @@ $(ENVTEST): $(LOCALBIN)
 	test -s $(LOCALBIN)/setup-envtest || GOBIN=$(LOCALBIN) go install sigs.k8s.io/controller-runtime/tools/setup-envtest@latest
 
 .PHONY: test
-test: envtest
-	KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(LOCALBIN) -p path)" go test ./... -coverprofile cover.out
+test: envtest ## Run tests.
+	mkdir -p .test/reports
+	KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(LOCALBIN) -p path)" $(GO_TEST) --junitfile .test/reports/unit-test.xml -- -race ./... -count=1 -short -cover -coverprofile .test/reports/unit-test-coverage.out

pkg/controller/ingress_controller.go

@@ -40,7 +40,8 @@ type ingressReconciler struct {
 	scheme *runtime.Scheme
 }
 
-// Reconcile ...
+// Reconcile is part of the main kubernetes reconciliation loop which aims to
+// move the current state of the cluster closer to the desired state.
 func (c *ingressReconciler) Reconcile(ctx context.Context, r reconcile.Request) (reconcile.Result, error) {
 	log := ctrl.LoggerFrom(ctx)
 	log.Info("reconcile ingress", "name", r.Name, "namespace", r.Namespace)
@@ -77,6 +78,7 @@ func (c *ingressReconciler) Reconcile(ctx context.Context, r reconcile.Request)
 	return reconcile.Result{}, nil
 }
 
+//nolint:gocyclo
 func (c *ingressReconciler) reconcileResources(ctx context.Context, in *networkingv1.Ingress) error {
 	existingMonitors := &v1alpha1.UptrendsList{}
 	err := c.List(ctx, existingMonitors, client.InNamespace(in.Namespace))
@@ -212,6 +214,7 @@ func (c *ingressReconciler) reconcileResources(ctx context.Context, in *networki
 	return nil
 }
 
+//nolint:gocyclo
 func (c *ingressReconciler) reconcileDelete(ctx context.Context, in *networkingv1.Ingress) (reconcile.Result, error) {
 	items := make(map[string]string)
 

pkg/controller/monitor_controller.go

@@ -21,7 +21,7 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/source"
 )
 
-// NewMonitorController ...
+// NewMonitorController is returning a new controller for the Uptrends resource
 func NewMonitorController(mgr manager.Manager, creds *credentials.API) error {
 	return ctrl.NewControllerManagedBy(mgr).
 		For(&v1alpha1.Uptrends{}).
@@ -39,7 +39,8 @@ type monitorReconcile struct {
 	scheme *runtime.Scheme
 }
 
-// Reconcile ...
+// Reconcile is the main function of the controller
+// It is called when a Uptrends resource is created, updated or deleted.
 func (m *monitorReconcile) Reconcile(ctx context.Context, r reconcile.Request) (reconcile.Result, error) {
 	log := ctrl.LoggerFrom(ctx)
 	log.Info("reconcile monitor", "name", r.Name, "namespace", r.Namespace)
@@ -132,6 +133,7 @@ func (m *monitorReconcile) reconcileStatus(ctx context.Context, uptrends *v1alph
 	return nil
 }
 
+//nolint:gocyclo
 func (m *monitorReconcile) reconcileUpdate(ctx context.Context, mon *v1alpha1.Uptrends) error {
 	auth := context.WithValue(ctx, sw.ContextBasicAuth, sw.BasicAuth{
 		UserName: m.creds.Username,