Speed up DB2 client tests (#1655)

This commit modernizes the DB2 client test infrastructure by:

- upgrading to the community image icr.io/db2_community/db2:12.1.4.0
- eliminating the JDBC driver dependency
- removing z/OS *testing* support (not possible in containerized environments)

Also, a lot of NPE were logged because the DB2SocketConnection#closeHandler was always invoked even if not set.

With all these changes, on my box, the DB2 client build passes in 3-4 minutes instead of 7-8 minutes.

Some portions of this content were created with the assistance of IBM Bob.

Signed-off-by: Thomas Segismont <tsegismont@gmail.com>

Author: tsegismont

.github/workflows/ci-4.x.yml

@@ -46,7 +46,6 @@ jobs:
             module: 'vertx-mssql-client'
           - os: ubuntu-latest
             jdk: 8
-            profile: 'DB2-11.5'
             module: 'vertx-db2-client'
           - os: ubuntu-latest
             jdk: 8

.github/workflows/ci-matrix-5.x.yml

@@ -49,7 +49,6 @@ jobs:
             module: 'vertx-mssql-client'
           - os: ubuntu-latest
             jdk: 11
-            profile: 'DB2-11.5'
             module: 'vertx-db2-client'
           - os: ubuntu-latest
             jdk: 11

vertx-db2-client/pom.xml

@@ -45,16 +45,10 @@
     <!-- Testing purposes -->
     <dependency>
       <groupId>org.testcontainers</groupId>
-      <artifactId>db2</artifactId>
+      <artifactId>testcontainers</artifactId>
       <version>${testcontainers.version}</version>
       <scope>test</scope>
     </dependency>
-    <dependency>
-        <groupId>com.ibm.db2</groupId>
-        <artifactId>jcc</artifactId>
-        <version>11.1.4.4</version>
-        <scope>test</scope>
-    </dependency>
     <!-- SLF4J API for test code and Testcontainers -->
     <dependency>
       <groupId>org.slf4j</groupId>

vertx-db2-client/src/main/java/io/vertx/db2client/impl/DB2SocketConnection.java

@@ -1,22 +1,16 @@
 /*
- * Copyright (C) 2019,2020 IBM Corporation
+ * Copyright (c) 2011-2026 Contributors to the Eclipse Foundation
  *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
+ * which is available at https://www.apache.org/licenses/LICENSE-2.0.
  *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
+ * SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
  */
 package io.vertx.db2client.impl;
 
 import io.netty.channel.ChannelPipeline;
-import io.vertx.core.AsyncResult;
 import io.vertx.core.Completable;
 import io.vertx.core.Handler;
 import io.vertx.core.Promise;
@@ -28,9 +22,9 @@
 import io.vertx.db2client.impl.command.InitialHandshakeCommand;
 import io.vertx.db2client.impl.drda.ConnectionMetaData;
 import io.vertx.sqlclient.SqlConnectOptions;
+import io.vertx.sqlclient.impl.SocketConnectionBase;
 import io.vertx.sqlclient.internal.Connection;
 import io.vertx.sqlclient.internal.QueryResultHandler;
-import io.vertx.sqlclient.impl.SocketConnectionBase;
 import io.vertx.sqlclient.internal.command.*;
 import io.vertx.sqlclient.spi.DatabaseMetadata;
 
@@ -102,7 +96,9 @@ protected <R> void doSchedule(CommandBase<R> cmd, Completable<R> handler) {
   @Override
   public void handleClose(Throwable t) {
     super.handleClose(t);
-    context().runOnContext(closeHandler);
+    if (closeHandler != null) {
+      context().runOnContext(closeHandler);
+    }
   }
 
   @Override

vertx-db2-client/src/test/java/io/vertx/tests/db2client/DB2DataTypeTest.java

@@ -1,17 +1,12 @@
 /*
- * Copyright (C) 2020 IBM Corporation
+ * Copyright (c) 2011-2026 Contributors to the Eclipse Foundation
  *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
+ * which is available at https://www.apache.org/licenses/LICENSE-2.0.
  *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
+ * SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
  */
 package io.vertx.tests.db2client;
 
@@ -32,8 +27,6 @@
 import java.util.List;
 import java.util.UUID;
 
-import static org.junit.Assume.assumeTrue;
-
 @RunWith(VertxUnitRunner.class)
 public class DB2DataTypeTest extends DB2TestBase {
 
@@ -214,35 +207,6 @@ public void testUUID(TestContext ctx) {
     }));
   }
 
-  @Test
-  public void testRowId(TestContext ctx) {
-    assumeTrue("Only DB2/Z supports the ROWID column type", rule.isZOS());
-
-    final String msg = "insert data for testRowId";
-    connect(ctx.asyncAssertSuccess(conn -> {
-      // Insert some data
-      conn
-        .preparedQuery("INSERT INTO ROWTEST (message) VALUES ('" + msg + "')")
-        .execute()
-        .onComplete(ctx.asyncAssertSuccess(insertResult -> {
-           // Find it by msg
-           conn
-             .preparedQuery("SELECT * FROM ROWTEST WHERE message = '" + msg + "'")
-             .execute()
-             .onComplete(ctx.asyncAssertSuccess(rows -> {
-               RowId rowId = verifyRowId(ctx, rows, msg);
-               // Now find it by rowid
-               conn
-                 .preparedQuery("SELECT * FROM ROWTEST WHERE id = ?")
-                 .execute(Tuple.of(rowId))
-                 .onComplete(ctx.asyncAssertSuccess(rows2 -> {
-                   verifyRowId(ctx, rows2, msg);
-                 }));
-             }));
-        }));
-    }));
-  }
-
   /**
    * Test to support using enum string values in the Row and Tuple methods.
    */

vertx-db2-client/src/test/java/io/vertx/tests/db2client/QueryVariationsTest.java

@@ -1,19 +1,27 @@
-package io.vertx.tests.db2client;
-
-import static org.junit.Assume.assumeFalse;
-
-import java.util.Arrays;
-import java.util.function.Consumer;
+/*
+ * Copyright (c) 2011-2026 Contributors to the Eclipse Foundation
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
+ * which is available at https://www.apache.org/licenses/LICENSE-2.0.
+ *
+ * SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
+ */
 
-import org.junit.Test;
-import org.junit.runner.RunWith;
+package io.vertx.tests.db2client;
 
 import io.vertx.ext.unit.TestContext;
 import io.vertx.ext.unit.junit.VertxUnitRunner;
 import io.vertx.sqlclient.Row;
 import io.vertx.sqlclient.RowIterator;
 import io.vertx.sqlclient.RowSet;
 import io.vertx.sqlclient.Tuple;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+
+import java.util.Arrays;
+import java.util.function.Consumer;
 
 /**
  * Tests for subqueries which are documented here:
@@ -180,8 +188,6 @@ public void testSectionReuse(TestContext ctx) {
    */
   @Test
   public void testSequenceQuery(TestContext ctx) {
-      assumeFalse("TODO: Sequences behave differently on DB2/z and need to be implemented properly", rule.isZOS());
-
     connect(ctx.asyncAssertSuccess(con -> {
       con
         .query("values nextval for my_seq")
@@ -214,8 +220,6 @@ public void testSequenceQuery(TestContext ctx) {
    */
   @Test
   public void testSequenceQueryPrepared(TestContext ctx) {
-      assumeFalse("TODO: Sequences behave differently on DB2/z and need to be implemented properly", rule.isZOS());
-
     connect(ctx.asyncAssertSuccess(con -> {
       con
         .preparedQuery("VALUES nextval for my_seq")

vertx-db2-client/src/test/java/io/vertx/tests/db2client/TableJoinTest.java

@@ -1,15 +1,23 @@
-package io.vertx.tests.db2client;
-
-import static org.junit.Assume.assumeFalse;
-
-import java.util.Arrays;
+/*
+ * Copyright (c) 2011-2026 Contributors to the Eclipse Foundation
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
+ * which is available at https://www.apache.org/licenses/LICENSE-2.0.
+ *
+ * SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
+ */
 
-import org.junit.Test;
-import org.junit.runner.RunWith;
+package io.vertx.tests.db2client;
 
 import io.vertx.ext.unit.TestContext;
 import io.vertx.ext.unit.junit.VertxUnitRunner;
 import io.vertx.sqlclient.Row;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+
+import java.util.Arrays;
 
 /**
  * Tests for table joins which are documented here:
@@ -84,7 +92,6 @@ public void testRightOuterJoin(TestContext ctx) {
 
   @Test
   public void testFullOuterJoin(TestContext ctx) {
-      assumeFalse("DB2 on Z does not support operations within ON clause for FULL OUTER JOIN", rule.isZOS());
     testJoin(ctx, "FULL OUTER JOIN");
   }
 

vertx-db2-client/src/test/java/io/vertx/tests/db2client/junit/DB2Resource.java

@@ -10,21 +10,18 @@
  */
 package io.vertx.tests.db2client.junit;
 
+import com.github.dockerjava.api.model.Capability;
+import io.netty.util.internal.PlatformDependent;
 import io.vertx.core.net.ClientSSLOptions;
 import io.vertx.core.net.JksOptions;
 import io.vertx.db2client.DB2ConnectOptions;
 import org.junit.rules.ExternalResource;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
-import org.testcontainers.containers.Db2Container;
+import org.testcontainers.containers.BindMode;
+import org.testcontainers.containers.GenericContainer;
 import org.testcontainers.containers.wait.strategy.LogMessageWaitStrategy;
 
-import java.nio.file.Files;
-import java.nio.file.Path;
-import java.nio.file.Paths;
-import java.sql.Connection;
-import java.sql.DriverManager;
-import java.sql.SQLSyntaxErrorException;
 import java.time.Duration;
 import java.util.Objects;
 
@@ -34,29 +31,40 @@ public class DB2Resource extends ExternalResource {
 
   private static final boolean CUSTOM_DB2 = get("DB2_HOST") != null;
 
-  /**
-   * In order for this container to be reused across test runs you need to add the line:
-   * <code>testcontainers.reuse.enable=true</code> to your <code>~/.testcontainers.properties</code>
-   * file (create it if it does not exist)
-   */
   public static final DB2Resource SHARED_INSTANCE = new DB2Resource();
 
   private boolean started = false;
-  private boolean isDb2OnZ = false;
   private DB2ConnectOptions options;
-  private final Db2Container instance = new Db2Container("ibmcom/db2:11.5.0.0a")
-    .acceptLicense()
-    .withLogConsumer(out -> logger.debug("[DB2] {}", out.getUtf8String()))
-    .withUsername("vertx")
-    .withPassword("vertx")
-    .withDatabaseName("vertx")
+  private final GenericContainer instance = new GenericContainer<>("icr.io/db2_community/db2:12.1.4.0")
+    .withCreateContainerCmdModifier(cmd -> cmd
+      .withCapAdd(Capability.IPC_LOCK)
+      .withCapAdd(Capability.IPC_OWNER))
+    .withEnv("LICENSE", "accept")
+    .withEnv("DB2INSTANCE", "vertx")
+    .withEnv("DB2INST1_PASSWORD", "vertx")
+    .withEnv("DBNAME", "vertx")
+    .withEnv("BLU", "false")
+    .withEnv("ENABLE_ORACLE_COMPATIBILITY", "false")
+    .withEnv("UPDATEAVAIL", "NO")
+    .withEnv("TO_CREATE_SAMPLEDB", "false")
+    .withEnv("REPODB", "false")
+    .withEnv("IS_OSXFS", String.valueOf(PlatformDependent.isOsx()))
+    .withEnv("PERSISTENT_HOME", "true")
+    .withEnv("HADR_ENABLED", "false")
+    .withEnv("ETCD_ENDPOINT", "")
+    .withEnv("ETCD_USERNAME", "")
+    .withEnv("ETCD_PASSWORD", "")
+    .withEnv("AUTOCONFIG", "false")
+    .withEnv("ARCHIVE_LOGS", "false")
     .withExposedPorts(50000, 50001)
-    .withFileSystemBind("src/test/resources/tls/server/", "/certs/")
-    .withFileSystemBind("src/test/resources/tls/db2_tls_setup.sh", "/var/custom/db2_tls_setup.sh")
+    .withClasspathResourceMapping("tls/server/", "/certs/", BindMode.READ_ONLY)
+    .withClasspathResourceMapping("tls/01-db2_tls_setup.sh", "/var/custom/01-db2_tls_setup.sh", BindMode.READ_ONLY)
+    .withClasspathResourceMapping("init.sql", "/tmp/init.sql", BindMode.READ_ONLY)
+    .withClasspathResourceMapping("02-init-db.sh", "/var/custom/02-init-db.sh", BindMode.READ_ONLY)
+    .withLogConsumer(out -> logger.debug("[DB2] {}", out.getUtf8String()))
     .waitingFor(new LogMessageWaitStrategy()
-      .withRegEx(".*VERTX SSH SETUP DONE.*")
-      .withStartupTimeout(Duration.ofMinutes(10)))
-    .withReuse(true);
+      .withRegEx(".*DB2 DATABASE INITIALIZATION COMPLETE.*")
+      .withStartupTimeout(Duration.ofMinutes(10)));
 
   @Override
   protected void before() throws Throwable {
@@ -68,9 +76,9 @@ protected void before() throws Throwable {
           options = new DB2ConnectOptions()
             .setHost(instance.getHost())
             .setPort(instance.getMappedPort(50000))
-                  .setDatabase(instance.getDatabaseName())
-                  .setUser(instance.getUsername())
-                  .setPassword(instance.getPassword());
+            .setDatabase("vertx")
+            .setUser("vertx")
+            .setPassword("vertx");
       } else {
       logger.info("Using custom DB2 instance as requested via DB2_HOST={}", get("DB2_HOST"));
           Objects.requireNonNull(get("DB2_PORT"), "Must set DB2_PORT to a non-null value if DB2_HOST is set");
@@ -83,11 +91,7 @@ protected void before() throws Throwable {
                   .setDatabase(get("DB2_NAME"))
                   .setUser(get("DB2_USER"))
                   .setPassword(get("DB2_PASS"));
-      }
-      String jdbcUrl = "jdbc:db2://" + options.getHost() + ":" + options.getPort() + "/" + options.getDatabase();
-    logger.info("Initializing DB2 database at: {}", jdbcUrl);
-      try (Connection con = DriverManager.getConnection(jdbcUrl, options.getUser(), options.getPassword())) {
-        runInitSql(con);
+      logger.info("Custom DB2 instance must be manually initialized with init.sql");
       }
       started = true;
     }
@@ -106,40 +110,8 @@ public DB2ConnectOptions secureOptions() {
             .setPassword("db2test")));
   }
 
-  public boolean isZOS() {
-    return isDb2OnZ;
-  }
-
   private static String get(String name) {
     return System.getProperty(name, System.getenv(name));
   }
 
-    private void runInitSql(Connection con) throws Exception {
-      isDb2OnZ = con.getMetaData().getDatabaseProductVersion().startsWith("DSN");
-      String currentLine = "";
-      Path initScript = Paths.get("src", "test", "resources", isDb2OnZ ? "init.zos.sql" : "init.sql");
-      logger.info("Running init script at: {}", initScript);
-      for (String sql : Files.readAllLines(initScript)) {
-          if (sql.startsWith("--"))
-              continue;
-          currentLine += sql;
-          if (sql.endsWith(";")) {
-            logger.debug("  {}", currentLine);
-              try {
-                con.createStatement().execute(currentLine);
-              } catch (SQLSyntaxErrorException e) {
-                if (sql.startsWith("DROP ") && e.getErrorCode() == -204) {
-                  logger.debug("  ignoring syntax exception: {}", e.getMessage());
-                } else {
-                  throw e;
-                }
-              }
-              currentLine = "";
-          }
-      }
-      if (!currentLine.isEmpty()) {
-        throw new IllegalStateException("Dangling SQL on init script. Ensure all statements are terminated with ';' char. SQL: " + currentLine);
-      }
-  }
-
 }