Skip to content
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

Jump to bottom

[TEP-0133] Apply default resolver to finally tasks #6481

Merged
merged 1 commit into from
Apr 6, 2023
Merged

[TEP-0133] Apply default resolver to finally tasks #6481

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
34 changes: 16 additions & 18 deletions pkg/apis/pipeline/v1/pipeline_defaults.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,34 +32,32 @@ func (p *Pipeline) SetDefaults(ctx context.Context) {

// SetDefaults sets default values for the PipelineSpec's Params, Tasks, and Finally
func (ps *PipelineSpec) SetDefaults(ctx context.Context) {
cfg := config.FromContextOrDefaults(ctx)
for i := range ps.Params {
ps.Params[i].SetDefaults(ctx)
}

for _, pt := range ps.Tasks {
if pt.TaskRef != nil {
if pt.TaskRef.Kind == "" {
pt.TaskRef.Kind = NamespacedTaskKind
}
if pt.TaskRef.Name == "" && pt.TaskRef.Resolver == "" {
pt.TaskRef.Resolver = ResolverName(cfg.Defaults.DefaultResolverType)
}
}
if pt.TaskSpec != nil {
pt.TaskSpec.SetDefaults(ctx)
}
pt.SetDefaults(ctx)
}

for _, ft := range ps.Finally {
ctx := ctx // Ensure local scoping per Task
if ft.TaskRef != nil {
if ft.TaskRef.Kind == "" {
ft.TaskRef.Kind = NamespacedTaskKind
}
ft.SetDefaults(ctx)
}
}

// SetDefaults sets default values for a PipelineTask
func (pt *PipelineTask) SetDefaults(ctx context.Context) {
cfg := config.FromContextOrDefaults(ctx)
if pt.TaskRef != nil {
if pt.TaskRef.Kind == "" {
pt.TaskRef.Kind = NamespacedTaskKind
}
if ft.TaskSpec != nil {
ft.TaskSpec.SetDefaults(ctx)
if pt.TaskRef.Name == "" && pt.TaskRef.Resolver == "" {
pt.TaskRef.Resolver = ResolverName(cfg.Defaults.DefaultResolverType)
}
}
if pt.TaskSpec != nil {
pt.TaskSpec.SetDefaults(ctx)
}
}
251 changes: 147 additions & 104 deletions pkg/apis/pipeline/v1/pipeline_defaults_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,38 +38,13 @@ func TestPipeline_SetDefaults(t *testing.T) {

func TestPipelineSpec_SetDefaults(t *testing.T) {
cases := []struct {
desc string
ps *v1.PipelineSpec
want *v1.PipelineSpec
defaults map[string]string
desc string
ps *v1.PipelineSpec
want *v1.PipelineSpec
}{{
desc: "empty pipelineSpec must not change after setting defaults",
ps: &v1.PipelineSpec{},
want: &v1.PipelineSpec{},
}, {
desc: "pipeline task - default task kind must be " + string(v1.NamespacedTaskKind),
ps: &v1.PipelineSpec{
Tasks: []v1.PipelineTask{{
Name: "foo", TaskRef: &v1.TaskRef{Name: "foo-task"},
}},
},
want: &v1.PipelineSpec{
Tasks: []v1.PipelineTask{{
Name: "foo", TaskRef: &v1.TaskRef{Name: "foo-task", Kind: v1.NamespacedTaskKind},
}},
},
}, {
desc: "final pipeline task - default task kind must be " + string(v1.NamespacedTaskKind),
ps: &v1.PipelineSpec{
Finally: []v1.PipelineTask{{
Name: "final-task", TaskRef: &v1.TaskRef{Name: "foo-task"},
}},
},
want: &v1.PipelineSpec{
Finally: []v1.PipelineTask{{
Name: "final-task", TaskRef: &v1.TaskRef{Name: "foo-task", Kind: v1.NamespacedTaskKind},
}},
},
}, {
desc: "param type - default param type must be " + string(v1.ParamTypeString),
ps: &v1.PipelineSpec{
Expand Down Expand Up @@ -98,102 +73,170 @@ func TestPipelineSpec_SetDefaults(t *testing.T) {
}},
},
}, {
desc: "pipeline task with taskSpec - default param type must be " + string(v1.ParamTypeString),
desc: "multiple tasks and final tasks",
ps: &v1.PipelineSpec{
Tasks: []v1.PipelineTask{{
Name: "foo", TaskSpec: &v1.EmbeddedTask{
TaskSpec: v1.TaskSpec{
Params: []v1.ParamSpec{{
Name: "string-param",
}},
Tasks: []v1.PipelineTask{
{
Name: "task-with-taskRef",
TaskRef: &v1.TaskRef{Name: "bar-task-1"},
},
{
Name: "task-with-taskSpec",
TaskSpec: &v1.EmbeddedTask{
TaskSpec: v1.TaskSpec{
Params: []v1.ParamSpec{{
Name: "string-param",
}},
},
},
},
}},
},
want: &v1.PipelineSpec{
Tasks: []v1.PipelineTask{{
Name: "foo", TaskSpec: &v1.EmbeddedTask{
TaskSpec: v1.TaskSpec{
Params: []v1.ParamSpec{{
Name: "string-param",
Type: v1.ParamTypeString,
}},
},
Finally: []v1.PipelineTask{
{
Name: "final-task-with-taskRef",
TaskRef: &v1.TaskRef{Name: "foo-task-1"},
},
{
Name: "final-task-with-taskSpec",
TaskSpec: &v1.EmbeddedTask{
TaskSpec: v1.TaskSpec{
Params: []v1.ParamSpec{{
Name: "string-param",
}},
},
},
},
}},
},
}, {
desc: "pipeline task with taskRef - with default resolver",
ps: &v1.PipelineSpec{
Tasks: []v1.PipelineTask{{
Name: "foo",
TaskRef: &v1.TaskRef{},
}},
},
},
want: &v1.PipelineSpec{
Tasks: []v1.PipelineTask{{
Name: "foo",
TaskRef: &v1.TaskRef{
Kind: v1.NamespacedTaskKind,
ResolverRef: v1.ResolverRef{
Resolver: "git",
Tasks: []v1.PipelineTask{
{
Name: "task-with-taskRef",
TaskRef: &v1.TaskRef{Name: "bar-task-1", Kind: v1.NamespacedTaskKind},
},
{
Name: "task-with-taskSpec",
TaskSpec: &v1.EmbeddedTask{
TaskSpec: v1.TaskSpec{
Params: []v1.ParamSpec{{
Name: "string-param",
Type: v1.ParamTypeString,
}},
},
},
},
}},
},
Finally: []v1.PipelineTask{
{
Name: "final-task-with-taskRef",
TaskRef: &v1.TaskRef{Name: "foo-task-1", Kind: v1.NamespacedTaskKind},
},
{
Name: "final-task-with-taskSpec",
TaskSpec: &v1.EmbeddedTask{
TaskSpec: v1.TaskSpec{
Params: []v1.ParamSpec{{
Name: "string-param",
Type: v1.ParamTypeString,
}},
},
},
},
},
},
defaults: map[string]string{
"default-resolver-type": "git",
}}
for _, tc := range cases {
t.Run(tc.desc, func(t *testing.T) {
ctx := context.Background()
tc.ps.SetDefaults(ctx)
if d := cmp.Diff(tc.want, tc.ps); d != "" {
t.Errorf("Mismatch of pipelineSpec after setting defaults: %s", diff.PrintWantGot(d))
}
})
}
}

func TestPipelineTask_SetDefaults(t *testing.T) {
cases := []struct {
desc string
pt *v1.PipelineTask
want *v1.PipelineTask
defaults map[string]string
}{{
desc: "pipeline task - default task kind must be " + string(v1.NamespacedTaskKind),
pt: &v1.PipelineTask{
Name: "foo",
TaskRef: &v1.TaskRef{Name: "foo-task"},
},
want: &v1.PipelineTask{
Name: "foo",
TaskRef: &v1.TaskRef{
Name: "foo-task",
Kind: v1.NamespacedTaskKind,
},
},
}, {
desc: "pipeline task with taskRef - user-provided resolver overwrites default resolver",
ps: &v1.PipelineSpec{
Tasks: []v1.PipelineTask{{
Name: "foo",
TaskRef: &v1.TaskRef{
ResolverRef: v1.ResolverRef{
Resolver: "custom resolver",
},
desc: "pipeline task with taskSpec - default param type must be " + string(v1.ParamTypeString),
pt: &v1.PipelineTask{
Name: "foo",
TaskSpec: &v1.EmbeddedTask{
TaskSpec: v1.TaskSpec{
Params: []v1.ParamSpec{{
Name: "string-param",
}},
},
}},
},
},
want: &v1.PipelineTask{
Name: "foo",
TaskSpec: &v1.EmbeddedTask{
TaskSpec: v1.TaskSpec{
Params: []v1.ParamSpec{{
Name: "string-param",
Type: v1.ParamTypeString,
}},
},
},
},
want: &v1.PipelineSpec{
Tasks: []v1.PipelineTask{{
Name: "foo",
TaskRef: &v1.TaskRef{
Kind: v1.NamespacedTaskKind,
ResolverRef: v1.ResolverRef{
Resolver: "custom resolver",
},
}, {
desc: "pipeline task with taskRef - with default resolver",
pt: &v1.PipelineTask{
Name: "foo",
TaskRef: &v1.TaskRef{},
},
want: &v1.PipelineTask{
Name: "foo",
TaskRef: &v1.TaskRef{
Kind: v1.NamespacedTaskKind,
ResolverRef: v1.ResolverRef{
Resolver: "git",
},
}},
},
},
defaults: map[string]string{
"default-resolver-type": "git",
},
}, {
desc: "final pipeline task with taskSpec - default param type must be " + string(v1.ParamTypeString),
ps: &v1.PipelineSpec{
Finally: []v1.PipelineTask{{
Name: "foo", TaskSpec: &v1.EmbeddedTask{
TaskSpec: v1.TaskSpec{
Params: []v1.ParamSpec{{
Name: "string-param",
}},
},
desc: "pipeline task with taskRef - user-provided resolver overwrites default resolver",
pt: &v1.PipelineTask{
Name: "foo",
TaskRef: &v1.TaskRef{
ResolverRef: v1.ResolverRef{
Resolver: "custom resolver",
},
}},
},
want: &v1.PipelineSpec{
Finally: []v1.PipelineTask{{
Name: "foo", TaskSpec: &v1.EmbeddedTask{
TaskSpec: v1.TaskSpec{
Params: []v1.ParamSpec{{
Name: "string-param",
Type: v1.ParamTypeString,
}},
},
},
},
want: &v1.PipelineTask{
Name: "foo",
TaskRef: &v1.TaskRef{
Kind: v1.NamespacedTaskKind,
ResolverRef: v1.ResolverRef{
Resolver: "custom resolver",
},
}},
},
},
defaults: map[string]string{
"default-resolver-type": "git",
},
}}
for _, tc := range cases {
Expand All @@ -202,8 +245,8 @@ func TestPipelineSpec_SetDefaults(t *testing.T) {
if len(tc.defaults) > 0 {
ctx = dfttesting.SetDefaults(context.Background(), t, tc.defaults)
}
tc.ps.SetDefaults(ctx)
if d := cmp.Diff(tc.want, tc.ps); d != "" {
tc.pt.SetDefaults(ctx)
if d := cmp.Diff(tc.want, tc.pt); d != "" {
t.Errorf("Mismatch of pipelineSpec after setting defaults: %s", diff.PrintWantGot(d))
}
})
Expand Down
34 changes: 16 additions & 18 deletions pkg/apis/pipeline/v1beta1/pipeline_defaults.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,34 +32,32 @@ func (p *Pipeline) SetDefaults(ctx context.Context) {

// SetDefaults sets default values for the PipelineSpec's Params, Tasks, and Finally
func (ps *PipelineSpec) SetDefaults(ctx context.Context) {
cfg := config.FromContextOrDefaults(ctx)
for i := range ps.Params {
ps.Params[i].SetDefaults(ctx)
}

for _, pt := range ps.Tasks {
if pt.TaskRef != nil {
if pt.TaskRef.Kind == "" {
pt.TaskRef.Kind = NamespacedTaskKind
}
if pt.TaskRef.Name == "" && pt.TaskRef.Resolver == "" {
pt.TaskRef.Resolver = ResolverName(cfg.Defaults.DefaultResolverType)
}
}
if pt.TaskSpec != nil {
pt.TaskSpec.SetDefaults(ctx)
}
pt.SetDefaults(ctx)
}

for _, ft := range ps.Finally {
ctx := ctx // Ensure local scoping per Task
if ft.TaskRef != nil {
if ft.TaskRef.Kind == "" {
ft.TaskRef.Kind = NamespacedTaskKind
}
ft.SetDefaults(ctx)
}
}

// SetDefaults sets default values for a PipelineTask
func (pt *PipelineTask) SetDefaults(ctx context.Context) {
cfg := config.FromContextOrDefaults(ctx)
if pt.TaskRef != nil {
if pt.TaskRef.Kind == "" {
pt.TaskRef.Kind = NamespacedTaskKind
}
if ft.TaskSpec != nil {
ft.TaskSpec.SetDefaults(ctx)
if pt.TaskRef.Name == "" && pt.TaskRef.Resolver == "" {
pt.TaskRef.Resolver = ResolverName(cfg.Defaults.DefaultResolverType)
}
}
if pt.TaskSpec != nil {
pt.TaskSpec.SetDefaults(ctx)
}
}
Loading