Update to org.testcontainers:jdbc

Apply deprecation of ambiguous constructors

Author: mrotteveel

CHANGES.md

@@ -1,13 +1,21 @@
 Version History
 ===============
 
+1.0.5
+-----
+- Updated org.testcontainers:jdbc to 1.15.1
+- Deprecated no-arg constructor of `FirebirdContainer` (see also <https://github.com/testcontainers/testcontainers-java/pull/2839>) \
+  It is recommended to switch to using an explicit image name and version
+- Added constructor `FirebirdContainer(DockerImageName)`. \
+  Use with `DockerImageName.parse(FirebirdContainer.IMAGE).withTag("3.0.7")` to get an explicit version.
+
 1.0.4
 -----
 
 - Update org.testcontainers:jdbc to 1.14.3
-- Move static config in modules to constructor (see also https://github.com/testcontainers/testcontainers-java/pull/2473)
-- Add ContainerState#getHost as a replacement for getContainerIpAddress (see also https://github.com/testcontainers/testcontainers-java/pull/2742)
-- Added additional url params in JdbcDatabaseContainer (see also https://github.com/testcontainers/testcontainers-java/issues/1802)
+- Move static config in modules to constructor (see also <https://github.com/testcontainers/testcontainers-java/pull/2473>)
+- Add `ContainerState#getHost` as a replacement for `getContainerIpAddress` (see also <https://github.com/testcontainers/testcontainers-java/pull/2742>)
+- Added additional url params in `JdbcDatabaseContainer` (see also <https://github.com/testcontainers/testcontainers-java/issues/1802>)
 - For compatibility with Jaybird 4, when legacy client auth is enabled and `authPlugins` URL param has not been explicitly added, add URL param `authPlugins` with value `Srp256,Srp,Legacy_auth`
 - Updated default image version to Firebird 3.0.5.
 

README.md

@@ -58,10 +58,10 @@ The container defines several `withXXX` methods for configuration.
 Important standard options are:
 
 - `withUsername(String)` - Sets the username to create (defaults to `test`); if
-other than `sysdba` (case insensitive), sets docker environment variable
+other than `sysdba` (case-insensitive), sets docker environment variable
 `FIREBIRD_USER`
 - `withPassword(String)` - Sets the password of the user (defaults to `test`);
-if `withUsername` is other than `sysdba` (case insensitive), sets the docker
+if `withUsername` is other than `sysdba` (case-insensitive), sets the docker
 environment variable `FIREBIRD_PASSWORD`, otherwise `ISC_PASSWORD`
 - `withDatabaseName(String)` - Sets the database name (defaults to `test`);
 sets docker environment variable `FIREBIRD_DATABASE`
@@ -78,40 +78,46 @@ this property is not explicitly set through `withUrlParam`
 - `withTimeZone(String)` - Sets the time zone (defaults to JVM default time
 zone); sets docker environment variable `TZ` to the specified value
 - `withSysdbaPassword(String)` - Sets the SYSDBA password, but if 
-`withUsername(String)` is set to `sysdba` (case insensitive), this property is
+`withUsername(String)` is set to `sysdba` (case-insensitive), this property is
 ignored and the value of `withPassword` is used instead; sets docker
 environment variable `ISC_PASSWORD` to the specified value
 
 Example of use:
 
 ```java
+import org.firebirdsql.testcontainers.FirebirdContainer;
+import org.testcontainers.utility.DockerImageName;
+
 /**
  * Simple test demonstrating use of {@code @Rule}.
  */
 public class ExampleRuleTest {
 
-    @Rule
-    public final FirebirdContainer container = new FirebirdContainer()
-            .withUsername("testuser")
-            .withPassword("testpassword");
-
-    @Test
-    public void canConnectToContainer() throws Exception {
-        try (Connection connection = DriverManager
-                .getConnection(container.getJdbcUrl(), container.getUsername(), container.getPassword());
-             Statement stmt = connection.createStatement();
-             ResultSet rs = stmt.executeQuery("select CURRENT_USER from RDB$DATABASE")) {
-            assertTrue("has row", rs.next());
-            assertEquals("user name", "TESTUSER", rs.getString(1));
-        }
+  private static final DockerImageName IMAGE = 
+          DockerImageName.parse(FirebirdContainer.IMAGE).withTag("3.0.7");
+
+  @Rule
+  public final FirebirdContainer<?> container = new FirebirdContainer<?>(IMAGE)
+          .withUsername("testuser")
+          .withPassword("testpassword");
+
+  @Test
+  public void canConnectToContainer() throws Exception {
+    try (Connection connection = DriverManager
+            .getConnection(container.getJdbcUrl(), container.getUsername(), container.getPassword());
+         Statement stmt = connection.createStatement();
+         ResultSet rs = stmt.executeQuery("select CURRENT_USER from RDB$DATABASE")) {
+      assertTrue("has row", rs.next());
+      assertEquals("user name", "TESTUSER", rs.getString(1));
     }
+  }
 }
 ```
 
 ### Testcontainers URL
 
-The testcontainers URL defines the container and connects to it. As long as there
-are active connections, the container will stay up.
+The testcontainers URL defines the container and connects to it. As long as 
+there are active connections, the container will stay up.
 
 For Firebird the URL format is:
 
@@ -120,7 +126,8 @@ For Firebird the URL format is:
 
 Where:
 
-- `<image-tag>` (_optional_) is the tag of the docker image to use
+- `<image-tag>` (_optional, but recommended_) is the tag of the docker image to
+  use, otherwise the default is used (which might change between versions)
 - `<databasename>` (_optional_) is the name of the database (defaults to `test`)
 - `<property>` is a connection property (Jaybird properties **and** testcontainers properties are possible) \
   Of special note are the properties:

pom.xml

@@ -4,7 +4,7 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>org.firebirdsql</groupId>
     <artifactId>firebird-testcontainers-java</artifactId>
-    <version>1.0.5-SNAPSHOT</version>
+    <version>1.1.0-SNAPSHOT</version>
     <packaging>jar</packaging>
 
     <name>firebird-testcontainers-java</name>
@@ -37,9 +37,9 @@
         <maven.compiler.source>1.8</maven.compiler.source>
         <maven.compiler.target>1.8</maven.compiler.target>
 
-        <testcontainers.version>1.14.3</testcontainers.version>
+        <testcontainers.version>1.15.1</testcontainers.version>
         <lombok.version>1.18.12</lombok.version>
-        <jaybird.version>4.0.0.java8</jaybird.version>
+        <jaybird.version>4.0.2.java8</jaybird.version>
     </properties>
 
     <dependencies>

src/main/java/org/firebirdsql/testcontainers/FirebirdContainer.java

@@ -14,6 +14,7 @@ public class FirebirdContainer<SELF extends FirebirdContainer<SELF>> extends Jdb
     public static final String NAME = "firebird";
     public static final String ALTERNATE_NAME = "firebirdsql";
     public static final String IMAGE = "jacobalberty/firebird";
+    static final DockerImageName DEFAULT_IMAGE_NAME = DockerImageName.parse(IMAGE);
     public static final String DEFAULT_TAG = "3.0.5";
 
     public static final Integer FIREBIRD_PORT = 3050;
@@ -29,12 +30,35 @@ public class FirebirdContainer<SELF extends FirebirdContainer<SELF>> extends Jdb
     private boolean enableWireCrypt;
     private String sysdbaPassword;
 
+    /**
+     * Creates a Firebird container with the default image ({@link #IMAGE} and {@link #DEFAULT_TAG}).
+     *
+     * @deprecated Use explicit image using {@link #FirebirdContainer(DockerImageName)}
+     */
+    @Deprecated
     public FirebirdContainer() {
-        this(IMAGE + ":" + DEFAULT_TAG);
+        this(DEFAULT_IMAGE_NAME.withTag(DEFAULT_TAG));
     }
 
+    /**
+     * Creates a Firebird container with an image name (e.g. {@code "jacobalberty/firebird:3.0.7"}.
+     *
+     * @param dockerImageName Image name
+     */
     public FirebirdContainer(String dockerImageName) {
+        this(DockerImageName.parse(dockerImageName));
+    }
+
+    /**
+     * Creates a Firebird container with a parsed image name.
+     *
+     * @param dockerImageName Parse image name
+     */
+    public FirebirdContainer(DockerImageName dockerImageName) {
         super(dockerImageName);
+
+        dockerImageName.assertCompatibleWith(DEFAULT_IMAGE_NAME);
+
         addExposedPort(FIREBIRD_PORT);
     }
 

src/main/java/org/firebirdsql/testcontainers/FirebirdContainerProvider.java

@@ -3,6 +3,7 @@
 import org.testcontainers.containers.JdbcDatabaseContainer;
 import org.testcontainers.containers.JdbcDatabaseContainerProvider;
 import org.testcontainers.jdbc.ConnectionUrl;
+import org.testcontainers.utility.DockerImageName;
 
 public class FirebirdContainerProvider extends JdbcDatabaseContainerProvider {
 
@@ -21,7 +22,7 @@ public JdbcDatabaseContainer newInstance() {
 
     @Override
     public JdbcDatabaseContainer newInstance(String tag) {
-        return new FirebirdContainer(FirebirdContainer.IMAGE + ":" + tag);
+        return new FirebirdContainer(DockerImageName.parse(FirebirdContainer.IMAGE).withTag(tag));
     }
 
     @Override

src/test/java/org/firebirdsql/testcontainers/FirebirdContainerTest.java

@@ -7,7 +7,9 @@
 import java.sql.*;
 
 import static org.firebirdsql.testcontainers.FirebirdContainer.FIREBIRD_PORT;
-import static org.firebirdsql.testcontainers.FirebirdContainer.IMAGE;
+import static org.firebirdsql.testcontainers.FirebirdTestImages.FIREBIRD_259_SC_IMAGE;
+import static org.firebirdsql.testcontainers.FirebirdTestImages.FIREBIRD_259_SS_IMAGE;
+import static org.firebirdsql.testcontainers.FirebirdTestImages.FIREBIRD_TEST_IMAGE;
 import static org.hamcrest.CoreMatchers.allOf;
 import static org.hamcrest.CoreMatchers.containsString;
 import static org.hamcrest.MatcherAssert.assertThat;
@@ -20,7 +22,22 @@ public class FirebirdContainerTest {
     @Test
     public void testWithSysdbaPassword() throws SQLException {
         final String sysdbaPassword = "sysdbapassword";
-        try (FirebirdContainer<?> container = new FirebirdContainer<>().withSysdbaPassword(sysdbaPassword)) {
+        try (FirebirdContainer<?> container = new FirebirdContainer<>(FIREBIRD_TEST_IMAGE)
+                .withSysdbaPassword(sysdbaPassword)) {
+            container.start();
+
+            try (Connection connection = DriverManager.getConnection(container.getJdbcUrl(), "sysdba", sysdbaPassword)) {
+                assertTrue("Connection is valid", connection.isValid(100));
+            }
+        }
+    }
+
+    @SuppressWarnings("deprecation")
+    @Test
+    public void testImplicitImage() throws SQLException {
+        final String sysdbaPassword = "sysdbapassword";
+        try (FirebirdContainer<?> container = new FirebirdContainer<>()
+                .withSysdbaPassword(sysdbaPassword)) {
             container.start();
 
             try (Connection connection = DriverManager.getConnection(container.getJdbcUrl(), "sysdba", sysdbaPassword)) {
@@ -36,7 +53,8 @@ public void testWithSysdbaPassword() throws SQLException {
     public void testUserPasswordTakesPrecedenceOverWithSysdbaPassword() throws SQLException {
         final String userPassword = "password1";
         final String withSysdbaPassword = "password2";
-        try (FirebirdContainer<?> container = new FirebirdContainer<>().withUsername("sysdba").withPassword(userPassword).withSysdbaPassword(withSysdbaPassword)) {
+        try (FirebirdContainer<?> container = new FirebirdContainer<>(FIREBIRD_TEST_IMAGE)
+                .withUsername("sysdba").withPassword(userPassword).withSysdbaPassword(withSysdbaPassword)) {
             container.start();
 
             try (Connection connection = DriverManager.getConnection(container.getJdbcUrl(), "sysdba", userPassword)) {
@@ -47,7 +65,8 @@ public void testUserPasswordTakesPrecedenceOverWithSysdbaPassword() throws SQLEx
 
     @Test
     public void testWithEnableLegacyClientAuth() throws SQLException {
-        try (FirebirdContainer<?> container = new FirebirdContainer<>().withEnableLegacyClientAuth()) {
+        try (FirebirdContainer<?> container = new FirebirdContainer<>(FIREBIRD_TEST_IMAGE)
+                .withEnableLegacyClientAuth()) {
             container.start();
 
             try (Connection connection = container.createConnection("");
@@ -61,7 +80,7 @@ public void testWithEnableLegacyClientAuth() throws SQLException {
 
     @Test
     public void testWithEnableLegacyClientAuth_jdbcUrlIncludeAuthPlugins_default() {
-        try (FirebirdContainer<?> container = new FirebirdContainer<>()
+        try (FirebirdContainer<?> container = new FirebirdContainer<>(FIREBIRD_TEST_IMAGE)
                 .withEnableLegacyClientAuth()) {
             container.start();
 
@@ -74,7 +93,7 @@ public void testWithEnableLegacyClientAuth_jdbcUrlIncludeAuthPlugins_default() {
 
     @Test
     public void testWithEnableLegacyClientAuth_jdbcUrlIncludeAuthPlugins_explicitlySet() {
-        try (FirebirdContainer<?> container = new FirebirdContainer<>()
+        try (FirebirdContainer<?> container = new FirebirdContainer<>(FIREBIRD_TEST_IMAGE)
                 .withEnableLegacyClientAuth()
                 .withUrlParam("authPlugins", "Legacy_Auth")) {
             container.start();
@@ -88,7 +107,7 @@ public void testWithEnableLegacyClientAuth_jdbcUrlIncludeAuthPlugins_explicitlyS
 
     @Test
     public void testWithEnableWireCrypt() throws SQLException {
-        try (FirebirdContainer<?> container = new FirebirdContainer<>().withEnableWireCrypt()) {
+        try (FirebirdContainer<?> container = new FirebirdContainer<>(FIREBIRD_TEST_IMAGE).withEnableWireCrypt()) {
             container.start();
 
             if (FirebirdContainer.isWireEncryptionSupported()) {
@@ -111,7 +130,30 @@ public void testWithEnableWireCrypt() throws SQLException {
      */
     @Test
     public void test259_scImage() throws Exception {
-        try (FirebirdContainer<?> container = new FirebirdContainer<>(IMAGE + ":2.5.9-sc").withDatabaseName("test")) {
+        try (FirebirdContainer<?> container = new FirebirdContainer<>(FIREBIRD_259_SC_IMAGE).withDatabaseName("test")) {
+            assertEquals("Expect original database name before start",
+                    "test", container.getDatabaseName());
+
+            container.start();
+
+            assertEquals("Expect modified database name after start",
+                    "/firebird/data/test", container.getDatabaseName());
+
+            try (Connection connection = DriverManager
+                    .getConnection("jdbc:firebirdsql://" + container.getHost() + ":" + container.getMappedPort(FIREBIRD_PORT) + "/" + container.getDatabaseName(),
+                            container.getUsername(), container.getPassword())
+            ) {
+                assertTrue(connection.isValid(1000));
+            }
+        }
+    }
+
+    /**
+     * The 2.5 images of jacobalberty/firebird handle FIREBIRD_DATABASE and need an absolute path to access the database
+     */
+    @Test
+    public void test259_ssImage() throws Exception {
+        try (FirebirdContainer<?> container = new FirebirdContainer<>(FIREBIRD_259_SS_IMAGE).withDatabaseName("test")) {
             assertEquals("Expect original database name before start",
                     "test", container.getDatabaseName());
 
@@ -131,7 +173,7 @@ public void test259_scImage() throws Exception {
 
     @Test
     public void testWithAdditionalUrlParamInJdbcUrl() {
-        try (FirebirdContainer<?> firebird = new FirebirdContainer<>()
+        try (FirebirdContainer<?> firebird = new FirebirdContainer<>(FIREBIRD_TEST_IMAGE)
                 .withUrlParam("charSet", "utf-8")
                 .withUrlParam("blobBufferSize", "2048")) {
 

src/test/java/org/firebirdsql/testcontainers/FirebirdTestImages.java

@@ -0,0 +1,15 @@
+package org.firebirdsql.testcontainers;
+
+import org.testcontainers.utility.DockerImageName;
+
+public final class FirebirdTestImages {
+
+    public static final DockerImageName FIREBIRD_307_IMAGE = FirebirdContainer.DEFAULT_IMAGE_NAME.withTag("3.0.7");
+    public static final DockerImageName FIREBIRD_259_SC_IMAGE = FirebirdContainer.DEFAULT_IMAGE_NAME.withTag("2.5.9-sc");
+    public static final DockerImageName FIREBIRD_259_SS_IMAGE = FirebirdContainer.DEFAULT_IMAGE_NAME.withTag("2.5.9-ss");
+    public static final DockerImageName FIREBIRD_TEST_IMAGE = FIREBIRD_307_IMAGE;
+
+    private FirebirdTestImages() {
+        throw new AssertionError("no instances");
+    }
+}

src/test/java/org/firebirdsql/testcontainers/examples/ExampleRuleTest.java

@@ -9,6 +9,7 @@
 import java.sql.ResultSet;
 import java.sql.Statement;
 
+import static org.firebirdsql.testcontainers.FirebirdTestImages.FIREBIRD_TEST_IMAGE;
 import static org.rnorth.visibleassertions.VisibleAssertions.assertEquals;
 import static org.rnorth.visibleassertions.VisibleAssertions.assertTrue;
 
@@ -18,7 +19,7 @@
 public class ExampleRuleTest {
 
     @Rule
-    public final FirebirdContainer<?> container = new FirebirdContainer<>()
+    public final FirebirdContainer<?> container = new FirebirdContainer<>(FIREBIRD_TEST_IMAGE)
             .withUsername("testuser")
             .withPassword("testpassword");