Preserve scalar types when using the replacement filter #4494

lack · 2022-02-25T17:56:27Z

Erasing the scalar type tag leads to unfortunate circumstances, in that
the resulting yaml code is valid yaml, but will not meet the object
spec.

For example, using the replacement transformer to take a port number as
a string from a ConfigMap and set a Pod port would previously end up
with:

port: "8080"
when the spec requires that this is not a string:
port: 8080

Signed-off-by: Jim Ramsay i.am@jimramsay.com

k8s-ci-robot · 2022-02-25T17:56:34Z

Welcome @lack!

It looks like this is your first PR to kubernetes-sigs/kustomize 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/kustomize has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

k8s-ci-robot · 2022-02-25T17:56:35Z

Hi @lack. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

natasha41575 · 2022-03-04T02:20:30Z

/ok-to-test

natasha41575 · 2022-03-04T02:28:32Z

api/filters/replacement/replacement_test.go

+  - select:
+      kind: Pod
+    fieldPaths:
+    - spec.containers.0.ports.0.port


Question, what happens in the scenario that this path does not yet exist and we have to create it? e.g.

replacements: - source: kind: ConfigMap name: config fieldPath: data.PORT targets: - select: kind: Pod fieldPaths: - spec.containers.0.ports.0.port options: create: true

Would you mind adding a test for this case? No need to fix the behavior in this PR if it does something undesirable - but it would be good to just have the test as a record of the behavior.

Good idea!

Current behavior would be to create it with the source type (since Kustomize doesn't know what the target type is if it didn't already parse it)

Will add!

Added. Though it did expose another problem in the replacement code: Apparently the "create" option doesn't deal well with appending to arrays or creating intermediate maps or arrays.

I'll log separate issues about those.

Turns out intermediate maps are fine. Intermediate arrays are complicated. Following up on that in #4507

lack · 2022-03-08T16:51:51Z

Maybe I'll add an explicit test for boolean conversion as well as int?

natasha41575 · 2022-03-08T21:42:59Z

Maybe I'll add an explicit test for boolean conversion as well as int?

Yes please! Thank you. Once that is done I'll do another pass and we can get this PR in.

Erasing the scalar type tag leads to unfortunate circumstances, in that the resulting yaml code is valid yaml, but will not meet the object spec. For example, using the replacement transformer to take a port number as a string from a ConfigMap and set a Pod port would previously end up with: - containerPort: "8080" when the spec requires that this is not a string: - containerPort: 8080 Added unit tests for conversion to and from integers and booleans, plus creation from string and creation from integer. The creation behavior needs some refinement in a future PR. Signed-off-by: Jim Ramsay <i.am@jimramsay.com>

lack · 2022-03-09T11:43:10Z

Okay! Latest change adds unit tests for conversion to/from boolean as well.

lack · 2022-03-11T00:59:54Z

@natasha41575 ^^ Ready to go, I think!

natasha41575 · 2022-03-16T16:40:54Z

/lgtm
/approve

k8s-ci-robot · 2022-03-16T16:51:12Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: lack, natasha41575

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~~ [natasha41575]

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

lack · 2022-03-17T13:26:03Z

Fixes #4479

k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Feb 25, 2022

k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Feb 25, 2022

k8s-ci-robot requested review from natasha41575 and yuwenma February 25, 2022 17:56

k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Feb 25, 2022

k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Mar 4, 2022

natasha41575 reviewed Mar 4, 2022

View reviewed changes

lack force-pushed the replacement/string-int-autoconvert branch from e76b84e to c00ed07 Compare March 5, 2022 02:59

natasha41575 self-assigned this Mar 7, 2022

natasha41575 mentioned this pull request Mar 7, 2022

Ability to Use replacements for Boolean Fields #4479

Closed

lack force-pushed the replacement/string-int-autoconvert branch from c00ed07 to cb80659 Compare March 9, 2022 11:42

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 16, 2022

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 16, 2022

k8s-ci-robot merged commit 3ae5aa9 into kubernetes-sigs:master Mar 16, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Preserve scalar types when using the replacement filter #4494

Preserve scalar types when using the replacement filter #4494

lack commented Feb 25, 2022

k8s-ci-robot commented Feb 25, 2022

k8s-ci-robot commented Feb 25, 2022

natasha41575 commented Mar 4, 2022

natasha41575 Mar 4, 2022

lack Mar 4, 2022

lack Mar 5, 2022

lack Mar 6, 2022

lack commented Mar 8, 2022

natasha41575 commented Mar 8, 2022

lack commented Mar 9, 2022

lack commented Mar 11, 2022

natasha41575 commented Mar 16, 2022

k8s-ci-robot commented Mar 16, 2022

lack commented Mar 17, 2022

Preserve scalar types when using the replacement filter #4494

Preserve scalar types when using the replacement filter #4494

Conversation

lack commented Feb 25, 2022

k8s-ci-robot commented Feb 25, 2022

k8s-ci-robot commented Feb 25, 2022

natasha41575 commented Mar 4, 2022

natasha41575 Mar 4, 2022

Choose a reason for hiding this comment

lack Mar 4, 2022

Choose a reason for hiding this comment

lack Mar 5, 2022

Choose a reason for hiding this comment

lack Mar 6, 2022

Choose a reason for hiding this comment

lack commented Mar 8, 2022

natasha41575 commented Mar 8, 2022

lack commented Mar 9, 2022

lack commented Mar 11, 2022

natasha41575 commented Mar 16, 2022

k8s-ci-robot commented Mar 16, 2022

lack commented Mar 17, 2022