feat(MustConn): Add MustConnectionString on (some) dbs (#2343)

* Add MustConnectionString on (some) dbs * Remove requires * Update mod/sum after removing testify --------- Co-authored-by: bstrausser <[email protected]>
testcontainers · Mar 18, 2024 · 9f1d656 · 9f1d656
1 parent ecbbd62
commit 9f1d656
Show file tree

Hide file tree

Showing 8 changed files with 57 additions and 1 deletion.
diff --git a/modules/mariadb/mariadb.go b/modules/mariadb/mariadb.go
@@ -159,6 +159,16 @@ func RunContainer(ctx context.Context, opts ...testcontainers.ContainerCustomize
 	return &MariaDBContainer{container, username, password, database}, nil
 }
 
+// MustConnectionString panics if the address cannot be determined.
+func (c *MariaDBContainer) MustConnectionString(ctx context.Context, args ...string) string {
+	addr, err := c.ConnectionString(ctx,args...)
+	if err != nil {
+		panic(err)
+	}
+	return addr
+}
+
+
 func (c *MariaDBContainer) ConnectionString(ctx context.Context, args ...string) (string, error) {
 	containerPort, err := c.MappedPort(ctx, "3306/tcp")
 	if err != nil {

diff --git a/modules/mariadb/mariadb_test.go b/modules/mariadb/mariadb_test.go
@@ -36,6 +36,11 @@ func TestMariaDB(t *testing.T) {
 		t.Fatal(err)
 	}
 
+	mustConnectionString := container.MustConnectionString(ctx,"tls=false")
+	if mustConnectionString!=connectionString{
+		t.Errorf("ConnectionString was not equal to MustConnectionString")
+	}
+
 	db, err := sql.Open("mysql", connectionString)
 	if err != nil {
 		t.Fatal(err)

diff --git a/modules/mysql/mysql.go b/modules/mysql/mysql.go
@@ -90,6 +90,15 @@ func RunContainer(ctx context.Context, opts ...testcontainers.ContainerCustomize
 	return &MySQLContainer{container, username, password, database}, nil
 }
 
+// MustConnectionString panics if the address cannot be determined.
+func (c *MySQLContainer) MustConnectionString(ctx context.Context, args ...string) string {
+	addr, err := c.ConnectionString(ctx,args...)
+	if err != nil {
+		panic(err)
+	}
+	return addr
+}
+
 func (c *MySQLContainer) ConnectionString(ctx context.Context, args ...string) (string, error) {
 	containerPort, err := c.MappedPort(ctx, "3306/tcp")
 	if err != nil {

diff --git a/modules/mysql/mysql_test.go b/modules/mysql/mysql_test.go
@@ -34,6 +34,10 @@ func TestMySQL(t *testing.T) {
 	if err != nil {
 		t.Fatal(err)
 	}
+	mustConnectionString := container.MustConnectionString(ctx,"tls=skip-verify")
+	if mustConnectionString!=connectionString{
+		t.Errorf("ConnectionString was not equal to MustConnectionString")
+	}
 
 	db, err := sql.Open("mysql", connectionString)
 	if err != nil {

diff --git a/modules/nats/nats.go b/modules/nats/nats.go
@@ -64,6 +64,14 @@ func RunContainer(ctx context.Context, opts ...testcontainers.ContainerCustomize
 	return &natsContainer, nil
 }
 
+func (c *NATSContainer) MustConnectionString(ctx context.Context, args ...string) string {
+	addr, err := c.ConnectionString(ctx,args...)
+	if err != nil {
+		panic(err)
+	}
+	return addr
+}
+
 // ConnectionString returns a connection string for the NATS container
 func (c *NATSContainer) ConnectionString(ctx context.Context, args ...string) (string, error) {
 	mappedPort, err := c.MappedPort(ctx, defaultClientPort)

diff --git a/modules/nats/nats_test.go b/modules/nats/nats_test.go
@@ -32,6 +32,11 @@ func TestNATS(t *testing.T) {
 	if err != nil {
 		t.Fatalf("failed to get connection string: %s", err)
 	}
+	mustUri := container.MustConnectionString(ctx)
+	if mustUri!=uri{
+		t.Errorf("URI was not equal to MustUri")
+	}
+
 
 	// perform assertions
 	nc, err := nats.Connect(uri)

diff --git a/modules/postgres/postgres.go b/modules/postgres/postgres.go
@@ -26,6 +26,16 @@ type PostgresContainer struct {
 	snapshotName string
 }
 
+
+// MustConnectionString panics if the address cannot be determined.
+func (c *PostgresContainer) MustConnectionString(ctx context.Context, args ...string) string {
+	addr, err := c.ConnectionString(ctx,args...)
+	if err != nil {
+		panic(err)
+	}
+	return addr
+}
+
 // ConnectionString returns the connection string for the postgres container, using the default 5432 port, and
 // obtaining the host and exposed port from the container. It also accepts a variadic list of extra arguments
 // which will be appended to the connection string. The format of the extra arguments is the same as the

diff --git a/modules/postgres/postgres_test.go b/modules/postgres/postgres_test.go
@@ -87,7 +87,12 @@ func TestPostgres(t *testing.T) {
 			connStr, err := container.ConnectionString(ctx, "sslmode=disable", "application_name=test")
 			// }
 			require.NoError(t, err)
-
+
+			mustConnStr := container.MustConnectionString(ctx,"sslmode=disable", "application_name=test")
+			if mustConnStr!=connStr{
+				t.Errorf("ConnectionString was not equal to MustConnectionString")
+			}
+
 			// Ensure connection string is using generic format
 			id, err := container.MappedPort(ctx, "5432/tcp")
 			require.NoError(t, err)