Merge pull request #1204 from hashicorp/TF-27756-go-tfe-list-stack-configuration-group-summaries

Added support for listing `StackConfigurationSummaries`

Author: hwatkins05-hashicorp

CHANGELOG.md

@@ -6,6 +6,10 @@
 
 * Fixes timestamp attribute mapping for deployment runs to use correct API field names (`created-at`/`updated-at` instead of `started-at`/`completed-at`) by @shwetamurali [#1199](https://github.com/hashicorp/go-tfe/pull/1199)
 
+## Enhancements
+
+* Adds support for listing `StackConfigurationSummaries` by @hwatkins05-hashicorp [#1204](https://github.com/hashicorp/go-tfe/pull/1204)
+
 # v1.91.0
 
 ## Enhancements

stack_configuration_summary.go

@@ -0,0 +1,56 @@
+package tfe
+
+import (
+	"context"
+	"fmt"
+	"net/url"
+)
+
+type StackConfigurationSummaries interface {
+	// List lists all the stack configuration summaries for a stack.
+	List(ctx context.Context, stackID string, options *StackConfigurationSummaryListOptions) (*StackConfigurationSummaryList, error)
+}
+
+type stackConfigurationSummaries struct {
+	client *Client
+}
+
+var _ StackConfigurationSummaries = &stackConfigurationSummaries{}
+
+type StackConfigurationSummaryList struct {
+	*Pagination
+	Items []*StackConfigurationSummary
+}
+
+type StackConfigurationSummaryListOptions struct {
+	ListOptions
+}
+
+type StackConfigurationSummary struct {
+	ID             string `jsonapi:"primary,stack-configuration-summaries"`
+	Status         string `jsonapi:"attr,status"`
+	SequenceNumber int    `jsonapi:"attr,sequence-number"`
+}
+
+func (s stackConfigurationSummaries) List(ctx context.Context, stackID string, options *StackConfigurationSummaryListOptions) (*StackConfigurationSummaryList, error) {
+	if !validStringID(&stackID) {
+		return nil, fmt.Errorf("invalid stack ID: %s", stackID)
+	}
+
+	if options == nil {
+		options = &StackConfigurationSummaryListOptions{}
+	}
+
+	req, err := s.client.NewRequest("GET", fmt.Sprintf("stacks/%s/stack-configuration-summaries", url.PathEscape(stackID)), options)
+	if err != nil {
+		return nil, err
+	}
+
+	scl := &StackConfigurationSummaryList{}
+	err = req.Do(ctx, scl)
+	if err != nil {
+		return nil, err
+	}
+
+	return scl, nil
+}

stack_configuration_summary_integration_test.go

@@ -0,0 +1,79 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: MPL-2.0
+
+package tfe
+
+import (
+	"context"
+	"testing"
+	"time"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+func TestStackConfigurationSummaryList(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:   "hashicorp-guides/pet-nulls-stack",
+			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:   "hashicorp-guides/pet-nulls-stack",
+			OAuthTokenID: oauthClient.OAuthTokens[0].ID,
+		},
+		Project: &Project{
+			ID: orgTest.DefaultProject.ID,
+		},
+	})
+	require.NoError(t, err)
+	require.NotNil(t, stack2)
+
+	// Trigger first stack configuration by updating configuration
+	_, err = client.Stacks.UpdateConfiguration(ctx, stack2.ID)
+	require.NoError(t, err)
+
+	// Wait a bit and trigger second stack configuration
+	time.Sleep(2 * time.Second)
+	_, err = client.Stacks.UpdateConfiguration(ctx, stack2.ID)
+	require.NoError(t, err)
+
+	t.Run("Successful empty list", func(t *testing.T) {
+		stackConfigSummaryList, err := client.StackConfigurationSummaries.List(ctx, stack.ID, nil)
+		require.NoError(t, err)
+
+		assert.Len(t, stackConfigSummaryList.Items, 0)
+	})
+
+	t.Run("Successful multiple config summary list", func(t *testing.T) {
+		stackConfigSummaryList, err := client.StackConfigurationSummaries.List(ctx, stack2.ID, nil)
+		require.NoError(t, err)
+
+		assert.Len(t, stackConfigSummaryList.Items, 2)
+	})
+
+	t.Run("Unsuccessful list", func(t *testing.T) {
+		_, err := client.StackConfigurationSummaries.List(ctx, "", nil)
+		require.Error(t, err)
+	})
+}

tfe.go

@@ -166,6 +166,7 @@ type Client struct {
 	SSHKeys                         SSHKeys
 	Stacks                          Stacks
 	StackConfigurations             StackConfigurations
+	StackConfigurationSummaries     StackConfigurationSummaries
 	StackDeployments                StackDeployments
 	StackDeploymentGroups           StackDeploymentGroups
 	StackDeploymentRuns             StackDeploymentRuns
@@ -500,6 +501,7 @@ func NewClient(cfg *Config) (*Client, error) {
 	client.SSHKeys = &sshKeys{client: client}
 	client.Stacks = &stacks{client: client}
 	client.StackConfigurations = &stackConfigurations{client: client}
+	client.StackConfigurationSummaries = &stackConfigurationSummaries{client: client}
 	client.StackDeployments = &stackDeployments{client: client}
 	client.StackDeploymentGroups = &stackDeploymentGroups{client: client}
 	client.StackDeploymentRuns = &stackDeploymentRuns{client: client}