Merge pull request #113 from ChannelFinder/code-coverage-it

Code coverage it

Author: thelarsjohansson

.github/workflows/codecov.yml

@@ -37,7 +37,7 @@ jobs:
       shell: bash
       run: docker image prune -af
     - name: Integration Test with Maven
-      run: mvn clean install test-compile failsafe:integration-test failsafe:verify jacoco:report --batch-mode --fail-at-end
+      run: mvn clean install test-compile failsafe:integration-test failsafe:verify verify --batch-mode --fail-at-end -Djacoco.skip=false -DskipITs=false -DskipITCoverage=false
     - name: Publish Test Report
       uses: mikepenz/action-junit-report@v3
       if: success() || failure() # always run even if the previous step fails

.github/workflows/maven.yml

@@ -74,7 +74,7 @@ jobs:
       shell: bash
       run: docker image prune -af
     - name: Integration Test with Maven
-      run: mvn clean install test-compile failsafe:integration-test failsafe:verify --batch-mode --fail-at-end
+      run: mvn clean install test-compile failsafe:integration-test failsafe:verify --batch-mode --fail-at-end -Djacoco.skip=true -DskipITs=false -DskipITCoverage=true
     - name: Publish Test Report
       uses: mikepenz/action-junit-report@v4
       if: success() || failure() # always run even if the previous step fails

.gitignore

@@ -10,10 +10,12 @@
 .idea
 
 ### Eclipse ###
+.settings/org.eclipse.core.resources.prefs
 .settings/org.eclipse.jdt.core.prefs
+.settings/org.eclipse.m2e.core.prefs
 
 ### Docker ###
 docker-compose-local*
 
 ### Spring ###
-spring-shell.log
+spring-shell.log

.settings/org.eclipse.core.resources.prefs

@@ -21,4 +21,7 @@ FROM openjdk:11
 # deployment unit
 COPY target/ChannelFinder-*.jar /channelfinder/ChannelFinder-*.jar
 
+# code coverage
+COPY target/jacoco/jacocoagent.jar /channelfinder/jacocoagent.jar
+
 CMD ["java", "-jar", "/channelfinder/ChannelFinder-*.jar", "--spring.config.name=application"]

.settings/org.eclipse.jdt.core.prefs

@@ -141,7 +141,7 @@ There are tests for properties, tags and channels separately and in combination.
 Integration tests can be run in IDE and via Maven.
 
 ```
-mvn failsafe:integration-test
+mvn failsafe:integration-test -DskipITs=false
 ```
 
 See

.settings/org.eclipse.m2e.core.prefs

@@ -18,25 +18,6 @@
 
 version: "3.7"
 services:
-  elasticsearch:
-    image: docker.elastic.co/elasticsearch/elasticsearch:8.2.0
-    hostname: elasticsearch-cf
-    networks:
-      - channelfinder-net
-    environment:
-      cluster.name: channelfinder
-      bootstrap.memory_lock: "true"
-      discovery.type: single-node
-      ES_JAVA_OPTS: "-Xms512m -Xmx512m"
-      xpack.security.enabled: "false"
-    volumes:
-      - channelfinder-es-data:/usr/share/elasticsearch/data
-    healthcheck:
-      test: curl -f http://elasticsearch-cf:9200/_cluster/health
-      interval: 30s
-      timeout: 60s
-      retries: 5
-
   channelfinder:
     build: 
       context: .
@@ -58,14 +39,39 @@ services:
       ldap.enabled: "false"
       embedded_ldap.enabled: "false"
       demo_auth.enabled: "true"
-    command: "java -jar /channelfinder/ChannelFinder-*.jar --spring.config.name=application"
+      skipITCoverage: "true"
+    command: >
+      /bin/bash -c "
+        if [ ${skipITCoverage} == false ]; then
+          export JAVA_TOOL_OPTIONS=-javaagent:/channelfinder/jacocoagent.jar=destfile=/channelfinder/jacoco.exec,output=file,append=false
+        fi
+        java -jar /channelfinder/ChannelFinder-*.jar --spring.config.name=application"
     restart: on-failure
     healthcheck:
       test: curl -s -f http://channelfinder:8080/ChannelFinder
       interval: 30s
       timeout: 60s
       retries: 5
 
+  elasticsearch:
+    image: docker.elastic.co/elasticsearch/elasticsearch:8.2.0
+    hostname: elasticsearch-cf
+    networks:
+      - channelfinder-net
+    environment:
+      cluster.name: channelfinder
+      bootstrap.memory_lock: "true"
+      discovery.type: single-node
+      ES_JAVA_OPTS: "-Xms512m -Xmx512m"
+      xpack.security.enabled: "false"
+    volumes:
+      - channelfinder-es-data:/usr/share/elasticsearch/data
+    healthcheck:
+      test: curl -f http://elasticsearch-cf:9200/_cluster/health
+      interval: 30s
+      timeout: 60s
+      retries: 5
+
 
 volumes:
   channelfinder-es-data:
@@ -74,12 +80,3 @@ volumes:
 networks:
   channelfinder-net:
     driver: bridge
-
-
-# ------------------------------------------------------------------------------
-# Note
-# ------------------------------------------------------------------------------
-# elasticsearch port numbers
-#     can be exposed differently externally to avoid interference with any running instance
-#     to be reflected in docker integration tests
-# ------------------------------------------------------------------------------

Dockerfile.integrationtest

@@ -38,6 +38,9 @@
         <spring.boot-version>2.7.3</spring.boot-version>
         <elasticsearch.version>8.2.0</elasticsearch.version>
         <junit-jupiter.version>5.10.0</junit-jupiter.version>
+        <skipITs>true</skipITs>
+        <skipITCoverage>true</skipITCoverage>
+        <jacoco.skip>true</jacoco.skip>
     </properties>
     <dependencyManagement>
         <dependencies>
@@ -148,13 +151,22 @@
             <groupId>org.springframework.security</groupId>
             <artifactId>spring-security-test</artifactId>
         </dependency>
+
         <dependency>
             <groupId>org.epics</groupId>
             <artifactId>epics-core</artifactId>
             <type>pom</type>
             <version>7.0.2</version>
             <scope>compile</scope>
         </dependency>
+
+        <dependency>
+            <groupId>org.jacoco</groupId>
+            <artifactId>org.jacoco.agent</artifactId>
+            <version>0.8.11</version>
+            <scope>runtime</scope>
+        </dependency>
+
         <dependency>
             <groupId>org.springframework</groupId>
             <artifactId>spring-test</artifactId>
@@ -173,7 +185,7 @@
         <dependency>
             <groupId>org.testcontainers</groupId>
             <artifactId>junit-jupiter</artifactId>
-            <version>1.19.0</version>
+            <version>1.19.3</version>
             <scope>test</scope>
             <exclusions>
                 <exclusion>
@@ -235,12 +247,13 @@
                 <artifactId>maven-surefire-plugin</artifactId>
                 <version>3.1.2</version>
             </plugin>
+            <!-- use self-contained integration tests - org.phoebus.channelfinder.docker -->
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-failsafe-plugin</artifactId>
                 <version>3.1.2</version>
                 <configuration>
-                    <skipTests>false</skipTests>
+                    <skipITs>${skipITs}</skipITs>
                     <includes>
                         <include>**/*IT.java</include>
                     </includes>
@@ -261,6 +274,30 @@
                     </execution>
                 </executions>
             </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-dependency-plugin</artifactId>
+                <executions>
+                    <execution>
+                        <id>copy</id>
+                        <phase>package</phase>
+                        <goals>
+                            <goal>copy</goal>
+                        </goals>
+                        <configuration>
+                            <artifactItems>
+                                <artifactItem>
+                                    <groupId>org.jacoco</groupId>
+                                    <artifactId>org.jacoco.agent</artifactId>
+                                    <classifier>runtime</classifier>
+                                    <outputDirectory>${project.build.directory}/jacoco</outputDirectory>
+                                    <destFileName>jacocoagent.jar</destFileName>
+                                </artifactItem>
+                            </artifactItems>
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
             <plugin>
                 <groupId>org.jacoco</groupId>
                 <artifactId>jacoco-maven-plugin</artifactId>
@@ -271,12 +308,35 @@
                             <goal>prepare-agent</goal>
                         </goals>
                     </execution>
+                    <execution>
+                        <id>merge</id>
+                        <phase>verify</phase>
+                        <goals>
+                          <goal>merge</goal>
+                        </goals>
+                        <configuration>
+                            <fileSets>
+                                <fileSet>
+                                    <directory>${project.build.directory}</directory>
+                                    <includes>
+                                        <include>jacoco*.exec</include>
+                                    </includes>
+                                </fileSet>
+                            </fileSets>
+                            <destFile>${project.build.directory}/site/jacoco/jacoco.exec</destFile>
+                        </configuration>
+                    </execution>
                     <execution>
                         <id>report</id>
-                        <phase>prepare-package</phase>
+                        <!-- <phase>prepare-package</phase> -->
+                        <phase>verify</phase>
                         <goals>
                             <goal>report</goal>
                         </goals>
+                        <configuration>
+                            <dataFile>${project.build.directory}/site/jacoco/jacoco.exec</dataFile>
+                            <outputDirectory>${project.build.directory}/site/jacoco</outputDirectory>
+                        </configuration>
                     </execution>
                 </executions>
             </plugin>
@@ -416,6 +476,25 @@
                 </plugins>
             </build>
         </profile>
+        <!-- profile for integrationtest with docker -->
+        <profile>
+            <id>integrationtest-docker</id>
+            <build>
+                <plugins>
+                    <plugin>
+                        <groupId>org.apache.maven.plugins</groupId>
+                        <artifactId>maven-failsafe-plugin</artifactId>
+                        <version>3.1.2</version>
+                        <configuration>
+                            <skipITs>${skipITs}</skipITs>
+                            <includes>
+                                <include>**/docker/*IT.java</include>
+                            </includes>
+                        </configuration>
+                    </plugin>
+                </plugins>
+            </build>
+        </profile>
     </profiles>
     <repositories>
         <repository>