Enable misspell, nestif golang linter (#2240)

* Enable gocyclo linter

* Enable gocritic linter

* Fix typo for linters-settings, fix gocyclo lint failures

* Add lll linter

* Add nakedret linter

* Enable dupl linter

* Enable exportloopref linter

* Enable importas linter

* Enable misspell linter

* Enable nestif linter

* Fix minor typo

* Update new lint misses, add TODO for lint disables

* Merge master, resolve conflicts

* Fix misspell lint failure

* Apply linter to new changes

* Fix merge issues

* Add missing newlint

* Add explanation for ignoring dupl linter

* Remove unnecessary comment

* Address review comments

* Address review comments - move args

* Temporarily disable depguard linter, lint fix

* Fix merge error

* Fix error message in test

.golangci.yml

@@ -22,6 +22,8 @@ linters:
     - dupl
     - exportloopref
     - importas
+    - misspell
+    - nestif
 
 run:
   timeout: 10m                          # golangci-lint run's timeout.
@@ -37,6 +39,8 @@ issues:
         - unparam                       # Tests might have unused function parameters.
         - lll
         - dupl
+        - misspell
+        - nestif
 
     - text: "`ctx` is unused"           # Context might not be in use in places, but for consistency, we pass it.
       linters:
@@ -60,3 +64,5 @@ linters-settings:
         alias: metav1
       - pkg: github.com/kanisterio/kanister/pkg/apis/cr/v1alpha1
         alias: crv1alpha1
+  nestif:
+    min-complexity: 6

pkg/app/app.go

@@ -23,7 +23,7 @@ import (
 
 // App represents an application we can install into a namespace.
 type App interface {
-	// Init instantiates the app based on the environemnt configuration,
+	// Init instantiates the app based on the environment configuration,
 	// including environement variables and state in the Kubernetes cluster. If
 	// any required configuration is not discoverable, Init will return an
 	// error.
@@ -48,7 +48,7 @@ type App interface {
 type DatabaseApp interface {
 	App
 	// Ping will issue trivial request to the database to see if it is
-	// accessable.
+	// accessible.
 	Ping(context.Context) error
 	// Insert adds n entries to the database.
 	Insert(ctx context.Context) error

pkg/app/cassandra.go

@@ -123,7 +123,7 @@ func (cas *CassandraInstance) Object() crv1alpha1.ObjectReference {
 	}
 }
 
-// Uninstall us used to remove the datbase application
+// Uninstall us used to remove the database application
 func (cas *CassandraInstance) Uninstall(ctx context.Context) error {
 	log.Print("Uninstalling application.", field.M{"app": cas.name})
 	cli, err := helm.NewCliClient()
@@ -142,7 +142,7 @@ func (cas *CassandraInstance) GetClusterScopedResources(ctx context.Context) []c
 	return nil
 }
 
-// Ping is used to ping the application to check the datbase connectivity
+// Ping is used to ping the application to check the database connectivity
 func (cas *CassandraInstance) Ping(ctx context.Context) error {
 	log.Print("Pinging the application.", field.M{"app": cas.name})
 

pkg/app/elasticsearch.go

@@ -174,7 +174,7 @@ func (esi *ElasticsearchInstance) Insert(ctx context.Context) error {
 	addDocumentToIndexCMD := []string{"sh", "-c", esi.curlCommandWithPayload("POST", esi.indexname+"/_doc/?refresh=true", "'{\"appname\": \"kanister\" }'")}
 	_, stderr, err := esi.execCommand(ctx, addDocumentToIndexCMD)
 	if err != nil {
-		// even one insert failed we will have to return becasue
+		// even one insert failed we will have to return because
 		// the count wont  match anyway and the test will fail
 		return errors.Wrapf(err, "Error %s inserting document to an index %s.", stderr, esi.indexname)
 	}

pkg/app/mongodb-deploymentconfig.go

@@ -184,7 +184,7 @@ func (mongo *MongoDBDepConfig) execCommand(ctx context.Context, command []string
 		return "", "", err
 	}
 	stdout, stderr, err := kube.Exec(mongo.cli, mongo.namespace, podName, containerName, command, nil)
-	log.Print("Executing the command in pod and contianer", field.M{"pod": podName, "container": containerName, "cmd": command})
+	log.Print("Executing the command in pod and container", field.M{"pod": podName, "container": containerName, "cmd": command})
 
 	return stdout, stderr, errors.Wrapf(err, "Error executing command in the pod")
 }

pkg/blockstorage/awsefs/awsefs.go

@@ -66,7 +66,7 @@ var allowedMetadataKeys = map[string]bool{
 	"newFileSystem":   true,
 }
 
-// NewEFSProvider retuns a blockstorage provider for AWS EFS.
+// NewEFSProvider returns a blockstorage provider for AWS EFS.
 func NewEFSProvider(ctx context.Context, config map[string]string) (blockstorage.Provider, error) {
 	awsConfig, region, err := awsconfig.GetConfig(ctx, config)
 	if err != nil {

pkg/blockstorage/azure/auth.go

@@ -11,7 +11,7 @@ import (
 
 const ActiveDirectory = "activeDirectory"
 
-// currently avaialble types: https://docs.microsoft.com/en-us/azure/developer/go/azure-sdk-authorization
+// currently available types: https://docs.microsoft.com/en-us/azure/developer/go/azure-sdk-authorization
 // to be available with azidentity: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azidentity#readme-credential-types
 // determine if the combination of creds are client secret creds
 func isClientCredsAvailable(config map[string]string) bool {

pkg/blockstorage/gcepd/gcepd.go

@@ -479,20 +479,20 @@ func (s *GpdStorage) SetTags(ctx context.Context, resource interface{}, tags map
 				if err != nil {
 					return err
 				}
-			} else {
-				vol, err := s.service.Disks.Get(s.project, res.Az, res.ID).Context(ctx).Do()
-				if err != nil {
-					return err
-				}
-				tags = ktags.AddMissingTags(vol.Labels, ktags.GetTags(tags))
-				slr := &compute.ZoneSetLabelsRequest{
-					LabelFingerprint: vol.LabelFingerprint,
-					Labels:           blockstorage.SanitizeTags(tags),
-				}
-				op, err = s.service.Disks.SetLabels(s.project, res.Az, vol.Name, slr).Do()
-				if err != nil {
-					return err
-				}
+				return s.waitOnOperation(ctx, op, res.Az)
+			}
+			vol, err := s.service.Disks.Get(s.project, res.Az, res.ID).Context(ctx).Do()
+			if err != nil {
+				return err
+			}
+			tags = ktags.AddMissingTags(vol.Labels, ktags.GetTags(tags))
+			slr := &compute.ZoneSetLabelsRequest{
+				LabelFingerprint: vol.LabelFingerprint,
+				Labels:           blockstorage.SanitizeTags(tags),
+			}
+			op, err = s.service.Disks.SetLabels(s.project, res.Az, vol.Name, slr).Do()
+			if err != nil {
+				return err
 			}
 			return s.waitOnOperation(ctx, op, res.Az)
 		}

pkg/blockstorage/getter/getter.go

@@ -34,7 +34,7 @@ var _ Getter = (*getter)(nil)
 
 type getter struct{}
 
-// New retuns a new Getter
+// New returns a new Getter
 func New() Getter {
 	return &getter{}
 }

pkg/blockstorage/vmware/vmware.go

@@ -795,7 +795,7 @@ func (ge govmomiError) Format() string {
 	return fmt.Sprintf("[%s]", strings.Join(msgs, "; "))
 }
 
-//nolint:gocognit
+//nolint:gocognit,nestif
 func (ge govmomiError) ExtractMessages() []string {
 	err := ge.err
 

pkg/blockstorage/zone/zone.go

@@ -57,7 +57,7 @@ func FromSourceRegionZone(ctx context.Context, m Mapper, kubeCli kubernetes.Inte
 		}
 	}
 	if len(newZones) == 0 {
-		return nil, errors.Errorf("Unable to find valid availabilty zones for region (%s)", sourceRegion)
+		return nil, errors.Errorf("Unable to find valid availability zones for region (%s)", sourceRegion)
 	}
 	var zones []string
 	for z := range newZones {

pkg/blockstorage/zone/zone_test.go

@@ -562,14 +562,14 @@ func (s ZoneSuite) TestFromSourceRegionZone(c *C) {
 			inZones:  []string{"us-west-2a"},
 			inCli:    nil,
 			outZones: nil,
-			outErr:   fmt.Errorf(".*Unable to find valid availabilty zones for region.*"),
+			outErr:   fmt.Errorf(".*Unable to find valid availability zones for region.*"),
 		},
 		{ // Kubernetes provided zones are invalid use valid sourceZones
 			inRegion: "us-west-2",
 			inZones:  []string{"us-west-2a", "us-west-2b", "us-west-2d"},
 			inCli:    nil,
 			outZones: []string{"us-west-2a", "us-west-2b"},
-			outErr:   fmt.Errorf(".*Unable to find valid availabilty zones for region.*"),
+			outErr:   fmt.Errorf(".*Unable to find valid availability zones for region.*"),
 		},
 		{ // Source zone not found but other valid zones available
 			inRegion: "us-west-2",

pkg/config/helpers.go

@@ -39,7 +39,7 @@ func GetClusterName(cli kubernetes.Interface) (string, error) {
 func GetEnvOrSkip(c *check.C, varName string) string {
 	v := os.Getenv(varName)
 	if v == "" {
-		reason := fmt.Sprintf("Test %s requires the environemnt variable '%s'", c.TestName(), varName)
+		reason := fmt.Sprintf("Test %s requires the environment variable '%s'", c.TestName(), varName)
 		c.Skip(reason)
 	}
 	return v

pkg/controllers/repositoryserver/repository.go

@@ -37,7 +37,7 @@ func (h *RepoServerHandler) connectToKopiaRepository() error {
 			MetadataCacheLimitMB: *cacheSizeSettings.Metadata,
 		},
 		Username: h.RepositoryServer.Spec.Repository.Username,
-		// TODO(Amruta): Generate path for respository
+		// TODO(Amruta): Generate path for repository
 		RepoPathPrefix: h.RepositoryServer.Spec.Repository.RootPath,
 		Location:       h.RepositoryServerSecrets.storage.Data,
 	}

pkg/controllers/repositoryserver/secrets_manager.go

@@ -35,7 +35,7 @@ type repositoryServerSecrets struct {
 // getSecretsFromCR fetches all the secrets in the RepositoryServer CR
 func (h *RepoServerHandler) getSecretsFromCR(ctx context.Context) error {
 	// TODO: For now, users should make sure all the secrets and the RepositoryServer CR are present in the
-	//  same namespace. This namespace field can be overriden when we start creating secrets using 'kanctl' utility
+	//  same namespace. This namespace field can be overridden when we start creating secrets using 'kanctl' utility
 	repositoryServer := h.RepositoryServer
 	h.Logger.Info("Fetching secrets from all the secret references in the CR")
 	storage, err := h.fetchSecret(ctx, &repositoryServer.Spec.Storage.SecretRef)

pkg/customresource/customresource.go

@@ -153,7 +153,7 @@ func createCRD(context Context, resource CustomResource) error {
 }
 
 func rawCRDFromFile(path string) ([]byte, error) {
-	// yamls is the variable that has embeded custom resource manifest. More at `embed.go`
+	// yamls is the variable that has embedded custom resource manifest. More at `embed.go`
 	return yamls.ReadFile(path)
 }
 

pkg/customresource/embed.go

@@ -5,7 +5,7 @@ import "embed"
 // embed.go embeds the CRD yamls (actionset, profile, blueprint) with the
 // controller binary so that we can read these manifests in runtime.
 
-// We need these manfiests at two places, at `pkg/customresource/` and at
+// We need these manifests at two places, at `pkg/customresource/` and at
 // `helm/kanister-operator/crds`. To make sure we are not duplicating the
 // things we have original files at `pkg/customresource` and have soft links
 // at `helm/kanister-operator/crds`.

pkg/function/create_rds_snapshot.go

@@ -95,30 +95,9 @@ func createRDSSnapshot(ctx context.Context, instanceID string, dbEngine RDSDBEng
 	// Create Snapshot
 	snapshotID := fmt.Sprintf("%s-%s", instanceID, rand.String(10))
 
-	log.WithContext(ctx).Print("Creating RDS snapshot", field.M{"SnapshotID": snapshotID})
-	if !isAuroraCluster(string(dbEngine)) {
-		dbSnapshotOutput, err := rdsCli.CreateDBSnapshot(ctx, instanceID, snapshotID)
-		if err != nil {
-			return nil, errors.Wrap(err, "Failed to create snapshot")
-		}
-
-		// Wait until snapshot becomes available
-		log.WithContext(ctx).Print("Waiting for RDS snapshot to be available", field.M{"SnapshotID": snapshotID})
-		if err := rdsCli.WaitUntilDBSnapshotAvailable(ctx, snapshotID); err != nil {
-			return nil, errors.Wrap(err, "Error while waiting snapshot to be available")
-		}
-		if dbSnapshotOutput.DBSnapshot != nil && dbSnapshotOutput.DBSnapshot.AllocatedStorage != nil {
-			allocatedStorage = *(dbSnapshotOutput.DBSnapshot.AllocatedStorage)
-		}
-	} else {
-		if _, err := rdsCli.CreateDBClusterSnapshot(ctx, instanceID, snapshotID); err != nil {
-			return nil, errors.Wrap(err, "Failed to create cluster snapshot")
-		}
-
-		log.WithContext(ctx).Print("Waiting for RDS Aurora snapshot to be available", field.M{"SnapshotID": snapshotID})
-		if err := rdsCli.WaitUntilDBClusterSnapshotAvailable(ctx, snapshotID); err != nil {
-			return nil, errors.Wrap(err, "Error while waiting snapshot to be available")
-		}
+	allocatedStorage, err = createSnapshot(ctx, rdsCli, snapshotID, instanceID, string(dbEngine))
+	if err != nil {
+		return nil, err
 	}
 
 	// Find security group ids
@@ -160,6 +139,36 @@ func createRDSSnapshot(ctx context.Context, instanceID string, dbEngine RDSDBEng
 	return output, nil
 }
 
+func createSnapshot(ctx context.Context, rdsCli *rds.RDS, snapshotID, dbEngine, instanceID string) (int64, error) {
+	log.WithContext(ctx).Print("Creating RDS snapshot", field.M{"SnapshotID": snapshotID})
+	var allocatedStorage int64
+	if !isAuroraCluster(dbEngine) {
+		dbSnapshotOutput, err := rdsCli.CreateDBSnapshot(ctx, instanceID, snapshotID)
+		if err != nil {
+			return allocatedStorage, errors.Wrap(err, "Failed to create snapshot")
+		}
+
+		// Wait until snapshot becomes available
+		log.WithContext(ctx).Print("Waiting for RDS snapshot to be available", field.M{"SnapshotID": snapshotID})
+		if err := rdsCli.WaitUntilDBSnapshotAvailable(ctx, snapshotID); err != nil {
+			return allocatedStorage, errors.Wrap(err, "Error while waiting snapshot to be available")
+		}
+		if dbSnapshotOutput.DBSnapshot != nil && dbSnapshotOutput.DBSnapshot.AllocatedStorage != nil {
+			allocatedStorage = *(dbSnapshotOutput.DBSnapshot.AllocatedStorage)
+		}
+		return allocatedStorage, nil
+	}
+	if _, err := rdsCli.CreateDBClusterSnapshot(ctx, instanceID, snapshotID); err != nil {
+		return allocatedStorage, errors.Wrap(err, "Failed to create cluster snapshot")
+	}
+
+	log.WithContext(ctx).Print("Waiting for RDS Aurora snapshot to be available", field.M{"SnapshotID": snapshotID})
+	if err := rdsCli.WaitUntilDBClusterSnapshotAvailable(ctx, snapshotID); err != nil {
+		return allocatedStorage, errors.Wrap(err, "Error while waiting snapshot to be available")
+	}
+	return allocatedStorage, nil
+}
+
 func (crs *createRDSSnapshotFunc) Exec(ctx context.Context, tp param.TemplateParams, args map[string]interface{}) (map[string]interface{}, error) {
 	// Set progress percent
 	crs.progressPercent = progress.StartedPercent

pkg/function/restore_data_using_kopia_server.go

@@ -36,7 +36,7 @@ import (
 
 const (
 	RestoreDataUsingKopiaServerFuncName = "RestoreDataUsingKopiaServer"
-	// SparseRestoreOption is the key for specifiying whether to do a sparse restore
+	// SparseRestoreOption is the key for specifying whether to do a sparse restore
 	SparseRestoreOption = "sparseRestore"
 )
 

pkg/function/restore_rds_snapshot.go

@@ -199,11 +199,7 @@ func restoreRDSSnapshot(
 		// If securityGroupID arg is nil, we will try to find the sgIDs by describing the existing instance
 		// Find security group ids
 		if sgIDs == nil {
-			if !isAuroraCluster(string(dbEngine)) {
-				sgIDs, err = findSecurityGroups(ctx, rdsCli, instanceID)
-			} else {
-				sgIDs, err = findAuroraSecurityGroups(ctx, rdsCli, instanceID)
-			}
+			sgIDs, err = findSecurityGroupIDs(ctx, rdsCli, instanceID, string(dbEngine))
 			if err != nil {
 				return nil, errors.Wrapf(err, "Failed to fetch security group ids. InstanceID=%s", instanceID)
 			}
@@ -236,6 +232,12 @@ func restoreRDSSnapshot(
 		RestoreRDSSnapshotEndpoint: dbEndpoint,
 	}, nil
 }
+func findSecurityGroupIDs(ctx context.Context, rdsCli *rds.RDS, instanceID, dbEngine string) ([]string, error) {
+	if !isAuroraCluster(dbEngine) {
+		return findSecurityGroups(ctx, rdsCli, instanceID)
+	}
+	return findAuroraSecurityGroups(ctx, rdsCli, instanceID)
+}
 
 //nolint:unparam
 func postgresRestoreCommand(pgHost, username, password string, backupArtifactPrefix, backupID string, profile []byte, dbEngineVersion string) ([]string, error) {
@@ -336,7 +338,7 @@ func restoreAuroraFromSnapshot(ctx context.Context, rdsCli *rds.RDS, instanceID,
 	}
 
 	log.WithContext(ctx).Print("Creating DB instance in the cluster")
-	// After Aurora cluster is created, we will have to explictly create the DB instance
+	// After Aurora cluster is created, we will have to explicitly create the DB instance
 	dbInsOp, err := rdsCli.CreateDBInstance(
 		ctx,
 		nil,

pkg/kube/pod.go

@@ -376,7 +376,7 @@ func checkPVCAndPVStatus(ctx context.Context, vol corev1.Volume, p *corev1.Pod,
 
 	switch pvc.Status.Phase {
 	case corev1.ClaimLost:
-		return errors.Errorf("PVC %s assoicated with pod %s has status: %s", pvcName, p.Name, corev1.ClaimLost)
+		return errors.Errorf("PVC %s associated with pod %s has status: %s", pvcName, p.Name, corev1.ClaimLost)
 	case corev1.ClaimPending:
 		pvName := pvc.Spec.VolumeName
 		if pvName == "" {

pkg/kube/pod_controller.go

@@ -57,7 +57,7 @@ type PodController interface {
 
 // podController keeps Kubernetes Client and PodOptions needed for creating a Pod.
 // It implements the PodControllerProcessor interface.
-// All communication with kubernetes API are done via PodControllerProcessor interface, which could be overriden for testing purposes.
+// All communication with kubernetes API are done via PodControllerProcessor interface, which could be overridden for testing purposes.
 type podController struct {
 	cli        kubernetes.Interface
 	podOptions *PodOptions

pkg/objectstore/objectstore.go

@@ -63,7 +63,7 @@ type Directory interface {
 	// DeleteDirectory deletes the current directory
 	DeleteDirectory(context.Context) error
 
-	// DeleteAllWithPrefix deletes all directorys and objects with a provided prefix
+	// DeleteAllWithPrefix deletes all directories and objects with a provided prefix
 	DeleteAllWithPrefix(context.Context, string) error
 
 	// ListDirectories lists all the directories rooted in