Merge pull request #1137 from hashicorp/hw/approve-deployment-group

Added support for approving all plans in a `StackDeploymentGroup`

Author: hwatkins05-hashicorp

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 * Adds BETA support for approving all plans for a stack deployment run, which is EXPERIMENTAL, SUBJECT TO CHANGE, and may not be available to all users by @ctrombley [#1136](https://github.com/hashicorp/go-tfe/pull/1136)
 * Adds BETA support for listing and reading `StackDeploymentSteps`, which is EXPERIMENTAL, SUBJECT TO CHANGE, and may not be available to all users by @ctrombley [#1133](https://github.com/hashicorp/go-tfe/pull/1133)
+* Adds BETA support for approving all plans in `StackDeploymentGroups`, which is EXPERIMENTAL, SUBJECT TO CHANGE, and may not be available to all users by @hwatkins05-hashicorp [#1137](https://github.com/hashicorp/go-tfe/pull/1137)
 
 # v1.83.0
 

stack_deployment_groups.go

@@ -17,6 +17,9 @@ type StackDeploymentGroups interface {
 
 	// Read retrieves a stack deployment group by its ID.
 	Read(ctx context.Context, stackDeploymentGroupID string) (*StackDeploymentGroup, error)
+
+	// ApproveAllPlans approves all pending plans in a stack deployment group.
+	ApproveAllPlans(ctx context.Context, stackDeploymentGroupID string) error
 }
 
 type DeploymentGroupStatus string
@@ -103,3 +106,17 @@ func (s stackDeploymentGroups) Read(ctx context.Context, stackDeploymentGroupID
 
 	return sdg, nil
 }
+
+// ApproveAllPlans approves all pending plans in a stack deployment group.
+func (s stackDeploymentGroups) ApproveAllPlans(ctx context.Context, stackDeploymentGroupID string) error {
+	if !validStringID(&stackDeploymentGroupID) {
+		return fmt.Errorf("invalid stack deployment group ID: %s", stackDeploymentGroupID)
+	}
+
+	req, err := s.client.NewRequest("POST", fmt.Sprintf("stack-deployment-groups/%s/approve-all-plans", url.PathEscape(stackDeploymentGroupID)), nil)
+	if err != nil {
+		return err
+	}
+
+	return req.Do(ctx, nil)
+}

stack_deployment_groups_integration_test.go

@@ -124,3 +124,50 @@ func TestStackDeploymentGroupsRead(t *testing.T) {
 		require.Error(t, err)
 	})
 }
+
+func TestStackDeploymentGroupsApproveAllPlans(t *testing.T) {
+	skipUnlessBeta(t)
+
+	client := testClient(t)
+	ctx := context.Background()
+
+	orgTest, orgTestCleanup := createOrganization(t, client)
+	t.Cleanup(orgTestCleanup)
+
+	oauthClient, cleanup := createOAuthClient(t, client, orgTest, nil)
+	t.Cleanup(cleanup)
+
+	stack, err := client.Stacks.Create(ctx, StackCreateOptions{
+		Name: "test-stack",
+		VCSRepo: &StackVCSRepoOptions{
+			Identifier:   "hashicorp-guides/pet-nulls-stack",
+			OAuthTokenID: oauthClient.OAuthTokens[0].ID,
+			Branch:       "main",
+		},
+		Project: &Project{
+			ID: orgTest.DefaultProject.ID,
+		},
+	})
+	require.NoError(t, err)
+	require.NotNil(t, stack)
+
+	stackUpdated, err := client.Stacks.UpdateConfiguration(ctx, stack.ID)
+	require.NoError(t, err)
+	require.NotNil(t, stackUpdated)
+
+	stack = pollStackDeployments(t, ctx, client, stackUpdated.ID)
+	require.NotNil(t, stack.LatestStackConfiguration)
+
+	// Get the deployment group ID from the stack configuration
+	deploymentGroups, err := client.StackDeploymentGroups.List(ctx, stack.LatestStackConfiguration.ID, nil)
+	require.NoError(t, err)
+	require.NotNil(t, deploymentGroups)
+	require.NotEmpty(t, deploymentGroups.Items)
+
+	deploymentGroupID := deploymentGroups.Items[0].ID
+
+	t.Run("Approving all plans", func(t *testing.T) {
+		err := client.StackDeploymentGroups.ApproveAllPlans(ctx, deploymentGroupID)
+		require.NoError(t, err)
+	})
+}