chore: Expanding lll coverage to codegen

Author: yhakbar

.golangci.yml

@@ -121,7 +121,7 @@ linters:
       # trying to get this merged in.
       - linters:
           - lll
-        path-except: '^(internal/awshelper/|internal/cas/|internal/cli/commands/(backend/(delete|migrate)|catalog/tui/command|dag/graph|exec|find|help|list|scaffold|stack)/|internal/cloner/|internal/configbridge/|internal/engine/|internal/errorconfig/|internal/errors/|internal/experiment/|internal/gcphelper/|internal/git/|internal/os/exec/|internal/prepare/|internal/queue/|internal/report/|internal/retry/|internal/runner/(common|graph|run/creds|runall|runcfg)/|internal/stacks/(generate|output)/|internal/telemetry/|internal/tf/cache/(controllers|middleware)/|internal/tflint/|internal/tips/|internal/vfs/|internal/worktrees/|pkg/log/(format/(options|placeholders)|writer)/|pkg/options/)'
+        path-except: '^(internal/awshelper/|internal/cas/|internal/cli/commands/(backend/(delete|migrate)|catalog/tui/command|dag/graph|exec|find|help|list|scaffold|stack)/|internal/cloner/|internal/codegen/|internal/configbridge/|internal/engine/|internal/errorconfig/|internal/errors/|internal/experiment/|internal/gcphelper/|internal/git/|internal/os/exec/|internal/prepare/|internal/queue/|internal/report/|internal/retry/|internal/runner/(common|graph|run/creds|runall|runcfg)/|internal/stacks/(generate|output)/|internal/telemetry/|internal/tf/cache/(controllers|middleware)/|internal/tflint/|internal/tips/|internal/vfs/|internal/worktrees/|pkg/log/(format/(options|placeholders)|writer)/|pkg/options/)'
     paths:
       - docs
       - _ci

internal/codegen/generate.go

@@ -178,13 +178,15 @@ func shouldContinueWithFileExists(l log.Logger, path string, ifExists GenerateCo
 		return false, errors.New(GenerateFileExistsError{path: path})
 	case ExistsSkip:
 		// Do nothing since file exists and skip was configured
-		l.Debugf("The file path %s already exists and if_exists for code generation set to \"skip\". Will not regenerate file.", path)
+		l.Debugf("The file path %s already exists and if_exists for code generation"+
+			" set to \"skip\". Will not regenerate file.", path)
 
 		return false, nil
 	case ExistsOverwrite:
 		// We will continue to proceed to generate file, but log a message to indicate that we detected the file
 		// exists.
-		l.Debugf("The file path %s already exists and if_exists for code generation set to \"overwrite\". Regenerating file.", path)
+		l.Debugf("The file path %s already exists and if_exists for code generation"+
+			" set to \"overwrite\". Regenerating file.", path)
 
 		return true, nil
 	case ExistsOverwriteTerragrunt:
@@ -202,7 +204,9 @@ func shouldContinueWithFileExists(l log.Logger, path string, ifExists GenerateCo
 		}
 
 		// Since file was generated by terragrunt, continue.
-		l.Debugf("The file path %s already exists, but was a previously generated file by terragrunt. Since if_exists for code generation is set to \"overwrite_terragrunt\", regenerating file.", path)
+		l.Debugf("The file path %s already exists, but was a previously generated"+
+			" file by terragrunt. Since if_exists for code generation is set to"+
+			" \"overwrite_terragrunt\", regenerating file.", path)
 
 		return true, nil
 	default:
@@ -217,14 +221,20 @@ func shouldRemoveWithFileExists(l log.Logger, path string, ifDisable GenerateCon
 	switch ifDisable { //nolint:exhaustive
 	case DisabledSkip:
 		// Do nothing since skip was configured.
-		l.Debugf("The file path %s already exists and if_disabled for code generation set to \"skip\", will not remove file.", path)
+		l.Debugf("The file path %s already exists and if_disabled for code"+
+			" generation set to \"skip\", will not remove file.", path)
+
 		return false, nil
 	case DisabledRemove:
 		// The file exists and will be removed.
-		l.Debugf("The file path %s already exists and if_disabled for code generation set to \"remove\", removing file.", path)
+		l.Debugf("The file path %s already exists and if_disabled for code"+
+			" generation set to \"remove\", removing file.", path)
+
 		return true, nil
 	case DisabledRemoveTerragrunt:
-		// If file was not generated, error out because remove_terragrunt if_disabled setting only handles if the existing file was generated by terragrunt.
+		// If file was not generated, error out because remove_terragrunt
+		// if_disabled setting only handles if the existing file was
+		// generated by terragrunt.
 		wasGenerated, err := fileWasGeneratedByTerragrunt(path)
 		if err != nil {
 			return false, err
@@ -237,7 +247,9 @@ func shouldRemoveWithFileExists(l log.Logger, path string, ifDisable GenerateCon
 		}
 
 		// Since file was generated by terragrunt, removing.
-		l.Debugf("The file path %s already exists, but was a previously generated file by terragrunt. Since if_disabled for code generation is set to \"remove_terragrunt\", removing file.", path)
+		l.Debugf("The file path %s already exists, but was a previously generated"+
+			" file by terragrunt. Since if_disabled for code generation is set"+
+			" to \"remove_terragrunt\", removing file.", path)
 
 		return true, nil
 	default:
@@ -271,8 +283,14 @@ const (
 	backendBlock   = "backend"
 )
 
-// RemoteStateConfigToTerraformCode converts the arbitrary map that represents a remote state config into HCL code to configure that remote state.
-func RemoteStateConfigToTerraformCode(backend string, config map[string]any, encryption map[string]any) ([]byte, error) {
+// RemoteStateConfigToTerraformCode converts the arbitrary map that
+// represents a remote state config into HCL code to configure that
+// remote state.
+func RemoteStateConfigToTerraformCode(
+	backend string,
+	config map[string]any,
+	encryption map[string]any,
+) ([]byte, error) {
 	f := hclwrite.NewEmptyFile()
 	terraformBlock := f.Body().AppendNewBlock(terraformBlock, nil).Body()
 	backendBlock := terraformBlock.AppendNewBlock(backendBlock, []string{backend})
@@ -479,10 +497,17 @@ func RemoteStateConfigToTerraformCode(backend string, config map[string]any, enc
 	encryptionBlockBody := encryptionBlock.Body()
 
 	// Append key_provider block
-	keyProviderBlockBody := encryptionBlockBody.AppendNewBlock(EncryptionKeyProviderKey, []string{keyProvider, encryptionResourceName}).Body()
+	keyProviderBlock := encryptionBlockBody.AppendNewBlock(
+		EncryptionKeyProviderKey,
+		[]string{keyProvider, encryptionResourceName},
+	)
+	keyProviderBlockBody := keyProviderBlock.Body()
 
 	// Append method block
-	methodBlock := encryptionBlockBody.AppendNewBlock(encryptionMethodKey, []string{encryptionDefaultMethod, encryptionResourceName}).Body()
+	methodBlock := encryptionBlockBody.AppendNewBlock(
+		encryptionMethodKey,
+		[]string{encryptionDefaultMethod, encryptionResourceName},
+	).Body()
 	methodBlock.SetAttributeTraversal(encryptionKeysAttributeName, keyProviderTraversal)
 
 	// Append state block
@@ -596,7 +621,9 @@ func GenerateConfigExistsFromString(val string) (GenerateConfigExists, error) {
 	return ExistsUnknown, errors.New(UnknownGenerateIfExistsVal{val: val})
 }
 
-// GenerateConfigDisabledFromString converts a string representation of if_disabled into the enum, returning an error if it is not set to one of the known values.
+// GenerateConfigDisabledFromString converts a string representation of
+// if_disabled into the enum, returning an error if it is not set to one
+// of the known values.
 func GenerateConfigDisabledFromString(val string) (GenerateConfigDisabled, error) {
 	switch val {
 	case DisabledSkipStr:

internal/codegen/generate_test.go

@@ -156,8 +156,14 @@ func TestRemoteStateConfigToTerraformCode(t *testing.T) {
 			"s3-backend-with-assume-role",
 			"s3",
 			map[string]any{
-				"bucket":      "mybucket",
-				"assume_role": "{role_arn=\"arn:aws:iam::123456789012:role/MyRole\",tags={key=\"value\"}, duration=\"1h30m\", external_id=\"123456789012\", policy=\"{}\", policy_arns=[\"arn:aws:iam::123456789012:policy/MyPolicy\"], session_name=\"MySession\", source_identity=\"123456789012\", transitive_tag_keys=[\"key\"]}",
+				"bucket": "mybucket",
+				"assume_role": "{role_arn=\"arn:aws:iam::123456789012:role/MyRole\"," +
+					"tags={key=\"value\"}, duration=\"1h30m\", " +
+					"external_id=\"123456789012\", policy=\"{}\", " +
+					"policy_arns=[\"arn:aws:iam::123456789012:policy/MyPolicy\"], " +
+					"session_name=\"MySession\", " +
+					"source_identity=\"123456789012\", " +
+					"transitive_tag_keys=[\"key\"]}",
 			},
 			map[string]any{},
 			expectedS3WithAssumeRole,
@@ -167,8 +173,16 @@ func TestRemoteStateConfigToTerraformCode(t *testing.T) {
 			"s3-backend-with-assume-role-with-web-identity",
 			"s3",
 			map[string]any{
-				"bucket":                        "mybucket",
-				"assume_role_with_web_identity": "{role_arn=\"arn:aws:iam::123456789012:role/MyRole\",duration=\"1h30m\", policy=\"{}\", policy_arns=[\"arn:aws:iam::123456789012:policy/MyPolicy\"], session_name=\"MySession\", web_identity_token=\"123456789012\", web_identity_token_file=\"/path/to/web_identity_token_file\"}",
+				"bucket": "mybucket",
+				"assume_role_with_web_identity": "{role_arn=" +
+					"\"arn:aws:iam::123456789012:role/MyRole\"," +
+					"duration=\"1h30m\", policy=\"{}\", " +
+					"policy_arns=[\"arn:aws:iam::123456789012" +
+					":policy/MyPolicy\"], " +
+					"session_name=\"MySession\", " +
+					"web_identity_token=\"123456789012\", " +
+					"web_identity_token_file=" +
+					"\"/path/to/web_identity_token_file\"}",
 			},
 			map[string]any{},
 			expectedS3WithAssumeRoleWithWebIdentity,