#10: Added a module for code coverage in UDFs (#12)

* #10: Added a module for code coverage in UDFs

Co-authored-by: Muhammet Orazov <m.orazow@gmail.com>

Author: jakobbraun

.github/workflows/maven.yml renamed to .github/workflows/dependencies_check.yml

@@ -1,6 +1,3 @@
-# This workflow will build a Java project with Maven
-# For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-maven
-
 name: Dependencies Check
 
 on:
@@ -17,5 +14,12 @@ jobs:
         uses: actions/setup-java@v1
         with:
           java-version: 11
+      - name: Cache local Maven repository
+        uses: actions/cache@v2
+        with:
+          path: ~/.m2/repository
+          key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
+          restore-keys: |
+            ${{ runner.os }}-maven-
       - name: Checking dependencies for vulnerabilities
         run: mvn org.sonatype.ossindex.maven:ossindex-maven-plugin:audit -f pom.xml

.github/workflows/maven_central_release.yml

@@ -0,0 +1,25 @@
+name: Maven Central Release
+
+on:
+  workflow_dispatch:
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Maven Central Repository
+        uses: actions/setup-java@v1
+        with:
+          java-version: 11
+          server-id: ossrh
+          server-username: MAVEN_USERNAME
+          server-password: MAVEN_PASSWORD
+      - name: Import GPG Key
+        run:
+          gpg --import --batch <(echo "${{ secrets.OSSRH_GPG_SECRET_KEY }}")
+      - name: Publish to Central Repository
+        env:
+          MAVEN_USERNAME: ${{ secrets.OSSRH_USERNAME }}
+          MAVEN_PASSWORD: ${{ secrets.OSSRH_PASSWORD }}
+        run: mvn clean -Dgpg.skip=false -Dgpg.passphrase=${{ secrets.OSSRH_GPG_SECRET_KEY_PASSWORD }} deploy

NOTICE

@@ -4,14 +4,20 @@ This project has the following dependencies:
   asm-analysis under BSD-3-Clause
   asm-commons under BSD-3-Clause
   asm-tree under BSD-3-Clause
+  Byte Buddy (without dependencies) under Apache License, Version 2.0
+  Byte Buddy agent under Apache License, Version 2.0
+  docker-java-api under The Apache Software License, Version 2.0
+  docker-java-transport under The Apache Software License, Version 2.0
+  docker-java-transport-zerodep under The Apache Software License, Version 2.0
   Duct Tape under MIT
+  error-reporting-java under MIT
+  Exasol Database fundamentals for Java under MIT
   EXASolution JDBC Driver under EXAClient License
+  Hamcrest All under New BSD License
   Hamcrest Core under New BSD License
-  JaCoCo :: Agent under Eclipse Public License 2.0
+  Jackson-annotations under The Apache Software License, Version 2.0
   JaCoCo :: Core under Eclipse Public License 2.0
   Java Native Access under LGPL, version 2.1 or Apache License v2.0
-  Java Native Access Platform under LGPL, version 2.1 or Apache License v2.0
-  JetBrains Java Annotations under The Apache Software License, Version 2.0
   JSR 374 (JSON Processing) API under Dual license consisting of the CDDL v1.1 and GPL v2
   JUnit under Eclipse Public License 1.0
   JUnit Jupiter API under Eclipse Public License v2.0
@@ -22,15 +28,16 @@ This project has the following dependencies:
   JUnit Platform Launcher under Eclipse Public License v2.0
   JUnit Platform Runner under Eclipse Public License v2.0
   JUnit Platform Suite API under Eclipse Public License v2.0
-  junixsocket-common under Apache License, Version 2.0
-  junixsocket-native-common under Apache License, Version 2.0
-  Native Library Loader under CC0 1.0 Universal License
+  mockito-core under The MIT License
+  MySQL Connector/J under The GNU General Public License, v2 with FOSS exception
+  Objenesis under Apache License, Version 2.0
   org.apiguardian:apiguardian-api under The Apache License, Version 2.0
   org.opentest4j:opentest4j under The Apache License, Version 2.0
+  Protocol Buffers [Core] under 3-Clause BSD License
   SLF4J API Module under MIT License
   SLF4J JDK14 Binding under MIT License
-  TCP to Unix Socket Proxy under MIT
   Test containers for Exasol on Docker under MIT
+  Test Database Builder for Java under MIT
   Testcontainers :: Database-Commons under MIT
   Testcontainers :: JDBC under MIT
   Testcontainers :: JUnit Jupiter Extension under MIT

README.md

@@ -15,7 +15,9 @@ You can get the dependency declaration by clicking the maven badge above.
 Typically, you use this package together with [test-db-builder-java](https://github.com/exasol/test-db-builder-java) and [exasol-testcontainers](https://github.com/exasol/exasol-testcontainers) as follows:
 
 ```java
-final UdfTestSetup udfTestSetup = new UdfTestSetup(getTestHostIp());
+
+private static final ExasolContainer<? extends ExasolContainer<?>> EXASOL = new ExasolContainer<>();
+final UdfTestSetup udfTestSetup = new UdfTestSetup(getTestHostIp(), EXASOL.getDefaultBucket());
 final ExasolObjectFactory testDbBuilder = new ExasolObjectFactory(EXASOL.createConnection(), 
     ExasolObjectConfiguration.builder().withJvmOptions(udfTestSetup.getJvmOptions()).build());
 ```
@@ -32,6 +34,14 @@ System property: `test.debug`
 
 This module instructs the UDF JVMs to connect to a Java debugger listening on the default port 8000 on you machine, running the tests.
 
+### Code Coverage
+
+System property: `test.coverage`
+
+This module installs a jacoco agent to the UDF JVM and receives the execution data using a TCP socket.
+
+This module requires additional maven configuration. Use the [project-keeper's](https://github.com/exasol/project-keeper-maven-plugin) `udf_coverage` module to verify it.   
+
 
 ## Additional Information
 

doc/changes/changelog.md

@@ -1,4 +1,5 @@
 # Changes
 
+* [0.3.0](changes_0.3.0.md)
 * [0.2.0](changes_0.2.0.md)
 * [0.1.0](changes_0.1.0.md)

doc/changes/changes_0.3.0.md

@@ -0,0 +1,20 @@
+# udf-debugging-java 0.3.0, released 2020-11-23
+ 
+Code name: Test setup for UDF code coverage
+
+## Features / Enhancements
+
+* #10: Added a module for code coverage in UDFs 
+
+## Dependency Updates:
+
+* Updated to `com:exasol:project-keeper-maven-plugin:0.3.0` (was 0.2.0)
+* Added `com.exasol:error-reporting-java:0.2.0`
+* Added  `org.jacoco:org.jacoco.core:0.8.6`
+* Added `com.exasol:exasol-testcontainers:3.3.1`
+* Added `org.mockito:mockito-core:3.6.0`
+* Added `org.hamcrest:hamcrest-all:1.3`
+* Added `com.exasol:test-db-builder-java:2.0.0`
+* Updated to `org.jacoco:jacoco-maven-plugin:0.8.6` (was 0.8.5) 
+* Added `org.sonatype.plugins:nexus-staging-maven-plugin:1.6.8`
+* Updated `org.jacoco:org.jacoco.agent0.8.6` (was 0.8.5)

pom.xml

@@ -4,7 +4,7 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>com.exasol</groupId>
     <artifactId>udf-debugging-java</artifactId>
-    <version>0.2.0</version>
+    <version>0.3.0</version>
     <name>udf-debugging-java</name>
     <description>Utilities for debugging, profiling and code coverage measure for UDFs.</description>
     <url>https://github.com/exasol/udf-debugging-javat</url>
@@ -14,9 +14,9 @@
         <java.version>11</java.version>
         <junit.version>5.6.2</junit.version>
         <junit.platform.version>1.6.2</junit.platform.version>
-        <jacoco.version>0.8.5</jacoco.version>
         <vscommon.version>11.0.0</vscommon.version>
         <gpg.skip>true</gpg.skip>
+        <jacoco.version>0.8.6</jacoco.version>
         <org.testcontainers.version>1.14.3</org.testcontainers.version>
         <surefire.and.failsafe.plugin.version>3.0.0-M4</surefire.and.failsafe.plugin.version>
     </properties>
@@ -76,6 +76,30 @@
             <artifactId>javax.json-api</artifactId>
             <version>1.1.4</version>
         </dependency>
+        <dependency>
+            <groupId>com.exasol</groupId>
+            <artifactId>error-reporting-java</artifactId>
+            <version>0.2.0</version>
+        </dependency>
+        <dependency>
+            <groupId>org.jacoco</groupId>
+            <artifactId>org.jacoco.core</artifactId>
+            <version>${jacoco.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.jacoco</groupId>
+            <artifactId>org.jacoco.agent</artifactId>
+            <version>${jacoco.version}</version>
+            <classifier>runtime</classifier>
+            <scope>test</scope>
+        </dependency>
+        <!-- This is a compile dependency for accessing Bucket from testcontainers.
+        It is planned to move it out there: -->
+        <dependency>
+            <groupId>com.exasol</groupId>
+            <artifactId>exasol-testcontainers</artifactId>
+            <version>3.3.1</version>
+        </dependency>
         <!-- test dependencies -->
         <dependency>
             <groupId>org.junit.jupiter</groupId>
@@ -95,31 +119,29 @@
             <version>${junit.version}</version>
             <scope>test</scope>
         </dependency>
-        <!--Integration test dependencies-->
         <dependency>
-            <groupId>com.exasol</groupId>
-            <artifactId>exasol-testcontainers</artifactId>
-            <version>3.2.0</version>
+            <groupId>org.mockito</groupId>
+            <artifactId>mockito-core</artifactId>
+            <version>3.6.0</version>
             <scope>test</scope>
         </dependency>
         <dependency>
-            <groupId>org.testcontainers</groupId>
-            <artifactId>junit-jupiter</artifactId>
-            <version>${org.testcontainers.version}</version>
+            <groupId>org.hamcrest</groupId>
+            <artifactId>hamcrest-all</artifactId>
+            <version>1.3</version>
             <scope>test</scope>
         </dependency>
+        <!--Integration test dependencies-->
         <dependency>
-            <groupId>org.jacoco</groupId>
-            <artifactId>org.jacoco.agent</artifactId>
-            <version>${jacoco.version}</version>
-            <classifier>runtime</classifier>
+            <groupId>org.testcontainers</groupId>
+            <artifactId>junit-jupiter</artifactId>
+            <version>${org.testcontainers.version}</version>
             <scope>test</scope>
         </dependency>
         <dependency>
-            <groupId>org.jacoco</groupId>
-            <artifactId>org.jacoco.core</artifactId>
-            <version>${jacoco.version}</version>
-            <scope>test</scope>
+            <groupId>com.exasol</groupId>
+            <artifactId>test-db-builder-java</artifactId>
+            <version>2.0.0</version>
         </dependency>
         <dependency>
             <groupId>org.slf4j</groupId>
@@ -324,6 +346,12 @@
                         </goals>
                     </execution>
                 </executions>
+                <configuration>
+                    <excludeVulnerabilityIds>
+                        <!-- Ignores CVE-2020-15250, because we use Java 11 and junit 4.13.1 which contains a fix: https://ossindex.sonatype.org/vuln/7ea56ad4-8a8b-4e51-8ed9-5aad83d8efb1 -->
+                        <exclude>7ea56ad4-8a8b-4e51-8ed9-5aad83d8efb1</exclude>
+                    </excludeVulnerabilityIds>
+                </configuration>
             </plugin>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
@@ -348,7 +376,7 @@
             <plugin>
                 <groupId>com.exasol</groupId>
                 <artifactId>project-keeper-maven-plugin</artifactId>
-                <version>0.2.0</version>
+                <version>0.3.0</version>
                 <executions>
                     <execution>
                         <goals>
@@ -358,6 +386,7 @@
                 </executions>
                 <configuration>
                     <modules>
+                        <module>maven_central</module>
                     </modules>
                 </configuration>
             </plugin>
@@ -382,6 +411,32 @@
                 </executions>
             </plugin>
             -->
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-deploy-plugin</artifactId>
+                <configuration>
+                    <skip>true</skip>
+                </configuration>
+            </plugin>
+            <plugin>
+                <groupId>org.sonatype.plugins</groupId>
+                <artifactId>nexus-staging-maven-plugin</artifactId>
+                <version>1.6.8</version>
+                <configuration>
+                    <autoReleaseAfterClose>true</autoReleaseAfterClose>
+                    <serverId>ossrh</serverId>
+                    <nexusUrl>https://oss.sonatype.org/</nexusUrl>
+                </configuration>
+                <executions>
+                    <execution>
+                        <id>default-deploy</id>
+                        <phase>deploy</phase>
+                        <goals>
+                            <goal>deploy</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
         </plugins>
         <testResources>
             <testResource>

src/main/java/com/exasol/udfdebugging/Module.java

@@ -2,7 +2,15 @@
 
 import java.util.stream.Stream;
 
+/**
+ * Modules define a specific functionality that users can enable using system properties.
+ */
 public interface Module {
 
+    /**
+     * Get JVM options required by this module.
+     * 
+     * @return JVM options
+     */
     public Stream<String> getJvmOptions();
 }

src/main/java/com/exasol/udfdebugging/ModuleFactory.java

@@ -1,5 +1,7 @@
 package com.exasol.udfdebugging;
 
+import com.exasol.bucketfs.Bucket;
+
 public interface ModuleFactory {
 
     /**
@@ -20,7 +22,8 @@ public interface ModuleFactory {
      * Build the {@link Module}.
      * 
      * @param testHostIpAddress IP address of the host running this UDF Test Setup under which UDFs can reach it
+     * @param bucket            BucketFS bucket to upload resource to
      * @return built {@link Module}
      */
-    public Module buildModule(final String testHostIpAddress);
+    public Module buildModule(final String testHostIpAddress, Bucket bucket);
 }

src/main/java/com/exasol/udfdebugging/UdfTestSetup.java

@@ -6,24 +6,29 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import com.exasol.bucketfs.Bucket;
+import com.exasol.udfdebugging.modules.coverage.CoverageModuleFactory;
 import com.exasol.udfdebugging.modules.debugging.DebuggingModuleFactory;
 
 /**
  * Test setup for testing UDFs in the database.
  */
 public class UdfTestSetup {
-    private static final List<ModuleFactory> AVAILABLE_MODULES = List.of(new DebuggingModuleFactory());
+    private static final List<ModuleFactory> AVAILABLE_MODULES = List.of(new DebuggingModuleFactory(),
+            new CoverageModuleFactory());
     private static final Logger LOGGER = LoggerFactory.getLogger(UdfTestSetup.class);
     private final List<Module> enabledModules;
 
     /**
      * Create a new instance of {@link UdfTestSetup}.
      * 
      * @param testHostIpAddress IP address of the host running this UDF Test Setup under which UDFs can reach it
+     * @param bucket            BucketFS bucket to upload resource to
      */
-    public UdfTestSetup(final String testHostIpAddress) {
+    public UdfTestSetup(final String testHostIpAddress, final Bucket bucket) {
         this.enabledModules = AVAILABLE_MODULES.stream().filter(ModuleFactory::isEnabled)
-                .map(moduleFactory -> moduleFactory.buildModule(testHostIpAddress)).collect(Collectors.toList());
+                .map(moduleFactory -> moduleFactory.buildModule(testHostIpAddress, bucket))
+                .collect(Collectors.toList());
         printInfoMessage();
     }