chore: add StackDeploymentGroupsSummary resource

Author: ctrombley

stack_deployment_groups_summary.go

@@ -0,0 +1,73 @@
+package tfe
+
+import (
+	"context"
+	"fmt"
+	"net/url"
+)
+
+type StackDeploymentGroupSummaries interface {
+	// List lists all the stack configuration summaries for a stack.
+	List(ctx context.Context, configurationID string, options *StackDeploymentGroupSummaryListOptions) (*StackDeploymentGroupSummaryList, error)
+}
+
+type stackDeploymentGroupSummaries struct {
+	client *Client
+}
+
+var _ StackDeploymentGroupSummaries = &stackDeploymentGroupSummaries{}
+
+type StackDeploymentGroupSummaryList struct {
+	*Pagination
+	Items []*StackDeploymentGroupSummary
+}
+
+type StackDeploymentGroupSummaryListOptions struct {
+	ListOptions
+}
+
+type StackDeploymentGroupStatusCounts struct {
+	Pending                     int `jsonapi:"attr,pending"`
+	PreDeploying                int `jsonapi:"attr,pre-deploying"`
+	PreDeployingPendingOperator int `jsonapi:"attr,pending-operator"`
+	AcquiringLock               int `jsonapi:"attr,acquiring-lock"`
+	Deploying                   int `jsonapi:"attr,deploying"`
+	Succeeded                   int `jsonapi:"attr,succeeded"`
+	Failed                      int `jsonapi:"attr,failed"`
+	Abandoned                   int `jsonapi:"attr,abandoned"`
+}
+
+type StackDeploymentGroupSummary struct {
+	ID string `jsonapi:"primary,stack-deployment-group-summaries"`
+
+	// Attributes
+	Name         string                            `jsonapi:"attr,name"`
+	Status       string                            `jsonapi:"attr,status"`
+	StatusCounts *StackDeploymentGroupStatusCounts `jsonapi:"attr,status-counts"`
+
+	// Relationships
+	StackDeploymentGroup *StackDeploymentGroup `jsonapi:"relation,stack-deployment-group"`
+}
+
+func (s stackDeploymentGroupSummaries) List(ctx context.Context, stackID string, options *StackDeploymentGroupSummaryListOptions) (*StackDeploymentGroupSummaryList, error) {
+	if !validStringID(&stackID) {
+		return nil, fmt.Errorf("invalid stack ID: %s", stackID)
+	}
+
+	if options == nil {
+		options = &StackDeploymentGroupSummaryListOptions{}
+	}
+
+	req, err := s.client.NewRequest("GET", fmt.Sprintf("stack-configurations/%s/stack-deployment-group-summaries", url.PathEscape(stackID)), options)
+	if err != nil {
+		return nil, err
+	}
+
+	scl := &StackDeploymentGroupSummaryList{}
+	err = req.Do(ctx, scl)
+	if err != nil {
+		return nil, err
+	}
+
+	return scl, nil
+}

stack_deployment_groups_summary_integration_test.go

@@ -0,0 +1,76 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: MPL-2.0
+
+package tfe
+
+import (
+	"context"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+func TestStackDeploymentGroupSummaryList(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: "aa-test-stack",
+		VCSRepo: &StackVCSRepoOptions{
+			Identifier:   "ctrombley/linked-stacks-demo-network",
+			OAuthTokenID: oauthClient.OAuthTokens[0].ID,
+		},
+		Project: &Project{
+			ID: orgTest.DefaultProject.ID,
+		},
+	})
+	require.NoError(t, err)
+	require.NotNil(t, stack)
+	stack2, err := client.Stacks.Create(ctx, StackCreateOptions{
+		Name: "bb-test-stack",
+		VCSRepo: &StackVCSRepoOptions{
+			Identifier:   "ctrombley/linked-stacks-demo-network",
+			OAuthTokenID: oauthClient.OAuthTokens[0].ID,
+		},
+		Project: &Project{
+			ID: orgTest.DefaultProject.ID,
+		},
+	})
+	require.NoError(t, err)
+	require.NotNil(t, stack2)
+
+	// Trigger first stack configuration with a fetch
+	_, err = client.Stacks.FetchConfiguration(ctx, stack.ID)
+	require.NoError(t, err)
+
+	updatedStack := pollStackDeploymentGroups(t, ctx, client, stack.ID)
+	require.NotNil(t, updatedStack.LatestStackConfiguration.ID)
+
+	// Trigger second stack configuration with a fetch
+	_, err = client.Stacks.FetchConfiguration(ctx, stack2.ID)
+	require.NoError(t, err)
+
+	updatedStack2 := pollStackDeploymentGroups(t, ctx, client, stack2.ID)
+	require.NotNil(t, updatedStack2.LatestStackConfiguration.ID)
+
+	t.Run("Successful multiple deployment group summary list", func(t *testing.T) {
+		stackConfigSummaryList, err := client.StackDeploymentGroupSummaries.List(ctx, updatedStack2.LatestStackConfiguration.ID, nil)
+		require.NoError(t, err)
+
+		assert.Len(t, stackConfigSummaryList.Items, 2)
+	})
+
+	t.Run("Unsuccessful list", func(t *testing.T) {
+		_, err := client.StackDeploymentGroupSummaries.List(ctx, "", nil)
+		require.Error(t, err)
+	})
+}

tfe.go

@@ -168,6 +168,7 @@ type Client struct {
 	StackConfigurations             StackConfigurations
 	StackConfigurationSummaries     StackConfigurationSummaries
 	StackDeploymentGroups           StackDeploymentGroups
+	StackDeploymentGroupSummaries   StackDeploymentGroupSummaries
 	StackDeploymentRuns             StackDeploymentRuns
 	StackDeploymentSteps            StackDeploymentSteps
 	StateVersionOutputs             StateVersionOutputs
@@ -499,6 +500,7 @@ func NewClient(cfg *Config) (*Client, error) {
 	client.StackConfigurations = &stackConfigurations{client: client}
 	client.StackConfigurationSummaries = &stackConfigurationSummaries{client: client}
 	client.StackDeploymentGroups = &stackDeploymentGroups{client: client}
+	client.StackDeploymentGroupSummaries = &stackDeploymentGroupSummaries{client: client}
 	client.StackDeploymentRuns = &stackDeploymentRuns{client: client}
 	client.StackDeploymentSteps = &stackDeploymentSteps{client: client}
 	client.StateVersionOutputs = &stateVersionOutputs{client: client}