Skip to content

Commit

Permalink
HSEARCH-4674 Update comments on TestRunner classes
Browse files Browse the repository at this point in the history
  • Loading branch information
yrodiere authored and marko-bekhta committed Nov 7, 2023
1 parent 88bec75 commit 7d9faad
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 10 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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")
Expand Down

0 comments on commit 7d9faad

Please sign in to comment.