feat: allow to opt out of aws accounts variable (#1002)

* feat: allow to opt out of aws accounts variable

* revert

* commit from ci -- updated golden files

* revert

* sum

---------

Co-authored-by: jakeyheath <jakeyheath@users.noreply.github.com>

config/v2/config.go

@@ -75,14 +75,15 @@ type TFE struct {
 }
 
 type Common struct {
-	Backend          *Backend          `yaml:"backend,omitempty"`
-	ExtraVars        map[string]string `yaml:"extra_vars,omitempty"`
-	Owner            *string           `yaml:"owner,omitempty"`
-	Project          *string           `yaml:"project,omitempty"`
-	Providers        *Providers        `yaml:"providers,omitempty"`
-	DependsOn        *DependsOn        `yaml:"depends_on,omitempty"`
-	TerraformVersion *string           `yaml:"terraform_version,omitempty"`
-	Tools            *Tools            `yaml:"tools,omitempty"`
+	Backend                  *Backend          `yaml:"backend,omitempty"`
+	ExtraVars                map[string]string `yaml:"extra_vars,omitempty"`
+	Owner                    *string           `yaml:"owner,omitempty"`
+	Project                  *string           `yaml:"project,omitempty"`
+	Providers                *Providers        `yaml:"providers,omitempty"`
+	DependsOn                *DependsOn        `yaml:"depends_on,omitempty"`
+	TerraformVersion         *string           `yaml:"terraform_version,omitempty"`
+	Tools                    *Tools            `yaml:"tools,omitempty"`
+	NeedsAWSAccountsVariable *bool             `yaml:"needs_aws_accounts_variable,omitempty"`
 }
 
 type Defaults struct {

config/v2/resolvers.go

@@ -308,6 +308,21 @@ func ResolveGithubProvider(commons ...Common) *GithubProvider {
 	}
 }
 
+func AWSAccountsNeededGetter(comm Common) *bool {
+	if comm.NeedsAWSAccountsVariable != nil {
+		return comm.NeedsAWSAccountsVariable
+	}
+	return nil
+}
+
+func ResolveAWSAccountsNeeded(commons ...Common) bool {
+	accountsNeeded := lastNonNilBool(AWSAccountsNeededGetter, commons...)
+	if accountsNeeded == nil {
+		return true
+	}
+	return *accountsNeeded
+}
+
 func ResolveSnowflakeProvider(commons ...Common) *SnowflakeProvider {
 	account := lastNonNil(SnowflakeProviderAccountGetter, commons...)
 	role := lastNonNil(SnowflakeProviderRoleGetter, commons...)

plan/plan.go

@@ -42,17 +42,18 @@ type Common struct {
 type ComponentCommon struct {
 	Common `yaml:",inline"`
 
-	AccountBackends       map[string]Backend         `yaml:"account_backends"`
-	Accounts              map[string]*json.Number    `yaml:"all_accounts"`
-	Backend               Backend                    `yaml:"backend"`
-	ComponentBackends     map[string]Backend         `yaml:"comonent_backends"`
-	Env                   string                     ` yaml:"env"`
-	ExtraVars             map[string]string          `yaml:"extra_vars"`
-	Name                  string                     `yaml:"name"`
-	Owner                 string                     `yaml:"owner"`
-	Project               string                     `yaml:"project"`
-	ProviderConfiguration ProviderConfiguration      `yaml:"providers_configuration"`
-	ProviderVersions      map[string]ProviderVersion `yaml:"provider_versions"`
+	AccountBackends          map[string]Backend         `yaml:"account_backends"`
+	Accounts                 map[string]*json.Number    `yaml:"all_accounts"`
+	Backend                  Backend                    `yaml:"backend"`
+	ComponentBackends        map[string]Backend         `yaml:"comonent_backends"`
+	Env                      string                     ` yaml:"env"`
+	ExtraVars                map[string]string          `yaml:"extra_vars"`
+	Name                     string                     `yaml:"name"`
+	Owner                    string                     `yaml:"owner"`
+	Project                  string                     `yaml:"project"`
+	ProviderConfiguration    ProviderConfiguration      `yaml:"providers_configuration"`
+	ProviderVersions         map[string]ProviderVersion `yaml:"provider_versions"`
+	NeedsAWSAccountsVariable bool                       `yaml:"needs_aws_accounts_variable"`
 
 	TfLint TfLint `yaml:"tf_lint"`
 
@@ -1254,7 +1255,8 @@ func resolveComponentCommon(commons ...v2.Common) ComponentCommon {
 	}
 
 	return ComponentCommon{
-		Backend: backend,
+		NeedsAWSAccountsVariable: v2.ResolveAWSAccountsNeeded(commons...),
+		Backend:                  backend,
 		ProviderConfiguration: ProviderConfiguration{
 			Assert:                 assertPlan,
 			Auth0:                  auth0Plan,

templates/templates/component/terraform/fogg.tf.tmpl

@@ -201,6 +201,7 @@ data "terraform_remote_state" "{{ $name }}" {
 }
 {{ end }}
 
+{{ if .NeedsAWSAccountsVariable }}
 # tflint-ignore: terraform_unused_declarations
 variable "aws_accounts" {
   type =  map(string)
@@ -210,3 +211,4 @@ variable "aws_accounts" {
   {{ end }}
   }
 }
+{{end}}

testdata/v2_full_yaml/fogg.yml

@@ -27,6 +27,7 @@ accounts:
         version: 0.4.2
         aws_region: us-west-2
   foo:
+    needs_aws_accounts_variable: true
     providers:
       aws:
         account_id: 123
@@ -39,6 +40,7 @@ accounts:
       accounts: []
       components: []
 defaults:
+  needs_aws_accounts_variable: false
   backend:
     bucket: buck
     profile: profile