Add jacoco & increase code coverage

Author: HydrolienF

build.gradle.kts

@@ -2,6 +2,7 @@ plugins {
     // Apply the java-library plugin for API and implementation separation.
     `java-library`
     `maven-publish` // Add ./gradlew publishToMavenLocal
+    jacoco
 }
 
 version = "0.0.3"
@@ -47,6 +48,11 @@ tasks.named<Test>("test") {
 		events("passed", "skipped", "failed")
         showStandardStreams = true
 	}
+
+    finalizedBy(tasks.jacocoTestReport) // report is always generated after tests run
+}
+tasks.jacocoTestReport {
+    dependsOn(tasks.test) // tests are required to run before generating the report
 }
 
 

src/main/java/fr/formiko/utils/FLUFiles.java

@@ -51,6 +51,7 @@ private FLUFiles() {} // hide constructor
 
     public static boolean openWebLinkInBrowser(String url) { return false; }
 
+    // Internal class to hide implementation
     private static class FLUFilesInternal {
         private FLUFilesInternal() {} // hide constructor
 

src/main/java/fr/formiko/utils/FLUOS.java

@@ -15,10 +15,10 @@ public class FLUOS {
 
     /**
      * Singleton pattern.
-     * Private constructor to prevent instantiation.
+     * Private constructor to prevent instantiation. (Protected for testing)
      */
-    private FLUOS() {
-        String osName = System.getProperty("os.name").toLowerCase();
+    protected FLUOS(String osName) {
+        instance = this;
         if (osName.contains("win")) {
             os = OS.WINDOWS;
         } else if (osName.contains("mac")) {
@@ -29,6 +29,7 @@ private FLUOS() {
             os = OS.OTHER;
         }
     }
+    private FLUOS() { this(System.getProperty("os.name").toLowerCase()); }
 
     public static @Nonnull OS getOS() { return instance.os; }
     public static boolean isWindows() { return instance.os == OS.WINDOWS; }

src/test/java/fr/formiko/utils/FLUFilesTest.java

@@ -40,7 +40,8 @@ void testCreateFiles(String path, boolean shouldWork) {
     private static Stream<Arguments> testCreateFilesSource() {
         return Stream.of(Arguments.of(TEST_PATH_TEMPORARY + "testCreateFiles1.txt", true),
                 Arguments.of(TEST_PATH_TEMPORARY + "testCreateFiles2.png", true), Arguments.of(TEST_PATH_TEMPORARY + "éà@--", true),
-                Arguments.of(TEST_PATH + "existingFile.x", false), Arguments.of(TEST_PATH_TEMPORARY + "/2/3/4/t", true));
+                Arguments.of(TEST_PATH + "existingFile.x", false), Arguments.of(TEST_PATH_TEMPORARY + "/2/3/4/t", true),
+                Arguments.of(null, false));
     }
 
     @ParameterizedTest
@@ -54,7 +55,7 @@ void testCreateDirectory(String path, boolean shouldWork) {
     private static Stream<Arguments> testCreateDirectorySource() {
         return Stream.of(Arguments.of(TEST_PATH_TEMPORARY + "testCreateDirectory1", true),
                 Arguments.of(TEST_PATH_TEMPORARY + "testCreateDirectory2", true), Arguments.of(TEST_PATH_TEMPORARY + "éàOP%u%", true),
-                Arguments.of(TEST_PATH, false), Arguments.of(TEST_PATH_TEMPORARY + "DIR/2/3/4/t/", true));
+                Arguments.of(TEST_PATH, false), Arguments.of(TEST_PATH_TEMPORARY + "DIR/2/3/4/t/", true), Arguments.of(null, false));
     }
 
     @ParameterizedTest
@@ -68,7 +69,8 @@ void testDelete(String path, boolean shouldWork, String pathToCreate) {
 
     private static Stream<Arguments> testDeleteSource() {
         return Stream.of(Arguments.of(TEST_PATH_TEMPORARY, true, TEST_PATH_TEMPORARY + "P/2/3/4"),
-                Arguments.of(TEST_PATH_TEMPORARY, false, null), Arguments.of(TEST_PATH + "unexistingDirectory", false, null));
+                Arguments.of(TEST_PATH_TEMPORARY, false, null), Arguments.of(TEST_PATH + "unexistingDirectory", false, null),
+                Arguments.of(null, false, null));
     }
 
     @ParameterizedTest
@@ -84,21 +86,25 @@ private static Stream<Arguments> testCopySource() {
         return Stream.of(Arguments.of(TEST_PATH + "existingFile.x", true, TEST_PATH_TEMPORARY + "existingFile.x"), // normal copy
                 Arguments.of(TEST_PATH + "unexistingFile.x", false, TEST_PATH_TEMPORARY + "unexistingFile.x"), // copy of missing file
                 Arguments.of(TEST_PATH_TEMPORARY + "existingFile.x", false, TEST_PATH_TEMPORARY + "existingFile.x"), // don't exist here
-                Arguments.of(TEST_PATH + "existingFile.x", false, TEST_PATH + "existingFile.x")); // same location
+                Arguments.of(TEST_PATH + "existingFile.x", false, TEST_PATH + "existingFile.x"), // same location
+                Arguments.of(null, false, TEST_PATH), Arguments.of(TEST_PATH + "existingFile.x", false, ""));
     }
 
     @ParameterizedTest
     @MethodSource("testMoveSource")
     void testMove(String source, boolean shouldWork, String destination) {
-        assertEquals(true, FLUFiles.createFile(source));
+        if (source != null) {
+            assertEquals(true, FLUFiles.createFile(source));
+        }
         assertEquals(shouldWork, FLUFiles.move(source, destination));
         if (shouldWork) {
             assertEquals(true, FLUFiles.delete(destination));
         }
     }
 
     private static Stream<Arguments> testMoveSource() {
-        return Stream.of(Arguments.of(TEST_PATH_TEMPORARY + "RTYUIFile.x", true, TEST_PATH_TEMPORARY + "DTCFile.x"));
+        return Stream.of(Arguments.of(TEST_PATH_TEMPORARY + "RTYUIFile.x", true, TEST_PATH_TEMPORARY + "DTCFile.x"),
+                Arguments.of(null, false, TEST_PATH), Arguments.of(TEST_PATH_TEMPORARY + "exzbnkistingFile.x", false, null));
     }
 
     @ParameterizedTest

src/test/java/fr/formiko/utils/FLUOSTest.java

@@ -1,13 +1,30 @@
 package fr.formiko.utils;
 
+import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertNotNull;
 import static org.junit.jupiter.api.Assertions.assertTrue;
 import org.junit.jupiter.api.Test;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.CsvSource;
 
 public class FLUOSTest {
     @Test
     void testNull() { assertNotNull(FLUOS.getOS()); }
 
     @Test
     void testIsX() { assertTrue(FLUOS.isWindows() || FLUOS.isLinux() || FLUOS.isMac() || FLUOS.isOther()); }
+
+    @ParameterizedTest
+    @CsvSource({"Windowsx64, true, false, false, false", "Debian-Linux, false, true, false, false", "MacOS56, false, false, true, false",
+            "X, false, false, false, true", "Onix, false, true, false, false", "maix, false, true, false, false"})
+    void testOS(String osName, boolean isWindows, boolean isLinux, boolean isMac, boolean isOther) {
+        assertEquals(isWindows, new FLUOSTestInstance(osName).isWindows());
+        assertEquals(isLinux, new FLUOSTestInstance(osName).isLinux());
+        assertEquals(isMac, new FLUOSTestInstance(osName).isMac());
+        assertEquals(isOther, new FLUOSTestInstance(osName).isOther());
+    }
+
+    class FLUOSTestInstance extends FLUOS {
+        public FLUOSTestInstance(String osName) { super(osName.toLowerCase()); }
+    }
 }