Change Maven config to allow skipping Lucene or Elasticsearch tests f…

…rom the Maven CLI
hibernate · Sep 20, 2023 · d87e279 · d87e279
1 parent 7b705ae
commit d87e279
Show file tree

Hide file tree

Showing 20 changed files with 139 additions and 17 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -222,6 +222,10 @@ and run unit tests and integration tests.
 ./mvnw clean install
 ```
 
+Note: on Windows, you will need a Docker install able to run Linux containers.
+If you don't have that, you can skip the Elasticsearch tests:
+`./mvnw clean install -Dtest.elasticsearch.skip=true`.
+
 Note: the produced JARs are compatible with Java 8 and later,
 regardless of the JDK used to build Hibernate Search.
 
@@ -302,6 +306,17 @@ Or more simply, if the newer JDK you want to test against is newer than 17 and i
 ./mvnw clean install -Djava-version.test.release=18
 ```
 
+### Lucene
+
+The Lucene integration tests do not, by themselves,
+require any external setup.
+
+If you are not interested in Lucene integration tests (e.g. you only want to test Elasticsearch),
+you can skip all Lucene tests with:
+
+```bash
+./mvnw clean install -Dtest.lucene.skip=true
+```
 ### Elasticsearch
 
 The Elasticsearch integration tests run against one single version of Elasticsearch at a time,
@@ -324,6 +339,13 @@ For available versions of [OpenSearch](https://www.opensearch.org/) distribution
 
 For Amazon OpenSearch Serverless, the version must be unset (set to an empty string).
 
+When necessary (e.g. you don't have Docker, or are on Windows and can't run Linux containers),
+you can skip all Elasticsearch tests (and thus the Elasticsearch container startup) with:
+
+```bash
+./mvnw clean install -Dtest.elasticsearch.skip=true
+```
+
 Alternatively, you can prevent the build from launching an Elasticsearch server automatically
 and run Elasticsearch-related tests against your own server using the
 `test.elasticsearch.connection.uris` property:

diff --git a/build/parents/build/pom.xml b/build/parents/build/pom.xml
@@ -183,17 +183,27 @@
         <!-- Containers executions tests properties -->
         <test.containers.run.skip>false</test.containers.run.skip>
 
+        <!-- Lucene tests properties -->
+
+        <!-- To skip all Lucene tests from the CLI -->
+        <test.lucene.skip>false</test.lucene.skip>
+
         <!-- Elasticsearch tests properties -->
 
+        <!-- To skip all Elasticsearch tests from the CLI -->
+        <test.elasticsearch.skip>false</test.elasticsearch.skip>
+
         <!-- Control how an Elasticsearch instance is run automatically during tests -->
         <!-- By default, the plugin is not skipped, but each container (elastic, opensearch, etc.) is skipped;
              Maven profiles will re-enable the right container depending on configuration.
           -->
         <test.elasticsearch.run.skip>true</test.elasticsearch.run.skip>
-
-        <!-- If an external connection url is defined this property will be true -->
-        <!-- See elasticsearch-run and elasticsearch-do-not-run profiles -->
-        <test.elasticsearch.connection.uris.defined></test.elasticsearch.connection.uris.defined>
+        <!-- This is set to true automatically when the Elasticsearch instance should not be started
+             even for modules that include Elasticsearch tests,
+             be it because Elasticsearch tests are disabled
+             or because an Elasticsearch instance is provided externally.
+             See elasticsearch-run, elasticsearch-test-skip and elasticsearch-do-not-run profiles -->
+        <test.elasticsearch.run.skip.forRelevantModules>false</test.elasticsearch.run.skip.forRelevantModules>
 
         <!--
              These properties are transparently passed as system properties to integration tests,

diff --git a/build/parents/integrationtest/pom.xml b/build/parents/integrationtest/pom.xml
@@ -467,7 +467,6 @@
             </activation>
             <properties>
                 <test.elasticsearch.connection.uris>http://localhost:9200</test.elasticsearch.connection.uris>
-                <test.elasticsearch.connection.uris.defined>false</test.elasticsearch.connection.uris.defined>
             </properties>
         </profile>
         <!-- Profile enabled when an Elasticsearch instance must NOT be run by Maven -->
@@ -480,7 +479,21 @@
                 </property>
             </activation>
             <properties>
-                <test.elasticsearch.connection.uris.defined>true</test.elasticsearch.connection.uris.defined>
+                <test.elasticsearch.run.skip.forRelevantModules>true</test.elasticsearch.run.skip.forRelevantModules>
+            </properties>
+        </profile>
+        <!-- Profile enabled when Elasticsearch tests are skipped -->
+        <profile>
+            <id>elasticsearch-test-skip</id>
+            <activation>
+                <!-- Activate if test.elasticsearch.connection.uris has been defined explicitly -->
+                <property>
+                    <name>test.elasticsearch.skip</name>
+                    <value>true</value>
+                </property>
+            </activation>
+            <properties>
+                <test.elasticsearch.run.skip.forRelevantModules>true</test.elasticsearch.run.skip.forRelevantModules>
             </properties>
         </profile>
 

diff --git a/documentation/pom.xml b/documentation/pom.xml
@@ -20,7 +20,7 @@
     <description>Hibernate Search reference documentation</description>
 
     <properties>
-        <test.elasticsearch.run.skip>${test.elasticsearch.connection.uris.defined}</test.elasticsearch.run.skip>
+        <test.elasticsearch.run.skip>${test.elasticsearch.run.skip.forRelevantModules}</test.elasticsearch.run.skip>
         <test.database.run.skip>false</test.database.run.skip>
 
         <asciidoctor.base-output-dir>${project.build.directory}/asciidoctor/</asciidoctor.base-output-dir>
@@ -128,6 +128,7 @@
                             <goal>integration-test</goal>
                         </goals>
                         <configuration>
+                            <skip>${test.lucene.skip}</skip>
                             <reportNameSuffix>${surefire.reportNameSuffix}-lucene</reportNameSuffix>
                             <classpathDependencyExcludes>
                                 <classpathDependencyExclude>org.hibernate.search:hibernate-search-backend-elasticsearch</classpathDependencyExclude>
@@ -146,6 +147,7 @@
                             <goal>integration-test</goal>
                         </goals>
                         <configuration>
+                            <skip>${test.elasticsearch.skip}</skip>
                             <reportNameSuffix>${surefire.reportNameSuffix}-elasticsearch</reportNameSuffix>
                             <classpathDependencyExcludes>
                                 <classpathDependencyExclude>org.hibernate.search:hibernate-search-backend-lucene</classpathDependencyExclude>

diff --git a/integrationtest/backend/elasticsearch/pom.xml b/integrationtest/backend/elasticsearch/pom.xml
@@ -15,7 +15,7 @@
     <properties>
         <surefire.module>elasticsearch</surefire.module>
 
-        <test.elasticsearch.run.skip>${test.elasticsearch.connection.uris.defined}</test.elasticsearch.run.skip>
+        <test.elasticsearch.run.skip>${test.elasticsearch.run.skip.forRelevantModules}</test.elasticsearch.run.skip>
     </properties>
 
     <dependencies>
@@ -72,6 +72,7 @@
                             <goal>verify</goal>
                         </goals>
                         <configuration>
+                            <skip>${test.elasticsearch.skip}</skip>
                             <!-- WARNING: When using <dependenciesToScan>, be sure to set the Maven property surefire.module -->
                             <dependenciesToScan>
                                 <dependency>${project.groupId}:hibernate-search-integrationtest-backend-tck</dependency>

diff --git a/integrationtest/backend/lucene/pom.xml b/integrationtest/backend/lucene/pom.xml
@@ -52,6 +52,7 @@
                             <goal>verify</goal>
                         </goals>
                         <configuration>
+                            <skip>${test.lucene.skip}</skip>
                             <!-- WARNING: When using <dependenciesToScan>, be sure to set the Maven property surefire.module -->
                             <dependenciesToScan>
                                 <dependency>${project.groupId}:hibernate-search-integrationtest-backend-tck</dependency>

diff --git a/integrationtest/java/modules/orm-coordination-outbox-polling-elasticsearch/pom.xml b/integrationtest/java/modules/orm-coordination-outbox-polling-elasticsearch/pom.xml
@@ -17,7 +17,7 @@
     <description>Hibernate Search integration tests for Java 11+ modules</description>
 
     <properties>
-        <test.elasticsearch.run.skip>${test.elasticsearch.connection.uris.defined}</test.elasticsearch.run.skip>
+        <test.elasticsearch.run.skip>${test.elasticsearch.run.skip.forRelevantModules}</test.elasticsearch.run.skip>
         <test.database.run.skip>false</test.database.run.skip>
 
         <maven.compiler.release>11</maven.compiler.release>
@@ -89,6 +89,9 @@
                             <goal>integration-test</goal>
                             <goal>verify</goal>
                         </goals>
+                        <configuration>
+                            <skip>${test.elasticsearch.skip}</skip>
+                        </configuration>
                     </execution>
                 </executions>
             </plugin>

diff --git a/integrationtest/java/modules/orm-elasticsearch/pom.xml b/integrationtest/java/modules/orm-elasticsearch/pom.xml
@@ -17,7 +17,7 @@
     <description>Hibernate Search integration tests for Java 11+ modules</description>
 
     <properties>
-        <test.elasticsearch.run.skip>${test.elasticsearch.connection.uris.defined}</test.elasticsearch.run.skip>
+        <test.elasticsearch.run.skip>${test.elasticsearch.run.skip.forRelevantModules}</test.elasticsearch.run.skip>
         <test.database.run.skip>false</test.database.run.skip>
 
         <maven.compiler.release>11</maven.compiler.release>
@@ -71,6 +71,9 @@
                             <goal>integration-test</goal>
                             <goal>verify</goal>
                         </goals>
+                        <configuration>
+                            <skip>${test.elasticsearch.skip}</skip>
+                        </configuration>
                     </execution>
                 </executions>
             </plugin>

diff --git a/integrationtest/java/modules/orm-lucene/pom.xml b/integrationtest/java/modules/orm-lucene/pom.xml
@@ -66,6 +66,9 @@
                             <goal>integration-test</goal>
                             <goal>verify</goal>
                         </goals>
+                        <configuration>
+                            <skip>${test.lucene.skip}</skip>
+                        </configuration>
                     </execution>
                 </executions>
             </plugin>

diff --git a/integrationtest/java/modules/pojo-standalone-elasticsearch/pom.xml b/integrationtest/java/modules/pojo-standalone-elasticsearch/pom.xml
@@ -17,7 +17,7 @@
     <description>Hibernate Search integration tests for Java 11+ modules</description>
 
     <properties>
-        <test.elasticsearch.run.skip>${test.elasticsearch.connection.uris.defined}</test.elasticsearch.run.skip>
+        <test.elasticsearch.run.skip>${test.elasticsearch.run.skip.forRelevantModules}</test.elasticsearch.run.skip>
         <test.database.run.skip>false</test.database.run.skip>
 
         <maven.compiler.release>11</maven.compiler.release>
@@ -63,6 +63,9 @@
                             <goal>integration-test</goal>
                             <goal>verify</goal>
                         </goals>
+                        <configuration>
+                            <skip>${test.elasticsearch.skip}</skip>
+                        </configuration>
                     </execution>
                 </executions>
             </plugin>

diff --git a/integrationtest/java/modules/pojo-standalone-lucene/pom.xml b/integrationtest/java/modules/pojo-standalone-lucene/pom.xml
@@ -58,6 +58,9 @@
                             <goal>integration-test</goal>
                             <goal>verify</goal>
                         </goals>
+                        <configuration>
+                            <skip>${test.lucene.skip}</skip>
+                        </configuration>
                     </execution>
                 </executions>
             </plugin>

diff --git a/integrationtest/mapper/orm-batch-jsr352/pom.xml b/integrationtest/mapper/orm-batch-jsr352/pom.xml
@@ -13,7 +13,7 @@
     <description>Hibernate Search integration tests for the Batch JSR-352 integration</description>
 
     <properties>
-        <test.elasticsearch.run.skip>${test.elasticsearch.connection.uris.defined}</test.elasticsearch.run.skip>
+        <test.elasticsearch.run.skip>${test.elasticsearch.run.skip.forRelevantModules}</test.elasticsearch.run.skip>
         <test.database.run.skip>false</test.database.run.skip>
 
         <surefire.jvm.args.module>

diff --git a/integrationtest/mapper/orm-realbackend/pom.xml b/integrationtest/mapper/orm-realbackend/pom.xml
@@ -13,8 +13,11 @@
     <description>Hibernate Search integration tests for the Hibernate ORM mapper with a real (non-mock) backend</description>
 
     <properties>
-        <test.elasticsearch.run.skip>${test.elasticsearch.connection.uris.defined}</test.elasticsearch.run.skip>
+        <test.elasticsearch.run.skip>${test.elasticsearch.run.skip.forRelevantModules}</test.elasticsearch.run.skip>
         <test.database.run.skip>false</test.database.run.skip>
+
+        <!-- See profiles below -->
+        <test.multiplebackends.skip>false</test.multiplebackends.skip>
     </properties>
 
     <dependencies>
@@ -77,6 +80,7 @@
                             <goal>integration-test</goal>
                         </goals>
                         <configuration>
+                            <skip>${test.lucene.skip}</skip>
                             <reportNameSuffix>${surefire.reportNameSuffix}-lucene</reportNameSuffix>
                             <classpathDependencyExcludes>
                                 <classpathDependencyExclude>org.hibernate.search:hibernate-search-backend-elasticsearch</classpathDependencyExclude>
@@ -96,6 +100,7 @@
                             <goal>integration-test</goal>
                         </goals>
                         <configuration>
+                            <skip>${test.elasticsearch.skip}</skip>
                             <reportNameSuffix>${surefire.reportNameSuffix}-elasticsearch</reportNameSuffix>
                             <classpathDependencyExcludes>
                                 <classpathDependencyExclude>org.hibernate.search:hibernate-search-backend-lucene</classpathDependencyExclude>
@@ -115,6 +120,7 @@
                             <goal>integration-test</goal>
                         </goals>
                         <configuration>
+                            <skip>${test.multiplebackends.skip}</skip>
                             <reportNameSuffix>${surefire.reportNameSuffix}-multiplebackends</reportNameSuffix>
                             <includes>
                                 <include>org.hibernate.search.integrationtest.mapper.orm.realbackend.bootstrap.BackendTypeAutoDetectMultipleBackendTypesInClasspathIT</include>
@@ -138,5 +144,31 @@
         </plugins>
     </build>
 
+    <profiles>
+        <profile>
+            <id>skipLuceneTests</id>
+            <activation>
+                <property>
+                    <name>test.lucene.skip</name>
+                    <value>true</value>
+                </property>
+            </activation>
+            <properties>
+                <test.multiplebackends.skip>true</test.multiplebackends.skip>
+            </properties>
+        </profile>
+        <profile>
+            <id>skipElasticsearchTests</id>
+            <activation>
+                <property>
+                    <name>test.elasticsearch.skip</name>
+                    <value>true</value>
+                </property>
+            </activation>
+            <properties>
+                <test.multiplebackends.skip>true</test.multiplebackends.skip>
+            </properties>
+        </profile>
+    </profiles>
 </project>
 
diff --git a/integrationtest/mapper/orm-spring-uberjar/application/pom.xml b/integrationtest/mapper/orm-spring-uberjar/application/pom.xml
@@ -68,7 +68,6 @@
         </dependency>
     </dependencies>
 
-
     <build>
         <plugins>
             <plugin>
@@ -123,5 +122,20 @@
             </plugin>
         </plugins>
     </build>
+
+    <profiles>
+        <profile>
+            <id>skipLuceneTests</id>
+            <activation>
+                <property>
+                    <name>test.lucene.skip</name>
+                    <value>true</value>
+                </property>
+            </activation>
+            <properties>
+                <failsafe.spring.skip>true</failsafe.spring.skip>
+            </properties>
+        </profile>
+    </profiles>
 </project>
 
diff --git a/integrationtest/mapper/pojo-standalone-realbackend/pom.xml b/integrationtest/mapper/pojo-standalone-realbackend/pom.xml
@@ -13,7 +13,7 @@
     <description>Hibernate Search integration tests for the POJO Standalone mapper with a real (non-mock) backend</description>
 
     <properties>
-        <test.elasticsearch.run.skip>${test.elasticsearch.connection.uris.defined}</test.elasticsearch.run.skip>
+        <test.elasticsearch.run.skip>${test.elasticsearch.run.skip.forRelevantModules}</test.elasticsearch.run.skip>
     </properties>
 
     <dependencies>
@@ -63,6 +63,7 @@
                             <goal>integration-test</goal>
                         </goals>
                         <configuration>
+                            <skip>${test.lucene.skip}</skip>
                             <reportNameSuffix>${surefire.reportNameSuffix}-lucene</reportNameSuffix>
                             <classpathDependencyExcludes>
                                 <classpathDependencyExclude>org.hibernate.search:hibernate-search-backend-elasticsearch</classpathDependencyExclude>
@@ -81,6 +82,7 @@
                             <goal>integration-test</goal>
                         </goals>
                         <configuration>
+                            <skip>${test.elasticsearch.skip}</skip>
                             <reportNameSuffix>${surefire.reportNameSuffix}-elasticsearch</reportNameSuffix>
                             <classpathDependencyExcludes>
                                 <classpathDependencyExclude>org.hibernate.search:hibernate-search-backend-lucene</classpathDependencyExclude>

diff --git a/integrationtest/performance/backend/elasticsearch/pom.xml b/integrationtest/performance/backend/elasticsearch/pom.xml
@@ -22,7 +22,7 @@
         <!-- We don't want to use a Jacoco agent here, and we don't want to rely on these tests for coverage either -->
         <jacoco.skip>true</jacoco.skip>
 
-        <test.elasticsearch.run.skip>${test.elasticsearch.connection.uris.defined}</test.elasticsearch.run.skip>
+        <test.elasticsearch.run.skip>${test.elasticsearch.run.skip.forRelevantModules}</test.elasticsearch.run.skip>
     </properties>
 
     <dependencies>
@@ -59,6 +59,9 @@
                             <goal>integration-test</goal>
                             <goal>verify</goal>
                         </goals>
+                        <configuration>
+                            <skip>${test.elasticsearch.skip}</skip>
+                        </configuration>
                     </execution>
                 </executions>
             </plugin>

diff --git a/integrationtest/performance/backend/lucene/pom.xml b/integrationtest/performance/backend/lucene/pom.xml
@@ -53,6 +53,9 @@
                             <goal>integration-test</goal>
                             <goal>verify</goal>
                         </goals>
+                        <configuration>
+                            <skip>${test.lucene.skip}</skip>
+                        </configuration>
                     </execution>
                 </executions>
             </plugin>