Add TiDB module

docs/modules/databases/jdbc.md

@@ -51,6 +51,10 @@ Insert `tc:` after `jdbc:` as follows. Note that the hostname, port and database
 
 `jdbc:tc:cockroach:v21.2.3:///databasename`
 
+#### Using TiDB
+
+`jdbc:tc:tidb:v6.1.0:///databasename`
+
 ### Using a classpath init script
 
 Testcontainers can run an init script after the database container is started, but before your code is given a connection to it. The script must be on the classpath, and is referenced as follows:

docs/modules/databases/tidb.md

@@ -0,0 +1,25 @@
+# TiDB Module
+
+See [Database containers](./index.md) for documentation and usage that is common to all relational database container types.
+
+## Adding this module to your project dependencies
+
+Add the following dependency to your `pom.xml`/`build.gradle` file:
+
+=== "Gradle"
+    ```groovy
+    testImplementation "org.testcontainers:tidb:{{latest_version}}"
+    ```
+
+=== "Maven"
+    ```xml
+    <dependency>
+        <groupId>org.testcontainers</groupId>
+        <artifactId>tidb</artifactId>
+        <version>{{latest_version}}</version>
+        <scope>test</scope>
+    </dependency>
+    ```
+
+!!! hint
+    Adding this Testcontainers library JAR will not automatically add a database driver JAR to your project. You should ensure that your project also has a suitable database driver as a dependency.

mkdocs.yml

@@ -63,6 +63,7 @@ nav:
                 - modules/databases/orientdb.md
                 - modules/databases/postgres.md
                 - modules/databases/presto.md
+                - modules/databases/tidb.md
                 - modules/databases/trino.md
           - modules/azure.md
           - modules/docker_compose.md

modules/mysql/src/main/resources/META-INF/services/org.testcontainers.containers.JdbcDatabaseContainerProvider

@@ -1 +1 @@
-org.testcontainers.containers.MySQLContainerProvider
+org.testcontainers.containers.TiDBContainerProvider

modules/tidb/build.gradle

@@ -0,0 +1,19 @@
+description = "Testcontainers :: JDBC :: TiDB"
+
+dependencies {
+    annotationProcessor 'com.google.auto.service:auto-service:1.0.1'
+    compileOnly 'com.google.auto.service:auto-service:1.0.1'
+
+    api project(':jdbc')
+
+    compileOnly project(':r2dbc')
+    compileOnly 'dev.miku:r2dbc-mysql:0.8.2.RELEASE'
+
+    testImplementation project(':jdbc-test')
+    testImplementation 'mysql:mysql-connector-java:8.0.29'
+
+    testImplementation testFixtures(project(':r2dbc'))
+    testImplementation 'dev.miku:r2dbc-mysql:0.8.2.RELEASE'
+
+    compileOnly 'org.jetbrains:annotations:23.0.0'
+}

modules/tidb/sql/init_mysql.sql

@@ -0,0 +1,5 @@
+CREATE TABLE bar (
+  foo VARCHAR(255)
+);
+
+INSERT INTO bar (foo) VALUES ('hello world');

modules/tidb/src/main/java/org/testcontainers/containers/TiDBContainer.java

@@ -0,0 +1,146 @@
+package org.testcontainers.containers;
+
+import org.jetbrains.annotations.NotNull;
+import org.testcontainers.containers.wait.strategy.HttpWaitStrategy;
+import org.testcontainers.utility.DockerImageName;
+
+import java.sql.Connection;
+import java.sql.DriverManager;
+import java.sql.SQLException;
+import java.time.Duration;
+import java.util.HashSet;
+import java.util.Set;
+
+/**
+ * @author richardnorth
+ */
+public class TiDBContainer extends JdbcDatabaseContainer<TiDBContainer> {
+
+    public static final String NAME = "tidb";
+
+    private static final DockerImageName DEFAULT_IMAGE_NAME = DockerImageName.parse("pingcap/tidb");
+
+    @Deprecated
+    public static final String DEFAULT_TAG = "v6.1.0";
+
+    @Deprecated
+    public static final String IMAGE = DEFAULT_IMAGE_NAME.getUnversionedPart();
+
+    public static final String IMAGE_TAG = DEFAULT_TAG;
+
+    public static final Integer TIDB_PORT = 4000;
+
+    private static final int REST_API_PORT = 10080;
+
+    private String databaseName = "test";
+
+    private String username = "root";
+
+    private String password = "";
+
+    /**
+     * @deprecated use {@link TiDBContainer (DockerImageName)} instead
+     */
+    @Deprecated
+    public TiDBContainer() {
+        this(DEFAULT_IMAGE_NAME.withTag(DEFAULT_TAG));
+    }
+
+    public TiDBContainer(String dockerImageName) {
+        this(DockerImageName.parse(dockerImageName));
+    }
+
+    public TiDBContainer(final DockerImageName dockerImageName) {
+        super(dockerImageName);
+        dockerImageName.assertCompatibleWith(DEFAULT_IMAGE_NAME);
+
+        addExposedPorts(TIDB_PORT, REST_API_PORT);
+
+        waitingFor(
+            new HttpWaitStrategy()
+                .forPath("/status")
+                .forPort(REST_API_PORT)
+                .forStatusCode(200)
+                .withStartupTimeout(Duration.ofMinutes(1))
+        );
+    }
+
+    @NotNull
+    @Override
+    protected Set<Integer> getLivenessCheckPorts() {
+        return new HashSet<>(getMappedPort(TIDB_PORT));
+    }
+
+    @Override
+    public String getDriverClassName() {
+        try {
+            Class.forName("com.mysql.cj.jdbc.Driver");
+            return "com.mysql.cj.jdbc.Driver";
+        } catch (ClassNotFoundException e) {
+            return "com.mysql.jdbc.Driver";
+        }
+    }
+
+    @Override
+    public String getJdbcUrl() {
+        String additionalUrlParams = constructUrlParameters("?", "&");
+        return "jdbc:mysql://" + getHost() + ":" + getMappedPort(TIDB_PORT) + "/" + databaseName + additionalUrlParams;
+    }
+
+    @Override
+    protected String constructUrlForConnection(String queryString) {
+        String url = super.constructUrlForConnection(queryString);
+
+        if (!url.contains("useSSL=")) {
+            String separator = url.contains("?") ? "&" : "?";
+            url = url + separator + "useSSL=false";
+        }
+
+        if (!url.contains("allowPublicKeyRetrieval=")) {
+            url = url + "&allowPublicKeyRetrieval=true";
+        }
+
+        return url;
+    }
+
+    @Override
+    public String getDatabaseName() {
+        return databaseName;
+    }
+
+    @Override
+    public String getUsername() {
+        return username;
+    }
+
+    @Override
+    public String getPassword() {
+        return password;
+    }
+
+    @Override
+    public String getTestQueryString() {
+        return "SELECT 1";
+    }
+
+    @Override
+    public TiDBContainer withDatabaseName(final String databaseName) {
+        throw new UnsupportedOperationException(
+            "The TiDB docker image does not currently support this"
+        );
+    }
+
+    @Override
+    public TiDBContainer withUsername(final String username) {
+        throw new UnsupportedOperationException(
+            "The TiDB docker image does not currently support this"
+        );
+    }
+
+    @Override
+    public TiDBContainer withPassword(final String password) {
+        throw new UnsupportedOperationException(
+            "The TiDB docker image does not currently support this"
+        );
+    }
+}

modules/tidb/src/main/java/org/testcontainers/containers/TiDBContainerProvider.java

@@ -0,0 +1,33 @@
+package org.testcontainers.containers;
+
+import org.testcontainers.jdbc.ConnectionUrl;
+import org.testcontainers.utility.DockerImageName;
+
+/**
+ * Factory for TiDB containers.
+ */
+public class TiDBContainerProvider extends JdbcDatabaseContainerProvider {
+
+    private static final String USER_PARAM = "root";
+
+    private static final String PASSWORD_PARAM = "";
+
+    @Override
+    public boolean supports(String databaseType) {
+        return databaseType.equals(TiDBContainer.NAME);
+    }
+
+    @Override
+    public JdbcDatabaseContainer newInstance() {
+        return newInstance(TiDBContainer.DEFAULT_TAG);
+    }
+
+    @Override
+    public JdbcDatabaseContainer newInstance(String tag) {
+        if (tag != null) {
+            return new TiDBContainer(DockerImageName.parse(TiDBContainer.IMAGE).withTag(tag));
+        } else {
+            return newInstance();
+        }
+    }
+}

modules/tidb/src/main/resources/META-INF/services/org.testcontainers.containers.JdbcDatabaseContainerProvider

@@ -0,0 +1 @@
+org.testcontainers.containers.TiDBContainerProvider

modules/tidb/src/main/resources/mysql-default-conf/my.cnf

@@ -0,0 +1,49 @@
+[mysqld]
+user = mysql
+datadir = /var/lib/mysql
+port   		= 3306
+#socket 		= /tmp/mysql.sock
+skip-external-locking
+key_buffer_size = 16K
+max_allowed_packet = 1M
+table_open_cache = 4
+sort_buffer_size = 64K
+read_buffer_size = 256K
+read_rnd_buffer_size = 256K
+net_buffer_length = 2K
+skip-host-cache
+skip-name-resolve
+
+# Don't listen on a TCP/IP port at all. This can be a security enhancement,
+# if all processes that need to connect to mysqld run on the same host.
+# All interaction with mysqld must be made via Unix sockets or named pipes.
+# Note that using this option without enabling named pipes on Windows
+# (using the "enable-named-pipe" option) will render mysqld useless!
+#
+#skip-networking
+#server-id      	= 1
+
+# Uncomment the following if you want to log updates
+#log-bin=mysql-bin
+
+# binary logging format - mixed recommended
+#binlog_format=mixed
+
+# Causes updates to non-transactional engines using statement format to be
+# written directly to binary log. Before using this option make sure that
+# there are no dependencies between transactional and non-transactional
+# tables such as in the statement INSERT INTO t_myisam SELECT * FROM
+# t_innodb; otherwise, slaves may diverge from the master.
+#binlog_direct_non_transactional_updates=TRUE
+
+# Uncomment the following if you are using InnoDB tables
+innodb_data_file_path = ibdata1:10M:autoextend
+# You can set .._buffer_pool_size up to 50 - 80 %
+# of RAM but beware of setting memory usage too high
+innodb_buffer_pool_size = 16M
+#innodb_additional_mem_pool_size = 2M
+# Set .._log_file_size to 25 % of buffer pool size
+innodb_log_file_size = 5M
+innodb_log_buffer_size = 8M
+innodb_flush_log_at_trx_commit = 1
+innodb_lock_wait_timeout = 50

modules/tidb/src/test/java/org/testcontainers/TiDBTestImages.java

@@ -0,0 +1,8 @@
+package org.testcontainers;
+
+import org.testcontainers.utility.DockerImageName;
+
+public class TiDBTestImages {
+
+    public static final DockerImageName TIDB_IMAGE = DockerImageName.parse("pingcap/tidb:v6.1.0");
+}

modules/tidb/src/test/java/org/testcontainers/jdbc/tidb/TiDBJDBCDriverTest.java

@@ -0,0 +1,21 @@
+package org.testcontainers.jdbc.tidb;
+
+import org.junit.runner.RunWith;
+import org.junit.runners.Parameterized;
+import org.testcontainers.jdbc.AbstractJDBCDriverTest;
+
+import java.util.Arrays;
+import java.util.EnumSet;
+
+@RunWith(Parameterized.class)
+public class TiDBJDBCDriverTest extends AbstractJDBCDriverTest {
+
+    @Parameterized.Parameters(name = "{index} - {0}")
+    public static Iterable<Object[]> data() {
+        return Arrays.asList(
+            new Object[][] {
+                { "jdbc:tc:tidb://hostname/databasename", EnumSet.noneOf(Options.class) },
+            }
+        );
+    }
+}