Implement BuildPipelineSync with SDK

[ffjlabo]

What this PR does:

I implemented k8s BuildPipelineSync by using SDK.

Why we need it:

We want to implement plugins with SDK.

Which issue(s) this PR fixes:

Part of #4980 #5006

Which issue(s) this PR fixes:

Fixes #

Does this PR introduce a user-facing change?:

• How are users affected by this change:
• Is this breaking change:
• How to migrate (if breaking change):

[ffjlabo]

reference implementation

pipecd/pkg/app/pipedv1/plugin/kubernetes/deployment/pipeline.go

Lines 157 to 199 in 38a0086

	func buildPipelineStages(stages []*deployment.BuildPipelineSyncStagesRequest_StageConfig, autoRollback bool, now time.Time) []*model.PipelineStage {
	out := make([]*model.PipelineStage, 0, len(stages)+1)
	for _, s := range stages {
	id := s.GetId()
	if id == "" {
	id = fmt.Sprintf("stage-%d", s.GetIndex())
	}
	stage := &model.PipelineStage{
	Id: id,
	Name: s.GetName(),
	Desc: s.GetDesc(),
	Index: s.GetIndex(),
	Rollback: false,
	Status: model.StageStatus_STAGE_NOT_STARTED_YET,
	CreatedAt: now.Unix(),
	UpdatedAt: now.Unix(),
	}
	out = append(out, stage)
	}
	if autoRollback {
	// we set the index of the rollback stage to the minimum index of all stages.
	minIndex := slices.MinFunc(stages, func(a, b *deployment.BuildPipelineSyncStagesRequest_StageConfig) int {
	return int(a.GetIndex() - b.GetIndex())
	}).GetIndex()
	s, _ := GetPredefinedStage(PredefinedStageRollback)
	// we copy the predefined stage to avoid modifying the original one.
	out = append(out, &model.PipelineStage{
	Id: s.GetId(),
	Name: s.GetName(),
	Desc: s.GetDesc(),
	Index: minIndex,
	Rollback: s.GetRollback(),
	Status: model.StageStatus_STAGE_NOT_STARTED_YET,
	CreatedAt: now.Unix(),
	UpdatedAt: now.Unix(),
	})
	}
	return out
	}

[ffjlabo]

reference implementation

pipecd/pkg/app/pipedv1/plugin/kubernetes/deployment/pipeline_test.go

Lines 91 to 200 in 38a0086

	func TestBuildPipelineStages(t *testing.T) {
	t.Parallel()
	now := time.Now()
	tests := []struct {
	name string
	stages []*deployment.BuildPipelineSyncStagesRequest_StageConfig
	autoRollback bool
	expected []*model.PipelineStage
	}{
	{
	name: "without auto rollback",
	stages: []*deployment.BuildPipelineSyncStagesRequest_StageConfig{
	{
	Id: "stage-1",
	Name: "Stage 1",
	Desc: "Description 1",
	Index: 0,
	},
	{
	Id: "stage-2",
	Name: "Stage 2",
	Desc: "Description 2",
	Index: 1,
	},
	},
	autoRollback: false,
	expected: []*model.PipelineStage{
	{
	Id: "stage-1",
	Name: "Stage 1",
	Desc: "Description 1",
	Index: 0,
	Rollback: false,
	Status: model.StageStatus_STAGE_NOT_STARTED_YET,
	CreatedAt: now.Unix(),
	UpdatedAt: now.Unix(),
	},
	{
	Id: "stage-2",
	Name: "Stage 2",
	Desc: "Description 2",
	Index: 1,
	Rollback: false,
	Status: model.StageStatus_STAGE_NOT_STARTED_YET,
	CreatedAt: now.Unix(),
	UpdatedAt: now.Unix(),
	},
	},
	},
	{
	name: "with auto rollback",
	stages: []*deployment.BuildPipelineSyncStagesRequest_StageConfig{
	{
	Id: "stage-1",
	Name: "Stage 1",
	Desc: "Description 1",
	Index: 0,
	},
	{
	Id: "stage-2",
	Name: "Stage 2",
	Desc: "Description 2",
	Index: 1,
	},
	},
	autoRollback: true,
	expected: []*model.PipelineStage{
	{
	Id: "stage-1",
	Name: "Stage 1",
	Desc: "Description 1",
	Index: 0,
	Rollback: false,
	Status: model.StageStatus_STAGE_NOT_STARTED_YET,
	CreatedAt: now.Unix(),
	UpdatedAt: now.Unix(),
	},
	{
	Id: "stage-2",
	Name: "Stage 2",
	Desc: "Description 2",
	Index: 1,
	Rollback: false,
	Status: model.StageStatus_STAGE_NOT_STARTED_YET,
	CreatedAt: now.Unix(),
	UpdatedAt: now.Unix(),
	},
	{
	Id: PredefinedStageRollback,
	Name: StageK8sRollback.String(),
	Desc: "Rollback the deployment",
	Index: 0,
	Rollback: true,
	Status: model.StageStatus_STAGE_NOT_STARTED_YET,
	CreatedAt: now.Unix(),
	UpdatedAt: now.Unix(),
	},
	},
	},
	}
	for _, tt := range tests {
	t.Run(tt.name, func(t *testing.T) {
	actual := buildPipelineStages(tt.stages, tt.autoRollback, now)
	assert.Equal(t, tt.expected, actual)
	})
	}
	}

[codecov]

Codecov Report

Attention: Patch coverage is 89.28571% with 3 lines in your changes missing coverage. Please review.

Project coverage is 25.60%. Comparing base (38a0086) to head (d0fd69f).
Report is 2 commits behind head on master.

Files with missing lines	Patch %	Lines
...app/pipedv1/plugin/kubernetes/deployment/plugin.go	0.00%	3 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #5672      +/-   ##
==========================================
+ Coverage   25.56%   25.60%   +0.03%     
==========================================
  Files         478      478              
  Lines       51280    51307      +27     
==========================================
+ Hits        13110    13135      +25     
- Misses      37165    37167       +2     
  Partials     1005     1005              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[Warashi]

Thank you!
I commented on nits

[Warashi]

The s is used only here, so can we replace this with string(StageK8sRollback)?

[ffjlabo]

OK, fixed on d0fd69f
Also, I used StageK8sRollback.String() method.

[Warashi]

LGTM