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.

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

(cleanup) use skipping reason instead of existence of variables #4147

Merged
merged 1 commit into from
Aug 17, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
18 changes: 0 additions & 18 deletions pkg/apis/pipeline/v1beta1/when_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -54,13 +54,6 @@ func (we *WhenExpression) isTrue() bool {
return !we.isInputInValues()
}

func (we *WhenExpression) hasVariable() bool {
if _, hasVariable := we.GetVarSubstitutionExpressions(); hasVariable {
return true
}
return false
}

func (we *WhenExpression) applyReplacements(replacements map[string]string, arrayReplacements map[string][]string) WhenExpression {
replacedInput := substitution.ApplyReplacements(we.Input, replacements)

Expand Down Expand Up @@ -105,17 +98,6 @@ func (wes WhenExpressions) AllowsExecution() bool {
return true
}

// HaveVariables indicates whether When Expressions contains variables, such as Parameters
// or Results in the Inputs or Values.
func (wes WhenExpressions) HaveVariables() bool {
for _, we := range wes {
if we.hasVariable() {
return true
}
}
return false
}

// ReplaceWhenExpressionsVariables interpolates variables, such as Parameters and Results, in
// the Input and Values.
func (wes WhenExpressions) ReplaceWhenExpressionsVariables(replacements map[string]string, arrayReplacements map[string][]string) WhenExpressions {
Expand Down
60 changes: 0 additions & 60 deletions pkg/apis/pipeline/v1beta1/when_types_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -88,66 +88,6 @@ func TestAllowsExecution(t *testing.T) {
}
}

func TestHaveVariables(t *testing.T) {
tests := []struct {
name string
whenExpressions WhenExpressions
expected bool
}{{
name: "doesn't have variable",
whenExpressions: WhenExpressions{
{
Input: "foo",
Operator: selection.In,
Values: []string{"foo", "bar"},
},
},
expected: false,
}, {
name: "have variable - input",
whenExpressions: WhenExpressions{
{
Input: "$(params.foobar)",
Operator: selection.NotIn,
Values: []string{"foobar"},
},
},
expected: true,
}, {
name: "have variable - values",
whenExpressions: WhenExpressions{
{
Input: "foobar",
Operator: selection.In,
Values: []string{"$(params.foobar)"},
},
},
expected: true,
}, {
name: "have variable - multiple when expressions",
whenExpressions: WhenExpressions{
{
Input: "foo",
Operator: selection.NotIn,
Values: []string{"bar"},
}, {
Input: "foobar",
Operator: selection.In,
Values: []string{"$(params.foobar)"},
},
},
expected: true,
}}
for _, tc := range tests {
t.Run(tc.name, func(t *testing.T) {
got := tc.whenExpressions.HaveVariables()
if d := cmp.Diff(tc.expected, got); d != "" {
t.Errorf("Error evaluating HaveVariables() for When Expressions in test case %s", diff.PrintWantGot(d))
}
})
}
}

func TestReplaceWhenExpressionsVariables(t *testing.T) {
tests := []struct {
name string
Expand Down
2 changes: 1 addition & 1 deletion pkg/reconciler/pipelinerun/resources/pipelinerunstate.go
Original file line number Diff line number Diff line change
Expand Up @@ -423,7 +423,7 @@ func (facts *PipelineRunFacts) GetSkippedTasks() []v1beta1.SkippedTask {
}
// include the when expressions only when the finally task was skipped because
// its when expressions evaluated to false (not because results variables were missing)
if !rprt.PipelineTask.WhenExpressions.HaveVariables() {
if rprt.IsFinallySkipped(facts).SkippingReason == WhenExpressionsSkip {
jerop marked this conversation as resolved.
Show resolved Hide resolved
jerop marked this conversation as resolved.
Show resolved Hide resolved
skippedTask.WhenExpressions = rprt.PipelineTask.WhenExpressions
}
skipped = append(skipped, skippedTask)
Expand Down
76 changes: 53 additions & 23 deletions pkg/reconciler/pipelinerun/resources/pipelinerunstate_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -1586,30 +1586,60 @@ func TestPipelineRunFacts_GetPipelineTaskStatus(t *testing.T) {
}

func TestPipelineRunFacts_GetSkippedTasks(t *testing.T) {
dagFailedFinalSkipped := PipelineRunState{{
TaskRunName: "task0taskrun",
PipelineTask: &pts[0],
TaskRun: makeFailed(trs[0]),
for _, tc := range []struct {
name string
state PipelineRunState
dagTasks []v1beta1.PipelineTask
finallyTasks []v1beta1.PipelineTask
expectedSkippedTasks []v1beta1.SkippedTask
}{{
name: "missing-results-skip-finally",
state: PipelineRunState{{
TaskRunName: "task0taskrun",
PipelineTask: &pts[0],
TaskRun: makeFailed(trs[0]),
}, {
PipelineTask: &pts[14],
}},
dagTasks: []v1beta1.PipelineTask{pts[0]},
finallyTasks: []v1beta1.PipelineTask{pts[14]},
expectedSkippedTasks: []v1beta1.SkippedTask{{
Name: pts[14].Name,
}},
}, {
PipelineTask: &pts[14],
}}
expectedSkippedTasks := []v1beta1.SkippedTask{{Name: pts[14].Name}}
d, err := dag.Build(v1beta1.PipelineTaskList{pts[0]}, v1beta1.PipelineTaskList{pts[0]}.Deps())
if err != nil {
t.Fatalf("Unexpected error while building graph for DAG tasks %v: %v", v1beta1.PipelineTaskList{pts[0]}, err)
}
df, err := dag.Build(v1beta1.PipelineTaskList{pts[14]}, map[string][]string{})
if err != nil {
t.Fatalf("Unexpected error while building graph for final tasks %v: %v", v1beta1.PipelineTaskList{pts[14]}, err)
}
facts := PipelineRunFacts{
State: dagFailedFinalSkipped,
TasksGraph: d,
FinalTasksGraph: df,
}
actualSkippedTasks := facts.GetSkippedTasks()
if d := cmp.Diff(actualSkippedTasks, expectedSkippedTasks); d != "" {
t.Fatalf("Mismatch skipped tasks %s", diff.PrintWantGot(d))
name: "when-expressions-skip-finally",
state: PipelineRunState{{
PipelineTask: &pts[10],
}},
finallyTasks: []v1beta1.PipelineTask{pts[10]},
expectedSkippedTasks: []v1beta1.SkippedTask{{
Name: pts[10].Name,
WhenExpressions: []v1beta1.WhenExpression{{
Input: "foo",
Operator: "notin",
Values: []string{"foo", "bar"},
}},
}},
}} {
t.Run(tc.name, func(t *testing.T) {
d, err := dag.Build(v1beta1.PipelineTaskList(tc.dagTasks), v1beta1.PipelineTaskList(tc.dagTasks).Deps())
if err != nil {
t.Fatalf("Unexpected error while building graph for DAG tasks %v: %v", v1beta1.PipelineTaskList{pts[0]}, err)
}
df, err := dag.Build(v1beta1.PipelineTaskList(tc.finallyTasks), map[string][]string{})
if err != nil {
t.Fatalf("Unexpected error while building graph for final tasks %v: %v", v1beta1.PipelineTaskList{pts[14]}, err)
}
facts := PipelineRunFacts{
State: tc.state,
TasksGraph: d,
FinalTasksGraph: df,
}
actualSkippedTasks := facts.GetSkippedTasks()
if d := cmp.Diff(tc.expectedSkippedTasks, actualSkippedTasks); d != "" {
t.Fatalf("Mismatch skipped tasks %s", diff.PrintWantGot(d))
}
})
}
}

Expand Down