#7 Make firebirdsql/firebird the default image

Author: mrotteveel

CHANGES.md

@@ -3,24 +3,31 @@ Version History
 
 vNext
 -----
+- The _project_ image (`firebirdsql/firebird`) is now the default. \
+  Contrary to previously announced, the 5.0.3 tag is the default, not 5.0.1. \
+  If you want to continue using the _jacobalberty_ image, you'll need to explicitly reference the image name (e.g. using `FirebirdContainer.JACOB_ALBERTY_IMAGE`).
+- As a backwards compatibility measure, a subset of tags of the _jacobalberty_ image are recognized in `jdbc:tc:firebird[sql]:...` URLs and `FirebirdContainerProvider.newInstance(String)`. \
+  Specifically, tags starting with `2.`, `v2`, `v3`, `v4` and `v5` will select the _jacobalberty_ image instead of the _project_ image.
+- Support for the _jacobalberty_ image is considered deprecated, but there are currently no plans to remove it. \
+  Switch to the _project_ image  (`firebirdsql/firebird`).
+- Support for the _fdcastel_ image was removed as it is no longer available. \
+  Switch to the _project_ image (`firebirdsql/firebird`).
 - Updated org.testcontainers:jdbc to 1.21.0
 - Updated various test-dependencies
 - Updated Maven build plugins
-- Support for the _fdcastel_ image was removed as it is no longer available. \
-  You'll need to switch to the _project_ image (`firebirdsql/firebird`).
 
 1.5.1
 -----
 - Added support for [firebirdsql/firebird](https://hub.docker.com/r/firebirdsql/firebird). \
   This was originally the _fdcastel_ image. \
-  The name is defined in `FirebirdContainer.PROJECT_IMAGE` (`String`) and `FirebirdContainer.PROJECT_IMAGE_NAME` (`DockerImageName`). \
+  The name is defined in `FirebirdContainer.PROJECT_IMAGE`. \
   In 1.5.x, these images are not accessible as a `jdbc:tc:firebird[sql]:...` URL, only through `FirebirdContainer`; this will change with version 1.6.0. \
   All existing configuration options are mapped in a backwards compatible way.
-- Defined `JACOB_ALBERTY_IMAGE` and `JACOB_ALBERY_IMAGE_NAME` constants in `FirebirdContainer`.
+- Defined `JACOB_ALBERTY_IMAGE` constants in `FirebirdContainer`.
 - Support for the _fdcastel_ image is considered deprecated, but there are currently no plans to remove it. \
   Switch to the _project_ image.
 - In the 1.6.0 release, the 5.0.1 version of the _project_ image will become the default image. \
-  Make sure you explicitly use this image name (and a version tag) if you want to stick to the _Jacob Alberty_ image with the next release.
+  Make sure you explicitly use this image name (and a version tag) if you want to stick to the _jacobalberty_ image with the next release.
 - Updated various test-dependencies
 
 1.5.0
@@ -29,7 +36,7 @@ vNext
 - Updated various test-dependencies
 - Updated Maven build plugins
 - Added support for [ghcr.io/fdcastel/firebird](https://github.com/fdcastel/firebird-docker) images. \
-  The name is defined in `FirebirdContainer.FDCASTEL_IMAGE` (`String`) and `FirebirdContainer.FDCASTEL_IMAGE_NAME` (`DockerImageName`). \
+  The name is defined in `FirebirdContainer.FDCASTEL_IMAGE`. \
   These images are not accessible as a `jdbc:tc:firebird[sql]:...` URL, only through `FirebirdContainer`.\
   All existing configuration options are mapped in a backwards compatible way.
 

README.md

@@ -6,15 +6,13 @@ firebird-testcontainers-java
 Firebird-testcontainers-java is a module for [Testcontainers](https://www.testcontainers.org/)
 to provide lightweight, throwaway instances of Firebird for JUnit tests.
 
-The default Docker image used is [jacobalberty/firebird](https://hub.docker.com/r/jacobalberty/firebird/), and also supports 
-[firebirdsql/firebird](https://hub.docker.com/r/firebirdsql/firebird) (since 1.5.1) and 
-[ghcr.io/fdcastel/firebird](https://github.com/fdcastel/firebird-docker) (since 1.5.0).
-
-The `firebirdsql/firebird` image will become the default image in version 1.6.0.
+The default Docker image used is [firebirdsql/firebird](https://hub.docker.com/r/firebirdsql/firebird), and also supports 
+ [jacobalberty/firebird](https://hub.docker.com/r/jacobalberty/firebird/).
 
 If you want to use Firebird 2.5, use the 2.5.x-sc (SuperClassic) variant of 
 the `jacobalberty/firebird` image, or 2.5.9-ss as earlier versions of the 2.5.x-ss 
-(SuperServer) variant seem to be broken.
+(SuperServer) variant seem to be broken. However, recently, it seems that the
+2.5.x-sc variants also no longer work reliably.
 
 Prerequisites
 -------------
@@ -65,20 +63,20 @@ Important standard options are:
   For `jacobalberty/firebird`, if the value is `sysdba`, `FIREBIRD_USER` is not set.
 - `withPassword(String)` - Sets the password of the user (defaults to `test`); sets the docker environment variable `FIREBIRD_PASSWORD`. \
   For `jacobalberty/firebird`, if the username is `sysdba`, `ISC_PASSWORD` is set instead of `FIREBIRD_PASSWORD`. \
-  For `ghcr.io/fdcastel/firebird`, if the username is `sysdba`, it also sets `FIREBIRD_ROOT_PASSWORD`.
+  For `firebirdsql/firebird`, if the username is `sysdba`, it also sets `FIREBIRD_ROOT_PASSWORD`.
 - `withDatabaseName(String)` - Sets the database name (defaults to `test`); sets docker environment variable `FIREBIRD_DATABASE`
 
 Firebird specific options are:
 
 - `withEnableLegacyClientAuth()` - (_Firebird 3+_) Enables `LegacyAuth` and uses it as the default for creating users, also relaxes `WireCrypt` to `Enabled`;
-sets docker environment variable `EnableLegacyClientAuth` (`jacobalberty/firebird`) or `FIREBIRD_USE_LEGACY_AUTH` (`firebirdsql/firebird` and `ghcr.io/fdcastel/firebird`) to `true`;
+sets docker environment variable `EnableLegacyClientAuth` (`jacobalberty/firebird`) or `FIREBIRD_USE_LEGACY_AUTH` (`firebirdsql/firebird`) to `true`;
 passes connection property `authPlugins` with value `Srp256,Srp,Legacy_Auth` if this property is not explicitly set through `withUrlParam`.
 - `withEnableWireCrypt` - (_Firebird 3+_) Relaxes `WireCrypt` from `Required` to `Enabled`; 
-sets docker environment variable `EnableWireCrypt` (`jacobalberty/firebird`) to `true`, or `FIREBIRD_CONF_WireCrypt` (`firebirdsql/firebird` and `ghcr.io/fdcastel/firebird`) to `Enabled`.
+sets docker environment variable `EnableWireCrypt` (`jacobalberty/firebird`) to `true`, or `FIREBIRD_CONF_WireCrypt` (`firebirdsql/firebird`) to `Enabled`.
 - `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 ignored and the value of `withPassword` is used instead; 
-sets docker environment variable `ISC_PASSWORD` (`jacobalberty/firebird`) or `FIREBIRD_ROOT_PASSWORD` (`ghcr.io/fdcastel/firebird`) to the specified value.
+sets docker environment variable `ISC_PASSWORD` (`jacobalberty/firebird`) or `FIREBIRD_ROOT_PASSWORD` (`firebirdsql/firebird`) to the specified value.
 
 Example of use:
 
@@ -92,7 +90,7 @@ import org.testcontainers.utility.DockerImageName;
 public class ExampleRuleTest {
 
   private static final DockerImageName IMAGE = 
-          DockerImageName.parse(FirebirdContainer.IMAGE).withTag("v4.0.2");
+          DockerImageName.parse(FirebirdContainer.IMAGE).withTag("5.0.3");
 
   @Rule
   public final FirebirdContainer<?> container = new FirebirdContainer<?>(IMAGE)
@@ -127,14 +125,16 @@ Where:
 - `<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) \
+- `<property>` is a connection property (Jaybird properties **and** testcontainers
+  properties are possible) \
   Of special note are the properties:
   - `user` (_optional_) specifies the username to create and connect (defaults to `test`)
   - `password` (_optional_) specifies the password for the user (defaults to `test`)
 - `<value>` is the value of the property
 
-Currently, these URLs can only use the `jacobalberty/firebird` images. In 1.6.0, 
-this will switch to use `firebirdsql/firebird`.
+These URLs use the `firebirdsql/firebird` images, except for tags starting with
+`2.`, `v2`, `v3`, `v4` or `v5`, which will select the `jacobalberty/firebird`
+images for backwards compatibility.
 
 Example of use:
 

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

@@ -12,7 +12,7 @@
 /**
  * Testcontainers implementation for Firebird.
  * <p>
- * Supported image: {@code jacobalberty/firebird}, {@code firebirdsql/firebird}.
+ * Supported image: {@code firebirdsql/firebird} and {@code jacobalberty/firebird} (deprecated).
  * <p>
  * Exposed ports: 3050
  */
@@ -23,12 +23,20 @@ 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 PROJECT_IMAGE = "firebirdsql/firebird";
+    /**
+     * @deprecated Use {@link #PROJECT_IMAGE}
+     */
+    @Deprecated
     public static final String JACOB_ALBERTY_IMAGE = "jacobalberty/firebird";
-    public static final String IMAGE = JACOB_ALBERTY_IMAGE;
+    public static final String IMAGE = PROJECT_IMAGE;
     static final DockerImageName PROJECT_IMAGE_NAME = DockerImageName.parse(PROJECT_IMAGE);
+    /**
+     * @deprecated Use {@link #PROJECT_IMAGE_NAME}
+     */
+    @Deprecated
     static final DockerImageName JACOB_ALBERTY_IMAGE_NAME = DockerImageName.parse(JACOB_ALBERTY_IMAGE);
-    static final DockerImageName DEFAULT_IMAGE_NAME = JACOB_ALBERTY_IMAGE_NAME;
-    public static final String DEFAULT_TAG = "v4.0.2";
+    static final DockerImageName DEFAULT_IMAGE_NAME = PROJECT_IMAGE_NAME;
+    public static final String DEFAULT_TAG = "5.0.3";
 
     public static final Integer FIREBIRD_PORT = 3050;
     private static final String FIREBIRD_SYSDBA = "sysdba";
@@ -54,7 +62,7 @@ public FirebirdContainer() {
     }
 
     /**
-     * Creates a Firebird container with an image name (e.g. {@code "jacobalberty/firebird:3.0.7"}.
+     * Creates a Firebird container with an image name (e.g. {@code "firebirdsql/firebird:5.0.3"}.
      *
      * @param dockerImageName Image name
      */

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

@@ -5,6 +5,12 @@
 import org.testcontainers.jdbc.ConnectionUrl;
 import org.testcontainers.utility.DockerImageName;
 
+import java.util.Arrays;
+import java.util.HashSet;
+import java.util.Set;
+
+import static java.util.Collections.unmodifiableSet;
+
 /**
  * Factory for Firebird containers.
  */
@@ -23,9 +29,21 @@ public JdbcDatabaseContainer newInstance() {
         return newInstance(FirebirdContainer.DEFAULT_TAG);
     }
 
+    // Two character prefix of tags of the jacobalberty image
+    // The firebirdsql image uses versions without v prefix and doesn't provide a Firebird 2.x image
+    private static final Set<String> LEGACY_TAG_PREFIXES = unmodifiableSet(new HashSet<>(
+            Arrays.asList("2.", "v2", "v3", "v4", "v5")));
+
+    private static boolean isLegacyTag(String tag) {
+        return tag.length() >= 2 && LEGACY_TAG_PREFIXES.contains(tag.substring(0, 2));
+    }
+
     @Override
     public JdbcDatabaseContainer newInstance(String tag) {
-        return new FirebirdContainer(DockerImageName.parse(FirebirdContainer.IMAGE).withTag(tag));
+        DockerImageName imageName = isLegacyTag(tag)
+                ? FirebirdContainer.JACOB_ALBERTY_IMAGE_NAME
+                : FirebirdContainer.DEFAULT_IMAGE_NAME;
+        return new FirebirdContainer(imageName.withTag(tag));
     }
 
     @Override

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

@@ -12,9 +12,10 @@
 import java.util.stream.Stream;
 
 import static org.firebirdsql.testcontainers.FirebirdContainer.FIREBIRD_PORT;
-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.JACOB_ALBERTY_259_SC_IMAGE;
+import static org.firebirdsql.testcontainers.FirebirdTestImages.JACOB_ALBERTY_259_SS_IMAGE;
 import static org.firebirdsql.testcontainers.FirebirdTestImages.FIREBIRD_TEST_IMAGE;
+import static org.firebirdsql.testcontainers.FirebirdTestImages.JACOB_ALBERTY_TEST_IMAGE;
 import static org.firebirdsql.testcontainers.FirebirdTestImages.PROJECT_TEST_IMAGE;
 import static org.hamcrest.CoreMatchers.allOf;
 import static org.hamcrest.CoreMatchers.containsString;
@@ -139,11 +140,15 @@ void testWithEnableWireCrypt(DockerImageName imageName) throws SQLException {
     }
 
     /**
-     * The 2.5 images of jacobalberty/firebird handle FIREBIRD_DATABASE and need an absolute path to access the database
+     * The 2.5 images of jacobalberty/firebird handle FIREBIRD_DATABASE and need an absolute path to access the database.
+     * <p>
+     * NOTE: This test is ignored because it occasionally fails locally and repeatedly on GitHub Actions.
+     * </p>
      */
+    @Disabled
     @Test
     void test259_scImage() throws Exception {
-        try (FirebirdContainer<?> container = new FirebirdContainer<>(FIREBIRD_259_SC_IMAGE).withDatabaseName("test")) {
+        try (FirebirdContainer<?> container = new FirebirdContainer<>(JACOB_ALBERTY_259_SC_IMAGE).withDatabaseName("test")) {
             assertEquals("test", container.getDatabaseName(), "Expect original database name before start");
 
             container.start();
@@ -161,15 +166,15 @@ void test259_scImage() throws Exception {
     }
 
     /**
-     * The 2.5 images of jacobalberty/firebird handle FIREBIRD_DATABASE and need an absolute path to access the database
+     * The 2.5 images of jacobalberty/firebird handle FIREBIRD_DATABASE and need an absolute path to access the database.
      * <p>
      * NOTE: This test is ignored because it occasionally fails locally and repeatedly on GitHub Actions.
      * </p>
      */
     @Disabled
     @Test
     void test259_ssImage() throws Exception {
-        try (FirebirdContainer<?> container = new FirebirdContainer<>(FIREBIRD_259_SS_IMAGE).withDatabaseName("test")) {
+        try (FirebirdContainer<?> container = new FirebirdContainer<>(JACOB_ALBERTY_259_SS_IMAGE).withDatabaseName("test")) {
             assertEquals("test", container.getDatabaseName(), "Expect original database name before start");
 
             container.start();
@@ -187,8 +192,7 @@ void test259_ssImage() throws Exception {
     }
 
     /**
-     * The firebirdsql/firebird and fdcastel/firebird images handle FIREBIRD_DATABASE and need an absolute path to
-     * access the database
+     * The firebirdsql/firebird images handle FIREBIRD_DATABASE and need an absolute path to access the database.
      */
     @ParameterizedTest
     @MethodSource("projectCompatibleImages")
@@ -228,7 +232,7 @@ void testWithAdditionalUrlParamInJdbcUrl(DockerImageName imageName) {
     }
 
     static Stream<DockerImageName> defaultTestImages() {
-        return Stream.of(PROJECT_TEST_IMAGE, FIREBIRD_TEST_IMAGE);
+        return Stream.of(FIREBIRD_TEST_IMAGE, JACOB_ALBERTY_TEST_IMAGE);
     }
 
     static Stream<DockerImageName> projectCompatibleImages() {

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

@@ -4,12 +4,13 @@
 
 public final class FirebirdTestImages {
 
-    public static final DockerImageName FIREBIRD_402_IMAGE = FirebirdContainer.DEFAULT_IMAGE_NAME.withTag("v4.0.2");
-    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 PROJECT_501_IMAGE = FirebirdContainer.PROJECT_IMAGE_NAME.withTag("5.0.1");
-    public static final DockerImageName FIREBIRD_TEST_IMAGE = FIREBIRD_402_IMAGE;
-    public static final DockerImageName PROJECT_TEST_IMAGE = PROJECT_501_IMAGE;
+    public static final DockerImageName JACOB_ALBERTY_402_IMAGE = FirebirdContainer.JACOB_ALBERTY_IMAGE_NAME.withTag("v4.0.2");
+    public static final DockerImageName JACOB_ALBERTY_259_SC_IMAGE = FirebirdContainer.JACOB_ALBERTY_IMAGE_NAME.withTag("2.5.9-sc");
+    public static final DockerImageName JACOB_ALBERTY_259_SS_IMAGE = FirebirdContainer.JACOB_ALBERTY_IMAGE_NAME.withTag("2.5.9-ss");
+    public static final DockerImageName PROJECT_503_IMAGE = FirebirdContainer.PROJECT_IMAGE_NAME.withTag("5.0.3");
+    public static final DockerImageName PROJECT_TEST_IMAGE = PROJECT_503_IMAGE;
+    public static final DockerImageName JACOB_ALBERTY_TEST_IMAGE = JACOB_ALBERTY_402_IMAGE;
+    public static final DockerImageName FIREBIRD_TEST_IMAGE = PROJECT_TEST_IMAGE;
 
     private FirebirdTestImages() {
         throw new AssertionError("no instances");