Merge pull request #557 from xdev-software/develop

Release

Author: AB-xdev

.github/workflows/run-integration-tests.yml

@@ -27,12 +27,19 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        java: [21]
         project: [persistence-it, webapp-it]
         parallel: [0, 2]
         pre-start: [false, true]
+        java: [21]
+        include:
+          - project: webapp-it
+            jacoco: true
+            video: true
+    name: "run-integration-tests (${{matrix.project}}, ${{matrix.parallel}}, ${{matrix.pre-start}}, ${{matrix.java}})"
     runs-on: ubuntu-latest
     if: ${{ !(github.event_name == 'pull_request' && startsWith(github.head_ref, 'renovate/')) }}
+    permissions:
+      checks: write # JaCoCo Coverage Report check
     steps:
     - uses: actions/checkout@v6
 
@@ -55,21 +62,54 @@ jobs:
       run: |
         ./mvnw -B test \
         -pl "advanced-demo/integration-tests/${{ matrix.project }}" -am \
-        -P run-it \
+        -P run-it${{ matrix.jacoco && ',jacoco' || '' }} \
         ${{ matrix.pre-start && '-Dinfra-pre-start.enabled=1 ' || '' }} \
         ${{ matrix.parallel > 0 && format('-Djunit.jupiter.execution.parallel.enabled=true -Djunit.jupiter.execution.parallel.mode.default=concurrent -Djunit.jupiter.execution.parallel.mode.classes.default=concurrent -Djunit.jupiter.execution.parallel.config.strategy=fixed -Djunit.jupiter.execution.parallel.config.fixed.parallelism=2 -Djunit.jupiter.execution.parallel.config.fixed.max-pool-size={0} ', matrix.parallel) || '' }}
 
     # Replace '/' with '-'
     - name: Normalize project name
-      if: failure()
       env:
         PROJECT: ${{ matrix.project }}
       run: echo PROJECT_NORMALIZED=${PROJECT/\//-} >> $GITHUB_ENV
 
     - name: Upload videos of test failures
-      if: failure()
+      if: ${{ matrix.video && failure() }}
       uses: actions/upload-artifact@v6
       with:
         name: test-fail-videos-${{ matrix.java }}-${{ env.PROJECT_NORMALIZED }}-${{ matrix.parallel }}-${{ matrix.pre-start }}
         path: advanced-demo/integration-tests/${{ matrix.project }}/target/records
         if-no-files-found: ignore
+
+    - name: Aggregate WebApp JaCoCo report
+      if: ${{ matrix.jacoco && !cancelled() }}
+      # Important: Also run compile (if not already done) so that we have all class files - otherwise the report will be incomplete
+      run: |
+        ./mvnw -B compile jacoco-aggregator:report-aggregate-all -pl "advanced-demo/webapp" -am -T2C
+
+    - name: Upload WebApp JaCoCo report
+      if: ${{ matrix.jacoco && !cancelled() }}
+      uses: actions/upload-artifact@v6
+      with:
+        name: webapp-jacoco-report-${{ matrix.java }}-${{ env.PROJECT_NORMALIZED }}-${{ matrix.parallel }}-${{ matrix.pre-start }}
+        path: advanced-demo/target/site/jacoco-aggregate
+        if-no-files-found: ignore
+
+    - name: WebApp JaCoCo Code Coverage Report
+      if: ${{ matrix.jacoco && !cancelled() }}
+      id: jacoco_reporter
+      uses: PavanMudigonda/jacoco-reporter@4fc6bf270fe893e8dda5467e432253a6961345b8 # v5.0
+      with:
+        coverage_results_path: advanced-demo/target/site/jacoco-aggregate/jacoco.xml
+        coverage_report_name: WebApp Coverage (${{matrix.parallel}}, ${{matrix.pre-start}}, ${{matrix.java}})
+        coverage_report_title: JaCoCo
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+    
+    - name: Add WebApp JaCoCo report to workflow run summary
+      if: ${{ matrix.jacoco && !cancelled() }}
+      run: |
+        echo "| Outcome | Value |" >> $GITHUB_STEP_SUMMARY
+        echo "| --- | --- |" >> $GITHUB_STEP_SUMMARY
+        echo "| Code Coverage % | ${{ steps.jacoco_reporter.outputs.coverage_percentage }} |" >> $GITHUB_STEP_SUMMARY
+        echo "| :heavy_check_mark: Number of Lines Covered | ${{ steps.jacoco_reporter.outputs.covered_lines }} |" >> $GITHUB_STEP_SUMMARY
+        echo "| :x: Number of Lines Missed | ${{ steps.jacoco_reporter.outputs.missed_lines }} |" >> $GITHUB_STEP_SUMMARY
+        echo "| Total Number of Lines | ${{ steps.jacoco_reporter.outputs.total_lines }} |" >> $GITHUB_STEP_SUMMARY

CHANGELOG.md

@@ -1,3 +1,10 @@
+# 3.2.0
+* New module: `jacoco`
+  * Support recording Code Coverage files and extracting them from the corresponding containers
+  * See the documentation of the module for more details
+* Deprecated `SeleniumRecordingExtension`
+  * Use `SeleniumRecorder` and `FileSystemFriendlyName` instead
+
 # 3.1.0
 * `EntityManagerController`
   * Now always checks if the EntityManager is already closed

README.md

@@ -20,8 +20,12 @@ Modules for XDEV's Testcontainer Infrastructure Framework
   * Data-generation template
   * Improved JDBC Container wait strategy
   * Predefined implementations for [Spring-ORM](./db-jdbc-spring-orm/) and [Hibernate](./db-jdbc-spring-orm-hibernate/)
+* [jacoco](./jacoco/)
+  * Allows for recording of JaCoCo code coverage files with Java containers
 * [jul-to-slf4j](./jul-to-slf4j/)
   * Logging Adapter to redirect JUL to SLF4J
+* [junit-jupiter-api-support](./junit-jupiter-api-support/)
+  * Support for JUnit 5+ (Jupiter) API
 * [mockserver](./mockserver/)
   * Predefined implementation for [Mockserver](https://github.com/xdev-software/mockserver-neolight)
 * [oidc-server-mock](./oidc-server-mock/)

advanced-demo/entities-metamodel/pom.xml

@@ -7,7 +7,7 @@
 	<parent>
 		<groupId>software.xdev.tci.demo</groupId>
 		<artifactId>advanced-demo</artifactId>
-		<version>3.1.1-SNAPSHOT</version>
+		<version>3.2.0-SNAPSHOT</version>
 	</parent>
 	<artifactId>entities-metamodel</artifactId>
 

advanced-demo/entities/pom.xml

@@ -7,7 +7,7 @@
 	<parent>
 		<groupId>software.xdev.tci.demo</groupId>
 		<artifactId>advanced-demo</artifactId>
-		<version>3.1.1-SNAPSHOT</version>
+		<version>3.2.0-SNAPSHOT</version>
 	</parent>
 	<artifactId>entities</artifactId>
 

advanced-demo/integration-tests/persistence-it/pom.xml

@@ -7,7 +7,7 @@
 	<parent>
 		<groupId>software.xdev.tci.demo.it</groupId>
 		<artifactId>integration-tests</artifactId>
-		<version>3.1.1-SNAPSHOT</version>
+		<version>3.2.0-SNAPSHOT</version>
 	</parent>
 	<artifactId>persistence-it</artifactId>
 

advanced-demo/integration-tests/pom.xml

@@ -7,12 +7,12 @@
 	<parent>
 		<groupId>software.xdev.tci.demo</groupId>
 		<artifactId>advanced-demo</artifactId>
-		<version>3.1.1-SNAPSHOT</version>
+		<version>3.2.0-SNAPSHOT</version>
 	</parent>
 
 	<groupId>software.xdev.tci.demo.it</groupId>
 	<artifactId>integration-tests</artifactId>
-	<version>3.1.1-SNAPSHOT</version>
+	<version>3.2.0-SNAPSHOT</version>
 	<packaging>pom</packaging>
 
 	<modules>
@@ -28,13 +28,13 @@
 			<dependency>
 				<groupId>software.xdev.tci.demo.it</groupId>
 				<artifactId>tci-db</artifactId>
-				<version>3.1.1-SNAPSHOT</version>
+				<version>3.2.0-SNAPSHOT</version>
 			</dependency>
 
 			<dependency>
 				<groupId>software.xdev.tci.demo.it</groupId>
 				<artifactId>tci-webapp</artifactId>
-				<version>3.1.1-SNAPSHOT</version>
+				<version>3.2.0-SNAPSHOT</version>
 			</dependency>
 
 			<dependency>
@@ -47,6 +47,11 @@
 				<artifactId>db-jdbc-spring-orm-hibernate</artifactId>
 				<version>${project.version}</version>
 			</dependency>
+			<dependency>
+				<groupId>software.xdev.tci</groupId>
+				<artifactId>jacoco</artifactId>
+				<version>${project.version}</version>
+			</dependency>
 			<dependency>
 				<groupId>software.xdev.tci</groupId>
 				<artifactId>oidc-server-mock</artifactId>
@@ -67,7 +72,7 @@
 			<dependency>
 				<groupId>org.seleniumhq.selenium</groupId>
 				<artifactId>selenium-dependencies-bom</artifactId>
-				<version>4.40.0</version>
+				<version>4.41.0</version>
 				<type>pom</type>
 				<scope>import</scope>
 			</dependency>
@@ -84,7 +89,7 @@
 			<dependency>
 				<groupId>org.junit</groupId>
 				<artifactId>junit-bom</artifactId>
-				<version>6.0.2</version>
+				<version>6.0.3</version>
 				<type>pom</type>
 				<scope>import</scope>
 			</dependency>

advanced-demo/integration-tests/tci-db/pom.xml

@@ -7,7 +7,7 @@
 	<parent>
 		<groupId>software.xdev.tci.demo.it</groupId>
 		<artifactId>integration-tests</artifactId>
-		<version>3.1.1-SNAPSHOT</version>
+		<version>3.2.0-SNAPSHOT</version>
 	</parent>
 	<artifactId>tci-db</artifactId>
 

advanced-demo/integration-tests/tci-webapp/Dockerfile

@@ -74,6 +74,9 @@ RUN mv webapp/target/webapp.jar app.jar \
 
 FROM jre-minimized
 
+ARG JACOCO_AGENT_ENABLED
+ARG JACOCO_AGENT_VERSION="0.8.14"
+
 ARG user=app
 ARG group=app
 ARG uid=1000
@@ -84,7 +87,13 @@ ARG APP_DIR=/opt/app
 RUN mkdir -p ${APP_DIR} \
   && chown ${uid}:${gid} ${APP_DIR} \
   && addgroup -g ${gid} ${group} \
-  && adduser -h "$APP_DIR" -u ${uid} -G ${group} -s /bin/bash -D ${user}
+  && adduser -h "$APP_DIR" -u ${uid} -G ${group} -s /bin/bash -D ${user}; \
+  # Download JaCoCoAgent if required
+  if [ "$JACOCO_AGENT_ENABLED" = "1" ]; then \
+    mkdir -p /jacoco/report \
+    && chown $uid:$gid /jacoco/report \
+    && wget https://repo.maven.apache.org/maven2/org/jacoco/org.jacoco.agent/$JACOCO_AGENT_VERSION/org.jacoco.agent-$JACOCO_AGENT_VERSION-runtime.jar -O /jacoco/agent.jar; \
+  fi
 
 WORKDIR ${APP_DIR}
 
@@ -101,8 +110,9 @@ COPY --from=builder --chown=${user}:${group} /builder/extracted/snapshot-depende
 RUN true
 COPY --from=builder --chown=${user}:${group} /builder/extracted/application/ ./
 
+ENV JAVA_JACOCO_OPTS=${JACOCO_AGENT_ENABLED:+"-javaagent:/jacoco/agent.jar=destfile=/jacoco/report/jacoco.exec"}
 ENV JAVA_OPTS="-XX:MaxRAMPercentage=75 -XX:MinHeapFreeRatio=20 -XX:MaxHeapFreeRatio=30 -Djava.awt.headless=true"
 
 EXPOSE 8080
 
-CMD [ "/bin/sh", "-c", "java $JAVA_OPTS -jar /opt/app/app.jar" ]
+CMD [ "/bin/sh", "-c", "java $JAVA_OPTS $JAVA_JACOCO_OPTS -jar /opt/app/app.jar" ]

advanced-demo/integration-tests/tci-webapp/pom.xml

@@ -7,7 +7,7 @@
 	<parent>
 		<groupId>software.xdev.tci.demo.it</groupId>
 		<artifactId>integration-tests</artifactId>
-		<version>3.1.1-SNAPSHOT</version>
+		<version>3.2.0-SNAPSHOT</version>
 	</parent>
 	<artifactId>tci-webapp</artifactId>
 
@@ -16,6 +16,10 @@
 			<groupId>software.xdev.tci</groupId>
 			<artifactId>base</artifactId>
 		</dependency>
+		<dependency>
+			<groupId>software.xdev.tci</groupId>
+			<artifactId>jacoco</artifactId>
+		</dependency>
 		<dependency>
 			<groupId>software.xdev</groupId>
 			<artifactId>testcontainers-advanced-imagebuilder</artifactId>