Merge pull request #955 from hashicorp/fix-no-code-upgrade

Fix no-code upgrade return value

Author: paladin-devops

CHANGELOG.md

@@ -1,5 +1,9 @@
 # UNRELEASED
 
+## Bug Fixes
+
+* Fixed `RegistryNoCodeModules` method `UpgradeWorkspace` to return a `WorkspaceUpgrade` type. This resulted in a BREAKING CHANGE, yet the previous type was not properly decoded nor reflective of the actual API result by @paladin-devops [#955](https://github.com/hashicorp/go-tfe/pull/955)
+
 # v1.64.2
 
 ## Enhancements

mocks/registry_no_code_module_mocks.go

@@ -38,7 +38,7 @@ type RegistryNoCodeModules interface {
 	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) (*Workspace, error)
+	UpgradeWorkspace(ctx context.Context, noCodeModuleID string, workspaceID string, options *RegistryNoCodeModuleUpgradeWorkspaceOptions) (*WorkspaceUpgrade, error)
 }
 
 type RegistryNoCodeModuleCreateWorkspaceOptions struct {
@@ -181,6 +181,19 @@ type RegistryNoCodeModuleUpdateOptions struct {
 	VariableOptions []*NoCodeVariableOption `jsonapi:"relation,variable-options,omitempty"`
 }
 
+// WorkspaceUpgrade contains the data returned by the no-code workspace upgrade
+// API endpoint.
+type WorkspaceUpgrade struct {
+	// Status is the status of the run of the upgrade
+	Status string `jsonapi:"attr,status"`
+
+	// PlanURL is the URL to the plan of the upgrade
+	PlanURL string `jsonapi:"attr,plan-url"`
+
+	// Message is the message returned by the API when an upgrade is not available.
+	Message string `jsonapi:"attr,message"`
+}
+
 // Create a new registry no-code module
 func (r *registryNoCodeModules) Create(ctx context.Context, organization string, options RegistryNoCodeModuleCreateOptions) (*RegistryNoCodeModule, error) {
 	if !validStringID(&organization) {
@@ -304,7 +317,7 @@ func (r *registryNoCodeModules) UpgradeWorkspace(
 	noCodeModuleID string,
 	workspaceID string,
 	options *RegistryNoCodeModuleUpgradeWorkspaceOptions,
-) (*Workspace, error) {
+) (*WorkspaceUpgrade, error) {
 	if err := options.valid(); err != nil {
 		return nil, err
 	}
@@ -318,13 +331,13 @@ func (r *registryNoCodeModules) UpgradeWorkspace(
 		return nil, err
 	}
 
-	w := &Workspace{}
-	err = req.Do(ctx, w)
+	wu := &WorkspaceUpgrade{}
+	err = req.Do(ctx, wu)
 	if err != nil {
 		return nil, err
 	}
 
-	return w, nil
+	return wu, nil
 }
 
 func (o RegistryNoCodeModuleCreateOptions) valid() error {

registry_no_code_module.go

@@ -470,15 +470,16 @@ func TestRegistryNoCodeModuleWorkspaceUpgrade(t *testing.T) {
 	r.NotNil(uncm)
 
 	t.Run("test upgrading a workspace via a no-code module", func(t *testing.T) {
-		ws, err := client.RegistryNoCodeModules.UpgradeWorkspace(
+		wu, err := client.RegistryNoCodeModules.UpgradeWorkspace(
 			ctx,
 			ncm.ID,
 			w.ID,
 			&RegistryNoCodeModuleUpgradeWorkspaceOptions{},
 		)
 		r.NoError(err)
-		r.NotNil(ws)
-		r.Equal(w.ID, ws.ID)
+		r.NotNil(wu)
+		r.NotEmpty(wu.Status)
+		r.NotEmpty(wu.PlanURL)
 	})
 
 	t.Run("fail to upgrade workspace with invalid no-code module", func(t *testing.T) {