Merge pull request #1132 from hashicorp/hw/get-deployment-group

Added support for reading a `StackDeploymentGroup` by its ID

Author: hwatkins05-hashicorp

CHANGELOG.md

@@ -5,6 +5,7 @@
 * Add support for HCP Terraform `/api/v2/workspaces/{external_id}/all-vars` API endpoint to fetch the list of all variables available to a workspace (include inherited variables from varsets) by @debrin-hc [#1105](https://github.com/hashicorp/go-tfe/pull/1105)
 * Adds BETA support for listing `StackDeploymentGroups`, which is EXPERIMENTAL, SUBJECT TO CHANGE, and may not be available to all users by @hwatkins05-hashicorp [#1128](https://github.com/hashicorp/go-tfe/pull/1128)
 * Adds BETA support for removing/adding VCS backing for a Stack, which is EXPERIMENTAL, SUBJECT TO CHANGE, and may not be available to all users by @Maed223 [#1131](https://github.com/hashicorp/go-tfe/pull/1131)
+* Adds BETA support for reading a `StackDeploymentGroup`, which is EXPERIMENTAL, SUBJECT TO CHANGE, and may not be available to all users by @hwatkins05-hashicorp [#1132](https://github.com/hashicorp-go-tfe/pull/1132)
 
 ## Enhancements
 

stack_deployment_groups.go

@@ -10,6 +10,9 @@ import (
 type StackDeploymentGroups interface {
 	// List returns a list of Deployment Groups in a stack.
 	List(ctx context.Context, stackConfigID string, options *StackDeploymentGroupListOptions) (*StackDeploymentGroupList, error)
+
+	// Read retrieves a stack deployment group by its ID.
+	Read(ctx context.Context, stackDeploymentGroupID string) (*StackDeploymentGroup, error)
 }
 
 type DeploymentGroupStatus string
@@ -75,3 +78,23 @@ func (s stackDeploymentGroups) List(ctx context.Context, stackConfigID string, o
 
 	return sdgl, nil
 }
+
+// Read retrieves a stack deployment group by its ID.
+func (s stackDeploymentGroups) Read(ctx context.Context, stackDeploymentGroupID string) (*StackDeploymentGroup, error) {
+	if !validStringID(&stackDeploymentGroupID) {
+		return nil, fmt.Errorf("invalid stack deployment group ID: %s", stackDeploymentGroupID)
+	}
+
+	req, err := s.client.NewRequest("GET", fmt.Sprintf("stack-deployment-groups/%s", url.PathEscape(stackDeploymentGroupID)), nil)
+	if err != nil {
+		return nil, err
+	}
+
+	sdg := &StackDeploymentGroup{}
+	err = req.Do(ctx, sdg)
+	if err != nil {
+		return nil, err
+	}
+
+	return sdg, nil
+}

stack_deployment_groups_integration_test.go

@@ -73,3 +73,54 @@ func TestStackDeploymentGroupsList(t *testing.T) {
 		require.Len(t, sdgl.Items, 1)
 	})
 }
+
+func TestStackDeploymentGroupsRead(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",
+		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)
+
+	stackUpdated, err := client.Stacks.UpdateConfiguration(ctx, stack.ID)
+	require.NoError(t, err)
+	require.NotNil(t, stackUpdated)
+
+	stackUpdated = pollStackDeployments(t, ctx, client, stackUpdated.ID)
+	require.NotNil(t, stackUpdated.LatestStackConfiguration)
+
+	sdgl, err := client.StackDeploymentGroups.List(ctx, stackUpdated.LatestStackConfiguration.ID, nil)
+	require.NoError(t, err)
+	require.NotNil(t, sdgl)
+	require.Len(t, sdgl.Items, 2)
+
+	t.Run("Read with valid ID", func(t *testing.T) {
+		sdgRead, err := client.StackDeploymentGroups.Read(ctx, sdgl.Items[0].ID)
+		require.NoError(t, err)
+		assert.Equal(t, sdgl.Items[0].ID, sdgRead.ID)
+		assert.Equal(t, sdgl.Items[0].Name, sdgRead.Name)
+		assert.Equal(t, sdgl.Items[0].Status, sdgRead.Status)
+	})
+
+	t.Run("Read with invalid ID", func(t *testing.T) {
+		_, err := client.StackDeploymentGroups.Read(ctx, "")
+		require.Error(t, err)
+	})
+}