Merge pull request #70 from DataSQRL/coverage

Precarious test coverage

Author: velo

flink-sql-runner/pom.xml

@@ -188,6 +188,20 @@
       <version>1.0.0-SNAPSHOT</version>
       <scope>test</scope>
     </dependency>
+
+    <dependency>
+      <groupId>org.jacoco</groupId>
+      <artifactId>org.jacoco.core</artifactId>
+      <version>0.8.13</version>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.jacoco</groupId>
+      <artifactId>org.jacoco.agent</artifactId>
+      <version>0.8.13</version>
+      <classifier>runtime</classifier>
+      <scope>test</scope>
+    </dependency>
   </dependencies>
 
   <build>
@@ -283,6 +297,7 @@
           </execution>
         </executions>
       </plugin>
+
       <plugin>
         <groupId>com.marvinformatics</groupId>
         <artifactId>docker-compose-maven-plugin</artifactId>
@@ -367,6 +382,17 @@
               <outputDirectory>${project.build.directory}</outputDirectory>
             </configuration>
           </execution>
+          <execution>
+            <id>copy-jacoco-cli</id>
+            <goals>
+              <goal>copy-dependencies</goal>
+            </goals>
+            <phase>process-resources</phase>
+            <configuration>
+              <includeArtifactIds>org.jacoco.agent</includeArtifactIds>
+              <outputDirectory>${project.build.directory}</outputDirectory>
+            </configuration>
+          </execution>
         </executions>
       </plugin>
     </plugins>

flink-sql-runner/src/main/docker/docker-compose.yml

@@ -65,6 +65,8 @@ services:
       - ./test-classes/datasources/:/datasources/
       - /tmp:/tmp
       - ./test-classes/systemfunction/system-functions-sample-${project.version}.jar:/opt/flink/lib/systemfunction.jar
+      - ./org.jacoco.agent-0.8.13-runtime.jar:/opt/flink/lib/jacoco.agent.jar
+      - ./jacoco.job.exec:/opt/flink/jacoco.exec
     healthcheck:
       test: ["CMD-SHELL", "curl -f http://localhost:8081/ || exit 1"]
       interval: 1s
@@ -100,6 +102,7 @@ services:
       - ./test-classes/datasources/:/datasources/
       - /tmp:/tmp
       - ./test-classes/systemfunction/system-functions-sample-${project.version}.jar:/opt/flink/lib/systemfunction.jar
+      - ./org.jacoco.agent-0.8.13-runtime.jar:/opt/flink/lib/jacoco.agent.jar
     restart: always
     deploy:
       resources:

flink-sql-runner/src/test/java/com/datasqrl/FlinkMainIT.java

@@ -29,6 +29,11 @@
 import com.nextbreakpoint.flink.client.model.TerminationMode;
 import com.nextbreakpoint.flink.client.model.UploadStatus;
 import java.io.File;
+import java.io.FileInputStream;
+import java.io.FileOutputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.OutputStream;
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.sql.SQLException;
@@ -45,6 +50,8 @@
 import org.apache.flink.shaded.curator5.com.google.common.base.Objects;
 import org.apache.flink.shaded.curator5.com.google.common.collect.Lists;
 import org.awaitility.core.ThrowingRunnable;
+import org.jacoco.core.instr.Instrumenter;
+import org.jacoco.core.runtime.OfflineInstrumentationAccessGenerator;
 import org.jdbi.v3.core.Jdbi;
 import org.jdbi.v3.core.statement.SqlLogger;
 import org.jdbi.v3.core.statement.StatementContext;
@@ -243,11 +250,29 @@ JarRunResponseBody execute(String... arguments) {
     return restoreAndExecute(null, arguments);
   }
 
+  private int instrument(final File src, final File dest) throws IOException {
+    if (dest.exists()) {
+      return 0;
+    }
+    var instrumenter = new Instrumenter(new OfflineInstrumentationAccessGenerator());
+
+    dest.getParentFile().mkdirs();
+    try (final InputStream input = new FileInputStream(src);
+        final OutputStream output = new FileOutputStream(dest)) {
+      return instrumenter.instrumentAll(input, output, src.getAbsolutePath());
+    } catch (final IOException e) {
+      dest.delete();
+      throw e;
+    }
+  }
+
   @SneakyThrows
   JarRunResponseBody restoreAndExecute(String savepointPath, String... arguments) {
-    var jarFile = new File("target/flink-sql-runner.uber.jar");
+    var originalFile = new File("target/flink-sql-runner.uber.jar");
+    var instrumentedJarFile = new File("target/flink-sql-runner.jacoco.jar");
+    instrument(originalFile, instrumentedJarFile);
 
-    var uploadResponse = client.uploadJar(jarFile);
+    var uploadResponse = client.uploadJar(instrumentedJarFile);
 
     assertThat(uploadResponse.getStatus()).isEqualTo(UploadStatus.SUCCESS);
 

flink-sql-runner/src/test/java/com/datasqrl/TouchTest.java

@@ -0,0 +1,36 @@
+/*
+ * Copyright © 2024 DataSQRL (contact@datasqrl.com)
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.datasqrl;
+
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.attribute.PosixFilePermission;
+import java.util.EnumSet;
+import org.junit.jupiter.api.BeforeAll;
+import org.junit.jupiter.api.Test;
+
+public class TouchTest {
+
+  @BeforeAll
+  static void copyJacocoReports() throws Exception {
+    Files.createFile(Path.of("target/jacoco.job.exec"));
+    Files.setPosixFilePermissions(
+        Path.of("target/jacoco.job.exec"), EnumSet.allOf(PosixFilePermission.class));
+  }
+
+  @Test
+  void doNothing() {}
+}

testing/coverage/pom.xml

@@ -58,6 +58,8 @@
               <dataFileIncludes>
                 <dataFileInclude>**/jacoco.exec</dataFileInclude>
                 <dataFileInclude>**/jacoco-it.exec</dataFileInclude>
+                <dataFileInclude>**/jacoco.task.exec</dataFileInclude>
+                <dataFileInclude>**/jacoco.job.exec</dataFileInclude>
               </dataFileIncludes>
             </configuration>
           </execution>