convert example project into maven integration test

Author: stefanseifert

.github/workflows/maven-build.yml

@@ -42,6 +42,3 @@ jobs:
           sonar-run-on-java-version: 11
           sonar-token: ${{ secrets.SONAR_TOKEN }}
           github-token: ${{ secrets.GITHUB_TOKEN }}
-
-      - name: Build and verify example
-        run: ./mvnw -s ./.maven-settings.xml -Pcontinuous-integration -B -U clean verify -f example

pom.xml

@@ -52,8 +52,6 @@
     <module>conga-aem-plugin</module>
     <module>tooling/conga-aem-maven-plugin</module>
     <module>tooling/conga-aem-crypto-cli</module>
-    <!-- This is not included in main build due to conga-maven-plugin plugin dependency -->
-    <!--module>example</module-->
   </modules>
 
   <build>

src/site/markdown/usage.md

@@ -5,10 +5,8 @@ For basic CONGA usage see [CONGA documentation][conga-usage].
 
 ### CONGA AEM Plugin
 
-An example using the CONGA AEM plugin-specific features is in this GIT repository:<br/>
-https://github.com/wcm-io-devops/conga-aem-plugin
-
-In a subdirectory `example`.
+An example using the CONGA AEM plugin-specific features:<br/>
+https://github.com/wcm-io-devops/conga-aem-plugin/tree/develop/tooling/conga-aem-maven-plugin/src/it/example
 
 
 ### CONGA Maven AEM Plugin

tooling/conga-aem-maven-plugin/pom.xml

@@ -38,8 +38,12 @@
   <description>wcm.io DevOps CONGA - CONfiguration GenerAtor Maven Plugin for AEM</description>
 
   <properties>
-    <maven.version>3.0.5</maven.version>
+    <maven.version>3.3.9</maven.version>
     <site.url.module.prefix>tooling/conga-aem-maven-plugin</site.url.module.prefix>
+
+    <!-- Enable recording of coverage during execution of maven-invoker-plugin -->
+    <jacoco.propertyName>invoker.mavenOpts</jacoco.propertyName>
+    <jacoco.includes>org.jacoco.maven.*</jacoco.includes>
   </properties>
 
   <prerequisites>
@@ -175,6 +179,88 @@
         </executions>
       </plugin>
 
+      <!-- Merge Jacoco results from unit tests and integration tests -->
+      <plugin>
+        <groupId>org.jacoco</groupId>
+        <artifactId>jacoco-maven-plugin</artifactId>
+        <executions>
+          <execution>
+            <id>before-unit-test-execution</id>
+            <goals>
+              <goal>prepare-agent</goal>
+            </goals>
+            <configuration>
+              <destFile>${project.build.directory}/jacoco-output/jacoco-unit-tests.exec</destFile>
+              <propertyName>surefire.jacoco.args</propertyName>
+            </configuration>
+          </execution>
+          <execution>
+            <id>before-integration-test-execution</id>
+            <goals>
+              <goal>prepare-agent-integration</goal>
+             </goals>
+            <configuration>
+              <destFile>${project.build.directory}/jacoco-output/jacoco-integration-tests.exec</destFile>
+              <propertyName>invoker.jacoco.args</propertyName>
+            </configuration>
+          </execution>
+          <execution>
+            <id>merge-unit-and-integration</id>
+            <phase>post-integration-test</phase>
+            <goals>
+              <goal>merge</goal>
+            </goals>
+            <configuration>
+              <fileSets>
+                <fileSet>
+                  <directory>${project.build.directory}/jacoco-output</directory>
+                  <includes>
+                    <include>*.exec</include>
+                  </includes>
+                </fileSet>
+              </fileSets>
+            </configuration>
+          </execution>
+        </executions>
+      </plugin>
+
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-surefire-plugin</artifactId>
+        <configuration>
+          <argLine>${surefire.jacoco.args}</argLine>
+        </configuration>
+      </plugin>
+
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-invoker-plugin</artifactId>
+        <version>3.2.2</version>
+        <configuration>
+          <projectsDirectory>src/it</projectsDirectory>
+          <cloneProjectsTo>${project.build.directory}/it</cloneProjectsTo>
+          <pomIncludes>
+            <pomInclude>*/pom.xml</pomInclude>
+          </pomIncludes>
+          <postBuildHookScript>verify</postBuildHookScript>
+          <streamLogsOnFailures>true</streamLogsOnFailures>
+          <extraArtifacts>
+            <extraArtifact>org.jacoco:org.jacoco.agent:${jacoco-maven-plugin.version}:jar:runtime</extraArtifact>
+          </extraArtifacts>
+          <mavenOpts>${invoker.jacoco.args}</mavenOpts>
+        </configuration>
+        <executions>
+          <execution>
+            <id>integration-test</id>
+            <goals>
+              <goal>install</goal>
+              <goal>integration-test</goal>
+              <goal>verify</goal>
+            </goals>
+          </execution>
+        </executions>
+      </plugin>
+
     </plugins>
     <pluginManagement>
       <plugins>

example/README.md …em-maven-plugin/src/it/example/README.mdexample/README.md renamed to tooling/conga-aem-maven-plugin/src/it/example/README.md example/README.md renamed to tooling/conga-aem-maven-plugin/src/it/example/README.md

@@ -0,0 +1 @@
+invoker.goals = clean verify

tooling/conga-aem-maven-plugin/src/it/example/invoker.properties

@@ -65,7 +65,7 @@
           <dependency>
             <groupId>io.wcm.devops.conga.plugins</groupId>
             <artifactId>io.wcm.devops.conga.plugins.aem</artifactId>
-            <version>2.16.3-SNAPSHOT</version>
+            <version>@project.version@</version>
           </dependency>
 
         </dependencies>