Merge pull request #820 from dmage/linter

openshift-merge-robot · web-flow · commit 13471c888ed0 · 2022-11-29T09:54:18.000-05:00
Add config for golangci-lint and fix errors
diff --git a/.golangci.yaml b/.golangci.yaml
@@ -0,0 +1,13 @@
+linters:
+  enable:
+  - contextcheck
+  - errcheck
+  - exhaustive
+  - gofumpt
+  - gosimple
+  - govet
+  - ineffassign
+  - misspell
+  - staticcheck
+  - typecheck
+  - unused
diff --git a/Makefile b/Makefile
@@ -4,7 +4,7 @@ PROG  := cluster-image-registry-operator
 
 GOLANGCI_LINT = _output/tools/golangci-lint
 GOLANGCI_LINT_CACHE = $(PWD)/_output/golangci-lint-cache
-GOLANGCI_LINT_VERSION = v1.50.0
+GOLANGCI_LINT_VERSION = v1.50.1
 
 GO_REQUIRED_MIN_VERSION = 1.16
 
diff --git a/cmd/cluster-image-registry-operator/main.go b/cmd/cluster-image-registry-operator/main.go
@@ -26,9 +26,7 @@ import (
 
 const metricsPort = 60000
 
-var (
-	filesToWatch []string
-)
+var filesToWatch []string
 
 func printVersion() {
 	klog.Infof("Cluster Image Registry Operator Version: %s", version.Version)
diff --git a/pkg/client/operatorclient.go b/pkg/client/operatorclient.go
@@ -77,7 +77,7 @@ func (c *ConfigOperatorClient) UpdateOperatorStatus(ctx context.Context, oldReso
 
 	config.Status.OperatorStatus = *in
 
-	updatedConfig, err := c.client.UpdateStatus(context.TODO(), config, metav1.UpdateOptions{})
+	updatedConfig, err := c.client.UpdateStatus(ctx, config, metav1.UpdateOptions{})
 	if err != nil {
 		return nil, err
 	}
diff --git a/pkg/metrics/server_test.go b/pkg/metrics/server_test.go
@@ -197,10 +197,8 @@ func TestImagePrunerInstallStatus(t *testing.T) {
 					t.Errorf("expected metric %s to be 2, got %f", metricName, m.Gauge.GetValue())
 				}
 			}
-
 		})
 	}
-
 }
 
 func findMetricsByCounter(buf io.ReadCloser, name string) []*io_prometheus_client.Metric {
diff --git a/pkg/operator/metrics.go b/pkg/operator/metrics.go
@@ -32,7 +32,7 @@ func NewMetricsController(informer imageinformers.ImageStreamInformer) *MetricsC
 	}
 }
 
-// report gathers all metrics reported by this operator and calls approprate function in the
+// report gathers all metrics reported by this operator and calls appropriate function in the
 // metrics package to report the current values.
 func (m *MetricsController) report(_ context.Context) {
 	imgstreams, err := m.lister.List(labels.Everything())
diff --git a/pkg/operator/starter.go b/pkg/operator/starter.go
@@ -62,7 +62,7 @@ func RunOperator(ctx context.Context, kubeconfig *restclient.Config) error {
 
 	// library-go just logs a warning and continues
 	// https://github.com/openshift/library-go/blob/4362aa519714a4b62b00ab8318197ba2bba51cb7/pkg/controller/controllercmd/builder.go#L230
-	controllerRef, err := events.GetControllerReferenceForCurrentPod(context.TODO(), kubeClient, defaults.ImageRegistryOperatorNamespace, nil)
+	controllerRef, err := events.GetControllerReferenceForCurrentPod(ctx, kubeClient, defaults.ImageRegistryOperatorNamespace, nil)
 	if err != nil {
 		klog.Warningf("unable to get owner reference (falling back to namespace): %v", err)
 	}
diff --git a/pkg/resource/dependencies.go b/pkg/resource/dependencies.go
@@ -43,7 +43,7 @@ func (d dependencies) Checksum(configMapLister corelisters.ConfigMapNamespaceLis
 		cm, err := configMapLister.Get(name)
 		if errors.IsNotFound(err) {
 			// We may have optional dependencies.
-			klog.Infof("missing the deployment depencency: ConfigMap %s: %s", name, err)
+			klog.Infof("missing the deployment dependency: ConfigMap %s: %s", name, err)
 			continue
 		} else if err != nil {
 			return "", err
diff --git a/pkg/resource/deployment_test.go b/pkg/resource/deployment_test.go
@@ -61,7 +61,6 @@ func TestChecksum(t *testing.T) {
 
 	for _, test := range tests {
 		t.Run(test.name, func(t *testing.T) {
-
 			ctx, cancel := context.WithCancel(context.Background())
 			defer cancel()
 
diff --git a/pkg/resource/podtemplatespec_test.go b/pkg/resource/podtemplatespec_test.go
@@ -133,7 +133,8 @@ func TestMakePodTemplateSpecWithTopologySpread(t *testing.T) {
 							MatchLabels: map[string]string{"registry": "abc"},
 						},
 					},
-				}},
+				},
+			},
 			expected: []corev1.TopologySpreadConstraint{
 				{
 					MaxSkew:           2,
diff --git a/pkg/resource/strategy/override_test.go b/pkg/resource/strategy/override_test.go
@@ -45,7 +45,7 @@ func TestOverride(t *testing.T) {
 		t.Error("object is expected to be changed, but changed=false")
 	}
 	if o.ResourceVersion != "12345" {
-		t.Errorf("resouce version is changed: %v", o.ResourceVersion)
+		t.Errorf("resource version is changed: %v", o.ResourceVersion)
 	}
 	if val, ok := o.Annotations["hello"]; ok {
 		t.Errorf("annotation hello: expected to be removed, got %q", val)
diff --git a/pkg/signals/signal.go b/pkg/signals/signal.go
@@ -22,8 +22,10 @@ import (
 	"syscall"
 )
 
-var shutdownSignals = []os.Signal{os.Interrupt, syscall.SIGTERM}
-var onlyOneSignalHandler = make(chan struct{})
+var (
+	shutdownSignals      = []os.Signal{os.Interrupt, syscall.SIGTERM}
+	onlyOneSignalHandler = make(chan struct{})
+)
 
 // SetupSignalHandler registered for SIGTERM and SIGINT. A stop channel is returned
 // which is closed on one of these signals. If a second signal is caught, the program
diff --git a/pkg/storage/azure/azure.go b/pkg/storage/azure/azure.go
@@ -45,15 +45,13 @@ const (
 	storageExistsReasonAccountDeleted    = "AccountDeleted"
 )
 
-var (
-	// storageAccountInvalidCharRe is a regular expression for characters that
-	// cannot be used in Azure storage accounts names (i.e. that are not
-	// numbers nor lower-case letters) and that are not upper-case letters. If
-	// you use this regular expression to filter invalid characters, you also
-	// need to strings.ToLower to get a valid storage account name or an empty
-	// string.
-	storageAccountInvalidCharRe = regexp.MustCompile(`[^0-9A-Za-z]`)
-)
+// storageAccountInvalidCharRe is a regular expression for characters that
+// cannot be used in Azure storage accounts names (i.e. that are not
+// numbers nor lower-case letters) and that are not upper-case letters. If
+// you use this regular expression to filter invalid characters, you also
+// need to strings.ToLower to get a valid storage account name or an empty
+// string.
+var storageAccountInvalidCharRe = regexp.MustCompile(`[^0-9A-Za-z]`)
 
 // Azure holds configuration used to reach Azure's endpoints.
 type Azure struct {
diff --git a/pkg/storage/azure/azure_test.go b/pkg/storage/azure/azure_test.go
@@ -178,7 +178,7 @@ func TestGetConfig(t *testing.T) {
 }
 
 func TestGenerateAccountName(t *testing.T) {
-	var re = regexp.MustCompile(`^[0-9a-z]{3,24}$`)
+	re := regexp.MustCompile(`^[0-9a-z]{3,24}$`)
 	for _, infrastructureName := range []string{
 		"",
 		"foo",
diff --git a/pkg/storage/ibmcos/ibmcos.go b/pkg/storage/ibmcos/ibmcos.go
@@ -77,7 +77,6 @@ func (d *driver) CABundle() (string, bool, error) {
 // ConfigEnv configures the environment variables that will be
 // used in the image registry deployment.
 func (d *driver) ConfigEnv() (envs envvar.List, err error) {
-
 	_, err = d.UpdateEffectiveConfig()
 	if err != nil {
 		return
@@ -99,7 +98,6 @@ func (d *driver) ConfigEnv() (envs envvar.List, err error) {
 // UpdateEffectiveConfig updates the driver's local effective ImageRegistryConfig and returns the effective image
 // registry configuration based on infrastructure settings and any custom overrides.
 func (d *driver) UpdateEffectiveConfig() (*imageregistryv1.ImageRegistryConfigStorageIBMCOS, error) {
-
 	effectiveConfig := d.Config.DeepCopy()
 
 	if effectiveConfig == nil {
@@ -668,7 +666,6 @@ func (d *driver) bucketExists(bucketName string, serviceInstanceCRN string) erro
 // getIBMCOSClient returns a client that allows us to interact
 // with the IBM COS service.
 func (d *driver) getIBMCOSClient(serviceInstanceCRN string) (*s3.S3, error) {
-
 	infra, err := util.GetInfrastructure(d.Listers)
 	if err != nil {
 		return nil, err
diff --git a/pkg/storage/oss/oss.go b/pkg/storage/oss/oss.go
@@ -588,8 +588,10 @@ func (d *driver) RemoveStorage(cr *imageregistryv1.Config) (bool, error) {
 			return false, err
 		}
 		for _, upload := range lmur.Uploads {
-			var imur = oss.InitiateMultipartUploadResult{Bucket: bucket.BucketName,
-				Key: upload.Key, UploadID: upload.UploadID}
+			imur := oss.InitiateMultipartUploadResult{
+				Bucket: bucket.BucketName,
+				Key:    upload.Key, UploadID: upload.UploadID,
+			}
 			err = bucket.AbortMultipartUpload(imur)
 			if err != nil {
 				return false, err
diff --git a/pkg/storage/oss/oss_test.go b/pkg/storage/oss/oss_test.go
@@ -23,10 +23,12 @@ import (
 	"github.com/stretchr/testify/assert"
 )
 
-var TestAccessKeyId = "TEST_ACCESS_KEY_ID"
-var TestAccessKeySecret = "TEST_ACCESS_KEY_SECRET"
-var TestBucketName = "a-bucket"
-var TestAnotherBucketName = "another-bucket"
+var (
+	TestAccessKeyId       = "TEST_ACCESS_KEY_ID"
+	TestAccessKeySecret   = "TEST_ACCESS_KEY_SECRET"
+	TestBucketName        = "a-bucket"
+	TestAnotherBucketName = "another-bucket"
+)
 
 func TestGetConfig(t *testing.T) {
 	testBuilder := cirofake.NewFixturesBuilder()
@@ -648,7 +650,6 @@ func TestUserProvidedTags(t *testing.T) {
 				t.Errorf("unexpected err %q", err)
 				return
 			}
-
 		})
 	}
 }
@@ -700,7 +701,7 @@ func Test_isInternal(t *testing.T) {
 	result := d.isInternal()
 	assert.Equal(t, true, result)
 
-	//public
+	// public
 	d.Config.EndpointAccessibility = imageregistryv1.PublicEndpoint
 	result = d.isInternal()
 	assert.Equal(t, false, result)
diff --git a/pkg/storage/s3/s3.go b/pkg/storage/s3/s3.go
@@ -393,7 +393,7 @@ func isBucketNotFound(err interface{}) bool {
 // ConfigEnv configures the environment variables that will be
 // used in the image registry deployment, and returns an AWS credentials file
 // that can be used for setting up an AWS session/client.
-// Note: it is the callers responsiblity to make sure the returned file
+// Note: it is the callers responsibility to make sure the returned file
 // location is cleaned up after it is no longer needed.
 func (d *driver) ConfigEnv() (envs envvar.List, err error) {
 	err = d.UpdateEffectiveConfig()
@@ -573,7 +573,6 @@ func (d *driver) StorageExists(cr *imageregistryv1.Config) (bool, error) {
 
 	util.UpdateCondition(cr, defaults.StorageExists, operatorapi.ConditionTrue, "S3 Bucket Exists", "")
 	return true, nil
-
 }
 
 // StorageChanged checks to see if the name of the storage medium
diff --git a/pkg/storage/storage.go b/pkg/storage/storage.go
@@ -25,9 +25,7 @@ import (
 	"github.com/openshift/cluster-image-registry-operator/pkg/storage/util"
 )
 
-var (
-	ErrStorageNotConfigured = fmt.Errorf("storage backend not configured")
-)
+var ErrStorageNotConfigured = fmt.Errorf("storage backend not configured")
 
 // MultiStoragesError is returned when we have multiple storage engines
 // configured and we can't determine which one the user wants to use.
@@ -184,7 +182,10 @@ func GetPlatformStorage(listers *regopclient.StorageListers) (imageregistryv1.Im
 	case configapiv1.BareMetalPlatformType,
 		configapiv1.VSpherePlatformType,
 		configapiv1.NonePlatformType,
-		configapiv1.NutanixPlatformType:
+		configapiv1.NutanixPlatformType,
+		configapiv1.KubevirtPlatformType,
+		configapiv1.EquinixMetalPlatformType,
+		configapiv1.PowerVSPlatformType:
 		break
 
 	// These are the supported platforms. We do have backend implementation
diff --git a/pkg/storage/swift/swift.go b/pkg/storage/swift/swift.go
@@ -506,7 +506,7 @@ func (d *driver) RemoveStorage(cr *imageregistryv1.Config) (bool, error) {
 				errs[i] = fmt.Errorf("cannot delete object %v: %v", objectError[0], objectError[1])
 			}
 
-			return false, fmt.Errorf("errors occured during bulk deleting of container %v objects: %v", cr.Spec.Storage.Swift.Container, k8sutilerrors.NewAggregate(errs))
+			return false, fmt.Errorf("errors occurred during bulk deleting of container %v objects: %v", cr.Spec.Storage.Swift.Container, k8sutilerrors.NewAggregate(errs))
 		}
 
 		return true, nil
diff --git a/pkg/storage/swift/swift_test.go b/pkg/storage/swift/swift_test.go
@@ -480,7 +480,7 @@ func TestSwiftRemoveStorageWithContentFailure(t *testing.T) {
 	_, err := d.RemoveStorage(&installConfig)
 
 	th.AssertErr(t, err)
-	th.AssertEquals(t, "errors occured during bulk deleting of container registry objects: cannot delete object obj0: Internal Error", err.Error())
+	th.AssertEquals(t, "errors occurred during bulk deleting of container registry objects: cannot delete object obj0: Internal Error", err.Error())
 	th.AssertEquals(t, "registry", installConfig.Status.Storage.Swift.Container)
 	th.AssertEquals(t, true, containerContentListed)
 	th.AssertEquals(t, false, containerContentDeleted)
diff --git a/pkg/storage/util/util.go b/pkg/storage/util/util.go
@@ -17,10 +17,8 @@ import (
 	"github.com/openshift/cluster-image-registry-operator/pkg/defaults"
 )
 
-var (
-	// multiDashes is a regexp matching multiple dashes in a sequence.
-	multiDashes = regexp.MustCompile(`-{2,}`)
-)
+// multiDashes is a regexp matching multiple dashes in a sequence.
+var multiDashes = regexp.MustCompile(`-{2,}`)
 
 // UpdateCondition will update or add the provided condition.
 func UpdateCondition(cr *imageregistryv1.Config, conditionType string, status operatorapi.ConditionStatus, reason string, message string) {
@@ -100,7 +98,7 @@ func GenerateStorageName(listers *regopclient.StorageListers, additionalInfo ...
 		}
 	}
 
-	// Join the slice together with dashes, removing any occurence of
+	// Join the slice together with dashes, removing any occurrence of
 	// multiple dashes in a row as some cloud providers consider this
 	// invalid.
 	name := multiDashes.ReplaceAllString(strings.Join(parts, "-"), "-")
@@ -122,5 +120,4 @@ func GenerateStorageName(listers *regopclient.StorageListers, additionalInfo ...
 	}
 
 	return strings.ToLower(name), nil
-
 }
diff --git a/pkg/version/version.go b/pkg/version/version.go
@@ -1,5 +1,3 @@
 package version
 
-var (
-	Version = "v0.0.1"
-)
+var Version = "v0.0.1"
diff --git a/test/e2e/aws_test.go b/test/e2e/aws_test.go
@@ -37,13 +37,11 @@ const (
 	defaultBoundServiceAccountTokenMountpoint = "/var/run/secrets/openshift/serviceaccount/token"
 )
 
-var (
-	// Invalid AWS credentials map
-	fakeAWSCredsData = map[string]string{
-		"REGISTRY_STORAGE_S3_ACCESSKEY": "myAccessKey",
-		"REGISTRY_STORAGE_S3_SECRETKEY": "mySecretKey",
-	}
-)
+// Invalid AWS credentials map
+var fakeAWSCredsData = map[string]string{
+	"REGISTRY_STORAGE_S3_ACCESSKEY": "myAccessKey",
+	"REGISTRY_STORAGE_S3_SECRETKEY": "mySecretKey",
+}
 
 func TestAWSDefaults(t *testing.T) {
 	te := framework.Setup(t)
@@ -119,7 +117,6 @@ func TestAWSDefaults(t *testing.T) {
 	} else {
 		if cr.Spec.Storage.S3.Region != s3Driver.Config.Region {
 			t.Errorf("custom resource %s/%s contains incorrect data. S3 Region was %v but should have been %v", defaults.ImageRegistryOperatorNamespace, defaults.ImageRegistryResourceName, s3Driver.Config.Region, cr.Spec.Storage.S3)
-
 		}
 		if cr.Spec.Storage.S3.Bucket == "" {
 			t.Errorf("custom resource %s/%s contains incorrect data. S3 Bucket name should not be empty", defaults.ImageRegistryOperatorNamespace, defaults.ImageRegistryResourceName)
@@ -543,7 +540,6 @@ func TestAWSChangeS3Encryption(t *testing.T) {
 		if aerr, ok := err.(awserr.Error); ok {
 			t.Errorf("unable to get encryption information for S3 bucket: %#v, %#v", aerr.Code(), aerr.Error())
 		} else {
-
 			t.Errorf("unknown error occurred getting encryption information for S3 bucket: %#v", err)
 		}
 	}
@@ -617,7 +613,6 @@ func TestAWSChangeS3Encryption(t *testing.T) {
 					return false, nil
 				}
 			}
-
 		}
 		return true, nil
 	})
@@ -765,7 +760,6 @@ func TestAWSFinalizerDeleteS3Bucket(t *testing.T) {
 // containing credentials info.
 // Caller is returned an cleanup function that will clean up the temporary files created.
 func createAWSConfigFile(awsSecret *corev1.Secret, kubeClient *framework.Clientset) (awsConfigFilename string, cleanupFunc func(), err error) {
-
 	secretData, ok := awsSecret.Data["credentials"]
 	if !ok {
 		err = fmt.Errorf("Secret did not contain expected 'credentials' field")
diff --git a/test/e2e/configuration_test.go b/test/e2e/configuration_test.go
@@ -225,7 +225,7 @@ func TestPodAffinityConfiguration(t *testing.T) {
 
 	// The operator won't become available because of affinity settings. So
 	// instead of waiting for the operator, we'll just hope that everything is
-	// fine and the delpoyment will eventually be created.
+	// fine and the deployment will eventually be created.
 	deployment, err := framework.WaitForRegistryDeployment(te.Client())
 	if err != nil {
 		t.Fatal(err)
@@ -234,7 +234,6 @@ func TestPodAffinityConfiguration(t *testing.T) {
 	if !reflect.DeepEqual(affinity, deployment.Spec.Template.Spec.Affinity) {
 		t.Errorf("expected affinity configuration not found wanted: %#v, got %#v", affinity, deployment.Spec.Template.Spec.Affinity)
 	}
-
 }
 
 func TestRouteConfiguration(t *testing.T) {
@@ -534,7 +533,7 @@ func TestVersionReporting(t *testing.T) {
 			return false, nil
 		}
 		if len(clusterOperatorStatus.Status.Versions) == 0 {
-			// We should always have *some* version information in the clusteroperator once we are avaiable,
+			// We should always have *some* version information in the clusteroperator once we are available,
 			// so we do not retry in this scenario.
 			t.Fatalf("Cluster operator status has no version information: %v", clusterOperatorStatus)
 			return true, err
diff --git a/test/e2e/graceful_shutdown_test.go b/test/e2e/graceful_shutdown_test.go
diff --git a/test/e2e/leaderelection_test.go b/test/e2e/leaderelection_test.go
diff --git a/test/e2e/removed_test.go b/test/e2e/removed_test.go
diff --git a/test/framework/condition.go b/test/framework/condition.go
diff --git a/test/framework/framework.go b/test/framework/framework.go
diff --git a/test/framework/imageregistry.go b/test/framework/imageregistry.go
diff --git a/test/framework/logs.go b/test/framework/logs.go
diff --git a/test/framework/mock/listers/configmaps.go b/test/framework/mock/listers/configmaps.go
diff --git a/test/framework/mock/listers/secrets.go b/test/framework/mock/listers/secrets.go
diff --git a/test/framework/operator.go b/test/framework/operator.go
diff --git a/test/framework/secret.go b/test/framework/secret.go

Original file line number	Diff line number	Diff line change
`@@ -77,7 +77,7 @@ func (c *ConfigOperatorClient) UpdateOperatorStatus(ctx context.Context, oldReso`
`77`	`77`
`78`	`78`	`config.Status.OperatorStatus = *in`
`79`	`79`
`80`		`- updatedConfig, err := c.client.UpdateStatus(context.TODO(), config, metav1.UpdateOptions{})`
	`80`	`+ updatedConfig, err := c.client.UpdateStatus(ctx, config, metav1.UpdateOptions{})`
`81`	`81`	`if err != nil {`
`82`	`82`	`return nil, err`
`83`	`83`	`}`
Original file line number	Diff line number	Diff line change
`@@ -197,10 +197,8 @@ func TestImagePrunerInstallStatus(t *testing.T) {`
`197`	`197`	`t.Errorf("expected metric %s to be 2, got %f", metricName, m.Gauge.GetValue())`
`198`	`198`	`}`
`199`	`199`	`}`
`200`		`-`
`201`	`200`	`})`
`202`	`201`	`}`
`203`		`-`
`204`	`202`	`}`
`205`	`203`
`206`	`204`	`func findMetricsByCounter(buf io.ReadCloser, name string) []*io_prometheus_client.Metric {`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ func NewMetricsController(informer imageinformers.ImageStreamInformer) *MetricsC`
`32`	`32`	`}`
`33`	`33`	`}`
`34`	`34`
`35`		`-// report gathers all metrics reported by this operator and calls approprate function in the`
	`35`	`+// report gathers all metrics reported by this operator and calls appropriate function in the`
`36`	`36`	`// metrics package to report the current values.`
`37`	`37`	`func (m *MetricsController) report(_ context.Context) {`
`38`	`38`	`imgstreams, err := m.lister.List(labels.Everything())`
Original file line number	Diff line number	Diff line change
`@@ -62,7 +62,7 @@ func RunOperator(ctx context.Context, kubeconfig *restclient.Config) error {`
`62`	`62`
`63`	`63`	`// library-go just logs a warning and continues`
`64`	`64`	`// https://github.com/openshift/library-go/blob/4362aa519714a4b62b00ab8318197ba2bba51cb7/pkg/controller/controllercmd/builder.go#L230`
`65`		`- controllerRef, err := events.GetControllerReferenceForCurrentPod(context.TODO(), kubeClient, defaults.ImageRegistryOperatorNamespace, nil)`
	`65`	`+ controllerRef, err := events.GetControllerReferenceForCurrentPod(ctx, kubeClient, defaults.ImageRegistryOperatorNamespace, nil)`
`66`	`66`	`if err != nil {`
`67`	`67`	`klog.Warningf("unable to get owner reference (falling back to namespace): %v", err)`
`68`	`68`	`}`