chore: export DockerCompose type in the compose package

Author: youshibin

modules/compose/compose.go

@@ -122,11 +122,11 @@ func WithProfiles(profiles ...string) ComposeStackOption {
 	return ComposeProfiles(profiles)
 }
 
-func NewDockerCompose(filePaths ...string) (*dockerCompose, error) {
+func NewDockerCompose(filePaths ...string) (*DockerCompose, error) {
 	return NewDockerComposeWith(WithStackFiles(filePaths...))
 }
 
-func NewDockerComposeWith(opts ...ComposeStackOption) (*dockerCompose, error) {
+func NewDockerComposeWith(opts ...ComposeStackOption) (*DockerCompose, error) {
 	composeOptions := composeStackOptions{
 		Identifier:     uuid.New().String(),
 		temporaryPaths: make(map[string]bool),
@@ -161,7 +161,7 @@ func NewDockerComposeWith(opts ...ComposeStackOption) (*dockerCompose, error) {
 	dockerClient := dockerCli.Client()
 	provider.SetClient(dockerClient)
 
-	composeAPI := &dockerCompose{
+	composeAPI := &DockerCompose{
 		name:             composeOptions.Identifier,
 		configs:          composeOptions.Paths,
 		temporaryConfigs: composeOptions.temporaryPaths,

modules/compose/compose_api.go

@@ -179,7 +179,7 @@ const (
 	RemoveImagesLocal
 )
 
-type dockerCompose struct {
+type DockerCompose struct {
 	// used to synchronize operations
 	lock sync.RWMutex
 
@@ -234,21 +234,21 @@ type dockerCompose struct {
 	provider *testcontainers.DockerProvider
 }
 
-func (d *dockerCompose) ServiceContainer(ctx context.Context, svcName string) (*testcontainers.DockerContainer, error) {
+func (d *DockerCompose) ServiceContainer(ctx context.Context, svcName string) (*testcontainers.DockerContainer, error) {
 	d.lock.Lock()
 	defer d.lock.Unlock()
 
 	return d.lookupContainer(ctx, svcName)
 }
 
-func (d *dockerCompose) Services() []string {
+func (d *DockerCompose) Services() []string {
 	d.lock.Lock()
 	defer d.lock.Unlock()
 
 	return d.project.ServiceNames()
 }
 
-func (d *dockerCompose) Down(ctx context.Context, opts ...StackDownOption) error {
+func (d *DockerCompose) Down(ctx context.Context, opts ...StackDownOption) error {
 	d.lock.Lock()
 	defer d.lock.Unlock()
 
@@ -270,7 +270,7 @@ func (d *dockerCompose) Down(ctx context.Context, opts ...StackDownOption) error
 	return d.composeService.Down(ctx, d.name, options.DownOptions)
 }
 
-func (d *dockerCompose) Up(ctx context.Context, opts ...StackUpOption) (err error) {
+func (d *DockerCompose) Up(ctx context.Context, opts ...StackUpOption) (err error) {
 	d.lock.Lock()
 	defer d.lock.Unlock()
 
@@ -435,23 +435,23 @@ func (d *dockerCompose) Up(ctx context.Context, opts ...StackUpOption) (err erro
 	return nil
 }
 
-func (d *dockerCompose) WaitForService(s string, strategy wait.Strategy) ComposeStack {
+func (d *DockerCompose) WaitForService(s string, strategy wait.Strategy) ComposeStack {
 	d.lock.Lock()
 	defer d.lock.Unlock()
 
 	d.waitStrategies[s] = strategy
 	return d
 }
 
-func (d *dockerCompose) WithEnv(m map[string]string) ComposeStack {
+func (d *DockerCompose) WithEnv(m map[string]string) ComposeStack {
 	d.lock.Lock()
 	defer d.lock.Unlock()
 
 	d.projectOptions = append(d.projectOptions, withEnv(m))
 	return d
 }
 
-func (d *dockerCompose) WithOsEnv() ComposeStack {
+func (d *DockerCompose) WithOsEnv() ComposeStack {
 	d.lock.Lock()
 	defer d.lock.Unlock()
 
@@ -460,7 +460,7 @@ func (d *dockerCompose) WithOsEnv() ComposeStack {
 }
 
 // cachedContainer returns the cached container for svcName or nil if it doesn't exist.
-func (d *dockerCompose) cachedContainer(svcName string) *testcontainers.DockerContainer {
+func (d *DockerCompose) cachedContainer(svcName string) *testcontainers.DockerContainer {
 	d.containersLock.Lock()
 	defer d.containersLock.Unlock()
 
@@ -470,7 +470,7 @@ func (d *dockerCompose) cachedContainer(svcName string) *testcontainers.DockerCo
 // lookupContainer is used to retrieve the container instance from the cache or the Docker API.
 //
 // Safe for concurrent calls.
-func (d *dockerCompose) lookupContainer(ctx context.Context, svcName string) (*testcontainers.DockerContainer, error) {
+func (d *DockerCompose) lookupContainer(ctx context.Context, svcName string) (*testcontainers.DockerContainer, error) {
 	if c := d.cachedContainer(svcName); c != nil {
 		return c, nil
 	}
@@ -505,7 +505,7 @@ func (d *dockerCompose) lookupContainer(ctx context.Context, svcName string) (*t
 // lookupNetworks is used to retrieve the networks that are part of the compose stack.
 //
 // Safe for concurrent calls.
-func (d *dockerCompose) lookupNetworks(ctx context.Context) error {
+func (d *DockerCompose) lookupNetworks(ctx context.Context) error {
 	networks, err := d.dockerClient.NetworkList(ctx, dockernetwork.ListOptions{
 		Filters: filters.NewArgs(
 			filters.Arg("label", fmt.Sprintf("%s=%s", api.ProjectLabel, d.name)),
@@ -528,7 +528,7 @@ func (d *dockerCompose) lookupNetworks(ctx context.Context) error {
 	return nil
 }
 
-func (d *dockerCompose) compileProject(ctx context.Context) (*types.Project, error) {
+func (d *DockerCompose) compileProject(ctx context.Context) (*types.Project, error) {
 	const nameAndDefaultConfigPath = 2
 	projectOptions := make([]cli.ProjectOptionsFn, len(d.projectOptions), len(d.projectOptions)+nameAndDefaultConfigPath)
 

modules/compose/compose_api_test.go

@@ -148,7 +148,7 @@ func TestDockerComposeAPIWithProfiles(t *testing.T) {
 			t.Cleanup(cancel)
 
 			for _, service := range test.wantServices {
-				compose = compose.WaitForService(service, wait.NewHTTPStrategy("/").WithPort("80/tcp").WithStartupTimeout(10*time.Second)).(*dockerCompose)
+				compose = compose.WaitForService(service, wait.NewHTTPStrategy("/").WithPort("80/tcp").WithStartupTimeout(10*time.Second)).(*DockerCompose)
 			}
 			err = compose.Up(ctx, Wait(true))
 			cleanup(t, compose)
@@ -694,7 +694,7 @@ func testNameHash(name string) StackIdentifier {
 }
 
 // cleanup is a helper function that schedules the compose stack to be stopped when the test ends.
-func cleanup(t *testing.T, compose *dockerCompose) {
+func cleanup(t *testing.T, compose *DockerCompose) {
 	t.Helper()
 	t.Cleanup(func() {
 		require.NoError(t, compose.Down(