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

fix(backend): api server panics on workflow with parameter without value. Fixes #5423 #5424

Merged
merged 1 commit into from
Apr 4, 2021
Merged

fix(backend): api server panics on workflow with parameter without value. Fixes #5423 #5424

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 backend/src/common/util/workflow.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ func (w *Workflow) OverrideParameters(desiredParams map[string]string) {
var desiredValue *string = nil
if param, ok := desiredParams[currentParam.Name]; ok {
desiredValue = &param
} else {
} else if currentParam.Value != nil {
desired := currentParam.Value.String()
desiredValue = &desired
}
Expand Down
140 changes: 106 additions & 34 deletions backend/src/common/util/workflow_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,48 +180,120 @@ func TestWorkflow_OverrideName(t *testing.T) {
}

func TestWorkflow_OverrideParameters(t *testing.T) {
workflow := NewWorkflow(&workflowapi.Workflow{
ObjectMeta: metav1.ObjectMeta{
Name: "WORKFLOW_NAME",
},
Spec: workflowapi.WorkflowSpec{
Arguments: workflowapi.Arguments{
Parameters: []workflowapi.Parameter{
{Name: "PARAM1", Value: workflowapi.AnyStringPtr("VALUE1")},
{Name: "PARAM2", Value: workflowapi.AnyStringPtr("VALUE2")},
{Name: "PARAM3", Value: workflowapi.AnyStringPtr("VALUE3")},
{Name: "PARAM4", Value: workflowapi.AnyStringPtr("")},
{Name: "PARAM5", Value: workflowapi.AnyStringPtr("VALUE5")},
var tests = []struct {
name string
workflow *workflowapi.Workflow
overrides map[string]string
expected *workflowapi.Workflow
}{
{
name: "override parameters",
workflow: &workflowapi.Workflow{
ObjectMeta: metav1.ObjectMeta{
Name: "WORKFLOW_NAME",
},
Spec: workflowapi.WorkflowSpec{
Arguments: workflowapi.Arguments{
Parameters: []workflowapi.Parameter{
{Name: "PARAM1", Value: workflowapi.AnyStringPtr("VALUE1")},
{Name: "PARAM2", Value: workflowapi.AnyStringPtr("VALUE2")},
{Name: "PARAM3", Value: workflowapi.AnyStringPtr("VALUE3")},
{Name: "PARAM4", Value: workflowapi.AnyStringPtr("")},
{Name: "PARAM5", Value: workflowapi.AnyStringPtr("VALUE5")},
Comment on lines +198 to +202
Copy link
Member

Choose a reason for hiding this comment

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

nit: does it add anything to have to have all these cases or could re remove PARAM1 and PARAM2

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It's better to have cases that have focused goals. When they fail, it's easier to find out why.

},
},
},
},
overrides: map[string]string{
"PARAM1": "NEW_VALUE1",
"PARAM3": "NEW_VALUE3",
"PARAM4": "NEW_VALUE4",
"PARAM5": "",
"PARAM9": "NEW_VALUE9",
},
expected: &workflowapi.Workflow{
ObjectMeta: metav1.ObjectMeta{
Name: "WORKFLOW_NAME",
},
Spec: workflowapi.WorkflowSpec{
Arguments: workflowapi.Arguments{
Parameters: []workflowapi.Parameter{
{Name: "PARAM1", Value: workflowapi.AnyStringPtr("NEW_VALUE1")},
{Name: "PARAM2", Value: workflowapi.AnyStringPtr("VALUE2")},
{Name: "PARAM3", Value: workflowapi.AnyStringPtr("NEW_VALUE3")},
{Name: "PARAM4", Value: workflowapi.AnyStringPtr("NEW_VALUE4")},
{Name: "PARAM5", Value: workflowapi.AnyStringPtr("")},
},
},
},
},
},
})

workflow.OverrideParameters(map[string]string{
"PARAM1": "NEW_VALUE1",
"PARAM3": "NEW_VALUE3",
"PARAM4": "NEW_VALUE4",
"PARAM5": "",
"PARAM9": "NEW_VALUE9",
})

expected := &workflowapi.Workflow{
ObjectMeta: metav1.ObjectMeta{
Name: "WORKFLOW_NAME",
{
name: "handles missing parameter values",
workflow: &workflowapi.Workflow{
ObjectMeta: metav1.ObjectMeta{
Name: "NAME",
},
Spec: workflowapi.WorkflowSpec{
Arguments: workflowapi.Arguments{
Parameters: []workflowapi.Parameter{
{Name: "PARAM1"}, // note, there's no value here
},
},
},
},
overrides: nil,
expected: &workflowapi.Workflow{
ObjectMeta: metav1.ObjectMeta{
Name: "NAME",
},
Spec: workflowapi.WorkflowSpec{
Arguments: workflowapi.Arguments{
Parameters: []workflowapi.Parameter{
{Name: "PARAM1"},
},
},
},
},
},
Spec: workflowapi.WorkflowSpec{
Arguments: workflowapi.Arguments{
Parameters: []workflowapi.Parameter{
{Name: "PARAM1", Value: workflowapi.AnyStringPtr("NEW_VALUE1")},
{Name: "PARAM2", Value: workflowapi.AnyStringPtr("VALUE2")},
{Name: "PARAM3", Value: workflowapi.AnyStringPtr("NEW_VALUE3")},
{Name: "PARAM4", Value: workflowapi.AnyStringPtr("NEW_VALUE4")},
{Name: "PARAM5", Value: workflowapi.AnyStringPtr("")},
{
name: "overrides a missing parameter value",
workflow: &workflowapi.Workflow{
ObjectMeta: metav1.ObjectMeta{
Name: "NAME",
},
Spec: workflowapi.WorkflowSpec{
Arguments: workflowapi.Arguments{
Parameters: []workflowapi.Parameter{
{Name: "PARAM1"}, // note, there's no value here
},
},
},
},
overrides: map[string]string{
"PARAM1": "VALUE1",
},
expected: &workflowapi.Workflow{
ObjectMeta: metav1.ObjectMeta{
Name: "NAME",
},
Spec: workflowapi.WorkflowSpec{
Arguments: workflowapi.Arguments{
Parameters: []workflowapi.Parameter{
{Name: "PARAM1", Value: workflowapi.AnyStringPtr("VALUE1")},
},
},
},
},
},
}
assert.Equal(t, expected, workflow.Get())
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
workflow := NewWorkflow(tt.workflow)
workflow.OverrideParameters(tt.overrides)
assert.Equal(t, tt.expected, workflow.Get())
})
}
}

func TestWorkflow_SetOwnerReferences(t *testing.T) {
Expand Down