Update atmos describe affected command (#635)

* updates * updates
cloudposse · Jun 25, 2024 · ff192f3 · ff192f3
1 parent 2290855
commit ff192f3
Show file tree

Hide file tree

Showing 10 changed files with 33 additions and 16 deletions.
diff --git a/examples/quick-start/Dockerfile b/examples/quick-start/Dockerfile
@@ -6,7 +6,7 @@ ARG GEODESIC_OS=debian
 # https://atmos.tools/
 # https://github.com/cloudposse/atmos
 # https://github.com/cloudposse/atmos/releases
-ARG ATMOS_VERSION=1.82.0
+ARG ATMOS_VERSION=1.83.0
 
 # Terraform: https://github.com/hashicorp/terraform/releases
 ARG TF_VERSION=1.8.5

diff --git a/examples/quick-start/stacks/catalog/vpc/defaults.yaml b/examples/quick-start/stacks/catalog/vpc/defaults.yaml
@@ -5,6 +5,10 @@ components:
         # Point to the Terraform component
         component: vpc
       settings:
+        # The `vpc` component depends on the `vpc-flow-logs-bucket` component in the same stack
+        depends_on:
+          1:
+            component: "vpc-flow-logs-bucket"
         # Validation
         # Supports JSON Schema and OPA policies
         # All validation steps must succeed to allow the component to be provisioned

diff --git a/internal/exec/atmos.go b/internal/exec/atmos.go
@@ -115,7 +115,7 @@ func ExecuteAtmosCmd() error {
 	}
 
 	if selectedCommand == "describe dependents" {
-		data, err := ExecuteDescribeDependents(cliConfig, selectedComponent, selectedStack)
+		data, err := ExecuteDescribeDependents(cliConfig, selectedComponent, selectedStack, false)
 		if err != nil {
 			return err
 		}

diff --git a/internal/exec/describe_affected.go b/internal/exec/describe_affected.go
@@ -143,7 +143,7 @@ func ExecuteDescribeAffectedCmd(cmd *cobra.Command, args []string) error {
 
 	// Add dependent components and stacks for each affected component
 	if len(affected) > 0 && includeDependents {
-		err = addDependentsToAffected(cliConfig, &affected)
+		err = addDependentsToAffected(cliConfig, &affected, includeSettings)
 		if err != nil {
 			return err
 		}

diff --git a/internal/exec/describe_affected_utils.go b/internal/exec/describe_affected_utils.go
@@ -1491,18 +1491,22 @@ func addAffectedSpaceliftAdminStack(
 }
 
 // addDependentsToAffected adds dependent components and stacks to each affected component
-func addDependentsToAffected(cliConfig schema.CliConfiguration, affected *[]schema.Affected) error {
+func addDependentsToAffected(
+	cliConfig schema.CliConfiguration,
+	affected *[]schema.Affected,
+	includeSettings bool,
+) error {
 	for i := 0; i < len(*affected); i++ {
 		a := &(*affected)[i]
 
-		deps, err := ExecuteDescribeDependents(cliConfig, a.Component, a.Stack)
+		deps, err := ExecuteDescribeDependents(cliConfig, a.Component, a.Stack, includeSettings)
 		if err != nil {
 			return err
 		}
 
 		if len(deps) > 0 {
 			a.Dependents = deps
-			err = addDependentsToDependents(cliConfig, &deps)
+			err = addDependentsToDependents(cliConfig, &deps, includeSettings)
 			if err != nil {
 				return err
 			}
@@ -1516,18 +1520,22 @@ func addDependentsToAffected(cliConfig schema.CliConfiguration, affected *[]sche
 }
 
 // addDependentsToDependents recursively adds dependent components and stacks to each dependent component
-func addDependentsToDependents(cliConfig schema.CliConfiguration, dependents *[]schema.Dependent) error {
+func addDependentsToDependents(
+	cliConfig schema.CliConfiguration,
+	dependents *[]schema.Dependent,
+	includeSettings bool,
+) error {
 	for i := 0; i < len(*dependents); i++ {
 		d := &(*dependents)[i]
 
-		deps, err := ExecuteDescribeDependents(cliConfig, d.Component, d.Stack)
+		deps, err := ExecuteDescribeDependents(cliConfig, d.Component, d.Stack, includeSettings)
 		if err != nil {
 			return err
 		}
 
 		if len(deps) > 0 {
 			d.Dependents = deps
-			err = addDependentsToDependents(cliConfig, &deps)
+			err = addDependentsToDependents(cliConfig, &deps, includeSettings)
 			if err != nil {
 				return err
 			}

diff --git a/internal/exec/describe_dependents.go b/internal/exec/describe_dependents.go
@@ -53,7 +53,7 @@ func ExecuteDescribeDependentsCmd(cmd *cobra.Command, args []string) error {
 
 	component := args[0]
 
-	dependents, err := ExecuteDescribeDependents(cliConfig, component, stack)
+	dependents, err := ExecuteDescribeDependents(cliConfig, component, stack, false)
 	if err != nil {
 		return err
 	}
@@ -71,6 +71,7 @@ func ExecuteDescribeDependents(
 	cliConfig schema.CliConfiguration,
 	component string,
 	stack string,
+	includeSettings bool,
 ) ([]schema.Dependent, error) {
 
 	dependents := []schema.Dependent{}
@@ -235,7 +236,6 @@ func ExecuteDescribeDependents(
 
 					// Add Spacelift stack and Atlantis project if they are configured for the dependent stack component
 					if stackComponentType == "terraform" {
-
 						// Spacelift stack
 						configAndStacksInfo := schema.ConfigAndStacksInfo{
 							ComponentFromArg:         stackComponentName,
@@ -262,6 +262,10 @@ func ExecuteDescribeDependents(
 						dependent.AtlantisProject = atlantisProjectName
 					}
 
+					if includeSettings {
+						dependent.Settings = stackComponentSettingsSection
+					}
+
 					dependents = append(dependents, dependent)
 				}
 			}

diff --git a/pkg/describe/describe_dependents_test.go b/pkg/describe/describe_dependents_test.go
@@ -20,7 +20,7 @@ func TestDescribeDependents(t *testing.T) {
 	component := "test/test-component"
 	stack := "tenant1-ue2-test-1"
 
-	dependents, err := e.ExecuteDescribeDependents(cliConfig, component, stack)
+	dependents, err := e.ExecuteDescribeDependents(cliConfig, component, stack, false)
 	assert.Nil(t, err)
 	assert.Equal(t, 1, len(dependents))
 
@@ -38,7 +38,7 @@ func TestDescribeDependents2(t *testing.T) {
 	component := "test/test-component"
 	stack := "tenant1-ue2-dev"
 
-	dependents, err := e.ExecuteDescribeDependents(cliConfig, component, stack)
+	dependents, err := e.ExecuteDescribeDependents(cliConfig, component, stack, false)
 	assert.Nil(t, err)
 	assert.Equal(t, 4, len(dependents))
 

diff --git a/pkg/schema/schema.go b/pkg/schema/schema.go
@@ -479,7 +479,8 @@ type Dependent struct {
 	StackSlug       string      `yaml:"stack_slug" json:"stack_slug" mapstructure:"stack_slug"`
 	SpaceliftStack  string      `yaml:"spacelift_stack,omitempty" json:"spacelift_stack,omitempty" mapstructure:"spacelift_stack"`
 	AtlantisProject string      `yaml:"atlantis_project,omitempty" json:"atlantis_project,omitempty" mapstructure:"atlantis_project"`
-	Dependents      []Dependent `yaml:"dependents,omitempty" json:"dependents,omitempty" mapstructure:"dependents"`
+	Dependents      []Dependent `yaml:"dependents" json:"dependents" mapstructure:"dependents"`
+	Settings        map[any]any `yaml:"settings" json:"settings" mapstructure:"settings"`
 }
 
 // Settings

diff --git a/website/docs/integrations/atlantis.mdx b/website/docs/integrations/atlantis.mdx
@@ -687,7 +687,7 @@ on:
     branches: [ main ]
 
 env:
-  ATMOS_VERSION: 1.82.0
+  ATMOS_VERSION: 1.83.0
   ATMOS_CLI_CONFIG_PATH: ./
 
 jobs:

diff --git a/website/docs/integrations/github-actions/setup-atmos.mdx b/website/docs/integrations/github-actions/setup-atmos.mdx
@@ -30,6 +30,6 @@ jobs:
         uses: cloudposse/github-action-setup-atmos
         with:
           # Make sure to pin to the latest version of atmos
-          atmos_version: 1.82.0
+          atmos_version: 1.83.0
 ```
 </File>