feat: Adding wsl lint (#3351)

* feat: Adding `wsl` lint

* feat: Addressing `wsl` lint errors

Author: yhakbar

.golangci.yml

@@ -65,6 +65,7 @@ linters:
     - unconvert
     - unused
     - unparam
+    - wsl
   enable-all: false
   disable:
     - depguard

aws_helper/config.go

@@ -127,10 +127,12 @@ func (f tokenFetcher) FetchToken(ctx credentials.Context) ([]byte, error) {
 		// TODO: See if this lint error should be ignored
 		return []byte(f), nil //nolint: nilerr
 	}
+
 	token, err := os.ReadFile(string(f))
 	if err != nil {
 		return nil, errors.WithStackTrace(err)
 	}
+
 	return token, nil
 }
 
@@ -140,13 +142,16 @@ func getWebIdentityCredentialsFromIAMRoleOptions(sess *session.Session, iamRoleO
 		// Set a unique session name in the same way it is done in the SDK
 		roleSessionName = strconv.FormatInt(time.Now().UTC().UnixNano(), 10)
 	}
+
 	svc := sts.New(sess)
 	p := stscreds.NewWebIdentityRoleProviderWithOptions(svc, iamRoleOptions.RoleARN, roleSessionName, tokenFetcher(iamRoleOptions.WebIdentityToken))
+
 	if iamRoleOptions.AssumeRoleDuration > 0 {
 		p.Duration = time.Second * time.Duration(iamRoleOptions.AssumeRoleDuration)
 	} else {
 		p.Duration = time.Second * time.Duration(options.DefaultIAMAssumeRoleDuration)
 	}
+
 	return credentials.NewCredentials(p)
 }
 
@@ -157,10 +162,12 @@ func getSTSCredentialsFromIAMRoleOptions(sess *session.Session, iamRoleOptions o
 		} else {
 			p.Duration = time.Second * time.Duration(options.DefaultIAMAssumeRoleDuration)
 		}
+
 		if iamRoleOptions.AssumeRoleSessionName != "" {
 			p.RoleSessionName = iamRoleOptions.AssumeRoleSessionName
 		}
 	})
+
 	return stscreds.NewCredentials(sess, iamRoleOptions.RoleARN, optFns...)
 }
 
@@ -174,6 +181,7 @@ func getCredentialsFromEnvs(opts *options.TerragruntOptions) *credentials.Creden
 	if accessKeyID == "" || secretAccessKey == "" {
 		return nil
 	}
+
 	return credentials.NewStaticCredentials(accessKeyID, secretAccessKey, sessionToken)
 }
 
@@ -185,15 +193,21 @@ func getCredentialsFromEnvs(opts *options.TerragruntOptions) *credentials.Creden
 // Note that if the AwsSessionConfig object is null, this will return default session credentials using the default
 // credentials chain of the AWS SDK.
 func CreateAwsSession(config *AwsSessionConfig, terragruntOptions *options.TerragruntOptions) (*session.Session, error) {
-	var sess *session.Session
-	var err error
+	var (
+		sess *session.Session
+		err  error
+	)
+
 	if config == nil {
 		sessionOptions := session.Options{SharedConfigState: session.SharedConfigEnable}
+
 		sess, err = session.NewSessionWithOptions(sessionOptions)
 		if err != nil {
 			return nil, errors.WithStackTrace(err)
 		}
+
 		sess.Handlers.Build.PushFrontNamed(addUserAgent)
+
 		if terragruntOptions.IAMRoleOptions.RoleARN != "" {
 			if terragruntOptions.IAMRoleOptions.WebIdentityToken != "" {
 				terragruntOptions.Logger.Debugf("Assuming role %s using WebIdentity token", terragruntOptions.IAMRoleOptions.RoleARN)
@@ -227,6 +241,7 @@ func CreateAwsSession(config *AwsSessionConfig, terragruntOptions *options.Terra
 // Make API calls to AWS to assume the IAM role specified and return the temporary AWS credentials to use that role
 func AssumeIamRole(iamRoleOpts options.IAMRoleOptions) (*sts.Credentials, error) {
 	sessionOptions := session.Options{SharedConfigState: session.SharedConfigEnable}
+
 	sess, err := session.NewSessionWithOptions(sessionOptions)
 	if err != nil {
 		return nil, errors.WithStackTrace(err)
@@ -281,8 +296,10 @@ func AssumeIamRole(iamRoleOpts options.IAMRoleOptions) (*sts.Credentials, error)
 		if err != nil {
 			return nil, errors.WithStackTrace(err)
 		}
+
 		token = string(tb)
 	}
+
 	input := sts.AssumeRoleWithWebIdentityInput{
 		RoleArn:          aws.String(iamRoleOpts.RoleARN),
 		RoleSessionName:  aws.String(sessionName),
@@ -297,6 +314,7 @@ func AssumeIamRole(iamRoleOpts options.IAMRoleOptions) (*sts.Credentials, error)
 	if err := req.Send(); err != nil {
 		return nil, errors.WithStackTrace(err)
 	}
+
 	return resp.Credentials, nil
 }
 
@@ -333,6 +351,7 @@ func GetAWSPartition(config *AwsSessionConfig, terragruntOptions *options.Terrag
 	if err != nil {
 		return "", errors.WithStackTrace(err)
 	}
+
 	return arn.Partition, nil
 }
 

aws_helper/policy.go

@@ -24,6 +24,7 @@ type Statement struct {
 
 func UnmarshalPolicy(policy string) (Policy, error) {
 	var p Policy
+
 	err := json.Unmarshal([]byte(policy), &p)
 	if err != nil {
 		return p, err

cli/app.go

@@ -75,12 +75,15 @@ func NewApp(writer io.Writer, errWriter io.Writer) *App {
 	app.Version = version.GetVersion()
 	app.Writer = writer
 	app.ErrWriter = errWriter
+
 	app.Flags = append(
 		commands.NewGlobalFlags(opts),
 		commands.NewHelpVersionFlags(opts)...)
+
 	app.Commands = append(
 		DeprecatedCommands(opts),
 		TerragruntCommands(opts)...).WrapAction(WrapWithTelemetry(opts))
+
 	app.Before = beforeAction(opts)
 	app.DefaultCommand = terraformCmd.NewCommand(opts).WrapAction(WrapWithTelemetry(opts)) // by default, if no terragrunt command is specified, run the Terraform command
 	app.OsExiter = OSExiter
@@ -133,6 +136,7 @@ func (app *App) RunContext(ctx context.Context, args []string) error {
 	if engine.IsEngineEnabled() {
 		ctx = engine.WithEngineValues(ctx)
 	}
+
 	defer func(ctx context.Context) {
 		if err := engine.Shutdown(ctx); err != nil {
 			_, _ = app.ErrWriter.Write([]byte(err.Error()))
@@ -142,6 +146,7 @@ func (app *App) RunContext(ctx context.Context, args []string) error {
 	if err := app.App.RunContext(ctx, args); err != nil && !goerrors.Is(err, context.Canceled) {
 		return err
 	}
+
 	return nil
 }
 
@@ -198,6 +203,7 @@ func beforeAction(_ *options.TerragruntOptions) cli.ActionFunc {
 			// exit the app
 			return cli.NewExitError(err, 0)
 		}
+
 		return nil
 	}
 }
@@ -235,6 +241,7 @@ func runAction(cliCtx *cli.Context, opts *options.TerragruntOptions, action cli.
 		if action != nil {
 			return action(cliCtx)
 		}
+
 		return nil
 	})
 
@@ -298,8 +305,10 @@ func initialSetup(cliCtx *cli.Context, opts *options.TerragruntOptions) error {
 		if err != nil {
 			return errors.WithStackTrace(err)
 		}
+
 		opts.WorkingDir = currentDir
 	}
+
 	opts.WorkingDir = filepath.ToSlash(opts.WorkingDir)
 
 	// --- Download Dir
@@ -311,6 +320,7 @@ func initialSetup(cliCtx *cli.Context, opts *options.TerragruntOptions) error {
 	if err != nil {
 		return errors.WithStackTrace(err)
 	}
+
 	opts.DownloadDir = filepath.ToSlash(downloadDir)
 
 	// --- Terragrunt ConfigPath
@@ -346,6 +356,7 @@ func initialSetup(cliCtx *cli.Context, opts *options.TerragruntOptions) error {
 	if err != nil {
 		return err
 	}
+
 	opts.ExcludeDirs = append(opts.ExcludeDirs, excludeDirs...)
 
 	// --- Terragrunt Version
@@ -356,18 +367,21 @@ func initialSetup(cliCtx *cli.Context, opts *options.TerragruntOptions) error {
 			return errors.WithStackTrace(err)
 		}
 	}
+
 	opts.TerragruntVersion = terragruntVersion
 	// Log the terragrunt version in debug mode. This helps with debugging issues and ensuring a specific version of terragrunt used.
 	opts.Logger.Debugf("Terragrunt Version: %s", opts.TerragruntVersion)
 
 	// --- IncludeModulePrefix
 	jsonOutput := false
+
 	for _, arg := range opts.TerraformCliArgs {
 		if strings.EqualFold(arg, "-json") {
 			jsonOutput = true
 			break
 		}
 	}
+
 	if opts.IncludeModulePrefix && !jsonOutput {
 		opts.OutputPrefix = fmt.Sprintf("[%s] ", opts.WorkingDir)
 	} else {

cli/commands/aws-provider-patch/action.go

@@ -67,6 +67,7 @@ func runAwsProviderPatch(ctx context.Context, opts *options.TerragruntOptions, c
 
 	for _, terraformFile := range terraformFilesInModules {
 		opts.Logger.Debugf("Looking at file %s", terraformFile)
+
 		originalTerraformFileContents, err := util.ReadFileAsString(terraformFile)
 		if err != nil {
 			return err
@@ -79,6 +80,7 @@ func runAwsProviderPatch(ctx context.Context, opts *options.TerragruntOptions, c
 
 		if codeWasUpdated {
 			opts.Logger.Debugf("Patching AWS provider in %s", terraformFile)
+
 			if err := util.WriteFileWithSamePermissions(terraformFile, terraformFile, []byte(updatedTerraformFileContents)); err != nil {
 				return err
 			}
@@ -191,6 +193,7 @@ func PatchAwsProviderInTerraformCode(terraformCode string, terraformFilePath str
 				if err != nil {
 					return string(hclFile.Bytes()), codeWasUpdated, err
 				}
+
 				codeWasUpdated = codeWasUpdated || attributeOverridden
 			}
 		}
@@ -257,12 +260,14 @@ func overrideAttributeInBlock(block *hclwrite.Block, key string, value string) (
 	// we maintain a mapping of all possible provider configurations (which is unmaintainable). To handle this, we
 	// assume the user provided input is json, and convert to cty that way.
 	valueBytes := []byte(value)
+
 	ctyType, err := ctyjson.ImpliedType(valueBytes)
 	if err != nil {
 		// Wrap error in a custom error type that has better error messaging to the user.
 		returnErr := TypeInferenceError{value: value, underlyingErr: err}
 		return false, errors.WithStackTrace(returnErr)
 	}
+
 	ctyVal, err := ctyjson.Unmarshal(valueBytes, ctyType)
 	if err != nil {
 		// Wrap error in a custom error type that has better error messaging to the user.
@@ -271,6 +276,7 @@ func overrideAttributeInBlock(block *hclwrite.Block, key string, value string) (
 	}
 
 	body.SetAttributeValue(attr, ctyVal)
+
 	return true, nil
 }
 
@@ -317,5 +323,6 @@ func traverseBlock(block *hclwrite.Block, keyParts []string) (*hclwrite.Body, st
 	}
 
 	blockName := keyParts[0]
+
 	return traverseBlock(block.Body().FirstMatchingBlock(blockName, nil), keyParts[1:])
 }

cli/commands/catalog/module/doc.go

@@ -40,6 +40,7 @@ func (regs DocRegs) Replace(str string) string {
 	for _, reg := range regs {
 		str = reg.ReplaceAllString(str, "$1")
 	}
+
 	return str
 }
 
@@ -149,6 +150,7 @@ func FindDoc(dir string) (*Doc, error) {
 			if strings.EqualFold(readmeFile, file.Name()) {
 				filePath = filepath.Join(dir, file.Name())
 				fileExt = filepath.Ext(filePath)
+
 				break
 			}
 		}
@@ -167,6 +169,7 @@ func FindDoc(dir string) (*Doc, error) {
 	if err != nil {
 		return nil, errors.WithStackTrace(err)
 	}
+
 	rawContent := string(contentByte)
 
 	return NewDoc(rawContent, fileExt), nil
@@ -207,6 +210,7 @@ func (doc *Doc) Description(maxLenght int) string {
 			}
 
 			desc += "."
+
 			break
 		}
 	}
@@ -265,19 +269,22 @@ func (doc *Doc) parseTag(key docDataKey) string {
 
 	if doc.tagCache == nil {
 		doc.tagCache = make(map[docDataKey]string)
+
 		var h1Body, h2Body string
 
 		for tagName, tagReg := range doc.tagRegs {
 			match := tagReg.FindStringSubmatch(doc.rawContent)
 			if len(match) == 0 {
 				continue
 			}
+
 			lines := strings.Split(match[1], "\n")
 
 			switch tagName {
 			case tagH1Block:
 				// header title
 				doc.tagCache[docTitle] = lines[0]
+
 				if len(lines) > 1 {
 					h1Body = strings.Join(lines[1:], "\n")
 				}

cli/commands/catalog/module/module.go

@@ -48,6 +48,7 @@ func NewModule(repo *Repo, moduleDir string) (*Module, error) {
 	if err != nil {
 		return nil, err
 	}
+
 	module.url = moduleURL
 
 	modulePath := filepath.Join(module.repoPath, module.moduleDir)
@@ -56,6 +57,7 @@ func NewModule(repo *Repo, moduleDir string) (*Module, error) {
 	if err != nil {
 		return nil, err
 	}
+
 	module.Doc = doc
 
 	return module, nil

cli/commands/catalog/module/repo.go

@@ -83,6 +83,7 @@ func (repo *Repo) FindModules(ctx context.Context) (Modules, error) {
 				if err != nil {
 					return err
 				}
+
 				if !remote.IsDir() {
 					return nil
 				}
@@ -103,7 +104,6 @@ func (repo *Repo) FindModules(ctx context.Context) (Modules, error) {
 		if err != nil {
 			return nil, err
 		}
-
 	}
 
 	return modules, nil
@@ -154,6 +154,7 @@ func (repo *Repo) clone(ctx context.Context) error {
 
 			log.Debugf("Converting relative path %q to absolute %q", repoPath, absRepoPath)
 		}
+
 		repo.path = repoPath
 
 		return nil
@@ -185,6 +186,7 @@ func (repo *Repo) clone(ctx context.Context) error {
 	if err != nil {
 		return err
 	}
+
 	repo.cloneURL = sourceUrl.String()
 
 	log.Infof("Cloning repository %q to temporary directory %q", repo.cloneURL, repo.path)
@@ -212,10 +214,12 @@ func (repo *Repo) parseRemoteURL() error {
 	}
 
 	var sectionName string
+
 	for _, name := range inidata.SectionStrings() {
 		if !strings.HasPrefix(name, "remote") {
 			continue
 		}
+
 		sectionName = name
 
 		if sectionName == `remote "origin"` {