feat: applying lint and fixing the lint issues (#94)

open-component-model · Nov 29, 2023 · 1b808db · 1b808db
1 parent 9e1210c
commit 1b808db
Show file tree

Hide file tree

Showing 32 changed files with 802 additions and 450 deletions.
diff --git a/.github/workflows/tests.yaml b/.github/workflows/tests.yaml
@@ -1,4 +1,4 @@
-name: tests
+name: tests and lint
 
 on:
   pull_request:
@@ -32,5 +32,7 @@ jobs:
           key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
           restore-keys: |
             ${{ runner.os }}-go-
+      - name: Run lint
+        run: make lint
       - name: Run tests
         run: make test
diff --git a/.golangci.yaml b/.golangci.yaml
@@ -0,0 +1,121 @@
+run:
+  go: "1.21"
+  timeout: 10m
+  tests: false
+  allow-parallel-runners: true
+  skip-dirs:
+    - "./*/mock"
+  skip-files:
+    - "pkg/ocm/fakes/ocm.go"
+
+linters-settings:
+  funlen:
+    lines: 150
+    statements: 70
+  staticcheck:
+    go: "1.21"
+  stylecheck:
+    go: "1.21"
+  cyclop:
+    max-complexity: 20
+    skip-tests: true
+  gosec:
+    exclude-generated: true
+  lll:
+    line-length: 150
+  misspell:
+    locale: US
+  govet:
+    check-shadowing: true
+  nilaway:
+  nolintlint:
+    allow-unused: false
+    require-explanation: true
+    require-specific: false
+  varnamelen:
+    ignore-names:
+      - err
+      - wg
+      - fs
+      - id
+      - vm
+      - ns
+      - ip
+
+issues:
+  max-same-issues: 0
+  max-issues-per-linter: 0
+  exclude-rules:
+    - text: "should not use dot imports|don't use an underscore in package name"
+      linters:
+        - golint
+    - source: "https://"
+      linters:
+        - lll
+    - path: pkg/defaults/
+      linters:
+        - lll
+    - path: _test\.go
+      linters:
+        - goerr113
+        - gocyclo
+        - errcheck
+        - gosec
+        - dupl
+        - funlen
+        - scopelint
+        - testpackage
+        - goconst
+        - godox
+    - path: internal/version/
+      linters:
+        - gochecknoglobals
+    - path: internal/command/
+      linters:
+        - exhaustivestruct
+        - lll
+        - wrapcheck
+    - source: "// .* #\\d+"
+      linters:
+        - godox
+    - path: test/e2e/
+      linters:
+        - goerr113
+        - gomnd
+    # remove this once https://github.com/golangci/golangci-lint/issues/2649 is closed
+    - path: /
+      linters:
+        - typecheck
+
+linters:
+  enable-all: true
+  disable:
+    - gci
+    - depguard
+    - exhaustivestruct
+    - golint
+    - interfacer
+    - ireturn
+    - maligned
+    - nilnil
+    - scopelint
+    - tagliatelle
+    - gomoddirectives
+    - varcheck
+    - nosnakecase
+    - structcheck
+    - ifshort
+    - deadcode
+    - forbidigo
+    - prealloc
+    - gochecknoinits
+    - exhaustruct
+    - goerr113
+    - govet
+    - nonamedreturns
+    - varnamelen
+    - wrapcheck
+    - staticcheck
+    - gochecknoglobals
+    - paralleltest
+    - wsl
diff --git a/Makefile b/Makefile
@@ -57,6 +57,10 @@ fmt: ## Run go fmt against code.
 vet: ## Run go vet against code.
 	go vet ./...
 
+.PHONY: lint
+lint: golangci-lint ## Run golangci-lint.
+	$(GOLANGCI_LINT) run
+
 .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 ./... $(GO_TEST_ARGS) -coverprofile cover.out
@@ -133,10 +137,12 @@ $(LOCALBIN):
 KUSTOMIZE ?= $(LOCALBIN)/kustomize
 CONTROLLER_GEN ?= $(LOCALBIN)/controller-gen
 ENVTEST ?= $(LOCALBIN)/setup-envtest
+GOLANGCI_LINT ?= $(LOCALBIN)/golangci-lint
 
 ## Tool Versions
 KUSTOMIZE_VERSION ?= v3.8.7
 CONTROLLER_TOOLS_VERSION ?= v0.11.1
+GOLANGCI_LINT_VERSION ?= v1.55.2
 
 KUSTOMIZE_INSTALL_SCRIPT ?= "https://raw.githubusercontent.com/kubernetes-sigs/kustomize/master/hack/install_kustomize.sh"
 .PHONY: kustomize
@@ -158,3 +164,8 @@ $(CONTROLLER_GEN): $(LOCALBIN)
 envtest: $(ENVTEST) ## Download envtest-setup locally if necessary.
 $(ENVTEST): $(LOCALBIN)
 	test -s $(LOCALBIN)/setup-envtest || GOBIN=$(LOCALBIN) go install sigs.k8s.io/controller-runtime/tools/setup-envtest@latest
+
+.PHONY: golangci-lint
+golangci-lint: $(GOLANGCI_LINT)
+$(GOLANGCI_LINT): $(LOCALBIN)
+	curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s $(GOLANGCI_LINT_VERSION)
diff --git a/api/v1alpha1/condition_types.go b/api/v1alpha1/condition_types.go
@@ -50,7 +50,7 @@ const (
 	// CreateSnapshotFailedReason is used when we fail to create an ocm-controller.Snapshot object in the cluster.
 	CreateSnapshotFailedReason = "CreateSnapshotFailed"
 
-	// CommitTemplateEmptyReason is used when a the commit template is not set.
+	// CommitTemplateEmptyReason is used when a commit template is not set.
 	CommitTemplateEmptyReason = "CommitTemplateEmpty"
 
 	// CreateComponentVersionFailedReason is used when we fail to create an ocm-controller.ComponentVersion object in the cluster.

diff --git a/api/v1alpha1/constants.go b/api/v1alpha1/constants.go
@@ -0,0 +1,10 @@
+package v1alpha1
+
+const (
+	// LevelDebug defines the debug level logs.
+	LevelDebug = 4
+)
+
+const (
+	WritePermissions = 0o777
+)
diff --git a/api/v1alpha1/groupversion_info.go b/api/v1alpha1/groupversion_info.go
@@ -13,10 +13,10 @@ import (
 )
 
 var (
-	// GroupVersion is group version used to register these objects
+	// GroupVersion is group version used to register these objects.
 	GroupVersion = schema.GroupVersion{Group: "mpas.ocm.software", Version: "v1alpha1"}
 
-	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
+	// SchemeBuilder is used to add go types to the GroupVersionKind scheme.
 	SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}
 
 	// AddToScheme adds the types in this group-version to the given scheme.

diff --git a/api/v1alpha1/productdeployment_types.go b/api/v1alpha1/productdeployment_types.go
@@ -113,7 +113,7 @@ func (in *ProductDeployment) SetObservedGeneration(v int64) {
 //+kubebuilder:object:root=true
 //+kubebuilder:subresource:status
 
-// ProductDeployment is the Schema for the productdeployments API
+// ProductDeployment is the Schema for the productdeployments API.
 type ProductDeployment struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`
@@ -124,7 +124,7 @@ type ProductDeployment struct {
 
 //+kubebuilder:object:root=true
 
-// ProductDeploymentList contains a list of ProductDeployment
+// ProductDeploymentList contains a list of ProductDeployment.
 type ProductDeploymentList struct {
 	metav1.TypeMeta `json:",inline"`
 	metav1.ListMeta `json:"metadata,omitempty"`

diff --git a/api/v1alpha1/productdeploymentgenerator_types.go b/api/v1alpha1/productdeploymentgenerator_types.go
@@ -11,7 +11,7 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
-// ProductDeploymentGeneratorSpec defines the desired state of ProductDeploymentGenerator
+// ProductDeploymentGeneratorSpec defines the desired state of ProductDeploymentGenerator.
 type ProductDeploymentGeneratorSpec struct {
 	// Interval is the reconciliation interval, i.e. at what interval shall a reconciliation happen.
 	// This is used to requeue objects for reconciliation in case the related subscription hasn't been finished yet.
@@ -31,7 +31,7 @@ type ProductDeploymentGeneratorSpec struct {
 	ServiceAccountName string `json:"serviceAccountName"`
 }
 
-// ProductDeploymentGeneratorStatus defines the observed state of ProductDeploymentGenerator
+// ProductDeploymentGeneratorStatus defines the observed state of ProductDeploymentGenerator.
 type ProductDeploymentGeneratorStatus struct {
 	// ObservedGeneration is the last reconciled generation.
 	// +optional
@@ -53,12 +53,12 @@ type ProductDeploymentGeneratorStatus struct {
 	LastReconciledVersion string `json:"lastReconciledVersion,omitempty"`
 }
 
-// GetSnapshotDigest returns the latest snapshot digest for the localization
+// GetSnapshotDigest returns the latest snapshot digest for the localization.
 func (in ProductDeploymentGenerator) GetSnapshotDigest() string {
 	return in.Status.LatestSnapshotDigest
 }
 
-// GetSnapshotName returns the key for the snapshot produced by the Localization
+// GetSnapshotName returns the key for the snapshot produced by the Localization.
 func (in ProductDeploymentGenerator) GetSnapshotName() string {
 	return in.Status.SnapshotName
 }
@@ -93,7 +93,7 @@ func (in *ProductDeploymentGenerator) SetObservedGeneration(v int64) {
 //+kubebuilder:object:root=true
 //+kubebuilder:subresource:status
 
-// ProductDeploymentGenerator is the Schema for the productdeploymentgenerators API
+// ProductDeploymentGenerator is the Schema for the productdeploymentgenerators API.
 type ProductDeploymentGenerator struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`
@@ -104,7 +104,7 @@ type ProductDeploymentGenerator struct {
 
 //+kubebuilder:object:root=true
 
-// ProductDeploymentGeneratorList contains a list of ProductDeploymentGenerator
+// ProductDeploymentGeneratorList contains a list of ProductDeploymentGenerator.
 type ProductDeploymentGeneratorList struct {
 	metav1.TypeMeta `json:",inline"`
 	metav1.ListMeta `json:"metadata,omitempty"`

diff --git a/api/v1alpha1/productdeploymentpipeline_types.go b/api/v1alpha1/productdeploymentpipeline_types.go
@@ -9,7 +9,7 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
-// ProductDeploymentPipelineSpec defines the desired state of ProductDeploymentPipeline
+// ProductDeploymentPipelineSpec defines the desired state of ProductDeploymentPipeline.
 type ProductDeploymentPipelineSpec struct {
 	// ComponentVersionRef is the name of the generated component version object.
 	// +required
@@ -29,7 +29,7 @@ type ProductDeploymentPipelineSpec struct {
 	TargetRef meta.NamespacedObjectReference `json:"targetRef"`
 }
 
-// ProductDeploymentPipelineStatus defines the observed state of ProductDeploymentPipeline
+// ProductDeploymentPipelineStatus defines the observed state of ProductDeploymentPipeline.
 type ProductDeploymentPipelineStatus struct {
 	// ObservedGeneration is the last reconciled generation.
 	// +optional
@@ -84,13 +84,14 @@ func (in *ProductDeploymentPipeline) Equals(spec ProductDeploymentPipelineSpec)
 	case in.Spec.ConfigMapRef != spec.ConfigMapRef:
 		return false
 	}
+
 	return true
 }
 
 //+kubebuilder:object:root=true
 //+kubebuilder:subresource:status
 
-// ProductDeploymentPipeline is the Schema for the productdeploymentpipelines API
+// ProductDeploymentPipeline is the Schema for the productdeploymentpipelines API.
 type ProductDeploymentPipeline struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`
@@ -101,7 +102,7 @@ type ProductDeploymentPipeline struct {
 
 //+kubebuilder:object:root=true
 
-// ProductDeploymentPipelineList contains a list of ProductDeploymentPipeline
+// ProductDeploymentPipelineList contains a list of ProductDeploymentPipeline.
 type ProductDeploymentPipelineList struct {
 	metav1.TypeMeta `json:",inline"`
 	metav1.ListMeta `json:"metadata,omitempty"`

diff --git a/api/v1alpha1/productdescription_types.go b/api/v1alpha1/productdescription_types.go
@@ -8,7 +8,7 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
-// ProductDescriptionSpec defines the desired state of ProductDescription
+// ProductDescriptionSpec defines the desired state of ProductDescription.
 type ProductDescriptionSpec struct {
 	// +required
 	Description string `json:"description"`
@@ -19,7 +19,7 @@ type ProductDescriptionSpec struct {
 	TargetRoles []TargetRoles `json:"targetRoles,omitempty"`
 }
 
-// ProductDescriptionStatus defines the observed state of ProductDescription
+// ProductDescriptionStatus defines the observed state of ProductDescription.
 type ProductDescriptionStatus struct{}
 
 // TargetRoles defines a target role with a name.
@@ -54,7 +54,7 @@ type DescriptionConfiguration struct {
 //+kubebuilder:object:root=true
 //+kubebuilder:subresource:status
 
-// ProductDescription is the Schema for the productdescriptions API
+// ProductDescription is the Schema for the productdescriptions API.
 type ProductDescription struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`
@@ -65,7 +65,7 @@ type ProductDescription struct {
 
 //+kubebuilder:object:root=true
 
-// ProductDescriptionList contains a list of ProductDescription
+// ProductDescriptionList contains a list of ProductDescription.
 type ProductDescriptionList struct {
 	metav1.TypeMeta `json:",inline"`
 	metav1.ListMeta `json:"metadata,omitempty"`

diff --git a/api/v1alpha1/target_types.go b/api/v1alpha1/target_types.go
@@ -23,7 +23,7 @@ var (
 	OCIRepository TargetType = "ocirepository"
 )
 
-// TargetSpec defines the desired state of Target
+// TargetSpec defines the desired state of Target.
 type TargetSpec struct {
 	// +required
 	Type TargetType `json:"type"`
@@ -47,7 +47,7 @@ type TargetSpec struct {
 	SecretsSelector *metav1.LabelSelector `json:"selector,omitempty"`
 }
 
-// TargetStatus defines the observed state of Target
+// TargetStatus defines the observed state of Target.
 type TargetStatus struct {
 	// ObservedGeneration is the last reconciled generation.
 	// +optional
@@ -78,7 +78,7 @@ func (in Target) GetRequeueAfter() time.Duration {
 //+kubebuilder:object:root=true
 //+kubebuilder:subresource:status
 
-// Target is the Schema for the targets API
+// Target is the Schema for the targets API.
 type Target struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`
@@ -89,7 +89,7 @@ type Target struct {
 
 //+kubebuilder:object:root=true
 
-// TargetList contains a list of Target
+// TargetList contains a list of Target.
 type TargetList struct {
 	metav1.TypeMeta `json:",inline"`
 	metav1.ListMeta `json:"metadata,omitempty"`