Cleanup in appropriate order when running parallel execution#38247
Open
dsa0x wants to merge 5 commits into
Open
Cleanup in appropriate order when running parallel execution#38247dsa0x wants to merge 5 commits into
dsa0x wants to merge 5 commits into
Conversation
There was a problem hiding this comment.
Pull request overview
This PR fixes teardown (state cleanup) ordering for terraform test when runs execute in parallel, ensuring cleanup respects run dependencies rather than incidental run sequence. It also simplifies the cleanup dependency modeling by connecting teardown nodes based only on the “owning” (last) run for each state_key.
Changes:
- Reworked teardown graph construction to derive cleanup dependencies from run-node dependencies and to connect only the last run per
state_keyas the cleanup “owner”. - Updated/added tests and fixtures to validate correct teardown ordering in parallel dependency scenarios.
- Added a v1.15 bugfix changelog entry for the parallel cleanup dependency ordering fix.
Reviewed changes
Copilot reviewed 6 out of 7 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| internal/moduletest/graph/transform_state_cleanup.go | Refactors teardown subgraph dependency collection and simplifies cleanup-node edge creation based on owning runs per state_key. |
| internal/moduletest/graph/test_graph_builder.go | Updates TeardownSubgraph wiring to pass the run graph via the renamed field. |
| internal/command/testdata/test/parallel_deps/main.tftest.hcl | Adds a new test fixture exercising parallel teardown dependency ordering. |
| internal/command/testdata/test/parallel_deps/main.tf | Adds supporting Terraform config for the new parallel dependency fixture. |
| internal/command/testdata/test/cleanup/main.tftest.hcl | Minor formatting adjustment in existing cleanup fixture. |
| internal/command/test_test.go | Adds a JSON-output-based regression test to assert teardown ordering for parallel dependencies. |
| .changes/v1.15/BUG FIXES-20260309-084347.yaml | Adds changelog entry for the bugfix. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+6004
to
+6008
| actual := output.All() | ||
|
|
||
| var teardownOrder []string | ||
| lines, err := parseJSONLines(t, actual) | ||
| if err != nil { |
a7bf179 to
f0416b9
Compare
This file contains hidden or 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
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 PR started with me tracking a bug where in parallel mode, we still had some dependency ordering based on the sequence of runs.
For example,
In the test above,
run.test_threeis destroyed beforerun.test_two, but that is wrong. test_two depends on test_three, so test_two should be destroyed first, i.e reversing the order of creation.Having fixed that in f6f234f, I realized that the original implementation was unnecessarily complex. Instead, what I have done now is only connect references between the last runs of each state key. These last runs represent the last applied state.
In the above, the state_key
mainwill contain the state applied after evaluatingrun.test_four. Therefore, any reference torun.test(which also used the state_keymain) do not need to be taken into account when connecting cleanup nodes, asrun.test_fouris the "owner" of the cleanup process.Target Release
1.15.x
Rollback Plan
Changes to Security Controls
Are there any changes to security controls (access controls, encryption, logging) in this pull request? If so, explain.
CHANGELOG entry