Fix finding deployment group by name

Author: Maed223

stack_deployment_groups.go

@@ -19,6 +19,9 @@ type StackDeploymentGroups interface {
 	// Read retrieves a stack deployment group by its ID.
 	Read(ctx context.Context, stackDeploymentGroupID string) (*StackDeploymentGroup, error)
 
+	// ReadByName retrieves a stack deployment group by its Name.
+	ReadByName(ctx context.Context, stackConfigurationID string, stackDeploymentName string) (*StackDeploymentGroup, error)
+
 	// ApproveAllPlans approves all pending plans in a stack deployment group.
 	ApproveAllPlans(ctx context.Context, stackDeploymentGroupID string) error
 
@@ -65,8 +68,6 @@ 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"`
 }
 
 // StackDeploymentGroupRerunOptions represents options for rerunning deployments in a stack deployment group.
@@ -81,12 +82,11 @@ func (s stackDeploymentGroups) List(ctx context.Context, stackConfigID string, o
 		return nil, fmt.Errorf("invalid stack configuration ID: %s", stackConfigID)
 	}
 
-	u := fmt.Sprintf("stack-configurations/%s/stack-deployment-groups/", url.PathEscape(stackConfigID))
-	qp, err := decodeQueryParams(options)
-	if err != nil {
-		return nil, err
+	if options == nil {
+		options = &StackDeploymentGroupListOptions{}
 	}
-	req, err := s.client.NewRequestWithAdditionalQueryParams("GET", u, nil, qp)
+
+	req, err := s.client.NewRequest("GET", fmt.Sprintf("stack-configurations/%s/stack-deployment-groups", url.PathEscape(stackConfigID)), options)
 	if err != nil {
 		return nil, err
 	}
@@ -100,6 +100,29 @@ func (s stackDeploymentGroups) List(ctx context.Context, stackConfigID string, o
 	return sdgl, nil
 }
 
+// ReadByName retrieves a stack deployment group by its Name.
+func (s stackDeploymentGroups) ReadByName(ctx context.Context, stackConfigurationID string, stackDeploymentName string) (*StackDeploymentGroup, error) {
+	if !validStringID(&stackConfigurationID) {
+		return nil, fmt.Errorf("invalid stack configuration id: %s", stackConfigurationID)
+	}
+	if !validStringID(&stackDeploymentName) {
+		return nil, fmt.Errorf("invalid stack deployment group name: %s", stackDeploymentName)
+	}
+
+	req, err := s.client.NewRequest("GET", fmt.Sprintf("stack-configurations/%s/stack-deployment-groups/%s", url.PathEscape(stackConfigurationID), url.PathEscape(stackDeploymentName)), nil)
+	if err != nil {
+		return nil, err
+	}
+
+	sdg := &StackDeploymentGroup{}
+	err = req.Do(ctx, sdg)
+	if err != nil {
+		return nil, err
+	}
+
+	return sdg, nil
+}
+
 // Read retrieves a stack deployment group by its ID.
 func (s stackDeploymentGroups) Read(ctx context.Context, stackDeploymentGroupID string) (*StackDeploymentGroup, error) {
 	if !validStringID(&stackDeploymentGroupID) {

stack_deployment_groups_integration_test.go

@@ -72,21 +72,6 @@ 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) {