Merge pull request #1175 from hashicorp/TF-27927/deployment-group-list-name-filter

`StackDeploymentGroup` List name filter

Author: Maed223

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## Enhancements
 * Adds support for `RegistryModule` VCS source_directory and tag_prefix options, by @jillrami [#1154] (https://github.com/hashicorp/go-tfe/pull/1154)
+* Adds `GroupName` filter option for `StackDeploymentGroup` by @Maed223 [#1175](https://github.com/hashicorp/go-tfe/pull/1175)
 
 ## Bug Fixes
 * Fixes issue [1061](https://github.com/hashicorp/go-tfe/issues/1061), validation accepts all RunStatus including `"cost_estimated"` by @KenCox-Hashicorp [#1171](https://github.com/hashicorp/go-tfe/pull/1171)

stack_deployment_groups.go

@@ -61,6 +61,8 @@ type StackDeploymentGroupList struct {
 // StackDeploymentGroupListOptions represents additional options when listing stack deployment groups.
 type StackDeploymentGroupListOptions struct {
 	ListOptions
+	// A query string used to filter by deployment group name.
+	GroupName string `url:"group_name,omitempty"`
 }
 
 // List returns a list of Deployment Groups in a stack, optionally filtered by additional parameters.
@@ -69,11 +71,12 @@ func (s stackDeploymentGroups) List(ctx context.Context, stackConfigID string, o
 		return nil, fmt.Errorf("invalid stack configuration ID: %s", stackConfigID)
 	}
 
-	if options == nil {
-		options = &StackDeploymentGroupListOptions{}
+	u := fmt.Sprintf("stack-configurations/%s/stack-deployment-groups/", url.PathEscape(stackConfigID))
+	qp, err := decodeQueryParams(options)
+	if err != nil {
+		return nil, err
 	}
-
-	req, err := s.client.NewRequest("GET", fmt.Sprintf("stack-configurations/%s/stack-deployment-groups", url.PathEscape(stackConfigID)), options)
+	req, err := s.client.NewRequestWithAdditionalQueryParams("GET", u, nil, qp)
 	if err != nil {
 		return nil, err
 	}

stack_deployment_groups_integration_test.go

@@ -72,6 +72,21 @@ func TestStackDeploymentGroupsList(t *testing.T) {
 		require.NotNil(t, sdgl)
 		require.Len(t, sdgl.Items, 1)
 	})
+
+	t.Run("List with filtering by group name", func(t *testing.T) {
+		noOptionSdg, err := client.StackDeploymentGroups.List(ctx, stackUpdated.LatestStackConfiguration.ID, nil)
+		require.NoError(t, err)
+		require.NotNil(t, noOptionSdg)
+		require.GreaterOrEqual(t, len(noOptionSdg.Items), 1)
+		options := &StackDeploymentGroupListOptions{
+			GroupName: noOptionSdg.Items[0].Name,
+		}
+		sdgl, err := client.StackDeploymentGroups.List(ctx, stackUpdated.LatestStackConfiguration.ID, options)
+		require.NoError(t, err)
+		require.NotNil(t, sdgl)
+		require.Equal(t, 1, len(sdgl.Items))
+		require.Equal(t, noOptionSdg.Items[0].Name, sdgl.Items[0].Name)
+	})
 }
 
 func TestStackDeploymentGroupsRead(t *testing.T) {