Merge pull request #1176 from hashicorp/TF-25667-milestone-3-go-tfe-deployment-group-rerun-endpoint

Rerun deployment group

Author: Maed223

CHANGELOG.md

@@ -3,6 +3,8 @@
 ## Enhancements
 * Adds support for `RegistryModule` VCS source_directory and tag_prefix options, by @jillrami [#1154] (https://github.com/hashicorp/go-tfe/pull/1154)
 * Adds `GroupName` filter option for `StackDeploymentGroup` by @Maed223 [#1175](https://github.com/hashicorp/go-tfe/pull/1175)
+* Adds endpoint for reruning a stack deployment by @hwatkins05-hashicorp/@Maed223 [#1176](https://github.com/hashicorp/go-tfe/pull/1176)
+
 
 ## Bug Fixes
 * Fixes issue [1061](https://github.com/hashicorp/go-tfe/issues/1061), validation accepts all RunStatus including `"cost_estimated"` by @KenCox-Hashicorp [#1171](https://github.com/hashicorp/go-tfe/pull/1171)

stack_deployment_groups.go

@@ -20,6 +20,9 @@ type StackDeploymentGroups interface {
 
 	// ApproveAllPlans approves all pending plans in a stack deployment group.
 	ApproveAllPlans(ctx context.Context, stackDeploymentGroupID string) error
+
+	// Rerun re-runs all the stack deployment runs in a deployment group.
+	Rerun(ctx context.Context, stackDeploymentGroupID string, options *StackDeploymentGroupRerunOptions) error
 }
 
 type DeploymentGroupStatus string
@@ -65,6 +68,12 @@ type StackDeploymentGroupListOptions struct {
 	GroupName string `url:"group_name,omitempty"`
 }
 
+// StackDeploymentGroupRerunOptions represents options for rerunning deployments in a stack deployment group.
+type StackDeploymentGroupRerunOptions struct {
+	// Required query parameter: A list of deployment run IDs to rerun.
+	Deployments []string `url:"deployments"`
+}
+
 // List returns a list of Deployment Groups in a stack, optionally filtered by additional parameters.
 func (s stackDeploymentGroups) List(ctx context.Context, stackConfigID string, options *StackDeploymentGroupListOptions) (*StackDeploymentGroupList, error) {
 	if !validStringID(&stackConfigID) {
@@ -123,3 +132,21 @@ func (s stackDeploymentGroups) ApproveAllPlans(ctx context.Context, stackDeploym
 
 	return req.Do(ctx, nil)
 }
+
+// Rerun re-runs all the stack deployment runs in a deployment group.
+func (s stackDeploymentGroups) Rerun(ctx context.Context, stackDeploymentGroupID string, options *StackDeploymentGroupRerunOptions) error {
+	if !validStringID(&stackDeploymentGroupID) {
+		return fmt.Errorf("invalid stack deployment group ID: %s", stackDeploymentGroupID)
+	}
+
+	if options == nil || len(options.Deployments) == 0 {
+		return fmt.Errorf("no deployments specified for rerun")
+	}
+
+	req, err := s.client.NewRequest("POST", fmt.Sprintf("stack-deployment-groups/%s/rerun", url.PathEscape(stackDeploymentGroupID)), options)
+	if err != nil {
+		return err
+	}
+
+	return req.Do(ctx, nil)
+}

stack_deployment_groups_integration_test.go

@@ -186,3 +186,73 @@ func TestStackDeploymentGroupsApproveAllPlans(t *testing.T) {
 		require.NoError(t, err)
 	})
 }
+
+func TestStackDeploymentGroupsRerun(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)
+
+	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
+
+	deploymentRuns, err := client.StackDeploymentRuns.List(ctx, deploymentGroupID, nil)
+	require.NoError(t, err)
+	require.NotNil(t, deploymentRuns)
+	require.NotEmpty(t, deploymentRuns.Items)
+
+	err = client.StackDeploymentGroups.ApproveAllPlans(ctx, deploymentGroupID)
+	require.NoError(t, err)
+
+	pollStackDeploymentRunForDeployingStatus(t, ctx, client, deploymentRuns.Items[0].ID)
+
+	deploymentRunIds := []string{deploymentRuns.Items[0].ID}
+	for _, dr := range deploymentRuns.Items {
+		deploymentRunIds = append(deploymentRunIds, dr.ID)
+	}
+
+	t.Run("No deployments specified for rerun", func(t *testing.T) {
+		err := client.StackDeploymentGroups.Rerun(ctx, deploymentGroupID, nil)
+		require.Error(t, err)
+		assert.Contains(t, err.Error(), "no deployments specified for rerun")
+	})
+
+	t.Run("Rerun with invalid ID", func(t *testing.T) {
+		err := client.StackDeploymentGroups.Rerun(ctx, "", &StackDeploymentGroupRerunOptions{
+			Deployments: deploymentRunIds,
+		})
+		require.Error(t, err)
+		assert.Contains(t, err.Error(), "invalid stack deployment group ID")
+	})
+}