Use docker-compose.yaml in go testify suite

[rashmy-dev]

Hi,
I have a docker-compose.yaml file with a list of containers that needs to be started before running the e2e tests.
From the documentation here - https://golang.testcontainers.org/features/docker_compose/, it not clear to me how to use the new "ComposeStack".

In my testify suite, I do the following -

type Mye2eTestSuite struct {
	suite.Suite
}
func (suite *Mye2eTestSuite) SetupSuite() {
	compose, err := compose.NewDockerComposeWith(compose.ComposeStackFiles{"../docker-compose.yml"})
	suite.Require().NoError(err, "error starting test containers")
}

func (suite *Mye2eTestSuite) TearDownSuite() {
}

The 'compose' returned from NewDockerComposeWith() is of the type *dockerCompose (which as I understand is not exposed and deprecated).
How do I use the new ComposeStack to start the containers in docker-compose.yaml and then stop the containers in TearDownSuite() function?

Thanks!

[mdelapenya]

Hi, we have this example repo: https://github.com/mdelapenya/testcontainers-go-compose

Could you take a look?

[rashmy-dev]

@mdelapenya
Just checking to see if you are able share the solution to access the created docker containers and bring it down in the testify suite.TearDownSuite() function.

Thanks.

[mdelapenya]

Hey @rashmy-dev I could not find time for it, although I found this article that could help you out: https://www.dolthub.com/blog/2024-02-05-testcontainers-for-go-with-dolt/. Please look at the customer/clone_suite_test.go file described in there.

[rashmy-dev]

Thank you for the link. The blog shows the example of manually creating each container in the setup function and then manually shutting down each container in teardown function. My need is to create containers available in a docker-compose.yaml file and bring down the same.

The key issue is, I can create the containers like this -

type Mye2eTestSuite struct {
	suite.Suite
}
func (suite *Mye2eTestSuite) SetupSuite() {
	compose, err := compose.NewDockerComposeWith(compose.ComposeStackFiles{"../docker-compose.yml"})
	suite.Require().NoError(err, "error starting test containers")
}

func (suite *Mye2eTestSuite) TearDownSuite() {
}

But I cannot store a reference to 'compose' returned from NewDockerComposeWith() and later invoke shutdown in TearDownSuite(). The 'compose' is of type dockerCompose, which is not a exposed type and is deprecated. The documentation asks to use ComposeStack but it is not clear to me how.

Thanks,
Rashmy

[mdelapenya]

Yeah, you're totally right. @stevenh I'll add a note in our project board to enable this, thanks!

[mdelapenya]

Issue created here: #2907, not sure if you would like to work on it