remove Finish() and stop client in command

Author: dsa0x

internal/backend/backendrun/local_run.go

@@ -85,14 +85,3 @@ type LocalRun struct {
 	// during the run.
 	PolicyClient policy.Client
 }
-
-// Finish should be called when the local run has completed executing and
-// the resources should be cleaned up.
-func (lr *LocalRun) Finish() {
-	if lr == nil {
-		return
-	}
-	if lr.PolicyClient != nil {
-		lr.PolicyClient.Stop()
-	}
-}

internal/backend/local/backend_apply.go

@@ -59,7 +59,6 @@ func (b *Local) opApply(
 
 	// Get our context
 	lr, _, opState, contextDiags := b.localRun(op)
-	defer lr.Finish()
 
 	diags = diags.Append(contextDiags)
 	if contextDiags.HasErrors() {

internal/backend/local/backend_plan.go

@@ -90,7 +90,6 @@ func (b *Local) opPlan(
 
 	// Set up backend and get our context
 	lr, configSnap, opState, ctxDiags := b.localRun(op)
-	defer lr.Finish()
 
 	diags = diags.Append(ctxDiags)
 	if ctxDiags.HasErrors() {

internal/backend/local/backend_refresh.go

@@ -49,7 +49,6 @@ func (b *Local) opRefresh(
 
 	// Get our context
 	lr, _, opState, contextDiags := b.localRun(op)
-	defer lr.Finish()
 
 	diags = diags.Append(contextDiags)
 	if contextDiags.HasErrors() {

internal/command/apply.go

@@ -12,7 +12,6 @@ import (
 	"github.com/hashicorp/terraform/internal/command/arguments"
 	"github.com/hashicorp/terraform/internal/command/views"
 	"github.com/hashicorp/terraform/internal/plans/planfile"
-	"github.com/hashicorp/terraform/internal/policy"
 	"github.com/hashicorp/terraform/internal/tfdiags"
 )
 
@@ -106,13 +105,14 @@ func (c *ApplyCommand) Run(rawArgs []string) int {
 		return 1
 	}
 
-	if len(c.policyPaths) > 0 {
-		var policyDiags policy.Diagnostics
-		opReq.PolicyClient, policyDiags = c.PolicyClient(context.Background(), c.policyPaths)
+	if len(c.Meta.policyPaths) > 0 {
+		client, policyDiags, stopClient := c.PolicyClient(context.Background(), c.policyPaths)
 		// if there has been any errors when setting up the policy client, we'll log them
 		if opReq.View != nil && policyDiags != nil {
 			opReq.View.PolicyResults(nil, policyDiags)
 		}
+		opReq.PolicyClient = client
+		defer stopClient()
 	}
 
 	// Collect variable value and add them to the operation request

internal/command/console.go

@@ -95,7 +95,6 @@ func (c *ConsoleCommand) Run(args []string) int {
 
 	// Get the context
 	lr, _, ctxDiags := local.LocalRun(context.Background(), opReq)
-	defer lr.Finish()
 
 	diags = diags.Append(ctxDiags)
 	if ctxDiags.HasErrors() {

internal/command/graph.go

@@ -97,7 +97,6 @@ func (c *GraphCommand) Run(rawArgs []string) int {
 
 	// Get the context
 	lr, _, ctxDiags := local.LocalRun(context.Background(), opReq)
-	defer lr.Finish()
 
 	diags = diags.Append(ctxDiags)
 	if ctxDiags.HasErrors() {

internal/command/import.go

@@ -208,7 +208,6 @@ func (c *ImportCommand) Run(args []string) int {
 
 	// Get the context
 	lr, state, ctxDiags := local.LocalRun(context.Background(), opReq)
-	defer lr.Finish()
 
 	diags = diags.Append(ctxDiags)
 	if ctxDiags.HasErrors() {

internal/command/meta_policy.go

@@ -15,21 +15,24 @@ import (
 	"github.com/hashicorp/terraform/version"
 )
 
-func (c *Meta) PolicyClient(ctx context.Context, policyPaths []string) (policy.Client, policy.Diagnostics) {
+func (c *Meta) PolicyClient(ctx context.Context, policyPaths []string) (policy.Client, policy.Diagnostics, func()) {
 	var client policy.Client
+	closer := func() {
+		client.Stop()
+	}
 	if !c.AllowExperimentalFeatures {
 		log.Printf("[DEBUG] Policies are not supported without experiments enabled, skipping policy client setup")
-		return client, nil
+		return client, nil, closer
 	}
 	if len(policyPaths) == 0 {
 		log.Printf("[DEBUG] No policy paths configured, skipping policy client setup")
-		return client, nil
+		return client, nil, closer
 	}
 
 	// Use a pre-initialized client for tests if one is available
 	if c.testingOverrides != nil {
 		if client := c.testingOverrides.PolicyClient; client != nil {
-			return client, nil
+			return client, nil, closer
 		}
 	}
 
@@ -41,7 +44,7 @@ func (c *Meta) PolicyClient(ctx context.Context, policyPaths []string) (policy.C
 			fmt.Sprintf("Failed to connect to policy engine: %s.", err),
 			policy.SetupErrorResult,
 		))
-		return nil, diags
+		return nil, diags, closer
 	}
 
 	var callbackServiceID uint32
@@ -50,8 +53,7 @@ func (c *Meta) PolicyClient(ctx context.Context, policyPaths []string) (policy.C
 	if srv, ok := client.(policy.CallbackService); ok {
 		callbackServer, cbDiags := srv.RegisterCallbackService(ctx)
 		if cbDiags != nil {
-			client.Stop()
-			return nil, cbDiags
+			return nil, cbDiags, closer
 		}
 		callbackServiceID = callbackServer.ID
 	}
@@ -66,7 +68,6 @@ func (c *Meta) PolicyClient(ctx context.Context, policyPaths []string) (policy.C
 	for _, config := range resp.ServerConfigurations() {
 		version, err := constraints.ParseRubyStyleMulti(config.RequiredVersion)
 		if err != nil {
-			client.Stop()
 			diags = append(diags, policy.NewErrorDiagnostic(
 				"Failed to validate required Terraform version",
 				fmt.Sprintf("The policy file %s had a Terraform version constraint that could not be parsed: %s.", config.File, err),
@@ -80,7 +81,7 @@ func (c *Meta) PolicyClient(ctx context.Context, policyPaths []string) (policy.C
 
 	if len(diags) > 0 {
 		client.Stop()
-		return nil, diags
+		return nil, diags, closer
 	}
 
 	terraformVersion, err := versions.ParseVersion(version.Version)
@@ -97,10 +98,9 @@ func (c *Meta) PolicyClient(ctx context.Context, policyPaths []string) (policy.C
 			fmt.Sprintf("The current version of Terraform is %s, and it is not compatible with the versions of Terraform required by the selected policies.", version.String()),
 			policy.SetupErrorResult,
 		))
-		client.Stop()
-		return nil, diags
+		return nil, diags, closer
 	}
 
 	log.Printf("[INFO] backend/operation/policy: Policy engine initialized")
-	return client, diags
+	return client, diags, closer
 }

internal/command/plan.go

@@ -11,7 +11,6 @@ import (
 	"github.com/hashicorp/terraform/internal/backend/backendrun"
 	"github.com/hashicorp/terraform/internal/command/arguments"
 	"github.com/hashicorp/terraform/internal/command/views"
-	"github.com/hashicorp/terraform/internal/policy"
 	"github.com/hashicorp/terraform/internal/tfdiags"
 )
 
@@ -181,12 +180,13 @@ func (c *PlanCommand) OperationRequest(be backendrun.OperationsBackend, view vie
 	}
 
 	if len(c.Meta.policyPaths) > 0 {
-		var policyDiags policy.Diagnostics
-		opReq.PolicyClient, policyDiags = c.PolicyClient(context.Background(), c.policyPaths)
-		// if there has been any errors when setting up the policy client, we'll want to log them
+		client, policyDiags, stopClient := c.PolicyClient(context.Background(), c.policyPaths)
+		// if there has been any errors when setting up the policy client, we'll log them
 		if opReq.View != nil && policyDiags != nil {
 			opReq.View.PolicyResults(nil, policyDiags)
 		}
+		opReq.PolicyClient = client
+		defer stopClient()
 	}
 
 	return opReq, diags