testcontainers · eddumelendez · Aug 10, 2023 · Aug 10, 2023
@@ -6,7 +6,9 @@
 import java.security.KeyStore;
 
 /**
- * An Azure CosmosDB container
+ * Testcontainers implementation for CosmosDB Emulator.
+ * <p>
+ * Exposed ports: 8081
  */
 public class CosmosDBEmulatorContainer extends GenericContainer<CosmosDBEmulatorContainer> {
 

@@ -19,9 +19,9 @@
 import javax.script.ScriptException;
 
 /**
- * Cassandra container
- *
  * Testcontainers implementation for Apache Cassandra.
+ * <p>
+ * Exposed ports: 9042
  */
 public class CassandraContainer<SELF extends CassandraContainer<SELF>> extends GenericContainer<SELF> {
 

@@ -10,6 +10,12 @@
 
 /**
  * Testcontainers implementation for ClickHouse.
+ * <p>
+ * Exposed ports:
+ * <ul>
+ *     <li>Database: 8123</li>
+ *     <li>Console: 9000</li>
+ * </ul>
  */
 public class ClickHouseContainer extends JdbcDatabaseContainer<ClickHouseContainer> {
 

@@ -6,6 +6,15 @@
 
 import java.time.Duration;
 
+/**
+ * Testcontainers implementation for CockroachDB.
+ * <p>
+ * Exposed ports:
+ * <ul>
+ *     <li>Database: 26257</li>
+ *     <li>Console: 8080</li>
+ * </ul>
+ */
 public class CockroachContainer extends JdbcDatabaseContainer<CockroachContainer> {
 
     private static final DockerImageName DEFAULT_IMAGE_NAME = DockerImageName.parse("cockroachdb/cockroach");

@@ -14,6 +14,12 @@
 
 /**
  * Testcontainers implementation for Consul.
+ * <p>
+ * Exposed ports:
+ * <ul>
+ *     <li>HTTP: 8500</li>
+ *     <li>gRPC: 8502</li>
+ * </ul>
  */
 public class ConsulContainer extends GenericContainer<ConsulContainer> {
 

@@ -48,7 +48,12 @@
 import java.util.stream.Collectors;
 
 /**
- * The couchbase container initializes and configures a Couchbase Server single node cluster.
+ * Testcontainers implementation for Couchbase.
+ * <p>
+ * Exposed ports:
+ * <ul>
+ *     <li>Console: 8091</li>
+ * </ul>
  * <p>
  * Note that it does not depend on a specific couchbase SDK, so it can be used with both the Java SDK 2 and 3 as well
  * as the Scala SDK 1 or newer. We recommend using the latest and greatest SDKs for the best experience.

@@ -7,6 +7,15 @@
 
 import java.util.Set;
 
+/**
+ * Testcontainers implementation for CrateDB.
+ * <p>
+ * Exposed ports:
+ * <ul>
+ *     <li>Database: 5432</li>
+ *     <li>Console: 4200</li>
+ * </ul>
+ */
 public class CrateDBContainer extends JdbcDatabaseContainer<CrateDBContainer> {
 
     static final String NAME = "cratedb";

@@ -8,6 +8,14 @@
 import java.time.temporal.ChronoUnit;
 import java.util.Set;
 
+/**
+ * Testcontainers implementation for IBM DB2.
+ * <p>
+ * Exposed ports:
+ * <ul>
+ *     <li>Database: 50000</li>
+ * </ul>
+ */
 public class Db2Container extends JdbcDatabaseContainer<Db2Container> {
 
     public static final String NAME = "db2";

@@ -23,8 +23,13 @@
 import javax.net.ssl.TrustManagerFactory;
 
 /**
- * Represents an elasticsearch docker instance which exposes by default port 9200 and 9300 (transport.tcp.port)
- * The docker image is by default fetched from docker.elastic.co/elasticsearch/elasticsearch
+ * Testcontainers implementation for Elasticsearch.
+ * <p>
+ * Exposed ports:
+ * <ul>
+ *     <li>HTTP: 9200</li>
+ *     <li>TCP Transport: 9300</li>
+ * </ul>
  */
 @Slf4j
 public class ElasticsearchContainer extends GenericContainer<ElasticsearchContainer> {

@@ -29,6 +29,16 @@
 import java.util.regex.Pattern;
 import java.util.stream.Collectors;
 
+/**
+ * Testcontainers implementation for HiveMQ.
+ * <p>
+ * Exposed ports:
+ * <ul>
+ *     <li>MQTT: 1883</li>
+ *     <li>Control Center: 8080</li>
+ *     <li>Debug: 9000</li>
+ * </ul>
+ */
 public class HiveMQContainer extends GenericContainer<HiveMQContainer> {
 
     private static final Logger LOGGER = LoggerFactory.getLogger(HiveMQContainer.class);

@@ -13,6 +13,8 @@
 
 /**
  * Testcontainers implementation for InfluxDB.
+ * <p>
+ * Exposed ports: 8086
  */
 public class InfluxDBContainer<SELF extends InfluxDBContainer<SELF>> extends GenericContainer<SELF> {
 

@@ -9,7 +9,14 @@
 import java.util.Objects;
 
 /**
- * This container wraps Confluent Kafka and Zookeeper (optionally)
+ * Testcontainers implementation for Apache Kafka.
+ * Zookeeper can be optionally configured.
+ * <p>
+ * Exposed ports:
+ * <ul>
+ *     <li>Kafka: 9093</li>
+ *     <li>Zookeeper: 2181</li>
+ * </ul>
  */
 public class KafkaContainer extends GenericContainer<KafkaContainer> {
 

@@ -22,6 +22,8 @@
 
 /**
  * Testcontainers implementation for LocalStack.
+ * <p>
+ * Exposed ports: 4566
  */
 @Slf4j
 public class LocalStackContainer extends GenericContainer<LocalStackContainer> {

@@ -7,7 +7,9 @@
 import java.util.Set;
 
 /**
- * Container implementation for the MariaDB project.
+ * Testcontainers implementation for MariaDB.
+ * <p>
+ * Exposed ports: 3306
  */
 public class MariaDBContainer<SELF extends MariaDBContainer<SELF>> extends JdbcDatabaseContainer<SELF> {
 

@@ -11,9 +11,9 @@
 import java.io.IOException;
 
 /**
- * Constructs a single node MongoDB replica set for testing transactions.
- * <p>To construct a multi-node MongoDB cluster, consider the <a href="https://github.com/silaev/mongodb-replica-set/">mongodb-replica-set project on GitHub</a>
- * <p>Tested on a MongoDB version 4.0.10+ (that is the default version if not specified).
+ * Testcontainers implementation for MongoDB.
+ * <p>
+ * Exposed ports: 27017
  */
 @Slf4j
 public class MongoDBContainer extends GenericContainer<MongoDBContainer> {

@@ -7,6 +7,11 @@
 import java.util.regex.Pattern;
 import java.util.stream.Stream;
 
+/**
+ * Testcontainers implementation for Microsoft SQL Server.
+ * <p>
+ * Exposed ports: 1433
+ */
 public class MSSQLServerContainer<SELF extends MSSQLServerContainer<SELF>> extends JdbcDatabaseContainer<SELF> {
 
     private static final DockerImageName DEFAULT_IMAGE_NAME = DockerImageName.parse("mcr.microsoft.com/mssql/server");

@@ -6,6 +6,11 @@
 
 import java.util.Set;
 
+/**
+ * Testcontainers implementation for MySQL.
+ * <p>
+ * Exposed ports: 3306
+ */
 public class MySQLContainer<SELF extends MySQLContainer<SELF>> extends JdbcDatabaseContainer<SELF> {
 
     public static final String NAME = "mysql";

@@ -20,9 +20,14 @@
 import java.util.stream.Stream;
 
 /**
- * Testcontainer for Neo4j.
- *
- * @param <S> "SELF" to be used in the <code>withXXX</code> methods.
+ * Testcontainers implementation for Neo4j.
+ * <p>
+ * Exposed ports:
+ * <ul>
+ *     <li>Bolt: 7687</li>
+ *     <li>HTTP: 7474</li>
+ *     <li>HTTPS: 7473</li>
+ * </ul>
  */
 public class Neo4jContainer<S extends Neo4jContainer<S>> extends GenericContainer<S> {
 

@@ -13,6 +13,11 @@
 import java.util.Set;
 import java.util.concurrent.Future;
 
+/**
+ * Testcontainers implementation for Oracle.
+ * <p>
+ * Exposed ports: 1521
+ */
 public class OracleContainer extends JdbcDatabaseContainer<OracleContainer> {
 
     public static final String NAME = "oracle";

@@ -19,6 +19,15 @@
 import java.util.Arrays;
 import java.util.Optional;
 
+/**
+ * Testcontainers implementation for OrientDB.
+ * <p>
+ * Exposed ports:
+ * <ul>
+ *     <li>Database: 2424</li>
+ *     <li>Studio: 2480</li>
+ * </ul>
+ */
 public class OrientDBContainer extends GenericContainer<OrientDBContainer> {
 
     private static final Logger LOGGER = LoggerFactory.getLogger(OrientDBContainer.class);

@@ -8,6 +8,11 @@
 import java.time.temporal.ChronoUnit;
 import java.util.Set;
 
+/**
+ * Testcontainers implementation for PostgreSQL.
+ * <p>
+ * Exposed ports: 5432
+ */
 public class PostgreSQLContainer<SELF extends PostgreSQLContainer<SELF>> extends JdbcDatabaseContainer<SELF> {
 
     public static final String NAME = "postgresql";

@@ -5,7 +5,13 @@
 import org.testcontainers.utility.DockerImageName;
 
 /**
- * This container wraps Apache Pulsar running in standalone mode
+ * Testcontainers implementation for Apache Pulsar.
+ * <p>
+ * Exposed ports:
+ * <ul>
+ *     <li>Pulsar: 6650</li>
+ *     <li>HTTP: 8080</li>
+ * </ul>
  */
 public class PulsarContainer extends GenericContainer<PulsarContainer> {
 

@@ -6,6 +6,13 @@
 
 /**
  * Testcontainers implementation for QuestDB.
+ * <p>
+ * Exposed ports:
+ * <ul>
+ *     <li>Postgres: 8812</li>
+ *     <li>HTTP: 9000</li>
+ *     <li>ILP: 9009</li>
+ * </ul>
  */
 public class QuestDBContainer extends JdbcDatabaseContainer<QuestDBContainer> {
 

@@ -18,6 +18,14 @@
 
 /**
  * Testcontainers implementation for RabbitMQ.
+ * <p>
+ * Exposed ports:
+ * <ul>
+ *     <li>5671 (AMQPS)</li>
+ *     <li>5672 (AMQP)</li>
+ *     <li>15671 (HTTPS)</li>
+ *     <li>15672 (HTTP)</li>
+ * </ul>
  */
 public class RabbitMQContainer extends GenericContainer<RabbitMQContainer> {
 

@@ -9,6 +9,12 @@
 
 /**
  * Testcontainers implementation for Redpanda.
+ * <p>
+ * Exposed ports:
+ * <ul>
+ *     <li>Broker: 9092</li>
+ *     <li>Schema Registry: 8081</li>
+ * </ul>
  */
 public class RedpandaContainer extends GenericContainer<RedpandaContainer> {
 

@@ -16,7 +16,16 @@
 import java.util.List;
 
 /**
- * Testcontainers implementation of Solace PubSub+
+ * Testcontainers implementation of Solace PubSub+.
+ * <p>
+ * Exposed ports:
+ * <ul>
+ *     <li>AMQP: 5672</li>
+ *     <li>MQTT: 1883</li>
+ *     <li>HTTP: 9000</li>
+ *     <li>SMF: 55555</li>
+ *     <li>SMF SSL: 55443</li>
+ * </ul>
  */
 public class SolaceContainer extends GenericContainer<SolaceContainer> {
 

@@ -13,7 +13,13 @@
 import java.util.Set;
 
 /**
- * SolrContainer allows a solr container to be launched and controlled.
+ * Testcontainers implementation for Solr.
+ * <p>
+ * Exposed ports:
+ * <ul>
+ *     <li>Solr: 8983</li>
+ *     <li>Zookeeper: 9983</li>
+ * </ul>
  */
 public class SolrContainer extends GenericContainer<SolrContainer> {
 

@@ -10,6 +10,12 @@
 
 /**
  * Testcontainers implementation for TiDB.
+ * <p>
+ * Exposed ports:
+ * <ul>
+ *     <li>Database: 4000</li>
+ *     <li>HTTP: 10080</li>
+ * </ul>
  */
 public class TiDBContainer extends JdbcDatabaseContainer<TiDBContainer> {