chore: incorporate review feedback

Author: ctrombley

stack_deployment_runs.go

@@ -15,6 +15,7 @@ type StackDeploymentRuns interface {
 	// List returns a list of stack deployment runs for a given deployment group.
 	List(ctx context.Context, deploymentGroupID string, options *StackDeploymentRunListOptions) (*StackDeploymentRunList, error)
 	Read(ctx context.Context, stackDeploymentRunID string) (*StackDeploymentRun, error)
+	ReadWithOptions(ctx context.Context, stackDeploymentRunID string, options *StackDeploymentRunReadOptions) (*StackDeploymentRun, error)
 	ApproveAllPlans(ctx context.Context, deploymentRunID string) error
 	Cancel(ctx context.Context, stackDeploymentRunID string) error
 }
@@ -43,21 +44,20 @@ const (
 	SDRDeploymentGroup SDRIncludeOpt = "stack-deployment-group"
 )
 
-type StackDeploymentRunReadOptions struct {
-	// Optional: A list of relations to include.
-	Include []SDRIncludeOpt `url:"include,omitempty"`
-}
-
 // StackDeploymentRunList represents a list of stack deployment runs.
 type StackDeploymentRunList struct {
 	*Pagination
 	Items []*StackDeploymentRun
 }
 
+type StackDeploymentRunReadOptions struct {
+	// Optional: A list of relations to include.
+	Include []SDRIncludeOpt `url:"include,omitempty"`
+}
+
 // StackDeploymentRunListOptions represents the options for listing stack deployment runs.
 type StackDeploymentRunListOptions struct {
 	ListOptions
-
 	// Optional: A list of relations to include.
 	Include []SDRIncludeOpt `url:"include,omitempty"`
 }

stack_deployment_runs_integration_test.go

@@ -72,6 +72,28 @@ func TestStackDeploymentRunsList(t *testing.T) {
 		require.NoError(t, err)
 		assert.NotNil(t, runList)
 	})
+
+	t.Run("With include option", func(t *testing.T) {
+		t.Parallel()
+
+		runList, err := client.StackDeploymentRuns.List(ctx, deploymentGroupID, &StackDeploymentRunListOptions{
+			Include: []SDRIncludeOpt{"stack-deployment-group"},
+		})
+		assert.NoError(t, err)
+		assert.NotNil(t, runList)
+		for _, run := range runList.Items {
+			assert.NotNil(t, run.StackDeploymentGroup.ID)
+		}
+	})
+
+	t.Run("With invalid include option", func(t *testing.T) {
+		t.Parallel()
+
+		_, err := client.StackDeploymentRuns.List(ctx, deploymentGroupID, &StackDeploymentRunListOptions{
+			Include: []SDRIncludeOpt{"invalid-option"},
+		})
+		assert.Error(t, err)
+	})
 }
 
 func TestStackDeploymentRunsRead(t *testing.T) {
@@ -127,6 +149,22 @@ func TestStackDeploymentRunsRead(t *testing.T) {
 		_, err := client.StackDeploymentRuns.Read(ctx, "")
 		assert.Error(t, err)
 	})
+
+	t.Run("Read with options", func(t *testing.T) {
+		run, err := client.StackDeploymentRuns.ReadWithOptions(ctx, sdr.ID, &StackDeploymentRunReadOptions{
+			Include: []SDRIncludeOpt{"stack-deployment-group"},
+		})
+		assert.NoError(t, err)
+		assert.NotNil(t, run)
+		assert.NotNil(t, run.StackDeploymentGroup.ID)
+	})
+
+	t.Run("Read with invalid options", func(t *testing.T) {
+		_, err := client.StackDeploymentRuns.ReadWithOptions(ctx, sdr.ID, &StackDeploymentRunReadOptions{
+			Include: []SDRIncludeOpt{"invalid-option"},
+		})
+		assert.Error(t, err)
+	})
 }
 
 func TestStackDeploymentRunsApproveAllPlans(t *testing.T) {

stack_deployment_steps_integration_test.go

@@ -28,8 +28,9 @@ func TestStackDeploymentStepsList(t *testing.T) {
 		Project: orgTest.DefaultProject,
 		Name:    "test-stack",
 		VCSRepo: &StackVCSRepoOptions{
-			Identifier: "hashicorp-guides/pet-nulls-stack", OAuthTokenID: oauthClient.OAuthTokens[0].ID,
-			Branch: "main",
+			Identifier:   "hashicorp-guides/pet-nulls-stack",
+			OAuthTokenID: oauthClient.OAuthTokens[0].ID,
+			Branch:       "main",
 		},
 	})
 	require.NoError(t, err)
@@ -117,8 +118,9 @@ func TestStackDeploymentStepsRead(t *testing.T) {
 		Project: orgTest.DefaultProject,
 		Name:    "test-stack",
 		VCSRepo: &StackVCSRepoOptions{
-			Identifier: "hashicorp-guides/pet-nulls-stack", OAuthTokenID: oauthClient.OAuthTokens[0].ID,
-			Branch: "main",
+			Identifier:   "hashicorp-guides/pet-nulls-stack",
+			OAuthTokenID: oauthClient.OAuthTokens[0].ID,
+			Branch:       "main",
 		},
 	})
 	require.NoError(t, err)
@@ -178,8 +180,9 @@ func TestStackDeploymentStepsAdvance(t *testing.T) {
 		Project: orgTest.DefaultProject,
 		Name:    "testing-stack",
 		VCSRepo: &StackVCSRepoOptions{
-			Identifier: "hashicorp-guides/pet-nulls-stack", OAuthTokenID: oauthClient.OAuthTokens[0].ID,
-			Branch: "main",
+			Identifier:   "hashicorp-guides/pet-nulls-stack",
+			OAuthTokenID: oauthClient.OAuthTokens[0].ID,
+			Branch:       "main",
 		},
 	})
 	require.NoError(t, err)