Merge pull request #1181 from hashicorp/fix-deployment-group-itemss

Fix `StackDeploymentGroup` Rerun, add `ReadByName`

Author: Maed223

CHANGELOG.md

@@ -3,8 +3,8 @@
 ## Enhancements
 * Add support for querying and filtering private registry modules based on a search query, `provider`, `registry_name` and `organization_name`, by @gautambaghel [#1179](https://github.com/hashicorp/go-tfe/pull/1179) 
 * 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)
 * Adds endpoint for reruning a stack deployment by @hwatkins05-hashicorp/@Maed223 [#1176](https://github.com/hashicorp/go-tfe/pull/1176)
+* Adds `ReadByName` for `StackDeploymentGroup` by @Maed223 [#1181](https://github.com/hashicorp/go-tfe/pull/1181)
 
 
 ## Bug Fixes

stack_deployment_groups.go

@@ -7,6 +7,7 @@ import (
 	"context"
 	"fmt"
 	"net/url"
+	"strings"
 	"time"
 )
 
@@ -18,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, stackDeploymentName string) (*StackDeploymentGroup, error)
+
 	// ApproveAllPlans approves all pending plans in a stack deployment group.
 	ApproveAllPlans(ctx context.Context, stackDeploymentGroupID string) error
 
@@ -64,14 +68,12 @@ 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.
 type StackDeploymentGroupRerunOptions struct {
 	// Required query parameter: A list of deployment run IDs to rerun.
-	Deployments []string `url:"deployments"`
+	Deployments []string
 }
 
 // List returns a list of Deployment Groups in a stack, optionally filtered by additional parameters.
@@ -80,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
 	}
@@ -99,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, 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) {
@@ -143,7 +167,19 @@ func (s stackDeploymentGroups) Rerun(ctx context.Context, stackDeploymentGroupID
 		return fmt.Errorf("no deployments specified for rerun")
 	}
 
-	req, err := s.client.NewRequest("POST", fmt.Sprintf("stack-deployment-groups/%s/rerun", url.PathEscape(stackDeploymentGroupID)), options)
+	u := fmt.Sprintf("stack-deployment-groups/%s/rerun", url.PathEscape(stackDeploymentGroupID))
+
+	type DeploymentQueryParams struct {
+		Deployments string `url:"deployments"`
+	}
+
+	qp, err := decodeQueryParams(&DeploymentQueryParams{
+		Deployments: strings.Join(options.Deployments, ","),
+	})
+	if err != nil {
+		return err
+	}
+	req, err := s.client.NewRequestWithAdditionalQueryParams("POST", u, nil, qp)
 	if err != nil {
 		return err
 	}

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) {