Merge pull request #954 from hashicorp/no-code-workspace-output

Fix returned workspace for created & upgraded no-code workspaces
hashicorp · Aug 7, 2024 · ffbcfd3 · ffbcfd3
2 parents 08c99d6 + 2b5ca89
commit ffbcfd3
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 19 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,9 @@
 # UNRELEASED
 * Adds `AllowMemberTokenManagement` permission to `Team` by @juliannatetreault [#922](https://github.com/hashicorp/go-tfe/pull/922)
 
+## Bug Fixes
+* Fix returned workspace for no-code workspace creation & upgrade by @paladin-devops [#954](https://github.com/hashicorp/go-tfe/pull/954)
+
 # v1.61.0
 
 ## Enhancements

diff --git a/mocks/registry_no_code_module_mocks.go b/mocks/registry_no_code_module_mocks.go
diff --git a/registry_no_code_module.go b/registry_no_code_module.go
@@ -35,10 +35,10 @@ type RegistryNoCodeModules interface {
 	Delete(ctx context.Context, ID string) error
 
 	// CreateWorkspace creates a workspace using a no-code module.
-	CreateWorkspace(ctx context.Context, noCodeModuleID string, options *RegistryNoCodeModuleCreateWorkspaceOptions) (*RegistryNoCodeModuleWorkspace, error)
+	CreateWorkspace(ctx context.Context, noCodeModuleID string, options *RegistryNoCodeModuleCreateWorkspaceOptions) (*Workspace, error)
 
 	// UpgradeWorkspace initiates an upgrade of an existing no-code module workspace.
-	UpgradeWorkspace(ctx context.Context, noCodeModuleID string, workspaceID string, options *RegistryNoCodeModuleUpgradeWorkspaceOptions) (*RegistryNoCodeModuleWorkspace, error)
+	UpgradeWorkspace(ctx context.Context, noCodeModuleID string, workspaceID string, options *RegistryNoCodeModuleUpgradeWorkspaceOptions) (*Workspace, error)
 }
 
 type RegistryNoCodeModuleCreateWorkspaceOptions struct {
@@ -85,10 +85,6 @@ type RegistryNoCodeModuleUpgradeWorkspaceOptions struct {
 	Variables []*Variable `jsonapi:"relation,vars,omitempty"`
 }
 
-type RegistryNoCodeModuleWorkspace struct {
-	Workspace
-}
-
 // registryNoCodeModules implements RegistryNoCodeModules.
 type registryNoCodeModules struct {
 	client *Client
@@ -282,7 +278,7 @@ func (r *registryNoCodeModules) CreateWorkspace(
 	ctx context.Context,
 	noCodeModuleID string,
 	options *RegistryNoCodeModuleCreateWorkspaceOptions,
-) (*RegistryNoCodeModuleWorkspace, error) {
+) (*Workspace, error) {
 	if err := options.valid(); err != nil {
 		return nil, err
 	}
@@ -293,7 +289,7 @@ func (r *registryNoCodeModules) CreateWorkspace(
 		return nil, err
 	}
 
-	w := &RegistryNoCodeModuleWorkspace{}
+	w := &Workspace{}
 	err = req.Do(ctx, w)
 	if err != nil {
 		return nil, err
@@ -308,7 +304,7 @@ func (r *registryNoCodeModules) UpgradeWorkspace(
 	noCodeModuleID string,
 	workspaceID string,
 	options *RegistryNoCodeModuleUpgradeWorkspaceOptions,
-) (*RegistryNoCodeModuleWorkspace, error) {
+) (*Workspace, error) {
 	if err := options.valid(); err != nil {
 		return nil, err
 	}
@@ -322,7 +318,7 @@ func (r *registryNoCodeModules) UpgradeWorkspace(
 		return nil, err
 	}
 
-	w := &RegistryNoCodeModuleWorkspace{}
+	w := &Workspace{}
 	err = req.Do(ctx, w)
 	if err != nil {
 		return nil, err

diff --git a/registry_no_code_module_integration_test.go b/registry_no_code_module_integration_test.go
@@ -355,7 +355,7 @@ func TestRegistryNoCodeModulesCreateWorkspace(t *testing.T) {
 		wn := fmt.Sprintf("foo-%s", randomString(t))
 		sn := "my-app"
 		su := "http://my-app.com"
-		_, err = client.RegistryNoCodeModules.CreateWorkspace(
+		w, err := client.RegistryNoCodeModules.CreateWorkspace(
 			ctx,
 			ncm.ID,
 			&RegistryNoCodeModuleCreateWorkspaceOptions{
@@ -366,9 +366,6 @@ func TestRegistryNoCodeModulesCreateWorkspace(t *testing.T) {
 			},
 		)
 		r.NoError(err)
-
-		w, err := client.Workspaces.Read(ctx, org.Name, wn)
-		r.NoError(err)
 		r.Equal(wn, w.Name)
 		r.Equal(sn, w.SourceName)
 		r.Equal(su, w.SourceURL)
@@ -473,13 +470,15 @@ func TestRegistryNoCodeModuleWorkspaceUpgrade(t *testing.T) {
 	r.NotNil(uncm)
 
 	t.Run("test upgrading a workspace via a no-code module", func(t *testing.T) {
-		_, err = client.RegistryNoCodeModules.UpgradeWorkspace(
+		ws, err := client.RegistryNoCodeModules.UpgradeWorkspace(
 			ctx,
 			ncm.ID,
 			w.ID,
 			&RegistryNoCodeModuleUpgradeWorkspaceOptions{},
 		)
 		r.NoError(err)
+		r.NotNil(ws)
+		r.Equal(w.ID, ws.ID)
 	})
 
 	t.Run("fail to upgrade workspace with invalid no-code module", func(t *testing.T) {