🥒 Cucumber PoC 🥒

[laurazard]

What I did:

I got a bit curious from what we discussed regarding a PoC using Cucumber, so I started playing around with it! It needs a ton of refactoring/reorganizing (it's currently really ugly), and a good look regarding the testing utils and parallelization.

So far, steps implemented are:

• (Given) a compose file [xxx]: sets the compose file to get piped into the compose command
• (When) I run "compose [command]": runs the specified compose command with the given fixture piped in
• (Then) output contains [xxx]: checks that the output of the last command contains [xxx]
• (...) exit code is [i]: checks that the exit code of the last command is [i]
• (...) [service] service is [status]: runs compose ps, checks that the specific service is the desired status

This allows us to define tests such as:

Feature: Simple service up

Background:
    Given a compose file
        """
        services:
          simple:
            image: alpine
            command: top
        """

Scenario: compose up
    When I run "compose up -d"
    Then the output contains "simple-1  Started"
    And service "simple" is "running"

Run the cucumber feature tests with go test -v -run ^TestCucumberFeatures$ github.com/docker/compose/v2/pkg/e2e/cucumber

Output should look something like:

Signed-off-by: Laura Brehm [email protected]

(not mandatory) A picture of a cute animal, if possible in relation with what you did

[laurazard]

For comparison:

	t.Run("abort-on-container-exit", func(t *testing.T) {
		res := c.RunDockerComposeCmdNoCheck(t, "-f", "./fixtures/cascade-stop-test/compose.yaml", "--project-name", projectName, "up", "--abort-on-container-exit")
		res.Assert(t, icmd.Expected{ExitCode: 1, Out: `should_fail-1 exited with code 1`})
		res.Assert(t, icmd.Expected{ExitCode: 1, Out: `Aborting on container exit...`})
	})

	t.Run("exit-code-from", func(t *testing.T) {
		res := c.RunDockerComposeCmdNoCheck(t, "-f", "./fixtures/cascade-stop-test/compose.yaml", "--project-name", projectName, "up", "--exit-code-from=sleep")
		res.Assert(t, icmd.Expected{ExitCode: 137, Out: `should_fail-1 exited with code 1`})
		res.Assert(t, icmd.Expected{ExitCode: 137, Out: `Aborting on container exit...`})
	})

	t.Run("exit-code-from unknown", func(t *testing.T) {
		res := c.RunDockerComposeCmdNoCheck(t, "-f", "./fixtures/cascade-stop-test/compose.yaml", "--project-name", projectName, "up", "--exit-code-from=unknown")
		res.Assert(t, icmd.Expected{ExitCode: 1, Err: `no such service: unknown`})
	})

turns into:

Feature: Stop

Background:
    Given a compose file
        """
        services:
          should_fail:
            image: alpine
            command: ls /does_not_exist
          sleep: # will be killed
            image: alpine
            command: ping localhost
        """

Scenario: Cascade stop
    When I run "compose up --abort-on-container-exit"
    Then the output contains "should_fail-1 exited with code 1"
    And the output contains "Aborting on container exit..."
    And the exit code is 1

Scenario: Exit code from
    When I run "compose up --exit-code-from sleep"
    Then the output contains "should_fail-1 exited with code 1"
    And the output contains "Aborting on container exit..."
    And the exit code is 137

Scenario: Exit code from unknown service
    When I run "compose up --exit-code-from unknown"
    Then the output contains "no such service: unknown"
    And the exit code is 1

[laurazard]

Thanks! :)

I removed cascade_stop_test.go which was replaced by stop.feature and compose_down_test.go which was replaced by down.feature, and their corresponding fixtures, so the comparison is clearer in the PR.

[laurazard]

From here, moved the new tests into a new e2e module to separate out test dependencies.

[laurazard]

The CI isn't triggering 😢 Cursory google search seems to suggest I close and reopen the PR, so I'm going to try that.

[laurazard]

🥳