Add ShowPlanFileRaw #83
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The SDK used a non-JSON version of ShowPlanFile to return the human-friendly, opaque-to-machines plan output during testing. With the switch to tfexec, this is no longer possible, as all `terraform show` commands have the `-json` flag applied, meaning all output will be JSON output. This adds a new function, `ShowRawPlanFile`, which returns a string of the output of `terraform show` _without_ the `-json` flag, showing the raw contents of the plan file. A new function was chosen to avoid overloading the existing ShowPlanFile, and because the existing ShowPlanFile returns a `tfjson.Plan` type, which we can't shoehorn a non-JSON return type into easily. Rather than complicate the return type, it felt like a new function was a better solution.
@paultyng suggested `ShowPlanFileRaw`, so we'll run with that, instead, because I'm ambivalent.
|
Updated to |
paultyng
reviewed
Sep 12, 2020
| showCmd := tf.showCmd(ctx, false, mergeEnv, planPath) | ||
|
|
||
| var ret bytes.Buffer | ||
| showCmd.Stdout = &ret |
There was a problem hiding this comment.
This needs to use mergewriters just in case
There was a problem hiding this comment.
mergeWriters is already called by tf.runTerraformCmd, though? In fact, that's the only command that calls it.
kmoe
approved these changes
Sep 15, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The SDK used a non-JSON version of ShowPlanFile to return the
human-friendly, opaque-to-machines plan output during testing. With the
switch to tfexec, this is no longer possible, as all
terraform showcommands have the
-jsonflag applied, meaning all output will be JSONoutput.
This adds a new function,
ShowRawPlanFile, which returns a string ofthe output of
terraform showwithout the-jsonflag, showing theraw contents of the plan file. A new function was chosen to avoid
overloading the existing ShowPlanFile, and because the existing
ShowPlanFile returns a
tfjson.Plantype, which we can't shoehorn anon-JSON return type into easily. Rather than complicate the return
type, it felt like a new function was a better solution.