Merge pull request #1128 from hashicorp/hw/deploy-group-list

Added support for listing `StackDeploymentGroups`

Author: hwatkins05-hashicorp

CHANGELOG.md

@@ -1,6 +1,8 @@
 # Unreleased
 * Add support for HCP Terraform `/api/v2/workspaces/{external_id}/all-vars` API endpoint to fetch the list of all variables available to a workspace (include inherited variables from varsets) by @debrin-hc [#1105](https://github.com/hashicorp/go-tfe/pull/1105)
 
+* Adds BETA support for listing `StackDeploymentGroups`, which is EXPERIMENTAL, SUBJECT TO CHANGE, and may not be available to all users by @hwatkins05-hashicorp [#1128](https://github.com/hashicorp/go-tfe/pull/1128)
+
 # v1.82.0
 
 ## Enhancements

stack_deployment_groups.go

@@ -0,0 +1,77 @@
+package tfe
+
+import (
+	"context"
+	"fmt"
+	"net/url"
+)
+
+// StackDeploymentGroups describes all the stack-deployment-groups related methods that the HCP Terraform API supports.
+type StackDeploymentGroups interface {
+	// List returns a list of Deployment Groups in a stack.
+	List(ctx context.Context, stackConfigID string, options *StackDeploymentGroupListOptions) (*StackDeploymentGroupList, error)
+}
+
+type DeploymentGroupStatus string
+
+const (
+	DeploymentGroupStatusPending   DeploymentGroupStatus = "pending"
+	DeploymentGroupStatusDeploying DeploymentGroupStatus = "deploying"
+	DeploymentGroupStatusSucceeded DeploymentGroupStatus = "succeeded"
+	DeploymentGroupStatusFailed    DeploymentGroupStatus = "failed"
+	DeploymentGroupStatusAbandoned DeploymentGroupStatus = "abandoned"
+)
+
+// stackDeploymentGroups implements StackDeploymentGroups.
+type stackDeploymentGroups struct {
+	client *Client
+}
+
+var _ StackDeploymentGroups = &stackDeploymentGroups{}
+
+// StackDeploymentGroup represents a stack deployment group.
+type StackDeploymentGroup struct {
+	ID        string                `jsonapi:"primary,stacks-deployment-groups"`
+	Name      string                `jsonapi:"attr,name"`
+	Status    DeploymentGroupStatus `jsonapi:"attr,status"`
+	CreatedAt string                `jsonapi:"attr,created-at"`
+	UpdatedAt string                `jsonapi:"attr,updated-at"`
+
+	// Relationships
+	StackConfiguration StackConfiguration `jsonapi:"relation,stack-configurations"`
+}
+
+// StackDeploymentGroupList represents a list of stack deployment groups.
+type StackDeploymentGroupList struct {
+	*Pagination
+	Items []*StackDeploymentGroup
+}
+
+// StackDeploymentGroupListOptions represents additional options when listing stack deployment groups.
+type StackDeploymentGroupListOptions struct {
+	ListOptions
+}
+
+// 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) {
+		return nil, fmt.Errorf("invalid stack configuration ID: %s", stackConfigID)
+	}
+
+	if options == nil {
+		options = &StackDeploymentGroupListOptions{}
+	}
+
+	req, err := s.client.NewRequest("GET", fmt.Sprintf("stack-configurations/%s/stack-deployment-groups", url.PathEscape(stackConfigID)), options)
+	if err != nil {
+		return nil, err
+	}
+
+	sdgl := &StackDeploymentGroupList{}
+	err = req.Do(ctx, sdgl)
+	if err != nil {
+		return nil, err
+	}
+
+	return sdgl, nil
+}

stack_deployment_groups_integration_test.go

@@ -0,0 +1,75 @@
+package tfe
+
+import (
+	"context"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+func TestStackDeploymentGroupsList(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,
+		},
+		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)
+	require.NotEmpty(t, stackUpdated.LatestStackConfiguration.ID)
+
+	stackUpdated = pollStackDeployments(t, ctx, client, stackUpdated.ID)
+	require.NotNil(t, stackUpdated.LatestStackConfiguration)
+
+	t.Run("List with valid stack configuration ID", func(t *testing.T) {
+		sdgl, err := client.StackDeploymentGroups.List(ctx, stackUpdated.LatestStackConfiguration.ID, nil)
+		require.NoError(t, err)
+		require.NotNil(t, sdgl)
+		for _, item := range sdgl.Items {
+			assert.NotNil(t, item.ID)
+			assert.NotEmpty(t, item.Name)
+			assert.NotEmpty(t, item.Status)
+			assert.NotNil(t, item.CreatedAt)
+			assert.NotNil(t, item.UpdatedAt)
+		}
+		require.Len(t, sdgl.Items, 2)
+	})
+
+	t.Run("List with invalid stack configuration ID", func(t *testing.T) {
+		_, err := client.StackDeploymentGroups.List(ctx, "", nil)
+		require.Error(t, err)
+	})
+
+	t.Run("List with pagination", func(t *testing.T) {
+		options := &StackDeploymentGroupListOptions{
+			ListOptions: ListOptions{
+				PageNumber: 1,
+				PageSize:   1,
+			},
+		}
+		sdgl, err := client.StackDeploymentGroups.List(ctx, stackUpdated.LatestStackConfiguration.ID, options)
+		require.NoError(t, err)
+		require.NotNil(t, sdgl)
+		require.Len(t, sdgl.Items, 1)
+	})
+}

tfe.go

@@ -164,6 +164,7 @@ type Client struct {
 	Stacks                     Stacks
 	StackConfigurations        StackConfigurations
 	StackDeployments           StackDeployments
+	StackDeploymentGroups      StackDeploymentGroups
 	StackPlans                 StackPlans
 	StackPlanOperations        StackPlanOperations
 	StackSources               StackSources
@@ -492,6 +493,7 @@ func NewClient(cfg *Config) (*Client, error) {
 	client.Stacks = &stacks{client: client}
 	client.StackConfigurations = &stackConfigurations{client: client}
 	client.StackDeployments = &stackDeployments{client: client}
+	client.StackDeploymentGroups = &stackDeploymentGroups{client: client}
 	client.StackPlans = &stackPlans{client: client}
 	client.StackPlanOperations = &stackPlanOperations{client: client}
 	client.StackSources = &stackSources{client: client}