feat: Adding govet alignment check (#4057)

* feat: Adding just `fieldalignment` lint

* fix: Blindly implementing the alignment adjustments

* fix: Addressing errors in test cases

* fix: More alignment fixes

* fix: Addressing more errors in test cases

* fix: Dropping unnecessary bottom values

* fix: Fixing accidental drift in tests

* fix: Restoring accidentally removed comments

* fix: Fixing more accidental changes from addressing the lint findings

* fix: Addressing more comment removals

* fix: Addressing more unnecessary bottom values

* fix: Addressing more removed comments

* fix: Fixing test

* fix: More test fixes

* fix: Correcting `TestNewMatchingChecksumAuthentication` breakage

* fix: Correcting `TestMatchesAny`

Author: yhakbar

.golangci.yml

@@ -30,10 +30,6 @@ linters-settings:
   goconst:
     min-len: 3
     min-occurrences: 5
-  revive:
-    min-confidence: 0.8
-  unused:
-    check-exported: false
   unparam:
     check-exported: false
   nakedret:
@@ -48,6 +44,9 @@ linters-settings:
       - performance
     disabled-tags:
       - experimental
+  govet:
+    enable:
+      - fieldalignment
 
 linters:
   enable:
@@ -82,8 +81,6 @@ linters:
     - recvcheck # In the latest version of golangci-lint this https://github.com/raeperd/recvcheck/issues/7 issue is not fixed yet.
 
   fast: false
-  mnd:
-    ignored-functions: strconv.Format*,os.*,strconv.Parse*,strings.SplitN,bytes.SplitN
   presets:
     - bugs
     - performance
@@ -93,6 +90,7 @@ linters:
     # - style
     # - complexity
 
+
 issues:
   exclude-dirs:
     - docs

.strict.golangci.yml

@@ -53,6 +53,9 @@ linters-settings:
       - performance
     disabled-tags:
       - experimental
+  govet:
+    enable:
+      - fieldalignment
 
 linters:
   enable:

awshelper/config.go

@@ -24,17 +24,17 @@ import (
 
 // AwsSessionConfig is a representation of the configuration options for an AWS Session
 type AwsSessionConfig struct {
+	Tags                    map[string]string
 	Region                  string
 	CustomS3Endpoint        string
 	CustomDynamoDBEndpoint  string
 	Profile                 string
 	RoleArn                 string
 	CredsFilename           string
-	S3ForcePathStyle        bool
-	DisableComputeChecksums bool
 	ExternalID              string
 	SessionName             string
-	Tags                    map[string]string
+	S3ForcePathStyle        bool
+	DisableComputeChecksums bool
 }
 
 // addUserAgent - Add terragrunt version to the user agent for AWS API calls.

awshelper/policy.go

@@ -13,13 +13,13 @@ type Policy struct {
 // https://docs.aws.amazon.com/IAM//latest/UserGuide/reference_policies_elements_action.html
 // https://docs.aws.amazon.com/IAM//latest/UserGuide/reference_policies_elements_resource.html
 type Statement struct {
-	Sid          string          `json:"Sid"`
-	Effect       string          `json:"Effect"`
 	Principal    any             `json:"Principal,omitempty"`
 	NotPrincipal any             `json:"NotPrincipal,omitempty"`
 	Action       any             `json:"Action"`
 	Resource     any             `json:"Resource"`
 	Condition    *map[string]any `json:"Condition,omitempty"`
+	Sid          string          `json:"Sid"`
+	Effect       string          `json:"Effect"`
 }
 
 func UnmarshalPolicy(policy string) (Policy, error) {

cli/app_test.go

@@ -287,30 +287,30 @@ func TestPatchAwsProviderInTerraformCodeHappyPath(t *testing.T) {
 	t.Parallel()
 
 	testCases := []struct {
+		attributesToOverride   map[string]string
 		testName               string
 		originalTerraformCode  string
-		attributesToOverride   map[string]string
-		expectedCodeWasUpdated bool
 		expectedTerraformCode  []string
+		expectedCodeWasUpdated bool
 	}{
-		{"empty", "", nil, false, []string{""}},
-		{"empty with attributes", "", map[string]string{"region": `"eu-west-1"`}, false, []string{""}},
-		{"no provider", terraformCodeExampleOutputOnly, map[string]string{"region": `"eu-west-1"`}, false, []string{terraformCodeExampleOutputOnly}},
-		{"no aws provider", terraformCodeExampleGcpProvider, map[string]string{"region": `"eu-west-1"`}, false, []string{terraformCodeExampleGcpProvider}},
-		{"one empty aws provider, but no overrides", terraformCodeExampleAwsProviderEmptyOriginal, nil, false, []string{terraformCodeExampleAwsProviderEmptyOriginal}},
-		{"one empty aws provider, with region override", terraformCodeExampleAwsProviderEmptyOriginal, map[string]string{"region": `"eu-west-1"`}, false, []string{terraformCodeExampleAwsProviderEmptyOriginal}},
-		{"one empty aws provider, with region, version override", terraformCodeExampleAwsProviderEmptyOriginal, map[string]string{"region": `"eu-west-1"`, "version": `"0.3.0"`}, false, []string{terraformCodeExampleAwsProviderEmptyOriginal}},
-		{"one non-empty aws provider, but no overrides", terraformCodeExampleAwsProviderNonEmptyOriginal, nil, false, []string{terraformCodeExampleAwsProviderNonEmptyOriginal}},
-		{"one non-empty aws provider, with region override", terraformCodeExampleAwsProviderNonEmptyOriginal, map[string]string{"region": `"eu-west-1"`}, true, []string{terraformCodeExampleAwsProviderRegionOverridenVersionNotOverriddenExpected}},
-		{"one non-empty aws provider, with region, version override", terraformCodeExampleAwsProviderNonEmptyOriginal, map[string]string{"region": `"eu-west-1"`, "version": `"0.3.0"`}, true, []string{terraformCodeExampleAwsProviderRegionVersionOverridenExpected, terraformCodeExampleAwsProviderRegionVersionOverridenReverseOrderExpected}},
-		{"multiple providers, but no overrides", terraformCodeExampleAwsMultipleProvidersOriginal, nil, false, []string{terraformCodeExampleAwsMultipleProvidersOriginal}},
-		{"multiple providers, with region override", terraformCodeExampleAwsMultipleProvidersOriginal, map[string]string{"region": `"eu-west-1"`}, true, []string{terraformCodeExampleAwsMultipleProvidersRegionOverridenExpected}},
-		{"multiple providers, with region, version override", terraformCodeExampleAwsMultipleProvidersOriginal, map[string]string{"region": `"eu-west-1"`, "version": `"0.3.0"`}, true, []string{terraformCodeExampleAwsMultipleProvidersRegionVersionOverridenExpected}},
-		{"multiple providers with comments, but no overrides", terraformCodeExampleAwsMultipleProvidersNonEmptyWithCommentsOriginal, nil, false, []string{terraformCodeExampleAwsMultipleProvidersNonEmptyWithCommentsOriginal}},
-		{"multiple providers with comments, with region override", terraformCodeExampleAwsMultipleProvidersNonEmptyWithCommentsOriginal, map[string]string{"region": `"eu-west-1"`}, true, []string{terraformCodeExampleAwsMultipleProvidersNonEmptyWithCommentsRegionOverriddenExpected}},
-		{"multiple providers with comments, with region, version override", terraformCodeExampleAwsMultipleProvidersNonEmptyWithCommentsOriginal, map[string]string{"region": `"eu-west-1"`, "version": `"0.3.0"`}, true, []string{terraformCodeExampleAwsMultipleProvidersNonEmptyWithCommentsRegionVersionOverriddenExpected}},
-		{"one provider with nested blocks, with region and role_arn override", terraformCodeExampleAwsOneProviderNestedBlocks, map[string]string{"region": `"eu-west-1"`, "assume_role.role_arn": `"nested-override"`}, true, []string{terraformCodeExampleAwsOneProviderNestedBlocksRegionRoleArnExpected}},
-		{"one provider with nested blocks, with region and role_arn override, plus non-matching overrides", terraformCodeExampleAwsOneProviderNestedBlocks, map[string]string{"region": `"eu-west-1"`, "assume_role.role_arn": `"nested-override"`, "should-be": `"ignored"`, "assume_role.should-be": `"ignored"`}, true, []string{terraformCodeExampleAwsOneProviderNestedBlocksRegionRoleArnExpected}},
+		{testName: "empty", originalTerraformCode: "", attributesToOverride: nil, expectedCodeWasUpdated: false, expectedTerraformCode: []string{""}},
+		{testName: "empty with attributes", originalTerraformCode: "", attributesToOverride: map[string]string{"region": `"eu-west-1"`}, expectedCodeWasUpdated: false, expectedTerraformCode: []string{""}},
+		{testName: "no provider", originalTerraformCode: terraformCodeExampleOutputOnly, attributesToOverride: map[string]string{"region": `"eu-west-1"`}, expectedCodeWasUpdated: false, expectedTerraformCode: []string{terraformCodeExampleOutputOnly}},
+		{testName: "no aws provider", originalTerraformCode: terraformCodeExampleGcpProvider, attributesToOverride: map[string]string{"region": `"eu-west-1"`}, expectedCodeWasUpdated: false, expectedTerraformCode: []string{terraformCodeExampleGcpProvider}},
+		{testName: "one empty aws provider, but no overrides", originalTerraformCode: terraformCodeExampleAwsProviderEmptyOriginal, attributesToOverride: nil, expectedCodeWasUpdated: false, expectedTerraformCode: []string{terraformCodeExampleAwsProviderEmptyOriginal}},
+		{testName: "one empty aws provider, with region override", originalTerraformCode: terraformCodeExampleAwsProviderEmptyOriginal, attributesToOverride: map[string]string{"region": `"eu-west-1"`}, expectedCodeWasUpdated: false, expectedTerraformCode: []string{terraformCodeExampleAwsProviderEmptyOriginal}},
+		{testName: "one empty aws provider, with region, version override", originalTerraformCode: terraformCodeExampleAwsProviderEmptyOriginal, attributesToOverride: map[string]string{"region": `"eu-west-1"`, "version": `"0.3.0"`}, expectedCodeWasUpdated: false, expectedTerraformCode: []string{terraformCodeExampleAwsProviderEmptyOriginal}},
+		{testName: "one non-empty aws provider, but no overrides", originalTerraformCode: terraformCodeExampleAwsProviderNonEmptyOriginal, attributesToOverride: nil, expectedCodeWasUpdated: false, expectedTerraformCode: []string{terraformCodeExampleAwsProviderNonEmptyOriginal}},
+		{testName: "one non-empty aws provider, with region override", originalTerraformCode: terraformCodeExampleAwsProviderNonEmptyOriginal, attributesToOverride: map[string]string{"region": `"eu-west-1"`}, expectedCodeWasUpdated: true, expectedTerraformCode: []string{terraformCodeExampleAwsProviderRegionOverridenVersionNotOverriddenExpected}},
+		{testName: "one non-empty aws provider, with region, version override", originalTerraformCode: terraformCodeExampleAwsProviderNonEmptyOriginal, attributesToOverride: map[string]string{"region": `"eu-west-1"`, "version": `"0.3.0"`}, expectedCodeWasUpdated: true, expectedTerraformCode: []string{terraformCodeExampleAwsProviderRegionVersionOverridenExpected, terraformCodeExampleAwsProviderRegionVersionOverridenReverseOrderExpected}},
+		{testName: "multiple providers, but no overrides", originalTerraformCode: terraformCodeExampleAwsMultipleProvidersOriginal, attributesToOverride: nil, expectedCodeWasUpdated: false, expectedTerraformCode: []string{terraformCodeExampleAwsMultipleProvidersOriginal}},
+		{testName: "multiple providers, with region override", originalTerraformCode: terraformCodeExampleAwsMultipleProvidersOriginal, attributesToOverride: map[string]string{"region": `"eu-west-1"`}, expectedCodeWasUpdated: true, expectedTerraformCode: []string{terraformCodeExampleAwsMultipleProvidersRegionOverridenExpected}},
+		{testName: "multiple providers, with region, version override", originalTerraformCode: terraformCodeExampleAwsMultipleProvidersOriginal, attributesToOverride: map[string]string{"region": `"eu-west-1"`, "version": `"0.3.0"`}, expectedCodeWasUpdated: true, expectedTerraformCode: []string{terraformCodeExampleAwsMultipleProvidersRegionVersionOverridenExpected}},
+		{testName: "multiple providers with comments, but no overrides", originalTerraformCode: terraformCodeExampleAwsMultipleProvidersNonEmptyWithCommentsOriginal, attributesToOverride: nil, expectedCodeWasUpdated: false, expectedTerraformCode: []string{terraformCodeExampleAwsMultipleProvidersNonEmptyWithCommentsOriginal}},
+		{testName: "multiple providers with comments, with region override", originalTerraformCode: terraformCodeExampleAwsMultipleProvidersNonEmptyWithCommentsOriginal, attributesToOverride: map[string]string{"region": `"eu-west-1"`}, expectedCodeWasUpdated: true, expectedTerraformCode: []string{terraformCodeExampleAwsMultipleProvidersNonEmptyWithCommentsRegionOverriddenExpected}},
+		{testName: "multiple providers with comments, with region, version override", originalTerraformCode: terraformCodeExampleAwsMultipleProvidersNonEmptyWithCommentsOriginal, attributesToOverride: map[string]string{"region": `"eu-west-1"`, "version": `"0.3.0"`}, expectedCodeWasUpdated: true, expectedTerraformCode: []string{terraformCodeExampleAwsMultipleProvidersNonEmptyWithCommentsRegionVersionOverriddenExpected}},
+		{testName: "one provider with nested blocks, with region and role_arn override", originalTerraformCode: terraformCodeExampleAwsOneProviderNestedBlocks, attributesToOverride: map[string]string{"region": `"eu-west-1"`, "assume_role.role_arn": `"nested-override"`}, expectedCodeWasUpdated: true, expectedTerraformCode: []string{terraformCodeExampleAwsOneProviderNestedBlocksRegionRoleArnExpected}},
+		{testName: "one provider with nested blocks, with region and role_arn override, plus non-matching overrides", originalTerraformCode: terraformCodeExampleAwsOneProviderNestedBlocks, attributesToOverride: map[string]string{"region": `"eu-west-1"`, "assume_role.role_arn": `"nested-override"`, "should-be": `"ignored"`, "assume_role.should-be": `"ignored"`}, expectedCodeWasUpdated: true, expectedTerraformCode: []string{terraformCodeExampleAwsOneProviderNestedBlocksRegionRoleArnExpected}},
 	}
 
 	for _, testCase := range testCases {

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

@@ -9,8 +9,8 @@ func (flagName MissingOverrideAttrError) Error() string {
 }
 
 type TypeInferenceError struct {
-	value         string
 	underlyingErr error
+	value         string
 }
 
 func (err TypeInferenceError) Error() string {
@@ -19,8 +19,8 @@ func (err TypeInferenceError) Error() string {
 }
 
 type MalformedJSONValError struct {
-	value         string
 	underlyingErr error
+	value         string
 }
 
 func (err MalformedJSONValError) Error() string {

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

@@ -45,15 +45,13 @@ func (regs DocRegs) Replace(str string) string {
 }
 
 type Doc struct {
-	rawContent string
-	fileExt    string
-
-	tagCache     map[docDataKey]string
-	tagRegs      map[docTagName]*regexp.Regexp
-	tagStripRegs DocRegs
-
+	tagCache         map[docDataKey]string
+	tagRegs          map[docTagName]*regexp.Regexp
 	frontmatterCache map[docDataKey]string
 	frontmatterReg   *regexp.Regexp
+	rawContent       string
+	fileExt          string
+	tagStripRegs     DocRegs
 }
 
 func NewDoc(rawContent, fileExt string) *Doc {

cli/commands/catalog/module/doc.go

@@ -184,37 +184,37 @@ func TestElement(t *testing.T) {
 	testCases := []struct {
 		content              string
 		fileExt              string
-		maxDescriptionLength int
 		expectedTitle        string
 		expectedDescription  string
+		maxDescriptionLength int
 	}{
 		{
-			testH1EksK8sArgocd,
-			".md",
-			200,
-			"EKS K8s GitOps Module",
-			"This module deploys Argo CD to an EKS cluster. Argo CD is a declarative GitOps continuous delivery tool for Kubernetes. See the Argo CD for more details.",
+			content:              testH1EksK8sArgocd,
+			fileExt:              ".md",
+			maxDescriptionLength: 200,
+			expectedTitle:        "EKS K8s GitOps Module",
+			expectedDescription:  "This module deploys Argo CD to an EKS cluster. Argo CD is a declarative GitOps continuous delivery tool for Kubernetes. See the Argo CD for more details.",
 		},
 		{
-			testH1EksCloudwatchAgent,
-			".md",
-			200,
-			"EKS CloudWatch Agent Module",
-			"This Terraform Module installs and configures Amazon CloudWatch Agent on an EKS cluster, so that each node runs the agent to collect more system-level metrics from Amazon EC2 instances and ship them to Amazon CloudWatch.",
+			content:              testH1EksCloudwatchAgent,
+			fileExt:              ".md",
+			maxDescriptionLength: 200,
+			expectedTitle:        "EKS CloudWatch Agent Module",
+			expectedDescription:  "This Terraform Module installs and configures Amazon CloudWatch Agent on an EKS cluster, so that each node runs the agent to collect more system-level metrics from Amazon EC2 instances and ship them to Amazon CloudWatch.",
 		},
 		{
-			testH1EcsCluster,
-			".md",
-			200,
-			"Amazon ECS Cluster",
-			"This service contains Terraform code to deploy a production-grade ECS cluster on AWS using Elastic Container Service (ECS).",
+			content:              testH1EcsCluster,
+			fileExt:              ".md",
+			maxDescriptionLength: 200,
+			expectedTitle:        "Amazon ECS Cluster",
+			expectedDescription:  "This service contains Terraform code to deploy a production-grade ECS cluster on AWS using Elastic Container Service (ECS).",
 		},
 		{
-			testH1EksAWSAuthMerger,
-			".adoc",
-			200,
-			"EKS AWS Auth Merger",
-			"This module contains a go CLI, docker container, and terraform module for deploying a Kubernetes controller for managing mappings between AWS IAM roles and users to RBAC groups in Kubernetes.",
+			content:              testH1EksAWSAuthMerger,
+			fileExt:              ".adoc",
+			maxDescriptionLength: 200,
+			expectedTitle:        "EKS AWS Auth Merger",
+			expectedDescription:  "This module contains a go CLI, docker container, and terraform module for deploying a Kubernetes controller for managing mappings between AWS IAM roles and users to RBAC groups in Kubernetes.",
 		},
 	}
 

cli/commands/catalog/module/doc_test.go

@@ -170,10 +170,10 @@ func (repo *Repo) ModuleURL(moduleDir string) (string, error) {
 }
 
 type CloneOptions struct {
-	SourceURL  string
-	TargetPath string
 	Context    context.Context
 	Logger     log.Logger
+	SourceURL  string
+	TargetPath string
 }
 
 func (repo *Repo) clone(ctx context.Context, l log.Logger) error {