Skip to content

[sdk] Rename PipelineSyncPlugin to StagePlugin (missed to rename) #5593

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
t-kikuc merged 1 commit into from
Feb 20, 2025
Merged

[sdk] Rename PipelineSyncPlugin to StagePlugin (missed to rename) #5593

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion pkg/app/pipedv1/plugin/example/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
)

func main() {
sdk.RegisterPipelineSyncPlugin(&plugin{})
sdk.RegisterStagePlugin(&plugin{})

Check warning on line 24 in pkg/app/pipedv1/plugin/example/main.go

View check run for this annotation

Codecov / codecov/patch

pkg/app/pipedv1/plugin/example/main.go#L24 

Added line #L24 was not covered by tests

if err := sdk.Run(); err != nil {
log.Fatalln(err)
Expand Down
6 changes: 3 additions & 3 deletions pkg/app/pipedv1/plugin/example/plugin.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"}
}
2 changes: 1 addition & 1 deletion pkg/app/pipedv1/plugin/kubernetes_multicluster/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
)

func main() {
sdk.RegisterPipelineSyncPlugin(&plugin{})
sdk.RegisterStagePlugin(&plugin{})

Check warning on line 24 in pkg/app/pipedv1/plugin/kubernetes_multicluster/main.go

View check run for this annotation

Codecov / codecov/patch

pkg/app/pipedv1/plugin/kubernetes_multicluster/main.go#L24 

Added line #L24 was not covered by tests

if err := sdk.Run(); err != nil {
log.Fatalln(err)
Expand Down
6 changes: 3 additions & 3 deletions pkg/app/pipedv1/plugin/kubernetes_multicluster/plugin.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"}
}
2 changes: 1 addition & 1 deletion pkg/app/pipedv1/plugin/wait/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
)

func main() {
sdk.RegisterPipelineSyncPlugin(&plugin{})
sdk.RegisterStagePlugin(&plugin{})

Check warning on line 24 in pkg/app/pipedv1/plugin/wait/main.go

View check run for this annotation

Codecov / codecov/patch

pkg/app/pipedv1/plugin/wait/main.go#L24 

Added line #L24 was not covered by tests

if err := sdk.Run(); err != nil {
log.Fatalln(err)
Expand Down
6 changes: 3 additions & 3 deletions pkg/app/pipedv1/plugin/wait/plugin.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand All @@ -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}
}
32 changes: 16 additions & 16 deletions pkg/plugin/sdk/deployment.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,10 +98,10 @@
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}

Check warning on line 104 in pkg/plugin/sdk/deployment.go

View check run for this annotation

Codecov / codecov/patch

pkg/plugin/sdk/deployment.go#L103-L104 

Added lines #L103 - L104 were not covered by tests
}

type logPersister interface {
Expand Down Expand Up @@ -193,8 +193,8 @@
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

Expand All @@ -203,25 +203,25 @@
}

// Name returns the name of the plugin.
func (s *PipelineSyncPluginServiceServer[Config, DeployTargetConfig]) Name() string {
func (s *StagePluginServiceServer[Config, DeployTargetConfig]) Name() string {

Check warning on line 206 in pkg/plugin/sdk/deployment.go

View check run for this annotation

Codecov / codecov/patch

pkg/plugin/sdk/deployment.go#L206 

Added line #L206 was not covered by tests
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 {

Check warning on line 211 in pkg/plugin/sdk/deployment.go

View check run for this annotation

Codecov / codecov/patch

pkg/plugin/sdk/deployment.go#L211 

Added line #L211 was not covered by tests
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) {

Check warning on line 216 in pkg/plugin/sdk/deployment.go

View check run for this annotation

Codecov / codecov/patch

pkg/plugin/sdk/deployment.go#L216 

Added line #L216 was not covered by tests
deployment.RegisterDeploymentServiceServer(server, s)
}

func (s *PipelineSyncPluginServiceServer[Config, DeployTargetConfig]) setCommonFields(fields commonFields) {
func (s *StagePluginServiceServer[Config, DeployTargetConfig]) setCommonFields(fields commonFields) {

Check warning on line 220 in pkg/plugin/sdk/deployment.go

View check run for this annotation

Codecov / codecov/patch

pkg/plugin/sdk/deployment.go#L220 

Added line #L220 was not covered by tests
s.commonFields = fields
}

func (s *PipelineSyncPluginServiceServer[Config, DeployTargetConfig]) setConfig(bytes []byte) error {
func (s *StagePluginServiceServer[Config, DeployTargetConfig]) setConfig(bytes []byte) error {

Check warning on line 224 in pkg/plugin/sdk/deployment.go

View check run for this annotation

Codecov / codecov/patch

pkg/plugin/sdk/deployment.go#L224 

Added line #L224 was not covered by tests
if bytes == nil {
return nil
}
Expand All @@ -231,27 +231,27 @@
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) {

Check warning on line 234 in pkg/plugin/sdk/deployment.go

View check run for this annotation

Codecov / codecov/patch

pkg/plugin/sdk/deployment.go#L234 

Added line #L234 was not covered by tests
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) {

Check warning on line 237 in pkg/plugin/sdk/deployment.go

View check run for this annotation

Codecov / codecov/patch

pkg/plugin/sdk/deployment.go#L237 

Added line #L237 was not covered by tests
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) {

Check warning on line 240 in pkg/plugin/sdk/deployment.go

View check run for this annotation

Codecov / codecov/patch

pkg/plugin/sdk/deployment.go#L240 

Added line #L240 was not covered by tests
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) {

Check warning on line 243 in pkg/plugin/sdk/deployment.go

View check run for this annotation

Codecov / codecov/patch

pkg/plugin/sdk/deployment.go#L243 

Added line #L243 was not covered by tests
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) {

Check warning on line 251 in pkg/plugin/sdk/deployment.go

View check run for this annotation

Codecov / codecov/patch

pkg/plugin/sdk/deployment.go#L251 

Added line #L251 was not covered by tests
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) {

Check warning on line 254 in pkg/plugin/sdk/deployment.go

View check run for this annotation

Codecov / codecov/patch

pkg/plugin/sdk/deployment.go#L254 

Added line #L254 was not covered by tests
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.
Expand Down