feat(compose): select services via profiles

[ngrash]

What does this PR do?

This PR adds the option to use Compose profiles to enable/disable services based on the profiles defined in the compose file:

func WithProfiles(profiles ...string) ComposeStackOption

The current behavior is not changed unless WithProfiles is used.

Why is it important?

We would like to use our existing Compose files with testcontainers-go/modules/compose to set up test environments locally and in our pipelines.

However, our workflow relies on Compose profiles, which currently makes the use of testcontainers-go/modules/compose impossible, as only services without profiles are enabled by default.

Our workaround is to set up the test environment via the Compose CLI, but we think this could be well automated if testcontainers-go supported Compose profiles.

Related issues

• Relates Add support for --profiles to DockerComposeContainer testcontainers-java#5041 where as a workaround, withOptions("--profiles foo") is suggested. This is not possible with testcontainers-go as it relies directly on the Go module and does not wrap the CLI.

How to test this PR

To only run the tests for this individual feature, you can run go test -v -run TestDockerComposeAPIWithProfiles in modules/compose.

In addition to the unit tests, reviewers can try their own Compose files with profiles:

func ExampleWithProfiles() error {
    ctx := context.Background()

    filesOpt := compose.WithStackFiles("compose.yaml")
    profilesOpt := compose.WithProfiles("test", "dev")
    stack, err := compose.NewDockerComposeWith(filesOpt, profilesOpt)
    if err != nil {
       return fmt.Errorf("new docker compose: %w", err)
    }
    fmt.Println("stack up")
    if err := stack.Up(ctx); err != nil {
       return fmt.Errorf("stack up: %w", err)
    }
    fmt.Println("stack down")
    if err := stack.Down(ctx); err != nil {
       return fmt.Errorf("stack down: %w", err)
    }
    return nil
}

Follow-ups

From my perspective, this feature is self-contained.

If this gets merged and released, we will adapt our workflow to use testcontainers-go/modules/compose for setting up test environments. This might generate more insights and follow-ups.

[netlify]

✅ Deploy Preview for testcontainers-go ready!

Name	Link
🔨 Latest commit	debea8e
🔍 Latest deploy log	https://app.netlify.com/sites/testcontainers-go/deploys/66d5ba135d518200082fcc99
😎 Deploy Preview	https://deploy-preview-2758--testcontainers-go.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[mdelapenya]

LGTM, thanks for adding this! The changes are easy to review and the test is always welcomed.