Add toolRegistry as a common field for the Client in the SDK (#5621)

Author: ffjlabo

pkg/plugin/sdk/client.go

@@ -19,6 +19,7 @@ import (
 
 	"github.com/pipe-cd/pipecd/pkg/plugin/pipedapi"
 	"github.com/pipe-cd/pipecd/pkg/plugin/pipedservice"
+	"github.com/pipe-cd/pipecd/pkg/plugin/toolregistry"
 )
 
 // Client is a toolkit for interacting with the piped service.
@@ -42,6 +43,10 @@ type Client struct {
 	// logPersister is used to persist the stage logs.
 	// This field exists only when the client is working with a specific stage; for example, when this client is passed as the ExecuteStage method's argument.
 	logPersister StageLogPersister
+
+	// toolRegistry is used to install and get the path of the tools used in the plugin.
+	// TODO: We should consider installing the tools in other way.
+	toolRegistry *toolregistry.ToolRegistry
 }
 
 // StageLogPersister is a interface for persisting the stage logs.
@@ -139,3 +144,9 @@ func (c *Client) GetDeploymentSharedMetadata(ctx context.Context, key string) (s
 func (c *Client) LogPersister() StageLogPersister {
 	return c.logPersister
 }
+
+// ToolRegistry returns the tool registry.
+// Use this to install and get the path of the tools used in the plugin.
+func (c *Client) ToolRegistry() *toolregistry.ToolRegistry {
+	return c.toolRegistry
+}

pkg/plugin/sdk/deployment.go

@@ -32,6 +32,7 @@ import (
 	"github.com/pipe-cd/pipecd/pkg/plugin/logpersister"
 	"github.com/pipe-cd/pipecd/pkg/plugin/pipedapi"
 	"github.com/pipe-cd/pipecd/pkg/plugin/signalhandler"
+	"github.com/pipe-cd/pipecd/pkg/plugin/toolregistry"
 )
 
 var (
@@ -114,6 +115,7 @@ type commonFields struct {
 	logger       *zap.Logger
 	logPersister logPersister
 	client       *pipedapi.PipedServiceClient
+	toolRegistry *toolregistry.ToolRegistry
 }
 
 // DeploymentPluginServiceServer is the gRPC server that handles requests from the piped.
@@ -205,6 +207,7 @@ func (s *DeploymentPluginServiceServer[Config, DeployTargetConfig]) ExecuteStage
 		deploymentID:  request.GetInput().GetDeployment().GetId(),
 		stageID:       request.GetInput().GetStage().GetId(),
 		logPersister:  lp,
+		toolRegistry:  s.toolRegistry,
 	}
 
 	// Get the deploy targets set on the deployment from the piped plugin config.
@@ -308,6 +311,7 @@ func (s *StagePluginServiceServer[Config, DeployTargetConfig]) ExecuteStage(ctx
 		deploymentID:  request.GetInput().GetDeployment().GetId(),
 		stageID:       request.GetInput().GetStage().GetId(),
 		logPersister:  lp,
+		toolRegistry:  s.toolRegistry,
 	}
 
 	return executeStage(ctx, s.base, &s.config, nil, client, request, s.logger) // TODO: pass the deployTargets

pkg/plugin/sdk/sdk.go

@@ -31,6 +31,7 @@ import (
 	config "github.com/pipe-cd/pipecd/pkg/configv1"
 	"github.com/pipe-cd/pipecd/pkg/plugin/logpersister"
 	"github.com/pipe-cd/pipecd/pkg/plugin/pipedapi"
+	"github.com/pipe-cd/pipecd/pkg/plugin/toolregistry"
 	"github.com/pipe-cd/pipecd/pkg/rpc"
 )
 
@@ -161,6 +162,7 @@ func (s *plugin) run(ctx context.Context, input cli.Input) (runErr error) {
 			logger:       input.Logger.Named("deployment-service"),
 			logPersister: persister,
 			client:       pipedapiClient,
+			toolRegistry: toolregistry.NewToolRegistry(pipedapiClient),
 		})
 		if err := deploymentServiceServer.setConfig(cfg.Config); err != nil {
 			input.Logger.Error("failed to set configuration", zap.Error(err))