Stack configuration list endpoint (#1138)

* commit

* Update stack_configuration_integration_test.go

* Update CHANGELOG.md

* Update stack_configuration_integration_test.go

* add relationships to stackconfig

* Update stack_configuration_integration_test.go

* update relationships

Author: shwetamurali

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## Enhancements
 
+* Adds BETA support for listing `StackConfigurationList`, which is EXPERIMENTAL, SUBJECT TO CHANGE, and may not be available to all users by @shwetamurali [#1138](https://github.com/hashicorp/go-tfe/pull/1138)
 * Adds BETA support for approving all plans for a stack deployment run, which is EXPERIMENTAL, SUBJECT TO CHANGE, and may not be available to all users by @ctrombley [#1136](https://github.com/hashicorp/go-tfe/pull/1136)
 * Adds BETA support for listing and reading `StackDeploymentSteps`, which is EXPERIMENTAL, SUBJECT TO CHANGE, and may not be available to all users by @ctrombley [#1133](https://github.com/hashicorp/go-tfe/pull/1133)
 * Adds BETA support for approving all plans in `StackDeploymentGroups`, which is EXPERIMENTAL, SUBJECT TO CHANGE, and may not be available to all users by @hwatkins05-hashicorp [#1137](https://github.com/hashicorp/go-tfe/pull/1137)

stack.go

@@ -131,6 +131,8 @@ type StackConfiguration struct {
 	ErrorMessage         *string                             `jsonapi:"attr,error-message"`
 	EventStreamURL       string                              `jsonapi:"attr,event-stream-url"`
 	Diagnostics          []*StackDiagnostic                  `jsonapi:"attr,diags"`
+
+	Stack *Stack `jsonapi:"relation,stack"`
 }
 
 // StackDeployment represents a stack deployment, specified by configuration

stack_configuration.go

@@ -18,6 +18,9 @@ type StackConfigurations interface {
 	// ReadConfiguration returns a stack configuration by its ID.
 	Read(ctx context.Context, id string) (*StackConfiguration, error)
 
+	// ListStackConfigurations returns a list of stack configurations for a stack.
+	List(ctx context.Context, stackID string, options *StackConfigurationListOptions) (*StackConfigurationList, error)
+
 	// JSONSchemas returns a byte slice of the JSON schema for the stack configuration.
 	JSONSchemas(ctx context.Context, stackConfigurationID string) ([]byte, error)
 
@@ -121,3 +124,33 @@ func (s stackConfigurations) AwaitStatus(ctx context.Context, stackConfiguration
 		return stackConfiguration.Status, nil
 	}, []string{status.String(), StackConfigurationStatusErrored.String(), StackConfigurationStatusCanceled.String()})
 }
+
+// StackConfigurationList represents a paginated list of stack configurations.
+type StackConfigurationList struct {
+	Pagination *Pagination
+	Items      []*StackConfiguration
+}
+
+// StackConfigurationListOptions represents the options for listing stack configurations.
+type StackConfigurationListOptions struct {
+	ListOptions
+}
+
+func (s stackConfigurations) List(ctx context.Context, stackID string, options *StackConfigurationListOptions) (*StackConfigurationList, error) {
+	if options == nil {
+		options = &StackConfigurationListOptions{}
+	}
+
+	req, err := s.client.NewRequest("GET", fmt.Sprintf("stacks/%s/stack-configurations", url.PathEscape(stackID)), options)
+	if err != nil {
+		return nil, err
+	}
+
+	result := &StackConfigurationList{}
+	err = req.Do(ctx, result)
+	if err != nil {
+		return nil, err
+	}
+
+	return result, nil
+}

stack_configuration_integration_test.go

@@ -0,0 +1,80 @@
+// 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 TestStackConfigurationList(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-list",
+		VCSRepo: &StackVCSRepoOptions{
+			Identifier:   "hashicorp-guides/pet-nulls-stack",
+			OAuthTokenID: oauthClient.OAuthTokens[0].ID,
+		},
+		Project: &Project{
+			ID: orgTest.DefaultProject.ID,
+		},
+	})
+	require.NoError(t, err)
+
+	// Trigger first stack configuration by updating configuration
+	_, err = client.Stacks.UpdateConfiguration(ctx, stack.ID)
+	require.NoError(t, err)
+
+	// Wait a bit and trigger second stack configuration
+	time.Sleep(2 * time.Second)
+	_, err = client.Stacks.UpdateConfiguration(ctx, stack.ID)
+	require.NoError(t, err)
+
+	list, err := client.StackConfigurations.List(ctx, stack.ID, nil)
+	require.NoError(t, err)
+	require.NotNil(t, list)
+	assert.Equal(t, len(list.Items), 2)
+
+	// Assert attributes for each configuration
+	for _, cfg := range list.Items {
+		require.NotEmpty(t, cfg.ID)
+		require.NotEmpty(t, cfg.Status)
+		require.GreaterOrEqual(t, cfg.SequenceNumber, 1)
+
+		require.NotNil(t, cfg.Stack)
+		require.NotEmpty(t, cfg.Stack.ID)
+	}
+
+	// Test with pagination options
+	t.Run("with pagination options", func(t *testing.T) {
+		options := &StackConfigurationListOptions{
+			ListOptions: ListOptions{
+				PageNumber: 1,
+				PageSize:   10,
+			},
+		}
+
+		listWithOptions, err := client.StackConfigurations.List(ctx, stack.ID, options)
+		require.NoError(t, err)
+		require.NotNil(t, listWithOptions)
+		assert.GreaterOrEqual(t, len(listWithOptions.Items), 2)
+
+		require.NotNil(t, listWithOptions.Pagination)
+		assert.GreaterOrEqual(t, listWithOptions.Pagination.TotalCount, 2)
+	})
+}