From 37f57744de1c43262e05c007bd94aa464f64ed23 Mon Sep 17 00:00:00 2001 From: Nicolas De Loof Date: Mon, 17 Aug 2026 08:54:11 +0200 Subject: [PATCH] test(e2e): exec and provider scenarios - TestExec locks the container-selection order (service container over one-off) with one-off state observed at each step. - providers: a shared providerScenario helper wires the example-provider binary into PATH; the env assertions anchor on the 'test-1 | ' log prefix, replacing the hand-rolled env parser, and the stop-hook sentinel file is observed with FileExists. - Fixtures exec/ and providers/ are removed. Signed-off-by: Nicolas De Loof --- pkg/e2e/exec_test.go | 40 ++-- pkg/e2e/providers_test.go | 176 +++++------------- .../compose.yaml} | 0 .../exec => testdata/TestExec}/compose.yaml | 2 +- .../TestProviderRawSetEnv/compose.yaml} | 0 .../compose.yaml} | 0 .../compose.yaml} | 0 .../compose.yaml} | 0 .../TestProviderStopHook/compose.yaml} | 0 9 files changed, 68 insertions(+), 150 deletions(-) rename pkg/e2e/{fixtures/providers/depends-on-multiple-providers.yaml => testdata/TestDependsOnMultipleProviders/compose.yaml} (100%) rename pkg/e2e/{fixtures/exec => testdata/TestExec}/compose.yaml (53%) rename pkg/e2e/{fixtures/providers/rawsetenv.yaml => testdata/TestProviderRawSetEnv/compose.yaml} (100%) rename pkg/e2e/{fixtures/providers/rawsetenv-inherit.yaml => testdata/TestProviderRawSetEnvOverridesInheritedEnv/compose.yaml} (100%) rename pkg/e2e/{fixtures/providers/rawsetenv-inherit-map.yaml => testdata/TestProviderRawSetEnvOverridesInheritedEnvMapForm/compose.yaml} (100%) rename pkg/e2e/{fixtures/providers/rawsetenv-override.yaml => testdata/TestProviderRawSetEnvOverridesUserEnv/compose.yaml} (100%) rename pkg/e2e/{fixtures/providers/provider-stop.yaml => testdata/TestProviderStopHook/compose.yaml} (100%) diff --git a/pkg/e2e/exec_test.go b/pkg/e2e/exec_test.go index 16643a0f8..1f8d1018c 100644 --- a/pkg/e2e/exec_test.go +++ b/pkg/e2e/exec_test.go @@ -18,30 +18,24 @@ package e2e import ( "testing" - - "gotest.tools/v3/icmd" ) func TestExec(t *testing.T) { - const projectName = "e2e-exec" - c := NewParallelCLI(t) - - cleanup := func() { - c.RunDockerComposeCmd(t, "--project-name", projectName, "down", "--timeout=0", "--remove-orphans") - } - t.Cleanup(cleanup) - cleanup() - - c.RunDockerComposeCmd(t, "-f", "./fixtures/exec/compose.yaml", "--project-name", projectName, "run", "-d", "test", "cat") - - res := c.RunDockerComposeCmdNoCheck(t, "--project-name", projectName, "exec", "--index=1", "test", "ps") - res.Assert(t, icmd.Expected{Err: "service \"test\" is not running container #1", ExitCode: 1}) - - res = c.RunDockerComposeCmd(t, "--project-name", projectName, "exec", "test", "ps") - res.Assert(t, icmd.Expected{Out: "cat"}) // one-off container was selected - - c.RunDockerComposeCmd(t, "-f", "./fixtures/exec/compose.yaml", "--project-name", projectName, "up", "-d") - - res = c.RunDockerComposeCmd(t, "--project-name", projectName, "exec", "test", "ps") - res.Assert(t, icmd.Expected{Out: "tail"}) // service container was selected + NewScenario(t, "exec must prefer the service container over a one-off, falling back to the one-off when alone"). + Step("run starts a detached one-off with its own command", + ComposeCmd("run", "-d", "test", "cat"), + OneOffState("test", "running")). + Step("exec --index=1 finds no numbered replica", + ComposeCmd("exec", "--index=1", "test", "ps").MayFail(), + ExitCode(1), + OutputContains(`service "test" is not running container #1`)). + Step("with only a one-off around, exec lands in it", + ComposeCmd("exec", "test", "ps"), + StdoutContains("cat")). + Step("up starts the service container", + ComposeCmd("up", "-d"), + ServiceState("test", "running")). + Step("exec now selects the service container", + ComposeCmd("exec", "test", "ps"), + StdoutContains("tail")) } diff --git a/pkg/e2e/providers_test.go b/pkg/e2e/providers_test.go index 71fe13b75..91b0ab045 100644 --- a/pkg/e2e/providers_test.go +++ b/pkg/e2e/providers_test.go @@ -17,153 +17,77 @@ package e2e import ( - "bufio" "fmt" "os" "path/filepath" - "slices" - "strings" "testing" - - "gotest.tools/v3/assert" - "gotest.tools/v3/icmd" ) -// TestProviderStopHook verifies that "docker compose stop" invokes the provider -// binary's "stop" subcommand. The example provider writes a sentinel file at -// PROVIDER_STOP_MARKER when its stop subcommand runs. -func TestProviderStopHook(t *testing.T) { +// providerScenario creates a scenario whose commands can resolve the +// example-provider binary from PATH. The provider echoes options back as env +// variables, which the test service prints with its `env` command — the +// "test-1 | " log prefix anchors the assertions to the container's output. +func providerScenario(t *testing.T, intent string) *Scenario { + t.Helper() provider, err := findExecutable("example-provider") - assert.NilError(t, err) + if err != nil { + t.Fatalf("example-provider binary not available (run make example-provider): %v", err) + } + s := NewScenario(t, intent) + s.Env("PATH=" + fmt.Sprintf("%s%s%s", filepath.Dir(provider), string(os.PathListSeparator), os.Getenv("PATH"))) + return s +} - markerFile := filepath.Join(t.TempDir(), "example-provider-stop-marker") - - path := fmt.Sprintf("%s%s%s", filepath.Dir(provider), string(os.PathListSeparator), os.Getenv("PATH")) - c := NewParallelCLI(t, WithEnv( - "PATH="+path, - "PROVIDER_STOP_MARKER="+markerFile, - )) - const projectName = "provider-stop-hook" - - t.Cleanup(func() { - _ = os.Remove(markerFile) - c.cleanupWithDown(t, projectName) - }) - - res := c.RunDockerComposeCmd(t, "-f", "fixtures/providers/provider-stop.yaml", "--project-name", projectName, "up", "-d") - res.Assert(t, icmd.Success) - - res = c.RunDockerComposeCmd(t, "-f", "fixtures/providers/provider-stop.yaml", "--project-name", projectName, "stop") - res.Assert(t, icmd.Success) - - _, statErr := os.Stat(markerFile) - assert.NilError(t, statErr, "expected example-provider stop subcommand to write marker file %q", markerFile) +func TestProviderStopHook(t *testing.T) { + // The example provider writes a sentinel file at PROVIDER_STOP_MARKER when + // its stop subcommand runs. + marker := filepath.Join(t.TempDir(), "example-provider-stop-marker") + providerScenario(t, "stop must invoke the provider binary's stop subcommand"). + Env("PROVIDER_STOP_MARKER="+marker). + Step("up runs the provider then the service", + ComposeCmd("up", "-d")). + Step("stop triggers the provider's stop subcommand", + ComposeCmd("stop"), + FileExists(marker)) } func TestDependsOnMultipleProviders(t *testing.T) { - provider, err := findExecutable("example-provider") - assert.NilError(t, err) - - path := fmt.Sprintf("%s%s%s", filepath.Dir(provider), string(os.PathListSeparator), os.Getenv("PATH")) - c := NewParallelCLI(t, WithEnv("PATH="+path)) - const projectName = "depends-on-multiple-providers" - t.Cleanup(func() { - c.cleanupWithDown(t, projectName) - }) - - res := c.RunDockerComposeCmd(t, "-f", "fixtures/providers/depends-on-multiple-providers.yaml", "--project-name", projectName, "up") - res.Assert(t, icmd.Success) - env := getEnv(res.Combined()) - assert.Check(t, slices.Contains(env, "PROVIDER1_URL=https://magic.cloud/provider1"), env) - assert.Check(t, slices.Contains(env, "PROVIDER2_URL=https://magic.cloud/provider2"), env) + providerScenario(t, "a service depending on several providers must receive each provider's variables"). + Step("the service sees both providers' URLs", + ComposeCmd("up"), + OutputContains("test-1 | PROVIDER1_URL=https://magic.cloud/provider1"), + OutputContains("test-1 | PROVIDER2_URL=https://magic.cloud/provider2")) } func TestProviderRawSetEnv(t *testing.T) { - provider, err := findExecutable("example-provider") - assert.NilError(t, err) - - path := fmt.Sprintf("%s%s%s", filepath.Dir(provider), string(os.PathListSeparator), os.Getenv("PATH")) - c := NewParallelCLI(t, WithEnv("PATH="+path)) - const projectName = "rawsetenv" - t.Cleanup(func() { - c.cleanupWithDown(t, projectName) - }) - - res := c.RunDockerComposeCmd(t, "-f", "fixtures/providers/rawsetenv.yaml", "--project-name", projectName, "up") - res.Assert(t, icmd.Success) - env := getEnv(res.Combined()) - // setenv: prefixed with service name - assert.Check(t, slices.Contains(env, "SECRETS_URL=https://magic.cloud/secrets"), env) - // rawsetenv: injected as-is without prefix - assert.Check(t, slices.Contains(env, "CLOUD_REGION=us-east-1"), env) + providerScenario(t, "setenv variables must be service-prefixed, rawsetenv injected as-is"). + Step("the service sees both variable flavors", + ComposeCmd("up"), + OutputContains("test-1 | SECRETS_URL=https://magic.cloud/secrets"), + OutputContains("test-1 | CLOUD_REGION=us-east-1")) } func TestProviderRawSetEnvOverridesUserEnv(t *testing.T) { - provider, err := findExecutable("example-provider") - assert.NilError(t, err) - - path := fmt.Sprintf("%s%s%s", filepath.Dir(provider), string(os.PathListSeparator), os.Getenv("PATH")) - c := NewParallelCLI(t, WithEnv("PATH="+path)) - const projectName = "rawsetenv-override" - t.Cleanup(func() { - c.cleanupWithDown(t, projectName) - }) - - res := c.RunDockerComposeCmd(t, "-f", "fixtures/providers/rawsetenv-override.yaml", "--project-name", projectName, "up") - res.Assert(t, icmd.Success) - env := getEnv(res.Combined()) - // rawsetenv overrides a user-defined environment variable - assert.Check(t, slices.Contains(env, "CLOUD_REGION=us-east-1"), env) - assert.Check(t, !slices.Contains(env, "CLOUD_REGION=user-defined-region"), env) - // the override is surfaced to the user rather than happening silently - assert.Check(t, strings.Contains(res.Combined(), "overrides environment variable"), res.Combined()) + providerScenario(t, "rawsetenv must override a user-defined variable, with a visible warning"). + Step("the provider's value wins and the override is surfaced", + ComposeCmd("up"), + OutputContains("test-1 | CLOUD_REGION=us-east-1"), + OutputNotContains("test-1 | CLOUD_REGION=user-defined-region"), + OutputContains("overrides environment variable")) } func TestProviderRawSetEnvOverridesInheritedEnv(t *testing.T) { - provider, err := findExecutable("example-provider") - assert.NilError(t, err) - - path := fmt.Sprintf("%s%s%s", filepath.Dir(provider), string(os.PathListSeparator), os.Getenv("PATH")) - c := NewParallelCLI(t, WithEnv("PATH="+path)) - const projectName = "rawsetenv-inherit" - t.Cleanup(func() { - c.cleanupWithDown(t, projectName) - }) - - res := c.RunDockerComposeCmd(t, "-f", "fixtures/providers/rawsetenv-inherit.yaml", "--project-name", projectName, "up") - res.Assert(t, icmd.Success) - env := getEnv(res.Combined()) - assert.Check(t, slices.Contains(env, "CLOUD_REGION=us-east-1"), env) - assert.Check(t, strings.Contains(res.Combined(), "overrides environment variable"), res.Combined()) + providerScenario(t, "rawsetenv must override an inherited passthrough variable, with a visible warning"). + Step("the provider's value wins over the passthrough", + ComposeCmd("up"), + OutputContains("test-1 | CLOUD_REGION=us-east-1"), + OutputContains("overrides environment variable")) } func TestProviderRawSetEnvOverridesInheritedEnvMapForm(t *testing.T) { - provider, err := findExecutable("example-provider") - assert.NilError(t, err) - - path := fmt.Sprintf("%s%s%s", filepath.Dir(provider), string(os.PathListSeparator), os.Getenv("PATH")) - c := NewParallelCLI(t, WithEnv("PATH="+path)) - const projectName = "rawsetenv-inherit-map" - t.Cleanup(func() { - c.cleanupWithDown(t, projectName) - }) - - res := c.RunDockerComposeCmd(t, "-f", "fixtures/providers/rawsetenv-inherit-map.yaml", "--project-name", projectName, "up") - res.Assert(t, icmd.Success) - env := getEnv(res.Combined()) - assert.Check(t, slices.Contains(env, "CLOUD_REGION=us-east-1"), env) - assert.Check(t, strings.Contains(res.Combined(), "overrides environment variable"), res.Combined()) -} - -func getEnv(out string) []string { - var env []string - scanner := bufio.NewScanner(strings.NewReader(out)) - for scanner.Scan() { - line := scanner.Text() - if strings.HasPrefix(line, "test-1 | ") { - env = append(env, line[10:]) - } - } - slices.Sort(env) - return env + providerScenario(t, "rawsetenv must override a map-form passthrough variable, with a visible warning"). + Step("the provider's value wins over the map-form passthrough", + ComposeCmd("up"), + OutputContains("test-1 | CLOUD_REGION=us-east-1"), + OutputContains("overrides environment variable")) } diff --git a/pkg/e2e/fixtures/providers/depends-on-multiple-providers.yaml b/pkg/e2e/testdata/TestDependsOnMultipleProviders/compose.yaml similarity index 100% rename from pkg/e2e/fixtures/providers/depends-on-multiple-providers.yaml rename to pkg/e2e/testdata/TestDependsOnMultipleProviders/compose.yaml diff --git a/pkg/e2e/fixtures/exec/compose.yaml b/pkg/e2e/testdata/TestExec/compose.yaml similarity index 53% rename from pkg/e2e/fixtures/exec/compose.yaml rename to pkg/e2e/testdata/TestExec/compose.yaml index 8920173bf..a80a897cf 100644 --- a/pkg/e2e/fixtures/exec/compose.yaml +++ b/pkg/e2e/testdata/TestExec/compose.yaml @@ -1,4 +1,4 @@ services: test: image: alpine - command: tail -f /dev/null \ No newline at end of file + command: tail -f /dev/null diff --git a/pkg/e2e/fixtures/providers/rawsetenv.yaml b/pkg/e2e/testdata/TestProviderRawSetEnv/compose.yaml similarity index 100% rename from pkg/e2e/fixtures/providers/rawsetenv.yaml rename to pkg/e2e/testdata/TestProviderRawSetEnv/compose.yaml diff --git a/pkg/e2e/fixtures/providers/rawsetenv-inherit.yaml b/pkg/e2e/testdata/TestProviderRawSetEnvOverridesInheritedEnv/compose.yaml similarity index 100% rename from pkg/e2e/fixtures/providers/rawsetenv-inherit.yaml rename to pkg/e2e/testdata/TestProviderRawSetEnvOverridesInheritedEnv/compose.yaml diff --git a/pkg/e2e/fixtures/providers/rawsetenv-inherit-map.yaml b/pkg/e2e/testdata/TestProviderRawSetEnvOverridesInheritedEnvMapForm/compose.yaml similarity index 100% rename from pkg/e2e/fixtures/providers/rawsetenv-inherit-map.yaml rename to pkg/e2e/testdata/TestProviderRawSetEnvOverridesInheritedEnvMapForm/compose.yaml diff --git a/pkg/e2e/fixtures/providers/rawsetenv-override.yaml b/pkg/e2e/testdata/TestProviderRawSetEnvOverridesUserEnv/compose.yaml similarity index 100% rename from pkg/e2e/fixtures/providers/rawsetenv-override.yaml rename to pkg/e2e/testdata/TestProviderRawSetEnvOverridesUserEnv/compose.yaml diff --git a/pkg/e2e/fixtures/providers/provider-stop.yaml b/pkg/e2e/testdata/TestProviderStopHook/compose.yaml similarity index 100% rename from pkg/e2e/fixtures/providers/provider-stop.yaml rename to pkg/e2e/testdata/TestProviderStopHook/compose.yaml