feat: Add support for validating Output Changes
#1459
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
This commit updates the `PlanStruct` type to include the `OutputChangesMap` field, which contains a map of output names and their corresponding change. As part of this: * Add new `parseOutputChanges` function * Add new `AssertOutputChangesMapKeyExists` and `RequireOutputChangesMapKeyExists` public functions. * Add test for new functionality. Also bump the `terraform-json` fixture version to `0.13.0` to match the version in `go.mod`.
|
@denis256 Are the test failures there anything I need to worry about? Looking at the latest run on |
denis256
reviewed
Nov 1, 2024
modules/terraform/plan_struct.go
Outdated
| // If there are no changes, this returns an empty map instead of erroring | ||
| func parseOutputChanges(plan *PlanStruct) map[string]*tfjson.Change { | ||
| out := map[string]*tfjson.Change{} | ||
| for output_name, change := range plan.RawPlan.OutputChanges { |
There was a problem hiding this comment.
Use camel case instead of snake case
| @@ -91,6 +105,18 @@ func parseModulePlannedValues(module *tfjson.StateModule) map[string]*tfjson.Sta | |||
| return out | |||
| } | |||
|
|
|||
| // AssertOutputChangesMapKeyExists checks if the given key exists in the map, failing the test if it does not. | |||
| func AssertOutputChangesMapKeyExists(t testing.TestingT, plan *PlanStruct, keyQuery string) { | |||
There was a problem hiding this comment.
AssertOutputChangesMapKeyExists - seems to be unused, can be added a test for it?
| t.Parallel() | ||
|
|
||
| // Retrieve test data from the terraform-json project. | ||
| _, jsonData := http_helper.HttpGet(t, changesJsonUrl, nil) |
There was a problem hiding this comment.
can the status code also be verified?
There was a problem hiding this comment.
Sure... I straight copied this func from TestResourceChangesJson.
Will apply same tweak there aswell...
|
I will add a separate PR to fix the master tests |
|
@denis256 review comments addressed :) |
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.
This commit updates the
PlanStructtype to include theOutputChangesMapfield, which contains a map of output names and theircorresponding change.
As part of this:
parseOutputChangesfunctionAssertOutputChangesMapKeyExistsandRequireOutputChangesMapKeyExistspublic functions.terraform-jsonfixtureversion to
0.13.0to match the version ingo.mod.