Terraform Test: Allow skipping cleanup of entire test file or individual run blocks #36729
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
dsa0x
added
the
no-changelog-needed
dsa0x
force-pushed
the
sams/test_skip_cleanup
branch
from
f121f50 to
88896d6
Compare
dsa0x
force-pushed
the
sams/test_skip_cleanup
branch
from
88896d6 to
7f4cb14
Compare
SarahFrench
reviewed
Mar 21, 2025
Comment on lines
+2317
to
+2336
| stateGetter := func(stateKey string) (*states.State, error) { | ||
| backend := local.New() | ||
| dir := filepath.Dir(stateKey) | ||
| backendConfig := cty.ObjectVal(map[string]cty.Value{ | ||
| "path": cty.StringVal(stateKey), | ||
| "workspace_dir": cty.StringVal(dir), | ||
| }) | ||
| diags := backend.Configure(backendConfig) | ||
| if diags.HasErrors() { | ||
| return nil, fmt.Errorf("failed to configure backend: %s", diags) | ||
| } | ||
|
|
||
| mgr, err := backend.StateMgr("default") | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to create state manager: %s", err) | ||
| } | ||
| if err := mgr.RefreshState(); err != nil { | ||
| return nil, fmt.Errorf("failed to refresh state: %s", err) | ||
| } | ||
| return mgr.State(), nil |
There was a problem hiding this comment.
I've been learning about the state packages recently, and an easier way to implement code that does this is using a statemgr.Filesystem:
// stateKey is value like ".terraform/test/TpQOqtev.tfstate"
sm := statemgr.NewFilesystem(stateKey)
err := sm.RefreshState()
if err != nil {
return nil, fmt.Errorf("error when reading state file: %w", err)
}
return sm.State(), errAlternatively, I think your helper can be replaced with the pre-existing testStateRead function! I've just been refactoring some code to remove my own implementation of this helper also, and it looks like there are a number of helpers like this in the codebase 😂
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.
Implements
skip_cleanup, which allows skipping the cleanup of individual run blocks or the entire test file. This simply ensures that the cleanup stage for the state is an apply of the run requesting the skip, instead of the normal destroyTarget Release
1.12.x
CHANGELOG entry