Update auto-readme. Update examples and tests (#43)

Nuru · web-flow · commit b07efab6b237 · 2021-11-30T09:49:38.000-08:00
diff --git a/.github/auto-release.yml b/.github/auto-release.yml
@@ -47,7 +47,7 @@ template: |
 
 replacers:
 # Remove irrelevant information from Renovate bot
-- search: '/(?<=---\s+)+^#.*(Renovate configuration|Configuration)(?:.|\n)*?This PR has been generated .*/gm'
+- search: '/(?<=---\s)\s*^#.*(Renovate configuration|Configuration)(?:.|\n)*?This PR has been generated .*/gm'
   replace: ''
 # Remove Renovate bot banner image
 - search: '/\[!\[[^\]]*Renovate\][^\]]*\](\([^)]*\))?\s*\n+/gm'
diff --git a/.github/workflows/auto-readme.yml b/.github/workflows/auto-readme.yml
@@ -19,9 +19,13 @@ jobs:
       run: |
         make init
         make readme/build
+        # Ignore changes if they are only whitespace
+        git diff --ignore-all-space --ignore-blank-lines --quiet README.md && git restore README.md
 
     - name: Create Pull Request
-      uses: cloudposse/actions/github/create-pull-request@0.20.0
+      # This action will not create or change a pull request if there are no changes to make.
+      # If a PR of the auto-update/readme branch is open, this action will just update it, not create a new PR.
+      uses: cloudposse/actions/github/create-pull-request@0.30.0
       with:
         token: ${{ secrets.PUBLIC_REPO_ACCESS_TOKEN }}
         commit-message: Update README.md and docs
@@ -38,4 +42,5 @@ jobs:
         delete-branch: true
         labels: |
           auto-update
+          no-release
           readme
diff --git a/README.md b/README.md
@@ -346,13 +346,13 @@ Available targets:
 | <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.13.0 |
 | <a name="requirement_external"></a> [external](#requirement\_external) | >= 2.0 |
 | <a name="requirement_local"></a> [local](#requirement\_local) | >= 1.3 |
-| <a name="requirement_utils"></a> [utils](#requirement\_utils) | >= 0.17.4 |
+| <a name="requirement_utils"></a> [utils](#requirement\_utils) | >= 0.17.7 |
 
 ## Providers
 
 | Name | Version |
 |------|---------|
-| <a name="provider_utils"></a> [utils](#provider\_utils) | >= 0.17.4 |
+| <a name="provider_utils"></a> [utils](#provider\_utils) | >= 0.17.7 |
 
 ## Modules
 
diff --git a/docs/terraform.md b/docs/terraform.md
@@ -6,13 +6,13 @@
 | <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.13.0 |
 | <a name="requirement_external"></a> [external](#requirement\_external) | >= 2.0 |
 | <a name="requirement_local"></a> [local](#requirement\_local) | >= 1.3 |
-| <a name="requirement_utils"></a> [utils](#requirement\_utils) | >= 0.17.4 |
+| <a name="requirement_utils"></a> [utils](#requirement\_utils) | >= 0.17.7 |
 
 ## Providers
 
 | Name | Version |
 |------|---------|
-| <a name="provider_utils"></a> [utils](#provider\_utils) | >= 0.17.4 |
+| <a name="provider_utils"></a> [utils](#provider\_utils) | >= 0.17.7 |
 
 ## Modules
 
diff --git a/examples/complete/versions.tf b/examples/complete/versions.tf
@@ -12,7 +12,7 @@ terraform {
     }
     utils = {
       source  = "cloudposse/utils"
-      version = ">= 0.17.4"
+      version = ">= 0.17.7"
     }
   }
 }
diff --git a/examples/remote-state/stacks/catalog/terraform/test-component-override.yaml b/examples/remote-state/stacks/catalog/terraform/test-component-override.yaml
@@ -15,22 +15,16 @@ components:
       # In this example, variables for each service are overridden in `catalog/services/service-?-override.*`
       component: "test/test-component"
       # Other variables can be overridden here
-      vars: { }
-      # Override backend for this component
-      backend_type: static # s3, remote, vault, static, etc.
-      backend:
-        static:
-          val1: 1
-          val2: "2"
-          val3: true
-          val4: ""
-          val5: null
+      vars: {}
+      env:
+        TEST_ENV_VAR1: "val1-override"
+        TEST_ENV_VAR3: "val3-override"
+        TEST_ENV_VAR4: "val4"
       # Override remote state backend for this component
       remote_state_backend_type: static # s3, remote, vault, static, etc.
       remote_state_backend:
         static:
-          val1: 1
+          val1: true
           val2: "2"
-          val3: true
-          val4: ""
-          val5: 5
+          val3: 3
+          val4: null
diff --git a/examples/remote-state/stacks/catalog/terraform/test-component.yaml b/examples/remote-state/stacks/catalog/terraform/test-component.yaml
@@ -9,14 +9,12 @@ import:
 components:
   terraform:
     "test/test-component":
-      backend:
-        s3:
-          workspace_key_prefix: test-test-component
-      remote_state_backend:
-        s3:
-          workspace_key_prefix: test-test-component
       settings:
         spacelift:
           workspace_enabled: true
       vars:
         enabled: true
+      env:
+        TEST_ENV_VAR1: "val1"
+        TEST_ENV_VAR2: "val2"
+        TEST_ENV_VAR3: "val3"
diff --git a/examples/remote-state/stacks/catalog/terraform/top-level-component1.yaml b/examples/remote-state/stacks/catalog/terraform/top-level-component1.yaml
@@ -9,12 +9,6 @@ import:
 components:
   terraform:
     top-level-component1:
-      backend:
-        s3:
-          workspace_key_prefix: top-level-component1
-      remote_state_backend:
-        s3:
-          workspace_key_prefix: top-level-component1
       settings:
         spacelift:
           workspace_enabled: true
diff --git a/examples/remote-state/stacks/catalog/terraform/vpc.yaml b/examples/remote-state/stacks/catalog/terraform/vpc.yaml
@@ -4,9 +4,6 @@ components:
       backend:
         s3:
           workspace_key_prefix: infra-vpc
-      remote_state_backend:
-        s3:
-          workspace_key_prefix: infra-vpc
       settings:
         spacelift:
           workspace_enabled: true
diff --git a/examples/remote-state/stacks/globals/globals.yaml b/examples/remote-state/stacks/globals/globals.yaml
@@ -4,29 +4,22 @@ vars:
 terraform:
   vars: {}
 
-  backend_type: s3 # s3, remote, vault, etc.
+  backend_type: s3 # s3, remote, vault, static, etc.
   backend:
     s3:
       encrypt: true
       bucket: "eg-ue2-root-tfstate"
       key: "terraform.tfstate"
       dynamodb_table: "eg-ue2-root-tfstate-lock"
-      profile: "eg-gbl-root-terraform"
       acl: "bucket-owner-full-control"
       region: "us-east-2"
+      role_arn: null
     remote:
     vault:
 
-  remote_state_backend_type: s3 # s3, remote, vault, static, etc.
   remote_state_backend:
     s3:
-      encrypt: true
-      bucket: "eg-ue2-root-tfstate"
-      key: "terraform.tfstate"
-      dynamodb_table: "eg-ue2-root-tfstate-lock"
-      profile: "eg-gbl-root-terraform"
-      acl: "bucket-owner-full-control"
-      region: "us-east-2"
+      role_arn: "arn:aws:iam::123456789012:role/eg-gbl-root-terraform"
 
 helmfile:
   vars: {}
diff --git a/examples/remote-state/versions.tf b/examples/remote-state/versions.tf
@@ -12,7 +12,7 @@ terraform {
     }
     utils = {
       source  = "cloudposse/utils"
-      version = ">= 0.17.4"
+      version = ">= 0.17.7"
     }
   }
 }
diff --git a/examples/spacelift/stacks/catalog/terraform/test-component-override.yaml b/examples/spacelift/stacks/catalog/terraform/test-component-override.yaml
@@ -16,6 +16,10 @@ components:
       component: "test/test-component"
       # Other variables can be overridden here
       vars: {}
+      env:
+        TEST_ENV_VAR1: "val1-override"
+        TEST_ENV_VAR3: "val3-override"
+        TEST_ENV_VAR4: "val4"
       # Override remote state backend for this component
       remote_state_backend_type: static # s3, remote, vault, static, etc.
       remote_state_backend:
diff --git a/examples/spacelift/stacks/catalog/terraform/test-component.yaml b/examples/spacelift/stacks/catalog/terraform/test-component.yaml
@@ -9,14 +9,12 @@ import:
 components:
   terraform:
     "test/test-component":
-      backend:
-        s3:
-          workspace_key_prefix: test-test-component
-      remote_state_backend:
-        s3:
-          workspace_key_prefix: test-test-component
       settings:
         spacelift:
           workspace_enabled: true
       vars:
         enabled: true
+      env:
+        TEST_ENV_VAR1: "val1"
+        TEST_ENV_VAR2: "val2"
+        TEST_ENV_VAR3: "val3"
diff --git a/examples/spacelift/stacks/catalog/terraform/top-level-component1.yaml b/examples/spacelift/stacks/catalog/terraform/top-level-component1.yaml
@@ -9,12 +9,6 @@ import:
 components:
   terraform:
     top-level-component1:
-      backend:
-        s3:
-          workspace_key_prefix: top-level-component1
-      remote_state_backend:
-        s3:
-          workspace_key_prefix: top-level-component1
       settings:
         spacelift:
           workspace_enabled: true
diff --git a/examples/spacelift/stacks/catalog/terraform/vpc.yaml b/examples/spacelift/stacks/catalog/terraform/vpc.yaml
@@ -4,9 +4,6 @@ components:
       backend:
         s3:
           workspace_key_prefix: infra-vpc
-      remote_state_backend:
-        s3:
-          workspace_key_prefix: infra-vpc
       settings:
         spacelift:
           workspace_enabled: true
diff --git a/examples/spacelift/stacks/globals/globals.yaml b/examples/spacelift/stacks/globals/globals.yaml
@@ -13,19 +13,13 @@ terraform:
       dynamodb_table: "eg-ue2-root-tfstate-lock"
       acl: "bucket-owner-full-control"
       region: "us-east-2"
+      role_arn: null
     remote:
     vault:
 
-  remote_state_backend_type: s3 # s3, remote, vault, static, etc.
   remote_state_backend:
     s3:
-      encrypt: true
-      bucket: "eg-ue2-root-tfstate"
-      key: "terraform.tfstate"
-      dynamodb_table: "eg-ue2-root-tfstate-lock"
-      profile: "eg-gbl-root-terraform"
-      acl: "bucket-owner-full-control"
-      region: "us-east-2"
+      role_arn: "arn:aws:iam::123456789012:role/eg-gbl-root-terraform"
 
 helmfile:
   vars: {}
diff --git a/examples/spacelift/versions.tf b/examples/spacelift/versions.tf
@@ -12,7 +12,7 @@ terraform {
     }
     utils = {
       source  = "cloudposse/utils"
-      version = ">= 0.17.4"
+      version = ">= 0.17.7"
     }
   }
 }
diff --git a/examples/stack/versions.tf b/examples/stack/versions.tf
@@ -12,7 +12,7 @@ terraform {
     }
     utils = {
       source  = "cloudposse/utils"
-      version = ">= 0.17.4"
+      version = ">= 0.17.7"
     }
   }
 }
diff --git a/examples/stacks/versions.tf b/examples/stacks/versions.tf
@@ -12,7 +12,7 @@ terraform {
     }
     utils = {
       source  = "cloudposse/utils"
-      version = ">= 0.17.4"
+      version = ">= 0.17.7"
     }
   }
 }
diff --git a/modules/backend/versions.tf b/modules/backend/versions.tf
@@ -12,7 +12,7 @@ terraform {
     }
     utils = {
       source  = "cloudposse/utils"
-      version = ">= 0.17.4"
+      version = ">= 0.17.7"
     }
   }
 }
diff --git a/modules/env/versions.tf b/modules/env/versions.tf
@@ -12,7 +12,7 @@ terraform {
     }
     utils = {
       source  = "cloudposse/utils"
-      version = ">= 0.17.4"
+      version = ">= 0.17.7"
     }
   }
 }
diff --git a/modules/remote-state/versions.tf b/modules/remote-state/versions.tf
@@ -12,7 +12,7 @@ terraform {
     }
     utils = {
       source  = "cloudposse/utils"
-      version = ">= 0.17.4"
+      version = ">= 0.17.7"
     }
   }
 }
diff --git a/modules/settings/versions.tf b/modules/settings/versions.tf
@@ -12,7 +12,7 @@ terraform {
     }
     utils = {
       source  = "cloudposse/utils"
-      version = ">= 0.17.4"
+      version = ">= 0.17.7"
     }
   }
 }
diff --git a/modules/spacelift/versions.tf b/modules/spacelift/versions.tf
@@ -12,7 +12,7 @@ terraform {
     }
     utils = {
       source  = "cloudposse/utils"
-      version = ">= 0.17.4"
+      version = ">= 0.17.7"
     }
   }
 }
diff --git a/modules/vars/versions.tf b/modules/vars/versions.tf
@@ -12,7 +12,7 @@ terraform {
     }
     utils = {
       source  = "cloudposse/utils"
-      version = ">= 0.17.4"
+      version = ">= 0.17.7"
     }
   }
 }
diff --git a/test/src/examples_remote_state_test.go b/test/src/examples_remote_state_test.go
@@ -32,20 +32,18 @@ func TestExamplesRemoteState(t *testing.T) {
 
 	// Verify we're getting back the outputs we expect
 	assert.NotNilf(t, remoteStateUsingStack, "remote state is empty")
-	assert.Equal(t, float64(1), remoteStateUsingStack["val1"])
+	assert.Equal(t, true, remoteStateUsingStack["val1"])
 	assert.Equal(t, "2", remoteStateUsingStack["val2"])
-	assert.Equal(t, true, remoteStateUsingStack["val3"])
-	assert.Equal(t, "", remoteStateUsingStack["val4"])
-	assert.Equal(t, float64(5), remoteStateUsingStack["val5"])
+	assert.Equal(t, float64(3), remoteStateUsingStack["val3"])
+	assert.Equal(t, nil, remoteStateUsingStack["val4"])
 
 	terraform.OutputStruct(t, terraformOptions, "remote_state_using_context", &output)
 	remoteStateUsingContext := output.(map[string]interface{})
 
 	// Verify we're getting back the outputs we expect
 	assert.NotNilf(t, remoteStateUsingContext, "remote state is empty")
-	assert.Equal(t, float64(1), remoteStateUsingContext["val1"])
+	assert.Equal(t, true, remoteStateUsingContext["val1"])
 	assert.Equal(t, "2", remoteStateUsingContext["val2"])
-	assert.Equal(t, true, remoteStateUsingContext["val3"])
-	assert.Equal(t, "", remoteStateUsingContext["val4"])
-	assert.Equal(t, float64(5), remoteStateUsingContext["val5"])
+	assert.Equal(t, float64(3), remoteStateUsingContext["val3"])
+	assert.Equal(t, nil, remoteStateUsingContext["val4"])
 }
diff --git a/test/src/examples_spacelift_test.go b/test/src/examples_spacelift_test.go
@@ -33,20 +33,20 @@ func TestExamplesSpacelift(t *testing.T) {
 	assert.Equal(t, 24, len(spaceliftStacks))
 
 	tenant1Ue2DevInfraVpcStack := spaceliftStacks["tenant1-ue2-dev-infra-vpc"].(map[string]interface{})
-	tenant1Ue2DevInfraVpcStackStackName := tenant1Ue2DevInfraVpcStack["stack"].(string)
+	tenant1Ue2DevInfraVpcStackInfrastructureStackName := tenant1Ue2DevInfraVpcStack["stack"].(string)
 	tenant1Ue2DevInfraVpcStackBackend := tenant1Ue2DevInfraVpcStack["backend"].(map[string]interface{})
 	tenant1Ue2DevInfraVpcStackBackendWorkspaceKeyPrefix := tenant1Ue2DevInfraVpcStackBackend["workspace_key_prefix"].(string)
-	assert.Equal(t, "tenant1-ue2-dev-infra-vpc", tenant1Ue2DevInfraVpcStackStackName)
+	assert.Equal(t, "tenant1-ue2-dev", tenant1Ue2DevInfraVpcStackInfrastructureStackName)
 	assert.Equal(t, "infra-vpc", tenant1Ue2DevInfraVpcStackBackendWorkspaceKeyPrefix)
 
 	tenant1Ue2DevTestTestComponentOverrideComponent := spaceliftStacks["tenant1-ue2-dev-test-test-component-override"].(map[string]interface{})
-	tenant1Ue2DevTestTestComponentOverrideComponentStackName := tenant1Ue2DevTestTestComponentOverrideComponent["stack"].(string)
+	tenant1Ue2DevTestTestComponentOverrideComponentInfrastructureStackName := tenant1Ue2DevTestTestComponentOverrideComponent["stack"].(string)
 	tenant1Ue2DevTestTestComponentOverrideComponentBackend := tenant1Ue2DevTestTestComponentOverrideComponent["backend"].(map[string]interface{})
 	tenant1Ue2DevTestTestComponentOverrideComponentBaseComponent := tenant1Ue2DevTestTestComponentOverrideComponent["base_component"].(string)
-	tenant1Ue2DevTestTestComponentOverrideComponentBackendWorkspaceKeyPrefix := tenant1Ue2DevTestTestComponentOverrideComponentBackend["workspace_key_prefix"].(string)
+	tenant1Ue2DevTestTestComponentOverrideComponentBackendWorkspaceKeyPrefix := tenant1Ue2DevTestTestComponentOverrideComponentBackend["workspace_key_prefix"]
 	tenant1Ue2DevTestTestComponentOverrideComponentDeps := tenant1Ue2DevTestTestComponentOverrideComponent["deps"].([]interface{})
 	tenant1Ue2DevTestTestComponentOverrideComponentLabels := tenant1Ue2DevTestTestComponentOverrideComponent["labels"].([]interface{})
-	assert.Equal(t, "tenant1-ue2-dev-test-test-component-override", tenant1Ue2DevTestTestComponentOverrideComponentStackName)
+	assert.Equal(t, "tenant1-ue2-dev", tenant1Ue2DevTestTestComponentOverrideComponentInfrastructureStackName)
 	assert.Equal(t, "test-test-component", tenant1Ue2DevTestTestComponentOverrideComponentBackendWorkspaceKeyPrefix)
 	assert.Equal(t, "test/test-component", tenant1Ue2DevTestTestComponentOverrideComponentBaseComponent)
 	assert.Equal(t, 11, len(tenant1Ue2DevTestTestComponentOverrideComponentDeps))
diff --git a/versions.tf b/versions.tf

Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ terraform {`
`12`	`12`	`}`
`13`	`13`	`utils = {`
`14`	`14`	`source = "cloudposse/utils"`
`15`		`- version = ">= 0.17.4"`
	`15`	`+ version = ">= 0.17.7"`
`16`	`16`	`}`
`17`	`17`	`}`
`18`	`18`	`}`