Merge branch 'main' into feature/add-redpanda-wasm-transform

* main: feat(modules.clickhouse): Add zookeeper for clickhouse clusterization (testcontainers#1995) redpanda: allow using SASL and TLS together (testcontainers#2140) chore: do not panic in testable examples (testcontainers#2193) fix: all mounts should contain the testcontainers labels (testcontainers#2191) [redpanda] sasl test for wrong mechanism (testcontainers#2048) fix: deprecate BindMounts correctly (testcontainers#2190)
gene-redpanda · Feb 2, 2024 · 6495231 · 6495231
2 parents ee5e2c5 + bc67dc3
commit 6495231
Show file tree

Hide file tree

Showing 50 changed files with 648 additions and 280 deletions.
diff --git a/container_test.go b/container_test.go
@@ -7,6 +7,7 @@ import (
 	"errors"
 	"fmt"
 	"io"
+	"log"
 	"strings"
 	"testing"
 	"time"
@@ -525,13 +526,13 @@ func ExampleGenericContainer_withSubstitutors() {
 	})
 	// }
 	if err != nil {
-		panic(err)
+		log.Fatalf("could not start container: %v", err)
 	}
 
 	defer func() {
 		err := container.Terminate(ctx)
 		if err != nil {
-			panic(err)
+			log.Fatalf("could not terminate container: %v", err)
 		}
 	}()
 

diff --git a/docker_mounts.go b/docker_mounts.go
@@ -3,6 +3,7 @@ package testcontainers
 import "github.com/docker/docker/api/types/mount"
 
 var mountTypeMapping = map[MountType]mount.Type{
+	MountTypeBind:   mount.TypeBind, // Deprecated, it will be removed in a future release
 	MountTypeVolume: mount.TypeVolume,
 	MountTypeTmpfs:  mount.TypeTmpfs,
 	MountTypePipe:   mount.TypeNamedPipe,
@@ -100,6 +101,9 @@ func mapToDockerMounts(containerMounts ContainerMounts) []mount.Mount {
 			Source:   m.Source.Source(),
 			ReadOnly: m.ReadOnly,
 			Target:   m.Target.Target(),
+			VolumeOptions: &mount.VolumeOptions{
+				Labels: GenericLabels(),
+			},
 		}
 
 		switch typedMounter := m.Source.(type) {

diff --git a/docker_test.go b/docker_test.go
@@ -987,7 +987,7 @@ func ExampleDockerProvider_CreateContainer() {
 
 	state, err := nginxC.State(ctx)
 	if err != nil {
-		panic(err)
+		log.Fatalf("failed to get container state: %s", err) // nolint:gocritic
 	}
 
 	fmt.Println(state.Running)
@@ -1019,7 +1019,7 @@ func ExampleContainer_Host() {
 
 	state, err := nginxC.State(ctx)
 	if err != nil {
-		panic(err)
+		log.Fatalf("failed to get container state: %s", err) // nolint:gocritic
 	}
 
 	fmt.Println(state.Running)
@@ -1047,7 +1047,7 @@ func ExampleContainer_Start() {
 
 	state, err := nginxC.State(ctx)
 	if err != nil {
-		panic(err)
+		log.Fatalf("failed to get container state: %s", err) // nolint:gocritic
 	}
 
 	fmt.Println(state.Running)
@@ -1075,7 +1075,7 @@ func ExampleContainer_Stop() {
 	timeout := 10 * time.Second
 	err := nginxC.Stop(ctx, &timeout)
 	if err != nil {
-		panic(err)
+		log.Fatalf("failed to stop container: %s", err) // nolint:gocritic
 	}
 
 	fmt.Println("Container has been stopped")
@@ -1109,7 +1109,7 @@ func ExampleContainer_MappedPort() {
 
 	state, err := nginxC.State(ctx)
 	if err != nil {
-		panic(err)
+		log.Fatalf("failed to get container state: %s", err) // nolint:gocritic
 	}
 
 	fmt.Println(state.Running)

diff --git a/docs/features/docker_compose.md b/docs/features/docker_compose.md
@@ -32,22 +32,22 @@ import (
 	"context"
 	"testing"
 
-	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
 	tc "github.com/testcontainers/testcontainers-go/modules/compose"
 )
 
 func TestSomething(t *testing.T) {
 	compose, err := tc.NewDockerCompose("testdata/docker-compose.yml")
-	assert.NoError(t, err, "NewDockerComposeAPI()")
+	require.NoError(t, err, "NewDockerComposeAPI()")
 
 	t.Cleanup(func() {
-		assert.NoError(t, compose.Down(context.Background(), tc.RemoveOrphans(true), tc.RemoveImagesLocal), "compose.Down()")
+		require.NoError(t, compose.Down(context.Background(), tc.RemoveOrphans(true), tc.RemoveImagesLocal), "compose.Down()")
 	})
 
 	ctx, cancel := context.WithCancel(context.Background())
 	t.Cleanup(cancel)
 
-	assert.NoError(t, compose.Up(ctx, tc.Wait(true)), "compose.Up()")
+	require.NoError(t, compose.Up(ctx, tc.Wait(true)), "compose.Up()")
 
 	// do some testing here
 }
@@ -62,23 +62,23 @@ import (
 	"context"
 	"testing"
 
-	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
 	tc "github.com/testcontainers/testcontainers-go/modules/compose"
 )
 
 func TestSomethingElse(t *testing.T) {
 	identifier := tc.StackIdentifier("some_ident")
 	compose, err := tc.NewDockerComposeWith(tc.WithStackFiles("./testdata/docker-compose-simple.yml"), identifier)
-	assert.NoError(t, err, "NewDockerComposeAPIWith()")
+	require.NoError(t, err, "NewDockerComposeAPIWith()")
 
 	t.Cleanup(func() {
-		assert.NoError(t, compose.Down(context.Background(), tc.RemoveOrphans(true), tc.RemoveImagesLocal), "compose.Down()")
+		require.NoError(t, compose.Down(context.Background(), tc.RemoveOrphans(true), tc.RemoveImagesLocal), "compose.Down()")
 	})
 
 	ctx, cancel := context.WithCancel(context.Background())
 	t.Cleanup(cancel)
 
-	assert.NoError(t, compose.Up(ctx, tc.Wait(true)), "compose.Up()")
+	require.NoError(t, compose.Up(ctx, tc.Wait(true)), "compose.Up()")
 
 	// do some testing here
 }
@@ -110,18 +110,18 @@ import (
 	"testing"
 	"time"
 
-	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
 	tc "github.com/testcontainers/testcontainers-go/modules/compose"
 	"github.com/testcontainers/testcontainers-go/wait"
 )
 
 func TestSomethingWithWaiting(t *testing.T) {
 	identifier := tc.StackIdentifier("some_ident")
 	compose, err := tc.NewDockerComposeWith(tc.WithStackFiles("./testdata/docker-compose-simple.yml"), identifier)
-	assert.NoError(t, err, "NewDockerComposeAPIWith()")
+	require.NoError(t, err, "NewDockerComposeAPIWith()")
 
 	t.Cleanup(func() {
-		assert.NoError(t, compose.Down(context.Background(), tc.RemoveOrphans(true), tc.RemoveImagesLocal), "compose.Down()")
+		require.NoError(t, compose.Down(context.Background(), tc.RemoveOrphans(true), tc.RemoveImagesLocal), "compose.Down()")
 	})
 
 	ctx, cancel := context.WithCancel(context.Background())
@@ -131,7 +131,7 @@ func TestSomethingWithWaiting(t *testing.T) {
 		WaitForService("nginx", wait.NewHTTPStrategy("/").WithPort("80/tcp").WithStartupTimeout(10*time.Second)).
 		Up(ctx, tc.Wait(true))
 
-	assert.NoError(t, err, "compose.Up()")
+	require.NoError(t, err, "compose.Up()")
 
 	// do some testing here
 }

diff --git a/docs/modules/clickhouse.md b/docs/modules/clickhouse.md
@@ -73,6 +73,17 @@ initialization before starting the service.
 [Init script content](../../modules/clickhouse/testdata/init-db.sh)
 <!--/codeinclude-->
 
+#### Zookeeper
+
+Clusterized ClickHouse requires to start Zookeeper and pass link to it via `config.xml`.
+
+<!--codeinclude-->
+[Include zookeeper](../../modules/clickhouse/clickhouse_test.go) inside_block:withZookeeper
+<!--/codeinclude-->
+
+!!!warning
+    The `WithZookeeper` option will `panic` if it's not possible to create the Zookeeper config file.
+
 #### Custom configuration
 
 If you need to set a custom configuration, the module provides the `WithConfigFile` option to pass the path to a custom configuration file in XML format.

diff --git a/docs/quickstart.md b/docs/quickstart.md
@@ -37,11 +37,11 @@ func TestWithRedis(t *testing.T) {
 		Started:          true,
 	})
 	if err != nil {
-		panic(err)
+		log.Fatalf("Could not start redis: %s", err)
 	}
 	defer func() {
 		if err := redisC.Terminate(ctx); err != nil {
-			panic(err)
+			log.Fatalf("Could not stop redis: %s", err)
 		}
 	}()
 }

diff --git a/from_dockerfile_test.go b/from_dockerfile_test.go
@@ -4,6 +4,7 @@ import (
 	"context"
 	"fmt"
 	"io"
+	"log"
 	"strings"
 	"testing"
 	"time"
@@ -175,17 +176,17 @@ func ExampleGenericContainer_buildFromDockerfile() {
 	})
 	// }
 	if err != nil {
-		panic(err)
+		log.Fatalf("failed to start container: %v", err)
 	}
 
 	r, err := c.Logs(ctx)
 	if err != nil {
-		panic(err)
+		log.Fatalf("failed to get logs: %v", err)
 	}
 
 	logs, err := io.ReadAll(r)
 	if err != nil {
-		panic(err)
+		log.Fatalf("failed to read logs: %v", err)
 	}
 
 	fmt.Println(string(logs))

diff --git a/modulegen/_template/examples_test.go.tmpl b/modulegen/_template/examples_test.go.tmpl
@@ -14,20 +14,20 @@ func Example{{ $entrypoint }}() {
 
 	{{ $lower }}Container, err := {{ $lower }}.{{ $entrypoint }}(ctx, testcontainers.WithImage("{{ $image }}"))
 	if err != nil {
-		panic(err)
+		log.Fatalf("failed to start container: %s", err)
 	}
 
 	// Clean up the container
 	defer func() {
 		if err := {{ $lower }}Container.Terminate(ctx); err != nil {
-			panic(err)
+			log.Fatalf("failed to terminate container: %s", err)
 		}
 	}()
 	// }
 
 	state, err := {{ $lower }}Container.State(ctx)
 	if err != nil {
-		panic(err)
+		log.Fatalf("failed to get container state: %s", err)
 	}
 
 	fmt.Println(state.Running)

diff --git a/modules/artemis/examples_test.go b/modules/artemis/examples_test.go
@@ -3,6 +3,7 @@ package artemis_test
 import (
 	"context"
 	"fmt"
+	"log"
 
 	"github.com/go-stomp/stomp/v3"
 
@@ -19,18 +20,18 @@ func ExampleRunContainer() {
 		artemis.WithCredentials("test", "test"),
 	)
 	if err != nil {
-		panic(err)
+		log.Fatalf("failed to start container: %s", err)
 	}
 	defer func() {
 		if err := artemisContainer.Terminate(ctx); err != nil {
-			panic(err)
+			log.Fatalf("failed to terminate container: %s", err)
 		}
 	}()
 	// }
 
 	state, err := artemisContainer.State(ctx)
 	if err != nil {
-		panic(err)
+		log.Fatalf("failed to get container state: %s", err) // nolint:gocritic
 	}
 
 	fmt.Println(state.Running)
@@ -39,7 +40,7 @@ func ExampleRunContainer() {
 	// Get broker endpoint.
 	host, err := artemisContainer.BrokerEndpoint(ctx)
 	if err != nil {
-		panic(err)
+		log.Fatalf("failed to get broker endpoint: %s", err)
 	}
 
 	// containerUser {
@@ -52,11 +53,11 @@ func ExampleRunContainer() {
 	// Connect to Artemis via STOMP.
 	conn, err := stomp.Dial("tcp", host, stomp.ConnOpt.Login(user, pass))
 	if err != nil {
-		panic(err)
+		log.Fatalf("failed to connect to Artemis: %s", err)
 	}
 	defer func() {
 		if err := conn.Disconnect(); err != nil {
-			panic(err)
+			log.Fatalf("failed to disconnect from Artemis: %s", err)
 		}
 	}()
 	// }

diff --git a/modules/cassandra/examples_test.go b/modules/cassandra/examples_test.go
@@ -3,6 +3,7 @@ package cassandra_test
 import (
 	"context"
 	"fmt"
+	"log"
 	"path/filepath"
 
 	"github.com/gocql/gocql"
@@ -21,40 +22,40 @@ func ExampleRunContainer() {
 		cassandra.WithConfigFile(filepath.Join("testdata", "config.yaml")),
 	)
 	if err != nil {
-		panic(err)
+		log.Fatalf("failed to start container: %s", err)
 	}
 
 	// Clean up the container
 	defer func() {
 		if err := cassandraContainer.Terminate(ctx); err != nil {
-			panic(err)
+			log.Fatalf("failed to terminate container: %s", err)
 		}
 	}()
 	// }
 
 	state, err := cassandraContainer.State(ctx)
 	if err != nil {
-		panic(err)
+		log.Fatalf("failed to get container state: %s", err) // nolint:gocritic
 	}
 
 	fmt.Println(state.Running)
 
 	connectionHost, err := cassandraContainer.ConnectionHost(ctx)
 	if err != nil {
-		panic(err)
+		log.Fatalf("failed to get connection host: %s", err)
 	}
 
 	cluster := gocql.NewCluster(connectionHost)
 	session, err := cluster.CreateSession()
 	if err != nil {
-		panic(err)
+		log.Fatalf("failed to create session: %s", err)
 	}
 	defer session.Close()
 
 	var version string
 	err = session.Query("SELECT release_version FROM system.local").Scan(&version)
 	if err != nil {
-		panic(err)
+		log.Fatalf("failed to query: %s", err)
 	}
 
 	fmt.Println(version)