Merge pull request #1166 from hashicorp/TF-27757/deployment-step-advance

Added deployment step advance endpoint

Author: hwatkins05-hashicorp

CHANGELOG.md

@@ -10,6 +10,7 @@
 * Adds BETA support for reading, testing and updating Organization Audit Configuration by @glennsarti-hashi [#1151](https://github.com/hashicorp/go-tfe/pull/1151)
 * Adds `Completed` status to `StackConfiguration` by @hwatkins05-hashicorp [#1163](https://github.com/hashicorp/go-tfe/pull/1163)
 * Adds `CreatedAt` and `UpdatedAt` fields to `StackConfiguration` by @Maed223 [#1168](https://github.com/hashicorp/go-tfe/pull/1168)
+* Adds endpoint for advancing `StackDeploymentStep` by @hwatkins05-hashicorp [#1166](https://github.com/hashicorp/go-tfe/pull/1166)
 
 # v1.87.0
 

stack_deployment_steps.go

@@ -17,7 +17,10 @@ import (
 type StackDeploymentSteps interface {
 	// List returns the stack deployment steps for a stack deployment run.
 	List(ctx context.Context, stackDeploymentRunID string, opts *StackDeploymentStepsListOptions) (*StackDeploymentStepList, error)
+	// Read returns a stack deployment step by its ID.
 	Read(ctx context.Context, stackDeploymentStepID string) (*StackDeploymentStep, error)
+	// Advance advances the stack deployment step when in the "pending_operator" state.
+	Advance(ctx context.Context, stackDeploymentStepID string) error
 }
 
 // StackDeploymentStep represents a step from a stack deployment
@@ -66,6 +69,7 @@ func (s stackDeploymentSteps) List(ctx context.Context, stackDeploymentRunID str
 	return &steps, nil
 }
 
+// Read returns a stack deployment step by its ID.
 func (s stackDeploymentSteps) Read(ctx context.Context, stackDeploymentStepID string) (*StackDeploymentStep, error) {
 	req, err := s.client.NewRequest("GET", fmt.Sprintf("stack-deployment-steps/%s", url.PathEscape(stackDeploymentStepID)), nil)
 	if err != nil {
@@ -80,3 +84,13 @@ func (s stackDeploymentSteps) Read(ctx context.Context, stackDeploymentStepID st
 
 	return &step, nil
 }
+
+// Advance advances the stack deployment step when in the "pending_operator" state.
+func (s stackDeploymentSteps) Advance(ctx context.Context, stackDeploymentStepID string) error {
+	req, err := s.client.NewRequest("POST", fmt.Sprintf("stack-deployment-steps/%s/advance", url.PathEscape(stackDeploymentStepID)), nil)
+	if err != nil {
+		return err
+	}
+
+	return req.Do(ctx, nil)
+}

stack_deployment_steps_integration_test.go

@@ -6,6 +6,7 @@ package tfe
 import (
 	"context"
 	"testing"
+	"time"
 
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
@@ -162,3 +163,103 @@ func TestStackDeploymentStepsRead(t *testing.T) {
 		require.Error(t, err)
 	})
 }
+
+func TestStackDeploymentStepsAdvance(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:    "testing-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)
+
+	stackDeploymentGroups, err := client.StackDeploymentGroups.List(ctx, stack.LatestStackConfiguration.ID, nil)
+	require.NoError(t, err)
+	require.NotEmpty(t, stackDeploymentGroups)
+
+	sdg := stackDeploymentGroups.Items[0]
+
+	stackDeploymentRuns, err := client.StackDeploymentRuns.List(ctx, sdg.ID, nil)
+	require.NoError(t, err)
+	require.NotEmpty(t, stackDeploymentRuns)
+
+	sdr := stackDeploymentRuns.Items[0]
+
+	steps, err := client.StackDeploymentSteps.List(ctx, sdr.ID, nil)
+	assert.NoError(t, err)
+	assert.NotEmpty(t, steps)
+
+	step := steps.Items[0]
+	step = pollStackDeploymentStepStatus(t, ctx, client, step.ID, "pending_operator")
+	require.NotNil(t, step)
+
+	t.Run("Advance with valid ID", func(t *testing.T) {
+		err := client.StackDeploymentSteps.Advance(ctx, step.ID)
+		assert.NoError(t, err)
+
+		// Verify that the step status has changed to "completed"
+		sds, err := client.StackDeploymentSteps.Read(ctx, step.ID)
+		assert.NoError(t, err)
+		assert.Equal(t, "completed", sds.Status)
+	})
+
+	t.Run("Advance with invalid ID", func(t *testing.T) {
+		err := client.StackDeploymentSteps.Advance(ctx, "")
+		require.Error(t, err)
+	})
+}
+
+func pollStackDeploymentStepStatus(t *testing.T, ctx context.Context, client *Client, stackDeploymentStepID, status string) (deploymentStep *StackDeploymentStep) {
+	// pollStackDeploymentStepStatus will poll the given stack deployment step until its status changes or the deadline is reached.
+	ctx, cancel := context.WithDeadline(ctx, time.Now().Add(5*time.Minute))
+	defer cancel()
+
+	deadline, _ := ctx.Deadline()
+	t.Logf("Polling stack deployment step %q for change in status with deadline of %s", stackDeploymentStepID, deadline)
+
+	ticker := time.NewTicker(2 * time.Second)
+	defer ticker.Stop()
+
+	var err error
+	for finished := false; !finished; {
+		t.Log("...")
+		select {
+		case <-ctx.Done():
+			t.Fatalf("Stack deployment step %s did not have status %q at deadline", stackDeploymentStepID, status)
+		case <-ticker.C:
+			deploymentStep, err = client.StackDeploymentSteps.Read(ctx, stackDeploymentStepID)
+			if err != nil {
+				t.Fatalf("Failed to read stack deployment step %s: %s", stackDeploymentStepID, err)
+			}
+
+			t.Logf("Stack deployment step %s had status %q", deploymentStep.ID, deploymentStep.Status)
+			if deploymentStep.Status == status {
+				finished = true
+			}
+		}
+	}
+
+	return
+}