Skip to content

Test PERSISTENCE env vars #195

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
anisaoshafi merged 4 commits into from
Apr 27, 2026
+66 −2
Merged

Test PERSISTENCE env vars #195

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
588e14a
Forward PERSISTENCE and snapshot env vars to emulator container
anisaoshafi Apr 23, 2026
d84009d
Revert allow-listing: already covered by previous logic
anisaoshafi Apr 27, 2026
390e706
Fix test
anisaoshafi Apr 27, 2026
1a7e11c
Leftovers
anisaoshafi Apr 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion internal/container/start.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -542,7 +542,8 @@ func awaitStartup(ctx context.Context, rt runtime.Runtime, sink output.Sink, con
func filterHostEnv(envList []string) []string {
var out []string
for _, e := range envList {
if strings.HasPrefix(e, "CI=") || (strings.HasPrefix(e, "LOCALSTACK_") && !strings.HasPrefix(e, "LOCALSTACK_AUTH_TOKEN=")) {
if strings.HasPrefix(e, "CI=") ||
(strings.HasPrefix(e, "LOCALSTACK_") && !strings.HasPrefix(e, "LOCALSTACK_AUTH_TOKEN=")) {
out = append(out, e)
}
}
Expand Down
3 changes: 2 additions & 1 deletion internal/container/start_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,7 @@ func TestFilterHostEnv(t *testing.T) {
"LOCALSTACK_DISABLE_EVENTS=1",
"LOCALSTACK_API_ENDPOINT=https://example.test",
"LOCALSTACK_AUTH_TOKEN=host-token",
"LOCALSTACK_PERSISTENCE=1",
"PATH=/usr/bin",
"HOME=/home/user",
"CI_PIPELINE=foo",
Expand All @@ -166,10 +167,10 @@ func TestFilterHostEnv(t *testing.T) {
assert.Contains(t, got, "CI=true")
assert.Contains(t, got, "LOCALSTACK_DISABLE_EVENTS=1")
assert.Contains(t, got, "LOCALSTACK_API_ENDPOINT=https://example.test")
assert.Contains(t, got, "LOCALSTACK_PERSISTENCE=1")
assert.NotContains(t, got, "LOCALSTACK_AUTH_TOKEN=host-token",
"host LOCALSTACK_AUTH_TOKEN must be filtered so it cannot overwrite the lstk-resolved token")
assert.NotContains(t, got, "PATH=/usr/bin")
assert.NotContains(t, got, "HOME=/home/user")
assert.NotContains(t, got, "CI_PIPELINE=foo", "only exact CI= must be forwarded, not CI_*")
}

1 change: 1 addition & 0 deletions test/integration/env/env.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ const (
AnalyticsEndpoint Key = "LSTK_ANALYTICS_ENDPOINT"
DisableEvents Key = "LOCALSTACK_DISABLE_EVENTS"
Home Key = "HOME"
Persistence Key = "LOCALSTACK_PERSISTENCE"
)

func Get(key Key) string {
Expand Down
61 changes: 61 additions & 0 deletions test/integration/start_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -343,6 +343,67 @@ func TestStartCommandPassesCIAndLocalStackEnvVars(t *testing.T) {
assert.NotEmpty(t, envVars["LOCALSTACK_AUTH_TOKEN"])
}

func TestStartCommandForwardsPersistenceEnvFromHost(t *testing.T) {
requireDocker(t)
_ = env.Require(t, env.AuthToken)

cleanup()
t.Cleanup(cleanup)

mockServer := createMockLicenseServer(true)
defer mockServer.Close()

ctx := testContext(t)
_, stderr, err := runLstk(t, ctx, "", env.With(env.APIEndpoint, mockServer.URL).
With(env.Persistence, "1"),
"start")
require.NoError(t, err, "lstk start failed: %s", stderr)
requireExitCode(t, 0, err)

inspect, err := dockerClient.ContainerInspect(ctx, containerName)
require.NoError(t, err, "failed to inspect container")
require.True(t, inspect.State.Running)

envVars := containerEnvToMap(inspect.Config.Env)
assert.Equal(t, "1", envVars["LOCALSTACK_PERSISTENCE"])
}

func TestStartCommandSetsPersistenceEnvFromConfig(t *testing.T) {
requireDocker(t)
_ = env.Require(t, env.AuthToken)

cleanup()
t.Cleanup(cleanup)

mockServer := createMockLicenseServer(true)
defer mockServer.Close()

configContent := `
[env.persistence]
PERSISTENCE = "1"

[[containers]]
type = "aws"
tag = "latest"
port = "4566"
env = ["persistence"]
`
configFile := filepath.Join(t.TempDir(), "config.toml")
require.NoError(t, os.WriteFile(configFile, []byte(configContent), 0644))

ctx := testContext(t)
_, stderr, err := runLstk(t, ctx, "", env.With(env.APIEndpoint, mockServer.URL), "--config", configFile, "start")
require.NoError(t, err, "lstk start failed: %s", stderr)
requireExitCode(t, 0, err)

inspect, err := dockerClient.ContainerInspect(ctx, containerName)
require.NoError(t, err, "failed to inspect container")
require.True(t, inspect.State.Running)

envVars := containerEnvToMap(inspect.Config.Env)
assert.Equal(t, "1", envVars["PERSISTENCE"])
}

Copy link
Copy Markdown
Collaborator

@carole-lavillonniere carole-lavillonniere Apr 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

praise: good call adding a test to make sure we can enable persistence from config

// hasBindTarget checks if any bind mount targets the given container path.
func hasBindTarget(binds []string, containerPath string) bool {
for _, b := range binds {
Expand Down