enable linters in workflow (#8)

Made linting changes to pass linters check

Author: shirmoran

.checkmake

@@ -0,0 +1,2 @@
+[maxbodylength]
+disabled = true

.github/workflows/pre-main.yaml

@@ -6,6 +6,9 @@ on:
   pull_request:
     branches: [ main ]
   workflow_dispatch:
+env:
+  CM_BIN: /usr/local/bin/checkmake
+  CM_URL_LINUX: https://github.com/mrtazz/checkmake/releases/download/0.2.2/checkmake-0.2.2.linux.amd64 # yamllint disable-line
 
 jobs:
   lint:
@@ -56,8 +59,8 @@ jobs:
           dockerfile: Dockerfile
           recursive: true
 
-      - name: Shfmt
-        run: shfmt -d *.sh script
+      # - name: Shfmt
+      #   run: shfmt -d *.sh script
 
       - name: Markdownlint
         uses: nosborn/github-action-markdown-cli@v3.3.0

.golangci.yml

@@ -0,0 +1,128 @@
+linters-settings:
+  dupl:
+    threshold: 100
+  funlen:
+    lines: 60
+    statements: 45
+  gci:
+    local-prefixes: github.com/golangci/golangci-lint
+  goconst:
+    min-len: 4
+    min-occurrences: 2
+  gocritic:
+    enabled-tags:
+      - diagnostic
+      - experimental
+      - opinionated
+      - performance
+      - style
+    disabled-checks:
+      - whyNoLint
+  gocyclo:
+    min-complexity: 20
+  goimports:
+    local-prefixes: github.com/golangci/golangci-lint
+  gomnd:
+    settings:
+      mnd:
+        # do not include the "operation" and "assign"
+        checks: argument,case,condition,return
+  govet:
+    check-shadowing: true
+    settings:
+      printf:
+        funcs:
+          - (github.com/golangci/golangci-lint/pkg/logutils.Log).Infof
+          - (github.com/golangci/golangci-lint/pkg/logutils.Log).Warnf
+          - (github.com/golangci/golangci-lint/pkg/logutils.Log).Errorf
+          - (github.com/golangci/golangci-lint/pkg/logutils.Log).Fatalf
+  lll:
+    line-length: 250
+  maligned:
+    suggest-new: true
+  nolintlint:
+    allow-leading-space: false # disallow leading spaces. A space means the //nolint comment shows in `godoc` output.
+    allow-unused: false # report any unused nolint directives
+    require-explanation: false # do not require an explanation for nolint directives
+    require-specific: true # require nolint directives to be specific about which linter is being skipped
+  exhaustive:
+    default-signifies-exhaustive: true
+linters:
+  # please, do not use `enable-all`: it's deprecated and will be removed soon.
+  # inverted configuration with `enable-all` and `disable` is not scalable during updates of golangci-lint
+  disable-all: true
+  enable:
+    - bodyclose
+    - dogsled
+    - errcheck
+    - exhaustive
+    - exportloopref
+    - funlen
+    - goconst
+    - gocritic
+    - gocyclo
+    - gofmt
+    - goimports
+    - gomnd
+    - goprintffuncname
+    - gosec
+    - gosimple
+    - govet
+    - ineffassign
+    - lll
+    - misspell
+    - nolintlint
+    - revive
+    - rowserrcheck
+    - staticcheck
+    - stylecheck
+    - typecheck
+    - unconvert
+    - unparam
+    - unused
+    - whitespace
+  # do not enable:
+  # - asciicheck
+  # - depguard
+  # - dupl
+  # - gochecknoglobals
+  # - gochecknoinits
+  # - gocognit
+  # - godot
+  # - godox
+  # - goerr113
+  # - maligned
+  # - nakedret
+  # - nestif
+  # - noctx
+  # - prealloc
+  # - exportloopref
+  # - structcheck
+  # - testpackage
+  # - wsl
+issues:
+  # Excluding configuration per-path, per-linter, per-text and per-source
+  exclude-rules:
+    # Ignore magic numbers, inline strings and function length in tests.
+    - path: _test\.go
+      linters:
+        - gomnd
+        - goconst
+        - funlen
+    # Ignore line length for string assignments (do not try and wrap regex definitions)
+    - linters:
+        - lll
+      source: "^(.*= (\".*\"|`.*`))$"
+    # https://github.com/go-critic/go-critic/issues/926
+    - linters:
+        - gocritic
+      text: "unnecessaryDefer:"
+    # Ignore static strings in tests
+
+
+# golangci.com configuration
+# https://github.com/golangci/golangci/wiki/Configuration
+service:
+  golangci-lint-version: 1.55.x # use the fixed version to not introduce new linters unexpectedly
+  prepare:
+    - echo "here I can run custom commands, but no preparation needed for this repo"

.yamllint.yml

@@ -10,3 +10,5 @@ rules:
   empty-lines:
     level: warning
 no_warnings: true
+ignore:
+  - config

Makefile

@@ -4,6 +4,7 @@
 # - use the VERSION as arg of the bundle target (e.g make bundle VERSION=0.0.2)
 # - use environment variables to overwrite this value (e.g export VERSION=0.0.2)
 VERSION ?= 0.0.1
+BASH_SCRIPTS=$(shell find . -name "*.sh" -not -path "./.git/*")
 
 # CHANNELS define the bundle channels used in the bundle.
 # Add a new line here if you would like to change its default config. (E.g CHANNELS = "candidate,fast,stable")
@@ -63,7 +64,7 @@ endif
 SHELL = /usr/bin/env bash -o pipefail
 .SHELLFLAGS = -ec
 
-.PHONY: all
+.PHONY: all clean
 all: build
 
 ##@ General
@@ -101,6 +102,17 @@ fmt: ## Run go fmt against code.
 vet: ## Run go vet against code.
 	go vet ./...
 
+.PHONY: lint
+lint: # Runs configured linters
+	checkmake --config=.checkmake Makefile
+	golangci-lint run --timeout 10m0s
+	hadolint Dockerfile
+	# shfmt -d *.sh script
+	typos
+	markdownlint '**/*.md'
+	yamllint --no-warnings .
+	shellcheck --format=gcc ${BASH_SCRIPTS}
+
 .PHONY: test
 test: manifests generate fmt vet envtest ## Run tests.
 	KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(LOCALBIN) -p path)" go test ./... -coverprofile cover.out

README.md

@@ -1,77 +1,98 @@
 # tnf-op
+
 Red Hat's CNF Certification Suite Operator PoC
 
 ## Description
-Proof of Concept for a Kubernetes/Openshift Operator running the [CNF Certification Suite Container](https://github.com/test-network-function/cnf-certification-test).
+
+Proof of Concept for a Kubernetes/Openshift Operator running the
+[CNF Certification Suite Container](https://github.com/test-network-function/cnf-certification-test).
 
 ## Getting Started
-You’ll need a Kubernetes cluster to run against. You can use [KIND](https://sigs.k8s.io/kind) to get a local cluster for testing, or run against a remote cluster.
-**Note:** Your controller will automatically use the current context in your kubeconfig file (i.e. whatever cluster `kubectl cluster-info` shows).
+
+You’ll need a Kubernetes cluster to run against.
+You can use [KIND](https://sigs.k8s.io/kind) to get a local cluster for testing,
+or run against a remote cluster.
+**Note:** Your controller will automatically use the current context in your
+kubeconfig file (i.e. whatever cluster `kubectl cluster-info` shows).
 
 ### Running on the cluster
+
 1. Install Instances of Custom Resources:
 
-```sh
-kubectl apply -f config/samples/
-```
+    ```sh
+    kubectl apply -f config/samples/
+    ```
 
 2. Build and push your image to the location specified by `IMG`:
 
-```sh
-make docker-build docker-push IMG=<some-registry>/tnf-op:tag
-```
+    ```sh
+    make docker-build docker-push IMG=<some-registry>/tnf-op:tag
+    ```
 
 3. Deploy the controller to the cluster with the image specified by `IMG`:
 
-```sh
-make deploy IMG=<some-registry>/tnf-op:tag
-```
+    ```sh
+    make deploy IMG=<some-registry>/tnf-op:tag
+    ```
 
 ### Uninstall CRDs
+
 To delete the CRDs from the cluster:
 
 ```sh
 make uninstall
 ```
 
 ### Undeploy controller
+
 UnDeploy the controller from the cluster:
 
 ```sh
 make undeploy
 ```
 
 ## Contributing
-// TODO(user): Add detailed information on how you would like others to contribute to this project
+
+// TODO(user): Add detailed information on how you would
+like others to contribute to this project
 
 ### How it works
-This project aims to follow the Kubernetes [Operator pattern](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/).
 
-It uses [Controllers](https://kubernetes.io/docs/concepts/architecture/controller/),
-which provide a reconcile function responsible for synchronizing resources until the desired state is reached on the cluster.
+This project aims to follow the Kubernetes
+[Operator pattern](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/).
+
+It uses
+[Controllers](https://kubernetes.io/docs/concepts/architecture/controller/),
+which provide a reconcile function responsible for synchronizing resources until
+the desired state is reached on the cluster.
 
 ### Test It Out
+
 1. Install the CRDs into the cluster:
 
-```sh
-make install
-```
+    ```sh
+    make install
+    ```
 
-2. Run your controller (this will run in the foreground, so switch to a new terminal if you want to leave it running):
+2. Run your controller (this will run in the foreground,
+so switch to a new terminal if you want to leave it running):
 
-```sh
-make run
-```
+    ```sh
+    make run
+    ```
 
-**NOTE:** You can also run this in one step by running: `make install run`
+    **NOTE:** You can also run this in one step by running: `make install run`
 
 3. Sample CnfCertificationSuiteRun CR:
-```
-oc apply -f cert-run.yaml
-```
+
+    ```sh
+    oc apply -f cert-run.yaml
+    ```
 
 ### Modifying the API definitions
-If you are editing the API definitions, generate the manifests such as CRs or CRDs using:
+
+If you are editing the API definitions,
+generate the manifests such as CRs or CRDs using:
 
 ```sh
 make manifests
@@ -89,11 +110,12 @@ 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
+```plaintext
+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.
-

_typos.toml

@@ -0,0 +1,7 @@
+[default.extend-words]
+iif = "iif"
+ono = "ono"
+daa = "daa"
+
+[files]
+extend-exclude = ["depends-on.json", "go.mod"]

cnf-cert-sidecar/Dockerfile

@@ -1,4 +1,4 @@
-FROM registry.access.redhat.com/ubi8/ubi:latest AS build
+FROM registry.access.redhat.com/ubi8/ubi:8.9-1028 AS build
 
 # Install dependencies
 # hadolint ignore=DL3041
@@ -21,19 +21,21 @@ ENV \
 ENV GO_BIN_URL_x86_64=${GO_DL_URL}/${GO_BIN_TAR}
 RUN \
 	if [ "$(uname -m)" = x86_64 ]; then \
-		wget --directory-prefix=${TEMP_DIR} ${GO_BIN_URL_x86_64} --quiet \
+		wget --directory-prefix="${TEMP_DIR}" ${GO_BIN_URL_x86_64} --quiet \
 		&& rm -rf /usr/local/go \
-		&& tar -C /usr/local -xzf ${TEMP_DIR}/${GO_BIN_TAR}; \
+		&& tar -C /usr/local -xzf "${TEMP_DIR}/${GO_BIN_TAR}"; \
 	else \
 		echo "CPU architecture is not supported." && exit 1; \
 	fi
 ENV PATH=${PATH}:"/usr/local/go/bin":${GOPATH}/"bin"
 
 # Build app and copy into a empty ubi-minimal image.
+WORKDIR /
 COPY . .
 RUN ls -la && go build -o app cnf-cert-sidecar/app/main.go
 
-FROM registry.access.redhat.com/ubi8/ubi-minimal
+FROM registry.access.redhat.com/ubi8/ubi-minimal:8.9-1029
+WORKDIR /
 COPY --from=build app .
 
 ENV SHELL=/bin/bash

cnf-cert-sidecar/app/claim/claim.go

@@ -4,10 +4,6 @@ import (
 	corev1 "k8s.io/api/core/v1"
 )
 
-const (
-	supportedClaimFormatVersion = "v0.1.0"
-)
-
 const (
 	TestCaseResultPassed  = "passed"
 	TestCaseResultSkipped = "skipped"

cnf-cert-sidecar/app/cnf-cert-suite-report/cnfcertsuitereport.go

@@ -4,7 +4,6 @@ import (
 	"fmt"
 	"os"
 
-	"github.com/greyerof/cnf-certification-operator/api/v1alpha1"
 	cnfcertificationsv1alpha1 "github.com/greyerof/cnf-certification-operator/api/v1alpha1"
 	"github.com/greyerof/cnf-certification-operator/cnf-cert-sidecar/app/claim"
 	corev1 "k8s.io/api/core/v1"
@@ -14,7 +13,7 @@ import (
 const (
 	podNameEnvVar      = "MY_POD_NAME"
 	podNamespaceEnvVar = "MY_POD_NAMESPACE"
-	runCrNameEnvVar   = "RUN_CR_NAME"
+	runCrNameEnvVar    = "RUN_CR_NAME"
 )
 
 type Config struct {
@@ -31,10 +30,12 @@ func addNamespacesToCnfSpecField(cnf *cnfcertificationsv1alpha1.Cnf, namespaces
 }
 
 func addPodsToCnfSpecField(cnf *cnfcertificationsv1alpha1.Cnf, pods []corev1.Pod) {
-	for _, pod := range pods {
+	for podIdx := 0; podIdx < len(pods); podIdx++ {
+		pod := &pods[podIdx]
+		podsContainers := &pod.Spec.Containers
 		var containers []string
-		for _, container := range pod.Spec.Containers {
-			containers = append(containers, container.Name)
+		for containerIdx := 0; containerIdx < len(*podsContainers); containerIdx++ {
+			containers = append(containers, (*podsContainers)[containerIdx].Name)
 		}
 		cnf.Pods = append(cnf.Pods, cnfcertificationsv1alpha1.CnfPod{
 			Name:       pod.Name,
@@ -119,7 +120,8 @@ func UpdateStatus(cnfCertSuiteReport *cnfcertificationsv1alpha1.CnfCertification
 	testSuiteResults *claim.TestSuiteResults) {
 	results := []cnfcertificationsv1alpha1.TestCaseResult{}
 	totalTests, passedTests, skippedTests, failedTests, erroredTests := 0, 0, 0, 0, 0
-	for tcName, tcResult := range *testSuiteResults {
+	for tcName := range *testSuiteResults {
+		tcResult := (*testSuiteResults)[tcName]
 		reason := ""
 		switch tcResult.State {
 		case "passed":
@@ -130,7 +132,7 @@ func UpdateStatus(cnfCertSuiteReport *cnfcertificationsv1alpha1.CnfCertification
 		case "failed":
 			failedTests++
 			reason = tcResult.FailureReason
-		case "error":
+		case "error": //nolint:goconst
 			erroredTests++
 		}
 		totalTests++
@@ -142,7 +144,7 @@ func UpdateStatus(cnfCertSuiteReport *cnfcertificationsv1alpha1.CnfCertification
 		})
 	}
 	cnfCertSuiteReport.Status.Results = results
-	cnfCertSuiteReport.Status.Summary = v1alpha1.CnfCertificationSuiteReportStatusSummary{
+	cnfCertSuiteReport.Status.Summary = cnfcertificationsv1alpha1.CnfCertificationSuiteReportStatusSummary{
 		Total:   totalTests,
 		Passed:  passedTests,
 		Skipped: skippedTests,

cnf-cert-sidecar/app/main.go

@@ -19,46 +19,10 @@ import (
 const (
 	sideCarResultsFolderEnvVar = "TNF_RESULTS_FOLDER"
 	claimFileName              = "claim.json"
+	multiplier                 = 5
 )
 
-// This CNF Certification sidecar container expects to be running in the same
-// pod as the CNF Cert Suite container.
-//
-// The sidecar will wait for TNF_CNF_CERT_TIMEOUT secs until the claim.json output is present in a
-// shared volume folder. Then it will parse it to get the list of test cases
-// results, and creates the CR CnfCertificationSuiteReport
-func main() {
-	scheme := runtime.NewScheme()
-	err := clientgoscheme.AddToScheme(scheme)
-	if err != nil {
-		logrus.Fatalf("failed to add to scheme: %v", err)
-	}
-
-	err = cnfcertificationsv1alpha1.AddToScheme(scheme)
-	if err != nil {
-		logrus.Fatalf("failed to add cnfcertificationsv1alpha1 to scheme: %v", err)
-	}
-
-	// k8sRestConfig, err := rest.InClusterConfig()
-	kubeConfigFile := os.Getenv("HOME") + "/.kube/config"
-	_, err = os.Stat(kubeConfigFile)
-	if err != nil {
-		kubeConfigFile = ""
-	}
-
-	k8sRestConfig, err := clientcmd.BuildConfigFromFlags("", kubeConfigFile)
-	if err != nil {
-		logrus.Fatalf("Failed to get incluster rest config: %v", err)
-	}
-
-	DefaultTimeout := 10 * time.Second
-	k8sRestConfig.Timeout = DefaultTimeout
-
-	k8sClient, err := client.New(k8sRestConfig, client.Options{Scheme: scheme})
-	if err != nil {
-		logrus.Fatalf("Failed to get k8s client: %v", err)
-	}
-
+func handleClaimFile(k8sClient client.Client) {
 	claimFolder := os.Getenv(sideCarResultsFolderEnvVar)
 	logrus.Infof("Claim file folder: %v", claimFolder)
 
@@ -67,13 +31,13 @@ func main() {
 		_, err := os.Stat(claimFilePath)
 		if os.IsNotExist(err) {
 			logrus.Warnf("Claim file not found yet. Waiting 5 secs...")
-			time.Sleep(5 * time.Second)
+			time.Sleep(multiplier * time.Second)
 			continue
 		}
 
 		// Wait extra 5 secs to give time to the writer to finish.
 		// TODO: Use file locking mechanism between writer/reader of this file.
-		time.Sleep(5 * time.Second)
+		time.Sleep(multiplier * time.Second)
 
 		logrus.Infof("Claim file found at %v", claimFilePath)
 		claimBytes, err := os.ReadFile(claimFilePath)
@@ -105,3 +69,43 @@ func main() {
 		break
 	}
 }
+
+// This CNF Certification sidecar container expects to be running in the same
+// pod as the CNF Cert Suite container.
+//
+// The sidecar will wait for TNF_CNF_CERT_TIMEOUT secs until the claim.json output is present in a
+// shared volume folder. Then it will parse it to get the list of test cases
+// results, and creates the CR CnfCertificationSuiteReport
+func main() {
+	scheme := runtime.NewScheme()
+	err := clientgoscheme.AddToScheme(scheme)
+	if err != nil {
+		logrus.Fatalf("failed to add to scheme: %v", err)
+	}
+
+	err = cnfcertificationsv1alpha1.AddToScheme(scheme)
+	if err != nil {
+		logrus.Fatalf("failed to add cnfcertificationsv1alpha1 to scheme: %v", err)
+	}
+
+	kubeConfigFile := os.Getenv("HOME") + "/.kube/config"
+	_, err = os.Stat(kubeConfigFile)
+	if err != nil {
+		kubeConfigFile = ""
+	}
+
+	k8sRestConfig, err := clientcmd.BuildConfigFromFlags("", kubeConfigFile)
+	if err != nil {
+		logrus.Fatalf("Failed to get incluster rest config: %v", err)
+	}
+
+	DefaultTimeout := 10 * time.Second
+	k8sRestConfig.Timeout = DefaultTimeout
+
+	k8sClient, err := client.New(k8sRestConfig, client.Options{Scheme: scheme})
+	if err != nil {
+		logrus.Fatalf("Failed to get k8s client: %v", err)
+	}
+
+	handleClaimFile(k8sClient)
+}

controllers/cnf-cert-job/cnfcertjob.go

@@ -29,6 +29,7 @@ func NewConfig(podName, namespace, certSuiteConfigRunName, labelsFilter, logLeve
 	}
 }
 
+//nolint:funlen
 func New(config *Config) *corev1.Pod {
 	return &corev1.Pod{
 		TypeMeta: metav1.TypeMeta{},

controllers/cnfcertificationsuiterun_controller.go

@@ -54,9 +54,11 @@ var (
 	// certificationRuns maps a certificationRun to a pod name
 	certificationRuns map[certificationRun]string
 	// Holds an autoincremental CNF Cert Suite pod id
-	cnfRunPodId int
+	cnfRunPodID int
 )
 
+const multiplier = 5
+
 // +kubebuilder:rbac:groups="*",resources="*",verbs="*"
 // +kubebuilder:rbac:urls="*",verbs="*"
 
@@ -69,10 +71,13 @@ func ignoreUpdatePredicate() predicate.Predicate {
 	}
 }
 
-// Updates CnfCertificationSuiteRun.Status.Phase correspomding to a given status
+// Updates CnfCertificationSuiteRun.Status.Phase corresponding to a given status
 func (r *CnfCertificationSuiteRunReconciler) updateJobStatus(cnfrun *cnfcertificationsv1alpha1.CnfCertificationSuiteRun, status string) {
 	cnfrun.Status.Phase = status
-	r.Status().Update(context.Background(), cnfrun)
+	err := r.Status().Update(context.Background(), cnfrun)
+	if err != nil {
+		logrus.Errorf("Error found while updating CnfCertificationSuiteRun's status: %s", err)
+	}
 }
 
 func (r *CnfCertificationSuiteRunReconciler) waitForCnfCertJobPodToComplete(ctx context.Context, namespace string, cnfCertJobPod *corev1.Pod) {
@@ -91,7 +96,7 @@ func (r *CnfCertificationSuiteRunReconciler) waitForCnfCertJobPodToComplete(ctx
 			return
 		default:
 			logrus.Info("Cnf job pod is running. Current status: ", cnfCertJobPod.Status.Phase)
-			time.Sleep(5 * time.Second)
+			time.Sleep(multiplier * time.Second)
 		}
 		err := r.Get(ctx, cnfCertJobNamespacedName, cnfCertJobPod)
 		if err != nil {
@@ -101,7 +106,8 @@ func (r *CnfCertificationSuiteRunReconciler) waitForCnfCertJobPodToComplete(ctx
 }
 
 func (r *CnfCertificationSuiteRunReconciler) getCertSuiteContainerExitStatus(cnfCertJobPod *corev1.Pod) int32 {
-	for _, containerStatus := range cnfCertJobPod.Status.ContainerStatuses {
+	for i := range cnfCertJobPod.Status.ContainerStatuses {
+		containerStatus := &cnfCertJobPod.Status.ContainerStatuses[i]
 		if containerStatus.Name == definitions.CnfCertSuiteContainerName {
 			return containerStatus.State.Terminated.ExitCode
 		}
@@ -119,9 +125,8 @@ func (r *CnfCertificationSuiteRunReconciler) verifyCnfCertSuiteOutput(ctx contex
 		logrus.Info("CNF Cert job has finished running.")
 	} else {
 		r.updateJobStatus(cnfrun, "CertSuiteError")
-		logrus.Info("CNF Cert job encoutered an error. Exit status: ", certSuiteExitStatus)
+		logrus.Info("CNF Cert job encountered an error. Exit status: ", certSuiteExitStatus)
 	}
-
 }
 
 // Reconcile is part of the main kubernetes reconciliation loop which aims to
@@ -135,30 +140,22 @@ func (r *CnfCertificationSuiteRunReconciler) verifyCnfCertSuiteOutput(ctx contex
 // - https://pkg.go.dev/sigs.k8s.io/controller-runtime@v0.14.1/pkg/reconcile
 func (r *CnfCertificationSuiteRunReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
 	_ = log.FromContext(ctx)
-
 	logrus.Infof("Reconciling CnfCertificationSuiteRun CRD.")
 
-	reqCertificationRun := certificationRun{
-		name:      req.Name,
-		namespace: req.Namespace,
-	}
+	reqCertificationRun := certificationRun{name: req.Name, namespace: req.Namespace}
 
 	var cnfrun cnfcertificationsv1alpha1.CnfCertificationSuiteRun
-	if err := r.Get(ctx, req.NamespacedName, &cnfrun); err != nil {
+	if getErr := r.Get(ctx, req.NamespacedName, &cnfrun); getErr != nil {
 		logrus.Infof("CnfCertificationSuiteRun CR %s (ns %s) not found.", req.Name, req.NamespacedName)
-
 		if podName, exist := certificationRuns[reqCertificationRun]; exist {
 			logrus.Infof("CnfCertificationSuiteRun has been deleted. Removing the associated CNF Cert job pod %v", podName)
-
-			err := r.Delete(context.TODO(), &corev1.Pod{ObjectMeta: metav1.ObjectMeta{Name: podName, Namespace: req.Namespace}})
-			if err != nil {
-				logrus.Errorf("Failed to remove CNF Cert Job pod %s in namespace %s: %v", req.Name, req.Namespace, err)
+			deleteErr := r.Delete(context.TODO(), &corev1.Pod{ObjectMeta: metav1.ObjectMeta{Name: podName, Namespace: req.Namespace}})
+			if deleteErr != nil {
+				logrus.Errorf("Failed to remove CNF Cert Job pod %s in namespace %s: %v", req.Name, req.Namespace, deleteErr)
 			}
-
 			delete(certificationRuns, reqCertificationRun)
 		}
-
-		return ctrl.Result{}, client.IgnoreNotFound(err)
+		return ctrl.Result{}, client.IgnoreNotFound(getErr)
 	}
 
 	if podName, exist := certificationRuns[reqCertificationRun]; exist {
@@ -168,14 +165,14 @@ func (r *CnfCertificationSuiteRunReconciler) Reconcile(ctx context.Context, req
 
 	logrus.Infof("New CNF Certification Job run requested: %v", reqCertificationRun)
 
-	cnfRunPodId++
-	podName := fmt.Sprintf("%s-%d", definitions.CnfCertPodNamePrefix, cnfRunPodId)
+	cnfRunPodID++
+	podName := fmt.Sprintf("%s-%d", definitions.CnfCertPodNamePrefix, cnfRunPodID)
 
 	// Store the new run & associated CNF Cert pod name
 	certificationRuns[reqCertificationRun] = podName
 
 	logrus.Infof("Running CNF Certification Suite container (job id=%d) with labels %q, log level %q and timeout: %q",
-		cnfRunPodId, cnfrun.Spec.LabelsFilter, cnfrun.Spec.LogLevel, cnfrun.Spec.TimeOut)
+		cnfRunPodID, cnfrun.Spec.LabelsFilter, cnfrun.Spec.LogLevel, cnfrun.Spec.TimeOut)
 
 	// Launch the pod with the CNF Cert Suite container plus the sidecar container to fetch the results.
 	r.updateJobStatus(&cnfrun, "CreatingCertSuiteJob")
@@ -197,8 +194,7 @@ func (r *CnfCertificationSuiteRunReconciler) Reconcile(ctx context.Context, req
 		return ctrl.Result{}, nil
 	}
 	r.updateJobStatus(&cnfrun, "RunningCertSuite")
-	logrus.Info("Runnning CNF Cert job")
-
+	logrus.Info("Running CNF Cert job")
 	go r.verifyCnfCertSuiteOutput(ctx, req.NamespacedName.Namespace, cnfCertJobPod, &cnfrun)
 	return ctrl.Result{}, nil
 }

controllers/suite_test.go

@@ -20,8 +20,8 @@ import (
 	"path/filepath"
 	"testing"
 
-	. "github.com/onsi/ginkgo/v2"
-	. "github.com/onsi/gomega"
+	. "github.com/onsi/ginkgo/v2" //nolint:revive
+	. "github.com/onsi/gomega"    //nolint:revive
 
 	"k8s.io/client-go/kubernetes/scheme"
 	"k8s.io/client-go/rest"

go.mod

@@ -65,7 +65,7 @@ require (
 	k8s.io/klog/v2 v2.80.1 // indirect
 	k8s.io/kube-openapi v0.0.0-20221012153701-172d655c2280 // indirect
 	k8s.io/utils v0.0.0-20221128185143-99ec85e7a448 // indirect
-	sigs.k8s.io/json v0.0.0-20220713155537-f223a00ba0e2 // indirect
+	sigs.k8s.io/json v0.0.0-20220713155537-f223a00ba0e2 // indirect,nollint:typos
 	sigs.k8s.io/structured-merge-diff/v4 v4.2.3 // indirect
 	sigs.k8s.io/yaml v1.3.0 // indirect
 )

hack/deleteall.sh

@@ -1,6 +1,8 @@
+#!/bin/bash
+
 deleteAll() {
     res=$1
-    for name in `oc get $res -n cnf-certification-operator -o json | jq -r '.items[] | .metadata.name' | sort -r` ; do oc delete $res -n cnf-certification-operator $name ; done
+    for name in $(oc get "$res" -n cnf-certification-operator -o json | jq -r '.items[] | .metadata.name' | sort -r) ; do oc delete "$res" -n cnf-certification-operator "$name" ; done
 }
 
 deleteAll cnfcertificationsuiteruns

main.go

@@ -31,6 +31,7 @@ import (
 	ctrl "sigs.k8s.io/controller-runtime"
 	"sigs.k8s.io/controller-runtime/pkg/healthz"
 	"sigs.k8s.io/controller-runtime/pkg/log/zap"
+	"sigs.k8s.io/controller-runtime/pkg/manager"
 
 	cnfcertificationsv1alpha1 "github.com/greyerof/cnf-certification-operator/api/v1alpha1"
 	"github.com/greyerof/cnf-certification-operator/controllers"
@@ -63,18 +64,29 @@ func getWatchNamespace() (string, error) {
 	return ns, nil
 }
 
+func defineFlags(metricsAddr, probeAddr *string, enableLeaderElection *bool) {
+	flag.StringVar(metricsAddr, "metrics-bind-address", ":8080", "The address the metric endpoint binds to.")
+	flag.StringVar(probeAddr, "health-probe-bind-address", ":8081", "The address the probe endpoint binds to.")
+	flag.BoolVar(enableLeaderElection, "leader-elect", false, "Enable leader election for controller manager. "+
+		"Enabling this will ensure there is only one active controller manager.")
+}
+
+func setUpChecks(mgr manager.Manager) {
+	if err := mgr.AddHealthzCheck("healthz", healthz.Ping); err != nil {
+		setupLog.Error(err, "unable to set up health check")
+		os.Exit(1)
+	}
+	if err := mgr.AddReadyzCheck("readyz", healthz.Ping); err != nil {
+		setupLog.Error(err, "unable to set up ready check")
+		os.Exit(1)
+	}
+}
+
 func main() {
-	var metricsAddr string
+	var metricsAddr, probeAddr string
 	var enableLeaderElection bool
-	var probeAddr string
-	flag.StringVar(&metricsAddr, "metrics-bind-address", ":8080", "The address the metric endpoint binds to.")
-	flag.StringVar(&probeAddr, "health-probe-bind-address", ":8081", "The address the probe endpoint binds to.")
-	flag.BoolVar(&enableLeaderElection, "leader-elect", false,
-		"Enable leader election for controller manager. "+
-			"Enabling this will ensure there is only one active controller manager.")
-	opts := zap.Options{
-		Development: true,
-	}
+	defineFlags(&metricsAddr, &probeAddr, &enableLeaderElection)
+	opts := zap.Options{Development: true}
 	opts.BindFlags(flag.CommandLine)
 	flag.Parse()
 
@@ -85,7 +97,6 @@ func main() {
 		setupLog.Error(err, "unable to get WatchNamespace, "+
 			"the manager will watch and manage resources in all namespaces")
 	}
-
 	mgr, err := ctrl.NewManager(ctrl.GetConfigOrDie(), ctrl.Options{
 		Scheme:                 scheme,
 		MetricsBindAddress:     metricsAddr,
@@ -120,15 +131,7 @@ func main() {
 	}
 	//+kubebuilder:scaffold:builder
 
-	if err := mgr.AddHealthzCheck("healthz", healthz.Ping); err != nil {
-		setupLog.Error(err, "unable to set up health check")
-		os.Exit(1)
-	}
-	if err := mgr.AddReadyzCheck("readyz", healthz.Ping); err != nil {
-		setupLog.Error(err, "unable to set up ready check")
-		os.Exit(1)
-	}
-
+	setUpChecks(mgr)
 	setupLog.Info("starting manager")
 	if err := mgr.Start(ctrl.SetupSignalHandler()); err != nil {
 		setupLog.Error(err, "problem running manager")