Rename PipelineSyncPlugin -> StagePlugin (missed to rename) (#5593)

Signed-off-by: t-kikuc <[email protected]>
pipe-cd · Feb 20, 2025 · ad00a56 · ad00a56
1 parent 7b78a17
commit ad00a56
Show file tree

Hide file tree

Showing 7 changed files with 28 additions and 28 deletions.
diff --git a/pkg/app/pipedv1/plugin/example/main.go b/pkg/app/pipedv1/plugin/example/main.go
@@ -21,7 +21,7 @@ import (
 )
 
 func main() {
-	sdk.RegisterPipelineSyncPlugin(&plugin{})
+	sdk.RegisterStagePlugin(&plugin{})
 
 	if err := sdk.Run(); err != nil {
 		log.Fatalln(err)

diff --git a/pkg/app/pipedv1/plugin/example/plugin.go b/pkg/app/pipedv1/plugin/example/plugin.go
@@ -34,17 +34,17 @@ func (p *plugin) Version() string {
 	return "0.0.1"
 }
 
-// BuildPipelineSyncStages implements sdk.PipelineSyncPlugin.
+// BuildPipelineSyncStages implements sdk.StagePlugin.
 func (p *plugin) BuildPipelineSyncStages(context.Context, *config, *sdk.BuildPipelineSyncStagesInput) (*sdk.BuildPipelineSyncStagesResponse, error) {
 	return &sdk.BuildPipelineSyncStagesResponse{}, nil
 }
 
-// ExecuteStage implements sdk.PipelineSyncPlugin.
+// ExecuteStage implements sdk.StagePlugin.
 func (p *plugin) ExecuteStage(context.Context, *config, sdk.DeployTargetsNone, *sdk.ExecuteStageInput) (*sdk.ExecuteStageResponse, error) {
 	return &sdk.ExecuteStageResponse{}, nil
 }
 
-// FetchDefinedStages implements sdk.PipelineSyncPlugin.
+// FetchDefinedStages implements sdk.StagePlugin.
 func (p *plugin) FetchDefinedStages() []string {
 	return []string{"EXAMPLE_PLAN", "EXAMPLE_APPLY"}
 }
diff --git a/pkg/app/pipedv1/plugin/kubernetes_multicluster/main.go b/pkg/app/pipedv1/plugin/kubernetes_multicluster/main.go
@@ -21,7 +21,7 @@ import (
 )
 
 func main() {
-	sdk.RegisterPipelineSyncPlugin(&plugin{})
+	sdk.RegisterStagePlugin(&plugin{})
 
 	if err := sdk.Run(); err != nil {
 		log.Fatalln(err)

diff --git a/pkg/app/pipedv1/plugin/kubernetes_multicluster/plugin.go b/pkg/app/pipedv1/plugin/kubernetes_multicluster/plugin.go
@@ -34,17 +34,17 @@ func (p *plugin) Version() string {
 	return "0.0.1"
 }
 
-// BuildPipelineSyncStages implements sdk.PipelineSyncPlugin.
+// BuildPipelineSyncStages implements sdk.StagePlugin.
 func (p *plugin) BuildPipelineSyncStages(context.Context, *config, *sdk.BuildPipelineSyncStagesInput) (*sdk.BuildPipelineSyncStagesResponse, error) {
 	return &sdk.BuildPipelineSyncStagesResponse{}, nil
 }
 
-// ExecuteStage implements sdk.PipelineSyncPlugin.
+// ExecuteStage implements sdk.StagePlugin.
 func (p *plugin) ExecuteStage(context.Context, *config, sdk.DeployTargetsNone, *sdk.ExecuteStageInput) (*sdk.ExecuteStageResponse, error) {
 	return &sdk.ExecuteStageResponse{}, nil
 }
 
-// FetchDefinedStages implements sdk.PipelineSyncPlugin.
+// FetchDefinedStages implements sdk.StagePlugin.
 func (p *plugin) FetchDefinedStages() []string {
 	return []string{"K8S_SYNC"}
 }
diff --git a/pkg/app/pipedv1/plugin/wait/main.go b/pkg/app/pipedv1/plugin/wait/main.go
@@ -21,7 +21,7 @@ import (
 )
 
 func main() {
-	sdk.RegisterPipelineSyncPlugin(&plugin{})
+	sdk.RegisterStagePlugin(&plugin{})
 
 	if err := sdk.Run(); err != nil {
 		log.Fatalln(err)

diff --git a/pkg/app/pipedv1/plugin/wait/plugin.go b/pkg/app/pipedv1/plugin/wait/plugin.go
@@ -36,7 +36,7 @@ func (p *plugin) Version() string {
 	return "0.0.1" // TODO
 }
 
-// BuildPipelineSyncStages implements sdk.PipelineSyncPlugin.
+// BuildPipelineSyncStages implements sdk.StagePlugin.
 func (p *plugin) BuildPipelineSyncStages(ctx context.Context, _ sdk.ConfigNone, input *sdk.BuildPipelineSyncStagesInput) (*sdk.BuildPipelineSyncStagesResponse, error) {
 	stages := make([]sdk.PipelineStage, 0, len(input.Request.Stages))
 	for _, rs := range input.Request.Stages {
@@ -55,15 +55,15 @@ func (p *plugin) BuildPipelineSyncStages(ctx context.Context, _ sdk.ConfigNone,
 	}, nil
 }
 
-// ExecuteStage implements sdk.PipelineSyncPlugin.
+// ExecuteStage implements sdk.StagePlugin.
 func (p *plugin) ExecuteStage(ctx context.Context, _ sdk.ConfigNone, _ sdk.DeployTargetsNone, input *sdk.ExecuteStageInput) (*sdk.ExecuteStageResponse, error) {
 	status := p.executeWait(ctx, input)
 	return &sdk.ExecuteStageResponse{
 		Status: status,
 	}, nil
 }
 
-// FetchDefinedStages implements sdk.PipelineSyncPlugin.
+// FetchDefinedStages implements sdk.StagePlugin.
 func (p *plugin) FetchDefinedStages() []string {
 	return []string{stageWait}
 }
diff --git a/pkg/plugin/sdk/deployment.go b/pkg/plugin/sdk/deployment.go
@@ -98,10 +98,10 @@ func RegisterDeploymentPlugin[Config, DeployTargetConfig any](plugin DeploymentP
 	deploymentServiceServer = &DeploymentPluginServiceServer[Config, DeployTargetConfig]{base: plugin}
 }
 
-// RegisterPipelineSyncPlugin registers the given pipeline sync plugin.
+// RegisterStagePlugin registers the given stage plugin.
 // It will be used when running the piped.
-func RegisterPipelineSyncPlugin[Config, DeployTargetConfig any](plugin StagePlugin[Config, DeployTargetConfig]) {
-	deploymentServiceServer = &PipelineSyncPluginServiceServer[Config, DeployTargetConfig]{base: plugin}
+func RegisterStagePlugin[Config, DeployTargetConfig any](plugin StagePlugin[Config, DeployTargetConfig]) {
+	deploymentServiceServer = &StagePluginServiceServer[Config, DeployTargetConfig]{base: plugin}
 }
 
 type logPersister interface {
@@ -193,8 +193,8 @@ func (s *DeploymentPluginServiceServer[Config, DeployTargetConfig]) ExecuteStage
 	return executeStage(ctx, s.base, &s.config, nil, client, request, s.logger) // TODO: pass the deployTargets
 }
 
-// PipelineSyncPluginServiceServer is the gRPC server that handles requests from the piped.
-type PipelineSyncPluginServiceServer[Config, DeployTargetConfig any] struct {
+// StagePluginServiceServer is the gRPC server that handles requests from the piped.
+type StagePluginServiceServer[Config, DeployTargetConfig any] struct {
 	deployment.UnimplementedDeploymentServiceServer
 	commonFields
 
@@ -203,25 +203,25 @@ type PipelineSyncPluginServiceServer[Config, DeployTargetConfig any] struct {
 }
 
 // Name returns the name of the plugin.
-func (s *PipelineSyncPluginServiceServer[Config, DeployTargetConfig]) Name() string {
+func (s *StagePluginServiceServer[Config, DeployTargetConfig]) Name() string {
 	return s.base.Name()
 }
 
 // Version returns the version of the plugin.
-func (s *PipelineSyncPluginServiceServer[Config, DeployTargetConfig]) Version() string {
+func (s *StagePluginServiceServer[Config, DeployTargetConfig]) Version() string {
 	return s.base.Version()
 }
 
 // Register registers the server to the given gRPC server.
-func (s *PipelineSyncPluginServiceServer[Config, DeployTargetConfig]) Register(server *grpc.Server) {
+func (s *StagePluginServiceServer[Config, DeployTargetConfig]) Register(server *grpc.Server) {
 	deployment.RegisterDeploymentServiceServer(server, s)
 }
 
-func (s *PipelineSyncPluginServiceServer[Config, DeployTargetConfig]) setCommonFields(fields commonFields) {
+func (s *StagePluginServiceServer[Config, DeployTargetConfig]) setCommonFields(fields commonFields) {
 	s.commonFields = fields
 }
 
-func (s *PipelineSyncPluginServiceServer[Config, DeployTargetConfig]) setConfig(bytes []byte) error {
+func (s *StagePluginServiceServer[Config, DeployTargetConfig]) setConfig(bytes []byte) error {
 	if bytes == nil {
 		return nil
 	}
@@ -231,27 +231,27 @@ func (s *PipelineSyncPluginServiceServer[Config, DeployTargetConfig]) setConfig(
 	return nil
 }
 
-func (s *PipelineSyncPluginServiceServer[Config, DeployTargetConfig]) FetchDefinedStages(context.Context, *deployment.FetchDefinedStagesRequest) (*deployment.FetchDefinedStagesResponse, error) {
+func (s *StagePluginServiceServer[Config, DeployTargetConfig]) FetchDefinedStages(context.Context, *deployment.FetchDefinedStagesRequest) (*deployment.FetchDefinedStagesResponse, error) {
 	return &deployment.FetchDefinedStagesResponse{Stages: s.base.FetchDefinedStages()}, nil
 }
-func (s *PipelineSyncPluginServiceServer[Config, DeployTargetConfig]) DetermineVersions(context.Context, *deployment.DetermineVersionsRequest) (*deployment.DetermineVersionsResponse, error) {
+func (s *StagePluginServiceServer[Config, DeployTargetConfig]) DetermineVersions(context.Context, *deployment.DetermineVersionsRequest) (*deployment.DetermineVersionsResponse, error) {
 	return &deployment.DetermineVersionsResponse{}, nil
 }
-func (s *PipelineSyncPluginServiceServer[Config, DeployTargetConfig]) DetermineStrategy(context.Context, *deployment.DetermineStrategyRequest) (*deployment.DetermineStrategyResponse, error) {
+func (s *StagePluginServiceServer[Config, DeployTargetConfig]) DetermineStrategy(context.Context, *deployment.DetermineStrategyRequest) (*deployment.DetermineStrategyResponse, error) {
 	return &deployment.DetermineStrategyResponse{Unsupported: true}, nil
 }
-func (s *PipelineSyncPluginServiceServer[Config, DeployTargetConfig]) BuildPipelineSyncStages(ctx context.Context, request *deployment.BuildPipelineSyncStagesRequest) (*deployment.BuildPipelineSyncStagesResponse, error) {
+func (s *StagePluginServiceServer[Config, DeployTargetConfig]) BuildPipelineSyncStages(ctx context.Context, request *deployment.BuildPipelineSyncStagesRequest) (*deployment.BuildPipelineSyncStagesResponse, error) {
 	client := &Client{
 		base:       s.client,
 		pluginName: s.Name(),
 	}
 
 	return buildPipelineSyncStages(ctx, s.base, &s.config, client, request, s.logger) // TODO: pass the real client
 }
-func (s *PipelineSyncPluginServiceServer[Config, DeployTargetConfig]) BuildQuickSyncStages(context.Context, *deployment.BuildQuickSyncStagesRequest) (*deployment.BuildQuickSyncStagesResponse, error) {
+func (s *StagePluginServiceServer[Config, DeployTargetConfig]) BuildQuickSyncStages(context.Context, *deployment.BuildQuickSyncStagesRequest) (*deployment.BuildQuickSyncStagesResponse, error) {
 	return nil, status.Errorf(codes.Unimplemented, "method BuildQuickSyncStages not implemented")
 }
-func (s *PipelineSyncPluginServiceServer[Config, DeployTargetConfig]) ExecuteStage(ctx context.Context, request *deployment.ExecuteStageRequest) (response *deployment.ExecuteStageResponse, _ error) {
+func (s *StagePluginServiceServer[Config, DeployTargetConfig]) ExecuteStage(ctx context.Context, request *deployment.ExecuteStageRequest) (response *deployment.ExecuteStageResponse, _ error) {
 	lp := s.logPersister.StageLogPersister(request.GetInput().GetDeployment().GetId(), request.GetInput().GetStage().GetId())
 	defer func() {
 		// When termination signal received and the stage is not completed yet, we should not mark the log persister as completed.