Add Pre-Plan Run Tasks to Terraform CLI

Prevously the cloud backend would only render post-plan run tasks. Now
that pre-plan tasks are in beta, this commit updates the plan phase to
render pre-plan run tasks.  This commit also moves some common code to
the common backend as it will be used by other task stages in the
future.

Author: glennsarti

CHANGELOG.md

@@ -34,6 +34,7 @@ ENHANCEMENTS:
 * The AzureRM Backend now only supports MSAL (and Microsoft Graph) and no longer makes use of ADAL (and Azure Active Directory Graph) for authentication ([#31070](https://github.com/hashicorp/terraform/issues/31070))
 * The COS backend now supports global acceleration. ([#31425](https://github.com/hashicorp/terraform/issues/31425))
 * providercache: include host in provider installation error ([#31524](https://github.com/hashicorp/terraform/issues/31524))
+* When showing the progress of a remote operation running in Terraform Cloud, Terraform CLI will include information about pre-plan run tasks ([#31617](https://github.com/hashicorp/terraform/issues/31617))
 
 BUG FIXES:
 
@@ -52,7 +53,7 @@ EXPERIMENTS:
     * The built-in `defaults` function, previously used to meet the use-case of replacing null values with default values, will not graduate to stable and has been removed. Use the second argument of `optional` inline in your type constraint to declare default values instead.
 
     If you have any experimental modules that were participating in this experiment, you will need to remove the experiment opt-in and adopt the new syntax for declaring default values in order to migrate your existing module to the stablized version of this feature. If you are writing a shared module for others to use, we recommend declaring that your module requires Terraform v1.3.0 or later to give specific feedback when using the new feature on older Terraform versions, in place of the previous declaration to use the experimental form of this feature:
-    
+
     ```hcl
     terraform {
       required_version = ">= 1.3.0"

internal/cloud/backend_common.go

@@ -199,6 +199,17 @@ func (b *Cloud) waitForRun(stopCtx, cancelCtx context.Context, op *backend.Opera
 	}
 }
 
+func (b *Cloud) waitTaskStage(stopCtx, cancelCtx context.Context, op *backend.Operation, r *tfe.Run, stageID string, outputTitle string) error {
+	integration := &IntegrationContext{
+		B:             b,
+		StopContext:   stopCtx,
+		CancelContext: cancelCtx,
+		Op:            op,
+		Run:           r,
+	}
+	return b.runTasks(integration, integration.BeginOutput(outputTitle), stageID)
+}
+
 func (b *Cloud) costEstimate(stopCtx, cancelCtx context.Context, op *backend.Operation, r *tfe.Run) error {
 	if r.CostEstimate == nil {
 		return nil

internal/cloud/backend_plan.go

@@ -291,6 +291,27 @@ in order to capture the filesystem context the remote workspace expects:
 			runHeader, b.hostname, b.organization, op.Workspace, r.ID)) + "\n"))
 	}
 
+	// Retrieve the run to get task stages.
+	// Task Stages are calculated upfront so we only need to call this once for the run.
+	taskStages := make([]*tfe.TaskStage, 0)
+	if result, err := b.client.Runs.ReadWithOptions(stopCtx, r.ID, &tfe.RunReadOptions{
+		Include: []tfe.RunIncludeOpt{tfe.RunTaskStages},
+	}); err == nil {
+		taskStages = result.TaskStages
+	} else {
+		// This error would be expected for older versions of TFE that do not allow
+		// fetching task_stages.
+		if !strings.HasSuffix(err.Error(), "Invalid include parameter") {
+			return r, generalError("Failed to retrieve run", err)
+		}
+	}
+
+	if stageID := getTaskStageIDByName(taskStages, tfe.PrePlan); stageID != nil {
+		if err := b.waitTaskStage(stopCtx, cancelCtx, op, r, *stageID, "Pre-plan Tasks"); err != nil {
+			return r, err
+		}
+	}
+
 	r, err = b.waitForRun(stopCtx, cancelCtx, op, "plan", r, w)
 	if err != nil {
 		return r, err
@@ -324,20 +345,9 @@ in order to capture the filesystem context the remote workspace expects:
 	}
 
 	// Retrieve the run to get its current status.
-	runID := r.ID
-	r, err = b.client.Runs.ReadWithOptions(stopCtx, runID, &tfe.RunReadOptions{
-		Include: []tfe.RunIncludeOpt{tfe.RunTaskStages},
-	})
+	r, err = b.client.Runs.Read(stopCtx, r.ID)
 	if err != nil {
-		// This error would be expected for older versions of TFE that do not allow
-		// fetching task_stages.
-		if strings.HasSuffix(err.Error(), "Invalid include parameter") {
-			r, err = b.client.Runs.Read(stopCtx, runID)
-		}
-
-		if err != nil {
-			return r, generalError("Failed to retrieve run", err)
-		}
+		return r, generalError("Failed to retrieve run", err)
 	}
 
 	// If the run is canceled or errored, we still continue to the
@@ -346,18 +356,8 @@ in order to capture the filesystem context the remote workspace expects:
 	// status of the run will be "errored", but there is still policy
 	// information which should be shown.
 
-	// Await post-plan run tasks
-	integration := &IntegrationContext{
-		B:             b,
-		StopContext:   stopCtx,
-		CancelContext: cancelCtx,
-		Op:            op,
-		Run:           r,
-	}
-
-	if stageID := getTaskStageIDByName(r.TaskStages, tfe.PostPlan); stageID != nil {
-		err = b.runTasks(integration, integration.BeginOutput("Run Tasks (post-plan)"), *stageID)
-		if err != nil {
+	if stageID := getTaskStageIDByName(taskStages, tfe.PostPlan); stageID != nil {
+		if err := b.waitTaskStage(stopCtx, cancelCtx, op, r, *stageID, "Post-plan Tasks"); err != nil {
 			return r, err
 		}
 	}

internal/cloud/backend_runTasks.go

@@ -52,7 +52,7 @@ func (b *Cloud) runTasksWithTaskResults(context *IntegrationContext, output Inte
 		stage, err := fetchTaskStage(b, context.StopContext)
 
 		if err != nil {
-			return false, generalError("Failed to retrieve pre-apply task stage", err)
+			return false, generalError("Failed to retrieve task stage", err)
 		}
 
 		summary := summarizeTaskResults(stage.TaskResults)