apply triggertemplate param default value if body/header based triggerbinding param missing from body/header #761

gabemontero · 2020-09-18T19:43:23Z

Changes

Fixes #568

Submitter Checklist

These are the criteria that every PR should meet, please check them off as you
review them:

[/] Includes tests (if functionality changed/added)
[n/a] Includes docs (if user facing)
[/] Commit messages follow commit message best practices

See the contribution guide for more details.

Release Notes

```release-note
NONE
```

/assign @dibyom

savitaashture

How about adding sample example to examples to show usage of this or any doc update which provide this information that there is a support of default values if not found from binding

dibyom · 2020-09-21T21:13:43Z

pkg/template/event.go

+	if err != nil {
+		return nil, fmt.Errorf("failed to ApplyEventValuesToParams: %w", err)
+	}
+
 	return MergeInDefaultParams(out, ttParams), nil


do we still need to call MergeInDefaultParams since we are now adding default values in applyEventValuesToParams itself?

Yes we do. Unit tests fail without it:

using default defaultVal since failed to replace JSONPath value for param p2: $(body.p2): error: p2 is not found --- FAIL: TestResolveParams (0.00s) --- FAIL: TestResolveParams/add_default_values_for_params_with_missing_values (0.00s) event_test.go:351: didn't get expected params -want + got: []v1alpha1.Param{ {Name: "p1", Value: "val1"}, - {Name: "p2", Value: "defaultVal"}, } FAIL FAIL github.com/tektoncd/triggers/pkg/template 0.062s FAIL

Hmmm, interesting. I think that makes sense. But makes me wonder if we can simplify this code somehow.

ok @dibyom I've pushed a separate commit that consolidates applyEventValuesToParams and mergeInDefaultParams

it is possible the changes pulled in with the rebase helped things (the method was minimally switched from public to package only)

otherwise, the biggest takeaway is that an explicit for loop on the default array has been replaced with a golang map lookup.... that is positive.

If you like this approach better I'll squash the commits.

dibyom · 2020-09-21T21:15:37Z

pkg/template/event.go

+				// if the header or body was not supplied or was malformed, go with a default if it exists
+				for _, ps := range defaults {
+					if ps.Name == p.Name && ps.Default != nil {
+						fmt.Fprintf(os.Stdout, "using default %s since failed to replace JSONPath value for param %s: %s: error: %s\n",


This is useful information, but I'm not sure we need to print it out. If we do, maybe we can pass through the logger that we for other logging instead of using fmt.Fprintf?

Yeah I looked at that and found it a bit onerous to pass the logger through all the call levels to get it here.

But if this is not an tenable compromise, then sure. I can go one way or the other. I don't have a strong opinion. Will it be feasible for a user to figure out that if the default is used vs. the body/header reference, there was an issue with how it was constructed?

You got a final call here @dibyom ?

Yeah, I think its fine to remove the log statement here given that this is documented/expected behavior.

ok just pushed removal of log statement as part of rebasing this PR on top of recent changes

gabemontero · 2020-09-22T13:12:42Z

How about adding sample example to examples to show usage of this or any doc update which provide this information that there is a support of default values if not found from binding

Per #568 (comment) the existing example could be tweaked to leverage this, where the fact that the default is getting used is highlighted. Would that be amenable vs. creating a separate example?

I did scan the docs and was unclear on where to update. Suggestions on how to cross reference https://github.com/tektoncd/triggers/blob/master/docs/triggertemplates.md with https://github.com/tektoncd/triggers/blob/master/docs/triggerbindings.md to connect the dots @savitaashture @dibyom ?

dibyom · 2020-10-05T19:42:23Z

Per #568 (comment) the existing example could be tweaked to leverage this, where the fact that the default is getting used is highlighted. Would that be amenable vs. creating a separate example?

Sure as long as we have an example that shows that we substitute the default value when one from the event is missing, I'm ok!

I did scan the docs and was unclear on where to update. Suggestions on how to cross reference https://github.com/tektoncd/triggers/blob/master/docs/triggertemplates.md with https://github.com/tektoncd/triggers/blob/master/docs/triggerbindings.md to connect the dots

In the parameters section of TriggerTemplates, we can add something about the default field and when the default value is applied.

Similarly, in the TriggerBindings docs, we can add a something about the behavior maybe, as sub-section inside the Event Variable Interpolation section -- if we fail to resolve the param value from the event, we'll look to see if the trigger template param has a default value. If it doesn't we throw an error.

gabemontero · 2020-10-07T21:16:30Z

Per #568 (comment) the existing example could be tweaked to leverage this, where the fact that the default is getting used is highlighted. Would that be amenable vs. creating a separate example?

Sure as long as we have an example that shows that we substitute the default value when one from the event is missing, I'm ok!

OK pushed commit 64735d2 to try and capture this

gabemontero · 2020-10-07T21:31:07Z

In the parameters section of TriggerTemplates, we can add something about the default field and when the default value is applied.

Similarly, in the TriggerBindings docs, we can add a something about the behavior maybe, as sub-section inside the Event Variable Interpolation section -- if we fail to resolve the param value from the event, we'll look to see if the trigger template param has a default value. If it doesn't we throw an error.

doc updates following these recommendations in 774fb5c

tests have been passing previously, so I'm assuming this doc only change will not affect things

PTAL @dibyom @savitaashture

thanks!!

dibyom · 2020-10-08T16:30:35Z

Nice cleanup! Would you mind squashing up the commits?

dibyom · 2020-10-08T16:30:40Z

/approve

tekton-robot · 2020-10-08T16:30:45Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: dibyom

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [dibyom]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

…rbinding param missing from body/header

gabemontero · 2020-10-08T16:36:52Z

commits squashed @dibyom

dibyom · 2020-10-08T16:37:10Z

/lgtm

tekton-robot assigned dibyom Sep 18, 2020

tekton-robot added the release-note-none Denotes a PR that doesnt merit a release note. label Sep 18, 2020

tekton-robot requested review from bobcatfish and dlorenc September 18, 2020 19:43

tekton-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Sep 18, 2020

gabemontero force-pushed the apply-default-if-param-missing branch from 8dca2ad to 5df7ef2 Compare September 20, 2020 23:41

savitaashture reviewed Sep 21, 2020

View reviewed changes

dibyom reviewed Sep 21, 2020

View reviewed changes

tekton-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Sep 23, 2020

gabemontero force-pushed the apply-default-if-param-missing branch from 5df7ef2 to 300539d Compare October 7, 2020 20:04

tekton-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Oct 7, 2020

gabemontero force-pushed the apply-default-if-param-missing branch from bfe8d6c to 69d7a97 Compare October 7, 2020 21:01

tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 8, 2020

apply triggertemplate param default value if body/header based trigge…

f1ea098

…rbinding param missing from body/header

gabemontero force-pushed the apply-default-if-param-missing branch from 774fb5c to f1ea098 Compare October 8, 2020 16:36

tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Oct 8, 2020

tekton-robot merged commit 6420b23 into tektoncd:master Oct 8, 2020

gabemontero deleted the apply-default-if-param-missing branch October 8, 2020 17:32

praveen4g0 mentioned this pull request Jan 7, 2021

#761 would this behavior applies to CEL overlays too? #890

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

apply triggertemplate param default value if body/header based triggerbinding param missing from body/header #761

apply triggertemplate param default value if body/header based triggerbinding param missing from body/header #761

gabemontero commented Sep 18, 2020

savitaashture left a comment •

edited

Loading

dibyom Sep 21, 2020

gabemontero Sep 22, 2020

dibyom Oct 5, 2020

gabemontero Oct 7, 2020

dibyom Sep 21, 2020

gabemontero Sep 22, 2020

dibyom Oct 5, 2020

gabemontero Oct 7, 2020

gabemontero commented Sep 22, 2020

dibyom commented Oct 5, 2020

gabemontero commented Oct 7, 2020

gabemontero commented Oct 7, 2020

dibyom commented Oct 8, 2020

dibyom commented Oct 8, 2020

tekton-robot commented Oct 8, 2020

gabemontero commented Oct 8, 2020

dibyom commented Oct 8, 2020

apply triggertemplate param default value if body/header based triggerbinding param missing from body/header #761

apply triggertemplate param default value if body/header based triggerbinding param missing from body/header #761

Conversation

gabemontero commented Sep 18, 2020

Changes

Submitter Checklist

Release Notes

savitaashture left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gabemontero commented Sep 22, 2020

dibyom commented Oct 5, 2020

gabemontero commented Oct 7, 2020

gabemontero commented Oct 7, 2020

dibyom commented Oct 8, 2020

dibyom commented Oct 8, 2020

tekton-robot commented Oct 8, 2020

gabemontero commented Oct 8, 2020

dibyom commented Oct 8, 2020

savitaashture left a comment •

edited

Loading