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

Make PipelineSpec/PipelineRef in PipelineRun consistent with TaskRun #1495

Merged
merged 1 commit into from
Nov 5, 2019
Merged

Make PipelineSpec/PipelineRef in PipelineRun consistent with TaskRun #1495

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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
12 changes: 6 additions & 6 deletions pkg/apis/pipeline/v1alpha1/pipelinerun_defaults_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,12 +88,12 @@ func TestPipelineRunDefaulting(t *testing.T) {
name: "PipelineRef upgrade context",
in: &v1alpha1.PipelineRun{
Spec: v1alpha1.PipelineRunSpec{
PipelineRef: v1alpha1.PipelineRef{Name: "foo"},
PipelineRef: &v1alpha1.PipelineRef{Name: "foo"},
},
},
want: &v1alpha1.PipelineRun{
Spec: v1alpha1.PipelineRunSpec{
PipelineRef: v1alpha1.PipelineRef{Name: "foo"},
PipelineRef: &v1alpha1.PipelineRef{Name: "foo"},
Timeout: &metav1.Duration{Duration: config.DefaultTimeoutMinutes * time.Minute},
},
},
Expand All @@ -102,12 +102,12 @@ func TestPipelineRunDefaulting(t *testing.T) {
name: "PipelineRef default config context",
in: &v1alpha1.PipelineRun{
Spec: v1alpha1.PipelineRunSpec{
PipelineRef: v1alpha1.PipelineRef{Name: "foo"},
PipelineRef: &v1alpha1.PipelineRef{Name: "foo"},
},
},
want: &v1alpha1.PipelineRun{
Spec: v1alpha1.PipelineRunSpec{
PipelineRef: v1alpha1.PipelineRef{Name: "foo"},
PipelineRef: &v1alpha1.PipelineRef{Name: "foo"},
Timeout: &metav1.Duration{Duration: 5 * time.Minute},
},
},
Expand All @@ -127,12 +127,12 @@ func TestPipelineRunDefaulting(t *testing.T) {
name: "PipelineRef default config context with sa",
in: &v1alpha1.PipelineRun{
Spec: v1alpha1.PipelineRunSpec{
PipelineRef: v1alpha1.PipelineRef{Name: "foo"},
PipelineRef: &v1alpha1.PipelineRef{Name: "foo"},
},
},
want: &v1alpha1.PipelineRun{
Spec: v1alpha1.PipelineRunSpec{
PipelineRef: v1alpha1.PipelineRef{Name: "foo"},
PipelineRef: &v1alpha1.PipelineRef{Name: "foo"},
Timeout: &metav1.Duration{Duration: 5 * time.Minute},
ServiceAccountName: "tekton",
},
Expand Down
2 changes: 1 addition & 1 deletion pkg/apis/pipeline/v1alpha1/pipelinerun_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ var _ apis.Defaultable = (*PipelineRun)(nil)
// PipelineRunSpec defines the desired state of PipelineRun
type PipelineRunSpec struct {
// +optional
PipelineRef PipelineRef `json:"pipelineRef,omitempty"`
PipelineRef *PipelineRef `json:"pipelineRef,omitempty"`
// +optional
PipelineSpec *PipelineSpec `json:"pipelineSpec,omitempty"`
// Resources is a list of bindings specifying which actual instances of
Expand Down
10 changes: 5 additions & 5 deletions pkg/apis/pipeline/v1alpha1/pipelinerun_validation.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,14 +38,14 @@ func (ps *PipelineRunSpec) Validate(ctx context.Context) *apis.FieldError {
return apis.ErrMissingField("spec")
}

// can't have both pipelinekRef and pipelineSpec at the same time
if ps.PipelineRef.Name != "" && ps.PipelineSpec != nil {
return apis.ErrDisallowedFields("spec.pipelineRef", "spec.pipelineSpec")
// can't have both pipelineRef and pipelineSpec at the same time
if (ps.PipelineRef != nil && ps.PipelineRef.Name != "") && ps.PipelineSpec != nil {
return apis.ErrDisallowedFields("spec.pipelineref", "spec.pipelinespec")
}

// Check that one of PipelineRef and PipelineSpec is present
if ps.PipelineRef.Name == "" && ps.PipelineSpec == nil {
return apis.ErrMissingField("spec.pipelineRef.name", "spec.pipelineSpec")
if (ps.PipelineRef == nil || (ps.PipelineRef != nil && ps.PipelineRef.Name == "")) && ps.PipelineSpec == nil {
return apis.ErrMissingField("spec.pipelineref.name", "spec.pipelinespec")
}

// Validate PipelineSpec if it's present
Expand Down
16 changes: 8 additions & 8 deletions pkg/apis/pipeline/v1alpha1/pipelinerun_validation_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,15 +63,15 @@ func TestPipelineRun_Invalidate(t *testing.T) {
ServiceAccountName: "foo",
},
},
want: apis.ErrMissingField("spec.pipelineRef.name, spec.pipelineSpec"),
want: apis.ErrMissingField("spec.pipelineref.name, spec.pipelinespec"),
}, {
name: "negative pipeline timeout",
pr: v1alpha1.PipelineRun{
ObjectMeta: metav1.ObjectMeta{
Name: "pipelinelineName",
},
Spec: v1alpha1.PipelineRunSpec{
PipelineRef: v1alpha1.PipelineRef{
PipelineRef: &v1alpha1.PipelineRef{
Name: "prname",
},
Timeout: &metav1.Duration{Duration: -48 * time.Hour},
Expand Down Expand Up @@ -103,7 +103,7 @@ func TestPipelineRun_Validate(t *testing.T) {
Name: "pipelinelineName",
},
Spec: v1alpha1.PipelineRunSpec{
PipelineRef: v1alpha1.PipelineRef{
PipelineRef: &v1alpha1.PipelineRef{
Name: "prname",
},
},
Expand All @@ -115,7 +115,7 @@ func TestPipelineRun_Validate(t *testing.T) {
Name: "pipelinelineName",
},
Spec: v1alpha1.PipelineRunSpec{
PipelineRef: v1alpha1.PipelineRef{
PipelineRef: &v1alpha1.PipelineRef{
Name: "prname",
},
Timeout: &metav1.Duration{Duration: 0},
Expand Down Expand Up @@ -145,13 +145,13 @@ func TestPipelineRunSpec_Invalidate(t *testing.T) {
}, {
name: "pipelineRef without Pipeline Name",
spec: v1alpha1.PipelineRunSpec{
PipelineRef: v1alpha1.PipelineRef{},
PipelineRef: &v1alpha1.PipelineRef{},
},
wantErr: apis.ErrMissingField("spec"),
wantErr: apis.ErrMissingField("spec.pipelineref.name", "spec.pipelinespec"),
}, {
name: "pipelineRef and pipelineSpec together",
spec: v1alpha1.PipelineRunSpec{
PipelineRef: v1alpha1.PipelineRef{
PipelineRef: &v1alpha1.PipelineRef{
Name: "pipelinerefname",
},
PipelineSpec: &v1alpha1.PipelineSpec{
Expand All @@ -162,7 +162,7 @@ func TestPipelineRunSpec_Invalidate(t *testing.T) {
},
}}},
},
wantErr: apis.ErrDisallowedFields("spec.pipelineSpec", "spec.pipelineRef"),
wantErr: apis.ErrDisallowedFields("spec.pipelinespec", "spec.pipelineref"),
}}
for _, ps := range tests {
t.Run(ps.name, func(t *testing.T) {
Expand Down
6 changes: 5 additions & 1 deletion pkg/apis/pipeline/v1alpha1/zz_generated.deepcopy.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 5 additions & 1 deletion pkg/reconciler/pipelinerun/metrics.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,9 +134,13 @@ func (r *Recorder) DurationAndCount(pr *v1alpha1.PipelineRun) error {
status = "failed"
}

pipelineName := "anonymous"
if pr.Spec.PipelineRef != nil && pr.Spec.PipelineRef.Name != "" {
pipelineName = pr.Spec.PipelineRef.Name
}
ctx, err := tag.New(
context.Background(),
tag.Insert(r.pipeline, pr.Spec.PipelineRef.Name),
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The failure was legit 😅 this was putting the controller in a crashloop 😝

tag.Insert(r.pipeline, pipelineName),
tag.Insert(r.pipelineRun, pr.Name),
tag.Insert(r.namespace, pr.Namespace),
tag.Insert(r.status, status),
Expand Down
2 changes: 1 addition & 1 deletion pkg/reconciler/pipelinerun/resources/pipelinespec.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ func GetPipelineData(pipelineRun *v1alpha1.PipelineRun, getPipeline GetPipeline)
pipelineMeta := metav1.ObjectMeta{}
pipelineSpec := v1alpha1.PipelineSpec{}
switch {
case pipelineRun.Spec.PipelineRef.Name != "":
case pipelineRun.Spec.PipelineRef != nil && pipelineRun.Spec.PipelineRef.Name != "":
// Get related pipeline for pipelinerun
t, err := getPipeline(pipelineRun.Spec.PipelineRef.Name)
if err != nil {
Expand Down
4 changes: 2 additions & 2 deletions pkg/reconciler/pipelinerun/resources/pipelinespec_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ func TestGetPipelineSpec_Ref(t *testing.T) {
Name: "mypipelinerun",
},
Spec: v1alpha1.PipelineRunSpec{
PipelineRef: v1alpha1.PipelineRef{
PipelineRef: &v1alpha1.PipelineRef{
Name: "orchestrate",
},
},
Expand Down Expand Up @@ -115,7 +115,7 @@ func TestGetPipelineSpec_Error(t *testing.T) {
Name: "mypipelinerun",
},
Spec: v1alpha1.PipelineRunSpec{
PipelineRef: v1alpha1.PipelineRef{
PipelineRef: &v1alpha1.PipelineRef{
Name: "orchestrate",
},
},
Expand Down
4 changes: 3 additions & 1 deletion test/builder/pipeline.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -282,7 +282,9 @@ func PipelineRunSpec(name string, ops ...PipelineRunSpecOp) PipelineRunOp {
return func(pr *v1alpha1.PipelineRun) {
prs := &pr.Spec

prs.PipelineRef.Name = name
prs.PipelineRef = &v1alpha1.PipelineRef{
Name: name,
}
// Set a default timeout
prs.Timeout = &metav1.Duration{Duration: config.DefaultTimeoutMinutes * time.Minute}

Expand Down
4 changes: 2 additions & 2 deletions test/builder/pipeline_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ func TestPipelineRun(t *testing.T) {
},
},
Spec: v1alpha1.PipelineRunSpec{
PipelineRef: v1alpha1.PipelineRef{Name: "tomatoes"},
PipelineRef: &v1alpha1.PipelineRef{Name: "tomatoes"},
ServiceAccountName: "sa",
ServiceAccountNames: []v1alpha1.PipelineRunSpecServiceAccountName{{TaskName: "foo", ServiceAccountName: "sa-2"}},
Params: []v1alpha1.Param{{
Expand Down Expand Up @@ -220,7 +220,7 @@ func TestPipelineRunWithResourceSpec(t *testing.T) {
},
},
Spec: v1alpha1.PipelineRunSpec{
PipelineRef: v1alpha1.PipelineRef{Name: "tomatoes"},
PipelineRef: &v1alpha1.PipelineRef{Name: "tomatoes"},
ServiceAccountName: "sa",
ServiceAccountNames: []v1alpha1.PipelineRunSpecServiceAccountName{{TaskName: "foo", ServiceAccountName: "sa-2"}},
Params: []v1alpha1.Param{{
Expand Down
27 changes: 27 additions & 0 deletions third_party/VENDOR-LICENSE
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5429,6 +5429,33 @@ SOFTWARE.



===========================================================
Import: github.com/tektoncd/pipeline/vendor/github.com/mohae/deepcopy

The MIT License (MIT)

Copyright (c) 2014 Joel

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.



===========================================================
Import: github.com/tektoncd/pipeline/vendor/github.com/peterbourgon/diskv

Expand Down