Test for stack deployment run cancel

Author: Maed223

stack_deployment_runs_integration_test.go

@@ -6,6 +6,7 @@ package tfe
 import (
 	"context"
 	"testing"
+	"time"
 
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
@@ -216,3 +217,96 @@ func TestStackDeploymentRunsApproveAllPlans(t *testing.T) {
 		require.NoError(t, err)
 	})
 }
+
+func TestStackDeploymentRunsCancel(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{
+		Project: orgTest.DefaultProject,
+		Name:    "test-stack",
+		VCSRepo: &StackVCSRepoOptions{
+			Identifier:   "hashicorp-guides/pet-nulls-stack",
+			OAuthTokenID: oauthClient.OAuthTokens[0].ID,
+			Branch:       "main",
+		},
+	})
+	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
+
+	runList, err := client.StackDeploymentRuns.List(ctx, deploymentGroupID, nil)
+	require.NoError(t, err)
+	assert.NotNil(t, runList)
+
+	deploymentRunID := runList.Items[0].ID
+
+	t.Run("cancel deployment run", func(t *testing.T) {
+		t.Parallel()
+		err := client.StackDeploymentRuns.ApproveAllPlans(ctx, deploymentRunID)
+		require.NoError(t, err)
+
+		pollStackDeploymentRunForDeployingStatus(t, ctx, client, deploymentRunID)
+
+		err = client.StackDeploymentRuns.Cancel(ctx, deploymentRunID)
+		require.NoError(t, err)
+
+		dr, err := client.StackDeploymentRuns.Read(ctx, deploymentRunID)
+		require.NoError(t, err)
+		assert.NotNil(t, dr)
+		assert.Equal(t, "abandoned", dr.Status)
+	})
+}
+
+func pollStackDeploymentRunForDeployingStatus(t *testing.T, ctx context.Context, client *Client, stackDeploymentRunID string) {
+	t.Helper()
+
+	ctx, cancel := context.WithDeadline(ctx, time.Now().Add(5*time.Minute))
+	defer cancel()
+
+	deadline, _ := ctx.Deadline()
+	t.Logf("Polling stack deployment run %q for deploying status, with deadline of %s", stackDeploymentRunID, deadline)
+
+	ticker := time.NewTicker(2 * time.Second)
+	defer ticker.Stop()
+
+	for finished := false; !finished; {
+		t.Log("...")
+		select {
+		case <-ctx.Done():
+			t.Fatalf("Stack deployment run %q not deploying at deadline", stackDeploymentRunID)
+		case <-ticker.C:
+			var err error
+			sdr, err := client.StackDeploymentRuns.Read(ctx, stackDeploymentRunID)
+			if err != nil {
+				t.Fatalf("Failed to read stack deployment run %q: %s", stackDeploymentRunID, err)
+			}
+
+			if sdr.Status == "deploying" {
+				finished = true
+			}
+		}
+	}
+}