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

fix(controller): prepend script path to the script template args. Resolves #4481 #4492

Merged
merged 6 commits into from Nov 10, 2020
Merged

fix(controller): prepend script path to the script template args. Resolves #4481 #4492

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
03bf734
prepend script path to main container args
Nov 8, 2020
b4dcdd2
prepend script path only when script source is present
Nov 9, 2020
5301851
extract main ctr setup to separate function
Nov 10, 2020
ce11e2a
wrote tests for various configs of script template
Nov 10, 2020
7f2b06c
delete unnecessary tests
Nov 10, 2020
ea5ccf5
use minimal set of tests
Nov 10, 2020
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
13 changes: 11 additions & 2 deletions workflow/controller/operator.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2286,6 +2286,16 @@ func getStepOrDAGTaskName(nodeName string) string {
return nodeName
}

func extractMainCtrFromScriptTemplate(tmpl *wfv1.Template) apiv1.Container {
mainCtr := tmpl.Script.Container
// If script source is provided then pass all container args to the
// script instead of passing them to the container command directly
if tmpl.Script.Source != "" {
mainCtr.Args = append([]string{common.ExecutorScriptSourcePath}, mainCtr.Args...)
}
return mainCtr
}

func (woc *wfOperationCtx) executeScript(nodeName string, templateScope string, tmpl *wfv1.Template, orgTmpl wfv1.TemplateReferenceHolder, opts *executeTemplateOpts) (*wfv1.NodeStatus, error) {
node := woc.wf.GetNodeByName(nodeName)
if node == nil {
Expand All @@ -2301,8 +2311,7 @@ func (woc *wfOperationCtx) executeScript(nodeName string, templateScope string,
return node, err
}

mainCtr := tmpl.Script.Container
mainCtr.Args = append(mainCtr.Args, common.ExecutorScriptSourcePath)
mainCtr := extractMainCtrFromScriptTemplate(tmpl)
_, err = woc.createWorkflowPod(nodeName, mainCtr, tmpl, &createWorkflowPodOpts{
includeScriptOutput: includeScriptOutput,
onExitPod: opts.onExitTemplate,
Expand Down
36 changes: 36 additions & 0 deletions workflow/controller/workflowpod_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,42 @@ func TestScriptTemplateWithVolume(t *testing.T) {
assert.NoError(t, err)
}

var scriptTemplateWithArgsAndWithSource = `
Copy link
Contributor

Choose a reason for hiding this comment

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

I thought I'd never say this, but there is a first time for everything.

I think you've written TOO many tests.

I think you only need to test `extractMainCtrFromScriptTemplate.

Copy link
Author

@ghost ghost Nov 10, 2020 •
edited by ghost
Loading

Choose a reason for hiding this comment

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

Haha yeah probably, no problem I'll delete those that don't test extractMainCtrFromScriptTemplate explicitly.

Copy link
Contributor

Choose a reason for hiding this comment

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

cool - I'll mark this as "Draft" while you do that

Copy link
Author

Choose a reason for hiding this comment

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

Here you go, I left only 2 tests which cover extractMainCtrFromScriptTemplate. One for when script source is specified, and the other one when the source is empty.

name: script-with-args-and-with-source
script:
image: alpine:latest
command: [sh]
args: ["hello world"]
source: |
echo $@
`

// TestScriptTemplateMainCtrArgsWhenArgsAndWhenSource ensure order of merged args
// and script path is correct when both args and script source are specified
func TestScriptTemplateMainCtrArgsWhenArgsAndWhenSource(t *testing.T) {
tmpl := unmarshalTemplate(scriptTemplateWithArgsAndWithSource)
mainCtr := extractMainCtrFromScriptTemplate(tmpl)
assert.Equal(t, []string{"sh"}, mainCtr.Command)
assert.Equal(t, []string{common.ExecutorScriptSourcePath, "hello world"}, mainCtr.Args)
}

var scriptTemplateWithArgsAndWithoutSource = `
name: script-with-args-and-without-source
script:
image: alpine:latest
command: [echo]
args: ["hello world"]
`

// TestScriptTemplateMainCtrArgsWhenArgsAndWhenNoSource ensure only args are passed
// to the resulting container when script source is empty
func TestScriptTemplateMainCtrArgsWhenArgsAndWhenNoSource(t *testing.T) {
tmpl := unmarshalTemplate(scriptTemplateWithArgsAndWithoutSource)
mainCtr := extractMainCtrFromScriptTemplate(tmpl)
assert.Equal(t, []string{"echo"}, mainCtr.Command)
assert.Equal(t, []string{"hello world"}, mainCtr.Args)
}

var scriptTemplateWithOptionalInputArtifactProvided = `
name: script-with-input-artifact
inputs:
Expand Down