Merge pull request #4 from webhookrelay/feature/lint

Feature/lint

Author: rusenask

Diff for: .drone.yml

@@ -23,6 +23,13 @@ steps:
   commands:
   - make build
 
+- name: lint-code
+  pull: default
+  image: golang
+  commands:
+  - make golangci-lint
+  - make lint
+
 - name: lint-charts
   pull: default
   image: quay.io/helmpack/chart-testing:v3.0.0-rc.1

Diff for: .golangci.yml

@@ -0,0 +1,143 @@
+linters-settings:
+  depguard:
+    list-type: blacklist
+    packages:
+      # logging is allowed only by logutils.Log, logrus
+      # is allowed to use only in logutils package
+      - github.com/sirupsen/logrus
+    packages-with-error-message:
+      - github.com/sirupsen/logrus: "logging is allowed only by logutils.Log"
+  dupl:
+    threshold: 300
+  exhaustive:
+    default-signifies-exhaustive: false
+  funlen:
+    lines: 100
+    statements: 50
+  goconst:
+    min-len: 2
+    min-occurrences: 2
+  gocritic:
+    enabled-tags:
+      - diagnostic
+      - experimental
+      - opinionated
+      - performance
+      - style
+    disabled-checks:
+      - dupImport # https://github.com/go-critic/go-critic/issues/845
+      - ifElseChain
+      - octalLiteral
+      - whyNoLint
+      - wrapperFunc
+  gocyclo:
+    min-complexity: 20
+  goimports:
+    local-prefixes: github.com/golangci/golangci-lint
+  golint:
+    min-confidence: 0
+  gomnd:
+    settings:
+      mnd:
+        # don't 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: 180
+  maligned:
+    suggest-new: true
+  misspell:
+    locale: US
+  nolintlint:
+    allow-leading-space: true # don't require machine-readable nolint directives (i.e. with no leading space)
+    allow-unused: false # report any unused nolint directives
+    require-explanation: false # don't require an explanation for nolint directives
+    require-specific: false # don't require nolint directives to be specific about which linter is being skipped
+
+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
+    - deadcode
+    - depguard
+    - dogsled
+    - dupl
+    - errcheck
+    - funlen
+    # - gochecknoinits
+    - goconst
+    - gocritic
+    - gocyclo
+    - gofmt
+    - goimports
+    - golint
+    - gomnd
+    - goprintffuncname
+    - gosec
+    - gosimple
+    - govet
+    - ineffassign
+    - interfacer
+    - lll
+    - misspell
+    - nakedret
+    - nolintlint
+    - rowserrcheck
+    - scopelint
+    - staticcheck
+    - structcheck
+    - stylecheck
+    - typecheck
+    - unconvert
+    - unparam
+    - unused
+    - varcheck
+    # - whitespace
+
+  # don't enable:
+  # - asciicheck
+  # - exhaustive (TODO: enable after next release; current release at time of writing is v1.27)
+  # - gochecknoglobals
+  # - gocognit
+  # - godot
+  # - godox
+  # - goerr113
+  # - maligned
+  # - nestif
+  # - noctx (TODO: enable after next release; current release at time of writing is v1.27)
+  # - prealloc
+  # - testpackage
+  # - wsl
+
+issues:
+  # Excluding configuration per-path, per-linter, per-text and per-source
+  exclude-rules:
+    - path: _test\.go
+      linters:
+        - gomnd
+
+    # https://github.com/go-critic/go-critic/issues/926
+    - linters:
+        - gocritic
+      text: "unnecessaryDefer:"
+
+run:
+  skip-dirs:
+    - test/
+
+# golangci.com configuration
+# https://github.com/golangci/golangci/wiki/Configuration
+service:
+  golangci-lint-version: 1.23.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"

Diff for: Makefile

@@ -26,6 +26,10 @@ build:
 		-o ./build/_output/bin/webhookrelay-operator \
 		./cmd/manager
 
+##############################
+#           DEV              #
+##############################
+
 # Generate APIs, CRD specs and CRD clientset.
 go-gen:
 	$(OPERATOR_SDK) generate k8s
@@ -49,6 +53,9 @@ add-cr:
 image-operator:
 	docker build . -f build/Dockerfile -t $(OPERATOR_IMAGE)
 
+lint:
+	$(GOLANGCI_LINT) run
+
 ##############################
 #           OLM              #
 ##############################

Diff for: cmd/manager/main.go

@@ -119,10 +119,14 @@ func main() {
 		os.Exit(1)
 	}
 
-	mgr.AddHealthzCheck("up", func(req *http.Request) error {
+	if err := mgr.AddHealthzCheck("up", func(req *http.Request) error {
 		// OK
 		return nil
-	})
+	}); err != nil {
+		log.Error(err, "")
+		os.Exit(1)
+		return
+	}
 
 	log.Info("Registering Components.")
 
@@ -162,7 +166,8 @@ func addMetrics(ctx context.Context, cfg *rest.Config) {
 		}
 	}
 
-	if err := serveCRMetrics(cfg, operatorNs); err != nil {
+	err = serveCRMetrics(cfg, operatorNs)
+	if err != nil {
 		log.Info("Could not generate and serve custom resource metrics", "error", err.Error())
 	}
 

Diff for: pkg/config/load.go

@@ -9,7 +9,7 @@ func Load() (Config, error) {
 	return config, err
 }
 
-// MustLoad loads the configuration from the environmnet
+// MustLoad loads the configuration from the environment
 // and panics if an error is encountered.
 func MustLoad() Config {
 	config, err := Load()

Diff for: pkg/controller/webhookrelayforward/cache.go

@@ -63,7 +63,6 @@ func (c *bucketsCache) AddOutput(o *webhookrelay.Output) {
 			c.items[k] = bucket
 		}
 	}
-
 }
 
 // Add a bucket to the cache. Can be used after creation or bucket update
@@ -120,7 +119,7 @@ func (c *bucketsCache) List() []*webhookrelay.Bucket {
 		cp := new(webhookrelay.Bucket)
 		err = copier.Copy(v, cp)
 		if err != nil {
-			//
+			continue
 		}
 		items = append(items, cp)
 	}

Diff for: pkg/controller/webhookrelayforward/cache_test.go

@@ -28,14 +28,11 @@ func TestCache_AddOutput(t *testing.T) {
 	})
 
 	t.Run("TestUpdateBucket", func(t *testing.T) {
-		// c.Add(&webhookrelay.Bucket{ID: "foo", Name: "b-1"})
-
 		c.AddOutput(&webhookrelay.Output{ID: "foo", BucketID: "foo", Name: "o-1"})
 
 		name := c.items["b-1"].Outputs[0].Name
 		assert.Equal(t, 1, len(c.items))
 		assert.Equal(t, 1, len(c.items["b-1"].Outputs))
 		assert.Equal(t, "o-1", name)
 	})
-
 }

Diff for: pkg/controller/webhookrelayforward/public_endpoints_status.go

@@ -7,7 +7,6 @@ import (
 )
 
 func (r *ReconcileWebhookRelayForward) shouldUpdatePublicEndpoints(instance *forwardv1.WebhookRelayForward) (*forwardv1.WebhookRelayForward, bool) {
-
 	if len(instance.Spec.Buckets) == 0 && len(instance.Status.PublicEndpoints) == 0 {
 		// nothing to do
 		return nil, false
@@ -26,7 +25,6 @@ func (r *ReconcileWebhookRelayForward) shouldUpdatePublicEndpoints(instance *for
 	sort.Strings(instance.Status.PublicEndpoints)
 
 	if !sliceEquals(desiredEndpoints, instance.Status.PublicEndpoints) {
-
 		patch := instance.DeepCopy()
 		patch.Status.PublicEndpoints = desiredEndpoints
 		return patch, true
@@ -36,7 +34,6 @@ func (r *ReconcileWebhookRelayForward) shouldUpdatePublicEndpoints(instance *for
 }
 
 func computePublicEndpoints(instance *forwardv1.WebhookRelayForward, bucketsCache *bucketsCache) []string {
-
 	var (
 		endpoints []string
 		endpoint  string

Diff for: pkg/controller/webhookrelayforward/sync_buckets.go

@@ -24,7 +24,6 @@ func (r *ReconcileWebhookRelayForward) ensureBucketConfiguration(logger logr.Log
 	r.apiClient.bucketsCache.Set(buckets)
 
 	for i := range instance.Spec.Buckets {
-
 		if instance.Spec.Buckets[i].Description == "" {
 			instance.Spec.Buckets[i].Description = getBucketDescription(instance)
 		}
@@ -64,7 +63,6 @@ func (r *ReconcileWebhookRelayForward) ensureBucketConfiguration(logger logr.Log
 				"bucket_ref", instance.Spec.Buckets[i].Name,
 			)
 		}
-
 	}
 
 	if len(errors) > 0 {
@@ -87,6 +85,7 @@ func getBucketByName(name string, buckets []*webhookrelay.Bucket) (*webhookrelay
 	return nil, false
 }
 
+//nolint
 func bucketEqual(spec *forwardv1.BucketSpec, bucket *webhookrelay.Bucket) bool {
 
 	if spec.Description != bucket.Description {

Diff for: pkg/controller/webhookrelayforward/sync_inputs.go

@@ -10,8 +10,7 @@ import (
 )
 
 // ensureBucketInputs checks and configures input specific information
-func (r *ReconcileWebhookRelayForward) ensureBucketInputs(logger logr.Logger, instance *forwardv1.WebhookRelayForward, bucketSpec *forwardv1.BucketSpec) error {
-
+func (r *ReconcileWebhookRelayForward) ensureBucketInputs(logger logr.Logger, bucketSpec *forwardv1.BucketSpec) error {
 	// If no inputs are defined, nothing to do
 	if len(bucketSpec.Inputs) == 0 {
 		return nil
@@ -81,7 +80,6 @@ func (r *ReconcileWebhookRelayForward) ensureBucketInputs(logger logr.Logger, in
 }
 
 func desiredInputs(bucketSpec *forwardv1.BucketSpec, bucket *webhookrelay.Bucket) []*webhookrelay.Input {
-
 	var desired []*webhookrelay.Input
 
 	for i := range bucketSpec.Inputs {
@@ -92,7 +90,6 @@ func desiredInputs(bucketSpec *forwardv1.BucketSpec, bucket *webhookrelay.Bucket
 }
 
 func inputSpecToInput(spec *forwardv1.InputSpec, bucket *webhookrelay.Bucket) *webhookrelay.Input {
-
 	// Ensuring that ResponseFromOutput is either empty, 'anyOutput' or an actual ID
 	// of the output that is inside this bucket
 	if spec.ResponseFromOutput != "" && spec.ResponseFromOutput != "anyOutput" {
@@ -123,7 +120,6 @@ func inputSpecToInput(spec *forwardv1.InputSpec, bucket *webhookrelay.Bucket) *w
 }
 
 func getInputsDiff(current, desired []*webhookrelay.Input) *inputsDiff {
-
 	diff := &inputsDiff{}
 
 	currentMap := make(map[string]*webhookrelay.Input)

Diff for: pkg/controller/webhookrelayforward/sync_outputs.go

@@ -9,8 +9,7 @@ import (
 	forwardv1 "github.com/webhookrelay/webhookrelay-operator/pkg/apis/forward/v1"
 )
 
-func (r *ReconcileWebhookRelayForward) ensureBucketOutputs(logger logr.Logger, instance *forwardv1.WebhookRelayForward, bucketSpec *forwardv1.BucketSpec) error {
-
+func (r *ReconcileWebhookRelayForward) ensureBucketOutputs(logger logr.Logger, bucketSpec *forwardv1.BucketSpec) error {
 	// If no outputs are defined, nothing to do
 	if len(bucketSpec.Outputs) == 0 {
 		return nil
@@ -93,7 +92,6 @@ type outputsDiff struct {
 }
 
 func getOutputsDiff(current, desired []*webhookrelay.Output) *outputsDiff {
-
 	diff := &outputsDiff{}
 
 	currentMap := make(map[string]*webhookrelay.Output)
@@ -134,7 +132,6 @@ func getOutputsDiff(current, desired []*webhookrelay.Output) *outputsDiff {
 }
 
 func desiredOutputs(bucketSpec *forwardv1.BucketSpec, bucket *webhookrelay.Bucket) []*webhookrelay.Output {
-
 	var desired []*webhookrelay.Output
 
 	for i := range bucketSpec.Outputs {
@@ -173,7 +170,6 @@ func inputSpecToOutput(spec *forwardv1.OutputSpec, bucket *webhookrelay.Bucket)
 }
 
 func outputsEqual(current, desired *webhookrelay.Output) bool {
-
 	if current.Name != desired.Name {
 		return false
 	}

Diff for: pkg/controller/webhookrelayforward/webhookrelayforward_api_client.go

@@ -14,7 +14,7 @@ import (
 
 // Errors
 var (
-	ErrCredentialsNotProvided = errors.New("Webhook Relay access token key and secret not provided")
+	ErrCredentialsNotProvided = errors.New("access token key and secret not provided")
 )
 
 // WebhookRelayClient is a wrapper for the Webhook Relay API client
@@ -37,15 +37,13 @@ type WebhookRelayClient struct {
 }
 
 func (r *ReconcileWebhookRelayForward) setClientForCluster(instance *forwardv1.WebhookRelayForward) error {
-
 	// credentials to use
 	var (
 		relayKey    string
 		relaySecret string
 	)
 
 	if instance.Spec.SecretRefName != "" {
-
 		namespace := instance.Spec.SecretRefNamespace
 		if namespace == "" {
 			// defaulting to CR namespace