Unwrap scalars in shell output mode. #2548
Conversation
- Add UnwrapScalar boolean field to ShellVariablesPreferences struct. - Initialize UnwrapScalar to false in NewDefaultShellVariablesPreferences. - This preference will control whether shell output should be quoted or raw.
- In configureEncoder function, set UnwrapScalar in ConfiguredShellVariablesPreferences. - This ensures the -r flag's state is passed to the shell encoder for raw output control.
- Modify doEncode method to check pe.prefs.UnwrapScalar. - If UnwrapScalar is true, output raw node.Value. - Otherwise, use quoteValue for shell-safe quoting. - This enables quote-free output for Kubernetes workflows when -r is used.
- Introduce assertEncodesToUnwrapped helper function. - Add TestShellVariablesEncoderUnwrapScalar to verify quote-free output with -r. - Add TestShellVariablesEncoderDefaultQuoting to confirm default quoting behavior without -r. - Ensure comprehensive testing of conditional quoting logic for shell output.
Bumps [golang.org/x/text](https://github.com/golang/text) from 0.31.0 to 0.32.0. - [Release notes](https://github.com/golang/text/releases) - [Commits](golang/text@v0.31.0...v0.32.0) --- updated-dependencies: - dependency-name: golang.org/x/text dependency-version: 0.32.0 dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com>
Bumps [github.com/zclconf/go-cty](https://github.com/zclconf/go-cty) from 1.16.3 to 1.17.0. - [Release notes](https://github.com/zclconf/go-cty/releases) - [Changelog](https://github.com/zclconf/go-cty/blob/main/CHANGELOG.md) - [Commits](zclconf/go-cty@v1.16.3...v1.17.0) --- updated-dependencies: - dependency-name: github.com/zclconf/go-cty dependency-version: 1.17.0 dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com>
Bumps [golang.org/x/net](https://github.com/golang/net) from 0.47.0 to 0.48.0. - [Commits](golang/net@v0.47.0...v0.48.0) --- updated-dependencies: - dependency-name: golang.org/x/net dependency-version: 0.48.0 dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com>
| if pe.prefs.UnwrapScalar { | ||
| valueString = node.Value | ||
| } else { | ||
| valueString = quoteValue(node.Value) |
There was a problem hiding this comment.
Actually, looking at the quoteValue function, it only quotes if it determines that it needs to (non alpha numeric characters).
I think with this change yq could emit invalid shell script...
There was a problem hiding this comment.
Hi Mike,
Thanks for your reply.
The original, unchanged code used quoteValue indiscriminately.
Is this an issue with my PR or with the original issue?
If the former, I am not understanding the intended behavior.
Cheers.
There was a problem hiding this comment.
looking at what quoteValue does; it only quotes if necessary :/
I'm now wondering if this is the right approach 🤔 There's also a "properties" file format that may be more suited - can you give a couple of examples that you need for your usecase?
There was a problem hiding this comment.
Hi,
I am not the original opener of the issue, I was just implementing the change based on my understanding of it.
I would also be enlightened by some examples 😅
Maybe the issue should be closed if no examples are provided.
Best.
| if pe.prefs.UnwrapScalar { | ||
| valueString = node.Value | ||
| } else { | ||
| valueString = quoteValue(node.Value) |
There was a problem hiding this comment.
Hi Mike,
Thanks for your reply.
The original, unchanged code used quoteValue indiscriminately.
Is this an issue with my PR or with the original issue?
If the former, I am not understanding the intended behavior.
Cheers.
|
The "-r" Unwrap Scalars should only be used with "-o shell" if the output was intended to be used as an Env file per issue 2504. The "-o prop" output format can't be used because properties file keys can contain characters which are invalid for Env files. |
|
Clarification, the particular Env file format which issue 2504 was trying to address, was intended to be used with Kubernetes configmap/secret create --from-env-file. All shell variable names are also valid Kubernetes configmap/secret keys. But all properties file names are not. |
|
Alirght I think it all makes sense then 🤔 - @flintwinters can you rebase cause atm you've got commits in this PR that are already in master |
3 participants
Resolves #2504 Adds
-rsupport for-o shelloutputsFirst PR.