Add javadoc for supported images (#7422)

eddumelendez · web-flow · commit f1b0b07b2959 · 2023-08-18T10:07:11.000-06:00
diff --git a/modules/azure/src/main/java/org/testcontainers/containers/CosmosDBEmulatorContainer.java b/modules/azure/src/main/java/org/testcontainers/containers/CosmosDBEmulatorContainer.java
@@ -8,6 +8,8 @@
 /**
  * Testcontainers implementation for CosmosDB Emulator.
  * <p>
+ * Supported image: {@code mcr.microsoft.com/cosmosdb/linux/azure-cosmos-emulator}
+ * <p>
  * Exposed ports: 8081
  */
 public class CosmosDBEmulatorContainer extends GenericContainer<CosmosDBEmulatorContainer> {
diff --git a/modules/cassandra/src/main/java/org/testcontainers/containers/CassandraContainer.java b/modules/cassandra/src/main/java/org/testcontainers/containers/CassandraContainer.java
@@ -21,6 +21,8 @@
 /**
  * Testcontainers implementation for Apache Cassandra.
  * <p>
+ * Supported image: {@code cassandra}
+ * <p>
  * Exposed ports: 9042
  */
 public class CassandraContainer<SELF extends CassandraContainer<SELF>> extends GenericContainer<SELF> {
diff --git a/modules/clickhouse/src/main/java/org/testcontainers/clickhouse/ClickHouseContainer.java b/modules/clickhouse/src/main/java/org/testcontainers/clickhouse/ClickHouseContainer.java
@@ -11,6 +11,8 @@
 /**
  * Testcontainers implementation for ClickHouse.
  * <p>
+ * Supported image: {@code clickhouse/clickhouse-server}
+ * <p>
  * Exposed ports:
  * <ul>
  *     <li>Database: 8123</li>
diff --git a/modules/cockroachdb/src/main/java/org/testcontainers/containers/CockroachContainer.java b/modules/cockroachdb/src/main/java/org/testcontainers/containers/CockroachContainer.java
@@ -9,6 +9,8 @@
 /**
  * Testcontainers implementation for CockroachDB.
  * <p>
+ * Supported image: {@code cockroachdb/cockroach}
+ * <p>
  * Exposed ports:
  * <ul>
  *     <li>Database: 26257</li>
diff --git a/modules/consul/src/main/java/org/testcontainers/consul/ConsulContainer.java b/modules/consul/src/main/java/org/testcontainers/consul/ConsulContainer.java
@@ -15,6 +15,8 @@
 /**
  * Testcontainers implementation for Consul.
  * <p>
+ * Supported images: {@code hashicorp/consul}, {@code consul}
+ * <p>
  * Exposed ports:
  * <ul>
  *     <li>HTTP: 8500</li>
diff --git a/modules/couchbase/src/main/java/org/testcontainers/couchbase/CouchbaseContainer.java b/modules/couchbase/src/main/java/org/testcontainers/couchbase/CouchbaseContainer.java
@@ -50,6 +50,8 @@
 /**
  * Testcontainers implementation for Couchbase.
  * <p>
+ * Supported image: {@code couchbase/server}
+ * <p>
  * Exposed ports:
  * <ul>
  *     <li>Console: 8091</li>
diff --git a/modules/cratedb/src/main/java/org/testcontainers/cratedb/CrateDBContainer.java b/modules/cratedb/src/main/java/org/testcontainers/cratedb/CrateDBContainer.java
@@ -10,6 +10,8 @@
 /**
  * Testcontainers implementation for CrateDB.
  * <p>
+ * Supported image: {@code crate}
+ * <p>
  * Exposed ports:
  * <ul>
  *     <li>Database: 5432</li>
diff --git a/modules/db2/src/main/java/org/testcontainers/containers/Db2Container.java b/modules/db2/src/main/java/org/testcontainers/containers/Db2Container.java
@@ -11,6 +11,8 @@
 /**
  * Testcontainers implementation for IBM DB2.
  * <p>
+ * Supported images: {@code icr.io/db2_community/db2}, {@code ibmcom/db2}
+ * <p>
  * Exposed ports:
  * <ul>
  *     <li>Database: 50000</li>
diff --git a/modules/elasticsearch/src/main/java/org/testcontainers/elasticsearch/ElasticsearchContainer.java b/modules/elasticsearch/src/main/java/org/testcontainers/elasticsearch/ElasticsearchContainer.java
@@ -25,6 +25,8 @@
 /**
  * Testcontainers implementation for Elasticsearch.
  * <p>
+ * Supported image: {@code docker.elastic.co/elasticsearch/elasticsearch}
+ * <p>
  * Exposed ports:
  * <ul>
  *     <li>HTTP: 9200</li>
diff --git a/modules/gcloud/src/main/java/org/testcontainers/containers/BigQueryEmulatorContainer.java b/modules/gcloud/src/main/java/org/testcontainers/containers/BigQueryEmulatorContainer.java
@@ -4,6 +4,9 @@
 
 /**
  * Testcontainers implementation for BigQuery.
+ * <p>
+ * Supported image: {@code ghcr.io/goccy/bigquery-emulator}
+ * <p>
  */
 public class BigQueryEmulatorContainer extends GenericContainer<BigQueryEmulatorContainer> {
 
diff --git a/modules/gcloud/src/main/java/org/testcontainers/containers/BigtableEmulatorContainer.java b/modules/gcloud/src/main/java/org/testcontainers/containers/BigtableEmulatorContainer.java
@@ -5,7 +5,9 @@
 
 /**
  * A Bigtable container that relies in google cloud sdk.
- *
+ * <p>
+ * Supported images: {@code gcr.io/google.com/cloudsdktool/google-cloud-cli}, {@code gcr.io/google.com/cloudsdktool/cloud-sdk}
+ * <p>
  * Default port is 9000.
  */
 public class BigtableEmulatorContainer extends GenericContainer<BigtableEmulatorContainer> {
diff --git a/modules/gcloud/src/main/java/org/testcontainers/containers/DatastoreEmulatorContainer.java b/modules/gcloud/src/main/java/org/testcontainers/containers/DatastoreEmulatorContainer.java
@@ -5,7 +5,9 @@
 
 /**
  * A Datastore container that relies in google cloud sdk.
- *
+ * <p>
+ * Supported images: {@code gcr.io/google.com/cloudsdktool/google-cloud-cli}, {@code gcr.io/google.com/cloudsdktool/cloud-sdk}
+ * <p>
  * Default port is 8081.
  */
 public class DatastoreEmulatorContainer extends GenericContainer<DatastoreEmulatorContainer> {
diff --git a/modules/gcloud/src/main/java/org/testcontainers/containers/FirestoreEmulatorContainer.java b/modules/gcloud/src/main/java/org/testcontainers/containers/FirestoreEmulatorContainer.java
@@ -5,7 +5,9 @@
 
 /**
  * A Firestore container that relies in google cloud sdk.
- *
+ * <p>
+ * Supported images: {@code gcr.io/google.com/cloudsdktool/google-cloud-cli}, {@code gcr.io/google.com/cloudsdktool/cloud-sdk}
+ * <p>
  * Default port is 8080.
  */
 public class FirestoreEmulatorContainer extends GenericContainer<FirestoreEmulatorContainer> {
diff --git a/modules/gcloud/src/main/java/org/testcontainers/containers/PubSubEmulatorContainer.java b/modules/gcloud/src/main/java/org/testcontainers/containers/PubSubEmulatorContainer.java
@@ -5,7 +5,9 @@
 
 /**
  * A PubSub container that relies in google cloud sdk.
- *
+ * <p>
+ * Supported images: {@code gcr.io/google.com/cloudsdktool/google-cloud-cli}, {@code gcr.io/google.com/cloudsdktool/cloud-sdk}
+ * <p>
  * Default port is 8085.
  */
 public class PubSubEmulatorContainer extends GenericContainer<PubSubEmulatorContainer> {
diff --git a/modules/gcloud/src/main/java/org/testcontainers/containers/SpannerEmulatorContainer.java b/modules/gcloud/src/main/java/org/testcontainers/containers/SpannerEmulatorContainer.java
@@ -5,6 +5,8 @@
 
 /**
  * A Spanner container. Default ports: 9010 for GRPC and 9020 for HTTP.
+ * <p>
+ * Supported image: {@code gcr.io/cloud-spanner-emulator/emulator}
  */
 public class SpannerEmulatorContainer extends GenericContainer<SpannerEmulatorContainer> {
 
diff --git a/modules/hivemq/src/main/java/org/testcontainers/hivemq/HiveMQContainer.java b/modules/hivemq/src/main/java/org/testcontainers/hivemq/HiveMQContainer.java
@@ -32,6 +32,8 @@
 /**
  * Testcontainers implementation for HiveMQ.
  * <p>
+ * Supported images: {@code hivemq/hivemq4}, {@code hivemq/hivemq-ce}
+ * <p>
  * Exposed ports:
  * <ul>
  *     <li>MQTT: 1883</li>
diff --git a/modules/influxdb/src/main/java/org/testcontainers/containers/InfluxDBContainer.java b/modules/influxdb/src/main/java/org/testcontainers/containers/InfluxDBContainer.java
@@ -14,6 +14,8 @@
 /**
  * Testcontainers implementation for InfluxDB.
  * <p>
+ * Supported image: {@code influxdb}
+ * <p>
  * Exposed ports: 8086
  */
 public class InfluxDBContainer<SELF extends InfluxDBContainer<SELF>> extends GenericContainer<SELF> {
diff --git a/modules/k3s/src/main/java/org/testcontainers/k3s/K3sContainer.java b/modules/k3s/src/main/java/org/testcontainers/k3s/K3sContainer.java
@@ -17,6 +17,11 @@
 import java.util.HashMap;
 import java.util.Map;
 
+/**
+ * Testcontainers implementation for K3S
+ * <p>
+ * Supported image: {@code rancher/k3s}
+ */
 public class K3sContainer extends GenericContainer<K3sContainer> {
 
     public static int KUBE_SECURE_PORT = 6443;
diff --git a/modules/kafka/src/main/java/org/testcontainers/containers/KafkaContainer.java b/modules/kafka/src/main/java/org/testcontainers/containers/KafkaContainer.java
@@ -17,6 +17,8 @@
  * Testcontainers implementation for Apache Kafka.
  * Zookeeper can be optionally configured.
  * <p>
+ * Supported image: {@code confluentinc/cp-kafka}
+ * <p>
  * Exposed ports:
  * <ul>
  *     <li>Kafka: 9093</li>
diff --git a/modules/localstack/src/main/java/org/testcontainers/containers/localstack/LocalStackContainer.java b/modules/localstack/src/main/java/org/testcontainers/containers/localstack/LocalStackContainer.java
@@ -23,6 +23,8 @@
 /**
  * Testcontainers implementation for LocalStack.
  * <p>
+ * Supported images: {@code localstack/localstack}, {@code localstack/localstack-pro}
+ * <p>
  * Exposed ports: 4566
  */
 @Slf4j
diff --git a/modules/mariadb/src/main/java/org/testcontainers/containers/MariaDBContainer.java b/modules/mariadb/src/main/java/org/testcontainers/containers/MariaDBContainer.java
@@ -9,6 +9,8 @@
 /**
  * Testcontainers implementation for MariaDB.
  * <p>
+ * Supported image: {@code mariadb}
+ * <p>
  * Exposed ports: 3306
  */
 public class MariaDBContainer<SELF extends MariaDBContainer<SELF>> extends JdbcDatabaseContainer<SELF> {
diff --git a/modules/mongodb/src/main/java/org/testcontainers/containers/MongoDBContainer.java b/modules/mongodb/src/main/java/org/testcontainers/containers/MongoDBContainer.java
@@ -13,6 +13,8 @@
 /**
  * Testcontainers implementation for MongoDB.
  * <p>
+ * Supported image: {@code mongo}
+ * <p>
  * Exposed ports: 27017
  */
 @Slf4j
diff --git a/modules/mssqlserver/src/main/java/org/testcontainers/containers/MSSQLServerContainer.java b/modules/mssqlserver/src/main/java/org/testcontainers/containers/MSSQLServerContainer.java
@@ -10,6 +10,8 @@
 /**
  * Testcontainers implementation for Microsoft SQL Server.
  * <p>
+ * Supported image: {@code mcr.microsoft.com/mssql/server}
+ * <p>
  * Exposed ports: 1433
  */
 public class MSSQLServerContainer<SELF extends MSSQLServerContainer<SELF>> extends JdbcDatabaseContainer<SELF> {
diff --git a/modules/mysql/src/main/java/org/testcontainers/containers/MySQLContainer.java b/modules/mysql/src/main/java/org/testcontainers/containers/MySQLContainer.java
@@ -9,6 +9,8 @@
 /**
  * Testcontainers implementation for MySQL.
  * <p>
+ * Supported image: {@code mysql}
+ * <p>
  * Exposed ports: 3306
  */
 public class MySQLContainer<SELF extends MySQLContainer<SELF>> extends JdbcDatabaseContainer<SELF> {
diff --git a/modules/neo4j/src/main/java/org/testcontainers/containers/Neo4jContainer.java b/modules/neo4j/src/main/java/org/testcontainers/containers/Neo4jContainer.java
@@ -22,6 +22,8 @@
 /**
  * Testcontainers implementation for Neo4j.
  * <p>
+ * Supported image: {@code neo4j}
+ * <p>
  * Exposed ports:
  * <ul>
  *     <li>Bolt: 7687</li>
diff --git a/modules/oracle-xe/src/main/java/org/testcontainers/containers/OracleContainer.java b/modules/oracle-xe/src/main/java/org/testcontainers/containers/OracleContainer.java
@@ -16,6 +16,8 @@
 /**
  * Testcontainers implementation for Oracle.
  * <p>
+ * Supported image: {@code gvenzl/oracle-xe}
+ * <p>
  * Exposed ports: 1521
  */
 public class OracleContainer extends JdbcDatabaseContainer<OracleContainer> {
diff --git a/modules/orientdb/src/main/java/org/testcontainers/containers/OrientDBContainer.java b/modules/orientdb/src/main/java/org/testcontainers/containers/OrientDBContainer.java
@@ -22,6 +22,8 @@
 /**
  * Testcontainers implementation for OrientDB.
  * <p>
+ * Supported image: {@code orientdb}
+ * <p>
  * Exposed ports:
  * <ul>
  *     <li>Database: 2424</li>
diff --git a/modules/postgresql/src/main/java/org/testcontainers/containers/PostgreSQLContainer.java b/modules/postgresql/src/main/java/org/testcontainers/containers/PostgreSQLContainer.java
@@ -11,6 +11,8 @@
 /**
  * Testcontainers implementation for PostgreSQL.
  * <p>
+ * Supported image: {@code postgres}
+ * <p>
  * Exposed ports: 5432
  */
 public class PostgreSQLContainer<SELF extends PostgreSQLContainer<SELF>> extends JdbcDatabaseContainer<SELF> {
diff --git a/modules/pulsar/src/main/java/org/testcontainers/containers/PulsarContainer.java b/modules/pulsar/src/main/java/org/testcontainers/containers/PulsarContainer.java
@@ -7,6 +7,8 @@
 /**
  * Testcontainers implementation for Apache Pulsar.
  * <p>
+ * Supported image: {@code apachepulsar/pulsar}
+ * <p>
  * Exposed ports:
  * <ul>
  *     <li>Pulsar: 6650</li>
diff --git a/modules/questdb/src/main/java/org/testcontainers/containers/QuestDBContainer.java b/modules/questdb/src/main/java/org/testcontainers/containers/QuestDBContainer.java
@@ -7,6 +7,8 @@
 /**
  * Testcontainers implementation for QuestDB.
  * <p>
+ * Supported image: {@code questdb/questdb}
+ * <p>
  * Exposed ports:
  * <ul>
  *     <li>Postgres: 8812</li>
diff --git a/modules/rabbitmq/src/main/java/org/testcontainers/containers/RabbitMQContainer.java b/modules/rabbitmq/src/main/java/org/testcontainers/containers/RabbitMQContainer.java
@@ -19,6 +19,8 @@
 /**
  * Testcontainers implementation for RabbitMQ.
  * <p>
+ * Supported image: {@code rabbitmq}
+ * <p>
  * Exposed ports:
  * <ul>
  *     <li>5671 (AMQPS)</li>
diff --git a/modules/redpanda/src/main/java/org/testcontainers/redpanda/RedpandaContainer.java b/modules/redpanda/src/main/java/org/testcontainers/redpanda/RedpandaContainer.java
@@ -30,6 +30,8 @@
 /**
  * Testcontainers implementation for Redpanda.
  * <p>
+ * Supported images: {@code docker.redpanda.com/redpandadata/redpanda}, {@code docker.redpanda.com/vectorized/redpanda}
+ * <p>
  * Exposed ports:
  * <ul>
  *     <li>Broker: 9092</li>
diff --git a/modules/selenium/src/main/java/org/testcontainers/containers/BrowserWebDriverContainer.java b/modules/selenium/src/main/java/org/testcontainers/containers/BrowserWebDriverContainer.java
@@ -42,7 +42,10 @@
 /**
  * A chrome/firefox/custom container based on SeleniumHQ's standalone container sets.
  * <p>
- * The container should expose Selenium remote control protocol and VNC.
+ * Supported images: {@code selenium/standalone-chrome}, {@code selenium/standalone-firefox},
+ * {@code selenium/standalone-edge}, {@code selenium/standalone-chrome-debug}, {@code selenium/standalone-firefox-debug}
+ * <p>
+ * Exposed ports: 4444
  */
 public class BrowserWebDriverContainer<SELF extends BrowserWebDriverContainer<SELF>>
     extends GenericContainer<SELF>
diff --git a/modules/solace/src/main/java/org/testcontainers/solace/SolaceContainer.java b/modules/solace/src/main/java/org/testcontainers/solace/SolaceContainer.java
@@ -18,6 +18,8 @@
 /**
  * Testcontainers implementation of Solace PubSub+.
  * <p>
+ * Supported image: {@code solace/solace-pubsub-standard}
+ * <p>
  * Exposed ports:
  * <ul>
  *     <li>Console: 8080</li>
diff --git a/modules/solr/src/main/java/org/testcontainers/containers/SolrContainer.java b/modules/solr/src/main/java/org/testcontainers/containers/SolrContainer.java
@@ -15,6 +15,8 @@
 /**
  * Testcontainers implementation for Solr.
  * <p>
+ * Supported image: {@code solr}
+ * <p>
  * Exposed ports:
  * <ul>
  *     <li>Solr: 8983</li>
diff --git a/modules/tidb/src/main/java/org/testcontainers/tidb/TiDBContainer.java b/modules/tidb/src/main/java/org/testcontainers/tidb/TiDBContainer.java
@@ -11,6 +11,8 @@
 /**
  * Testcontainers implementation for TiDB.
  * <p>
+ * Supported image: {@code pingcap/tidb}
+ * <p>
  * Exposed ports:
  * <ul>
  *     <li>Database: 4000</li>
diff --git a/modules/toxiproxy/src/main/java/org/testcontainers/containers/ToxiproxyContainer.java b/modules/toxiproxy/src/main/java/org/testcontainers/containers/ToxiproxyContainer.java
@@ -19,6 +19,8 @@
 /**
  * Testcontainers implementation for Toxiproxy.
  * <p>
+ * Supported images: {@code ghcr.io/shopify/toxiproxy}, {@code shopify/toxiproxy}
+ * <p>
  * Exposed ports:
  * <ul>
  *     <li>HTTP: 8474</li>
diff --git a/modules/trino/src/main/java/org/testcontainers/containers/TrinoContainer.java b/modules/trino/src/main/java/org/testcontainers/containers/TrinoContainer.java
@@ -12,6 +12,8 @@
 /**
  * Testcontainers implementation for TrinoDB.
  * <p>
+ * Supported image: {@code trinodb/trino}
+ * <p>
  * Exposed ports: 8080
  */
 public class TrinoContainer extends JdbcDatabaseContainer<TrinoContainer> {
diff --git a/modules/vault/src/main/java/org/testcontainers/vault/VaultContainer.java b/modules/vault/src/main/java/org/testcontainers/vault/VaultContainer.java
@@ -18,6 +18,8 @@
 /**
  * Testcontainers implementation for Vault.
  * <p>
+ * Supported image: {@code hashicorp/vault}, {@code vault}
+ * <p>
  * Exposure ports: 8200
  */
 public class VaultContainer<SELF extends VaultContainer<SELF>> extends GenericContainer<SELF> {
diff --git a/modules/yugabytedb/src/main/java/org/testcontainers/containers/YugabyteDBYCQLContainer.java b/modules/yugabytedb/src/main/java/org/testcontainers/containers/YugabyteDBYCQLContainer.java
@@ -14,6 +14,8 @@
 /**
  * Testcontainers implementation for YugabyteDB YCQL API.
  * <p>
+ * Supported image: {@code yugabytedb/yugabyte}
+ * <p>
  * Exposed ports:
  * <ul>
  *     <li>YCQL: 5433</li>
diff --git a/modules/yugabytedb/src/main/java/org/testcontainers/containers/YugabyteDBYSQLContainer.java b/modules/yugabytedb/src/main/java/org/testcontainers/containers/YugabyteDBYSQLContainer.java
@@ -10,6 +10,8 @@
 /**
  * Testcontainers implementation for YugabyteDB YSQL API.
  * <p>
+ * Supported image: {@code yugabytedb/yugabyte}
+ * <p>
  * Exposed ports:
  * <ul>
  *     <li>YSQL: 5433</li>
