From 8918af4a99f82e016c40b89ef897c71003c085fa Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Yoann=20Rodi=C3=A8re?= <yoann@hibernate.org>
Date: Tue, 7 Nov 2023 13:42:51 +0100
Subject: [PATCH] HSEARCH-4674 Update comments on TestRunner classes

---
 .../util/ElasticsearchTckTestRunner.java            | 13 ++++++-------
 .../testsupport/util/LuceneTckTestRunner.java       |  5 +++--
 .../util/OutboxPollingOrmTestRunner.java            |  6 +++++-
 3 files changed, 14 insertions(+), 10 deletions(-)

diff --git a/integrationtest/backend/elasticsearch/src/test/java/org/hibernate/search/integrationtest/backend/elasticsearch/testsupport/util/ElasticsearchTckTestRunner.java b/integrationtest/backend/elasticsearch/src/test/java/org/hibernate/search/integrationtest/backend/elasticsearch/testsupport/util/ElasticsearchTckTestRunner.java
index 355ec8a59ef..f61f6a877e6 100644
--- a/integrationtest/backend/elasticsearch/src/test/java/org/hibernate/search/integrationtest/backend/elasticsearch/testsupport/util/ElasticsearchTckTestRunner.java
+++ b/integrationtest/backend/elasticsearch/src/test/java/org/hibernate/search/integrationtest/backend/elasticsearch/testsupport/util/ElasticsearchTckTestRunner.java
@@ -13,17 +13,16 @@
 
 /**
  * Helper for running specific TCK tests against the Elasticsearch backend from the IDE.
- *
- * <p>Adapt the classpath filter as needed to run a single test or an entire test package.
- *
- * <p>Running such tests from the IDE will require having an Elasticsearch
- * node running. You can easily start one by running 'mvn elasticsearch:runforked -Des.setAwait=true'
- * from this module's directory.
+ * <p>
+ * Adapt the {@code @IncludeClassNamePatterns}/{@code @SelectPackages} annotation as needed
+ * to run a single test or an entire test package.
+ * <p>
+ * Elasticsearch will be started automatically using TestContainers.
  *
  * @author Gunnar Morling
  */
 @Suite
-@SuiteDisplayName("Lucene TCK tests Runner")
+@SuiteDisplayName("Elasticsearch TCK tests Runner")
 // Defines a "root" package, subpackages are included. Use Include/Exclude ClassNamePatterns annotations to limit the executed tests:
 @SelectPackages("org.hibernate.search.integrationtest.backend.tck")
 // Default class pattern does not include IT tests, hence we want to customize it a bit:
diff --git a/integrationtest/backend/lucene/src/test/java/org/hibernate/search/integrationtest/backend/lucene/testsupport/util/LuceneTckTestRunner.java b/integrationtest/backend/lucene/src/test/java/org/hibernate/search/integrationtest/backend/lucene/testsupport/util/LuceneTckTestRunner.java
index da4935f7bb7..dabe1b14bc8 100644
--- a/integrationtest/backend/lucene/src/test/java/org/hibernate/search/integrationtest/backend/lucene/testsupport/util/LuceneTckTestRunner.java
+++ b/integrationtest/backend/lucene/src/test/java/org/hibernate/search/integrationtest/backend/lucene/testsupport/util/LuceneTckTestRunner.java
@@ -13,8 +13,9 @@
 
 /**
  * Helper for running specific TCK tests against the Lucene backend from the IDE.
- *
- * <p>Adapt the classpath filter as needed to run a single test or an entire test package.
+ * <p>
+ * Adapt the {@code @IncludeClassNamePatterns}/{@code @SelectPackages} annotation as needed
+ * to run a single test or an entire test package.
  *
  * @author Gunnar Morling
  */
diff --git a/integrationtest/mapper/orm-outbox-polling/src/test/java/org/hibernate/search/integrationtest/mapper/orm/outboxpolling/testsupport/util/OutboxPollingOrmTestRunner.java b/integrationtest/mapper/orm-outbox-polling/src/test/java/org/hibernate/search/integrationtest/mapper/orm/outboxpolling/testsupport/util/OutboxPollingOrmTestRunner.java
index 9de0ad91bf7..824d514d5f8 100644
--- a/integrationtest/mapper/orm-outbox-polling/src/test/java/org/hibernate/search/integrationtest/mapper/orm/outboxpolling/testsupport/util/OutboxPollingOrmTestRunner.java
+++ b/integrationtest/mapper/orm-outbox-polling/src/test/java/org/hibernate/search/integrationtest/mapper/orm/outboxpolling/testsupport/util/OutboxPollingOrmTestRunner.java
@@ -14,7 +14,11 @@
 /**
  * Helper for running specific Hibernate ORM integration tests with outbox-polling from the IDE.
  * <p>
- * Adapt the classpath filter as needed to run a single test or an entire test package.
+ * Adapt the {@code @IncludeClassNamePatterns}/{@code @SelectPackages} annotation as needed
+ * to run a single test or an entire test package.
+ * <p>
+ * If tests against a non-H2 database are requested (e.g. with the ci-postgressql Maven profile),
+ * the database will be started automatically using TestContainers.
  */
 @Suite
 @SuiteDisplayName("Outbox polling tests Runner")