PSS: Add tests showing `state` subcommands being used with PSS #37891

SarahFrench · 2025-11-11T17:17:17Z

Following #37569, this PR demonstrates that these commands work when pluggable state storage is in use:

state identities
state list
state mv
state replace-provider
state rm
state pull
state push
state show

This PR mostly implements integration tests, but adds E2E tests for state list and state show.

Target Release

N/A

Rollback Plan

If a change needs to be reverted, we will roll out an update to the code within 7 days.

Changes to Security Controls

Are there any changes to security controls (access controls, encryption, logging) in this pull request? If so, explain.

CHANGELOG entry

This change is user-facing and I added a changelog entry.
This change is not user-facing.

SarahFrench · 2025-11-12T13:41:13Z

...h-state-store-fs/.terraform/providers/registry.terraform.io/hashicorp/simple6/0.0.1/.gitkeep

Note: the test will still need to build the appropriate binary and put it in a folder here that's named appropriately for the platform that is running the test.

Nit: I thought that go build creates the parent directories in the path, so this should not be necessary? I suppose it just means we need to cleanup the directory afterwards rather than just the binary.

SarahFrench · 2025-11-20T14:47:14Z

Ooh, actually I'm going to add a non-E2E version of the tests to help with code coverage reporting, moving to draft.

SarahFrench · 2025-11-24T16:52:11Z

internal/command/testdata/state-push-state-store-good/replace.tfstate

The push command has its own test fixture, versus the shared internal/command/testdata/state-commands-state-store, because it needs a local state file to be the data that's pushed up to the state store.

radeksimko

My only major question is about the gating of the E2E test, the rest is really minor/nitpicky stuff.

radeksimko · 2025-12-04T15:06:42Z

internal/command/e2etest/pluggable_state_store_test.go

+		t.Skip("can't run without building a new provider executable")
+	}
+
+	t.Setenv(e2e.TestExperimentFlag, "true")


Why are we setting this to true? I feel like that defeats the original purpose of the flag/variable, which is to avoid running E2E tests by default during go test ./...

When the e2e.GoBuild method on L140 builds the Terraform binary it uses this ENV to decide if the binary should be built with experiments enabled or not:

terraform/internal/e2e/e2e.go

Lines 260 to 262 in 0941763

if exp := os.Getenv(TestExperimentFlag); exp != "" && exp != "false" {

args = append(args, "-ldflags", "-X 'main.experimentsAllowed=yes'")

}

It looks like this was added in the context of the Search project ~5 months ago.

internal/command/e2etest/pluggable_state_store_test.go

radeksimko · 2025-12-04T15:10:21Z

...h-state-store-fs/.terraform/providers/registry.terraform.io/hashicorp/simple6/0.0.1/.gitkeep

Nit: I thought that go build creates the parent directories in the path, so this should not be necessary? I suppose it just means we need to cleanup the directory afterwards rather than just the binary.

internal/command/init_test.go

internal/command/output_test.go

…ing tests where the values in `MockStates` aren't compatible with the `ReadStateBytesFn` default function. Make existing test set an appropriate value in `MockStates`.

…resource schema

…h pluggable state storage code.

…on with pluggable state storage code.

…pluggable state storage code.

…h pluggable state storage code.

…egration with pluggable state storage code.

SarahFrench · 2025-12-04T21:33:01Z

internal/command/state_identities_test.go

 	mockProviderAddress := addrs.NewDefaultProvider("test")
-	providerSource, close := newMockProviderSource(t, map[string][]string{
-		"hashicorp/test": {"1.0.0"},
-	})
-	defer close()



Context: I realised that in lots of tests for PSS I've been adding this provider source value into the Meta in tests. Provider sources are only needed in the context of an init command, so providing them in these tests is unnecessary.

Similarly there are times where supplying both a View and Ui is unnecessary, and some commands need a Stream. I guess this reflects how different commands' terminal output is implemented slightly differently (shout out to #37439), and so only some outputs are required in their tests.

…mand under test. This test fixure is reused across tests that need the config to define a state store but otherwise rely on the mock provider to set up the test scenario.

The internal/command/testdata/state-commands-state-store and internal/command/testdata/state-store-unchanged test fixtures are the same.

…using grpcwrap package This was removed, incorrectly, in #37899

…turned from `mockPluggableStateStorageProvider` and the `MockStates` that's been set in the mock

…y .gitkeep

SarahFrench added the no-changelog-needed Add this to your PR if the change does not require a changelog entry label Nov 11, 2025

SarahFrench commented Nov 12, 2025

View reviewed changes

Base automatically changed from pss/make-worspace-new-work-with-pss to main November 19, 2025 12:50

SarahFrench marked this pull request as ready for review November 20, 2025 14:46

SarahFrench requested a review from a team as a code owner November 20, 2025 14:46

SarahFrench marked this pull request as draft November 20, 2025 14:47

SarahFrench changed the title ~~PSS: Add E2E tests showing state subcommands being used with PSS~~ PSS: Add E2E tests showing state show and state list subcommands being used with PSS Nov 21, 2025

SarahFrench changed the title ~~PSS: Add E2E tests showing state show and state list subcommands being used with PSS~~ PSS: Add E2E and integration tests showing state show and state list subcommands being used with PSS Nov 21, 2025

SarahFrench changed the title ~~PSS: Add E2E and integration tests showing state show and state list subcommands being used with PSS~~ PSS: Add tests showing state subcommands being used with PSS Nov 21, 2025

SarahFrench force-pushed the pss/pss-with-state-commands branch 2 times, most recently from 28e61ce to cebf4a5 Compare November 24, 2025 13:11

SarahFrench marked this pull request as ready for review November 24, 2025 14:49

SarahFrench commented Nov 24, 2025

View reviewed changes

radeksimko reviewed Dec 4, 2025

View reviewed changes

SarahFrench added 11 commits December 4, 2025 21:23

test: Add E2E tests for state list and state show commands

10c5e22

test: Update mockPluggableStateStorageProvider to log a warning dur…

9aa680d

…ing tests where the values in `MockStates` aren't compatible with the `ReadStateBytesFn` default function. Make existing test set an appropriate value in `MockStates`.

test: Update mockPluggableStateStorageProvider helper to include a …

33635cd

…resource schema

test: Add command-level test for state list showing integration wit…

4d94e87

…h pluggable state storage code.

test: Add command-level test for state show showing integration wit…

b9a1d3f

…h pluggable state storage code.

test: Add command-level test for state pull showing integration wit…

6cb5625

…h pluggable state storage code.

test: Add command-level test for state identities showing integrati…

1bdfba5

…on with pluggable state storage code.

test: Add command-level test for state rm showing integration with …

bbfbf63

…pluggable state storage code.

test: Add command-level test for state mv showing integration with …

0536d82

…pluggable state storage code.

test: Add command-level test for state push showing integration wit…

4804cc3

…h pluggable state storage code.

test: Add command-level test for state replace-provider showing int…

55bfebc

…egration with pluggable state storage code.

SarahFrench force-pushed the pss/pss-with-state-commands branch from bd6f62e to 3af7596 Compare December 4, 2025 21:25

SarahFrench commented Dec 4, 2025

View reviewed changes

SarahFrench force-pushed the pss/pss-with-state-commands branch from 3af7596 to bb7d519 Compare December 4, 2025 21:51

SarahFrench requested a review from radeksimko December 4, 2025 21:52

SarahFrench added 7 commits December 4, 2025 21:57

test: Change shared test fixture to not be named after a specific com…

723c90d

…mand under test. This test fixure is reused across tests that need the config to define a state store but otherwise rely on the mock provider to set up the test scenario.

test: Update test to use shared test fixture

c3b7923

test: Remove redundant test fixture

c392a6f

The internal/command/testdata/state-commands-state-store and internal/command/testdata/state-store-unchanged test fixtures are the same.

fix: Re-add logic for setting chunk size in the context of E2E tests …

101f432

…using grpcwrap package This was removed, incorrectly, in #37899

refactor: Let panic happen if there's incompatibility between mock re…

1b0d141

…turned from `mockPluggableStateStorageProvider` and the `MockStates` that's been set in the mock

test: Refactor to contain paths in reused variable, remove unnecessar…

6ecb90a

…y .gitkeep

test: Remove unneeded test code

c2d9c42

SarahFrench force-pushed the pss/pss-with-state-commands branch from bb7d519 to c2d9c42 Compare December 4, 2025 21:57

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

PSS: Add tests showing `state` subcommands being used with PSS #37891

PSS: Add tests showing `state` subcommands being used with PSS #37891

SarahFrench commented Nov 11, 2025 •

edited

Loading

Uh oh!

SarahFrench Nov 12, 2025

Uh oh!

radeksimko Dec 4, 2025

Uh oh!

SarahFrench commented Nov 20, 2025

Uh oh!

SarahFrench Nov 24, 2025

Uh oh!

radeksimko left a comment

Uh oh!

radeksimko Dec 4, 2025

Uh oh!

SarahFrench Dec 4, 2025

Uh oh!

Uh oh!

radeksimko Dec 4, 2025

Uh oh!

Uh oh!

Uh oh!

SarahFrench Dec 4, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	if exp := os.Getenv(TestExperimentFlag); exp != "" && exp != "false" {
	args = append(args, "-ldflags", "-X 'main.experimentsAllowed=yes'")
	}

PSS: Add tests showing state subcommands being used with PSS #37891

Are you sure you want to change the base?

PSS: Add tests showing state subcommands being used with PSS #37891

Conversation

SarahFrench commented Nov 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Target Release

Rollback Plan

Changes to Security Controls

CHANGELOG entry

Uh oh!

SarahFrench Nov 12, 2025

Choose a reason for hiding this comment

Uh oh!

radeksimko Dec 4, 2025

Choose a reason for hiding this comment

Uh oh!

SarahFrench commented Nov 20, 2025

Uh oh!

SarahFrench Nov 24, 2025

Choose a reason for hiding this comment

Uh oh!

radeksimko left a comment

Choose a reason for hiding this comment

Uh oh!

radeksimko Dec 4, 2025

Choose a reason for hiding this comment

Uh oh!

SarahFrench Dec 4, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

radeksimko Dec 4, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

SarahFrench Dec 4, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

PSS: Add tests showing `state` subcommands being used with PSS #37891

PSS: Add tests showing `state` subcommands being used with PSS #37891

SarahFrench commented Nov 11, 2025 •

edited

Loading