Add ResourceUtil to load resource related files

Author: knutwalker

config-generator/build.gradle

@@ -19,6 +19,7 @@ dependencies {
     implementation             group: 'org.jetbrains',            name: 'annotations',        version: ver.'jetbrains-annotations'
 
     testImplementation platform(dep.junit5bom)
+    testImplementation project(':core-test-utils')
     testImplementation dep.junit5jupiter
     testImplementation dep.junit5migration
     testImplementation group: 'com.google.testing.compile',  name: 'compile-testing',  version: ver.'compile-testing'

config-generator/src/test/java/org/neo4j/gds/proc/ConfigurationProcessorTest.java

@@ -27,21 +27,15 @@
 import org.junit.jupiter.migrationsupport.rules.EnableRuleMigrationSupport;
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.ValueSource;
+import org.neo4j.gds.ResourceUtil;
 
 import javax.tools.JavaFileObject;
-import java.io.IOException;
-import java.io.UncheckedIOException;
-import java.net.URISyntaxException;
-import java.nio.file.Files;
-import java.nio.file.Paths;
 import java.util.Locale;
-import java.util.Objects;
 
 import static com.google.common.truth.Truth.assertAbout;
 import static com.google.testing.compile.JavaFileObjects.forResource;
 import static com.google.testing.compile.JavaFileObjects.forSourceLines;
 import static com.google.testing.compile.JavaSourceSubjectFactory.javaSource;
-import static java.nio.charset.StandardCharsets.UTF_8;
 import static org.junit.jupiter.api.condition.JRE.JAVA_12;
 
 // Need to disable this for Java versions > 11
@@ -251,21 +245,12 @@ private void runNegativeTest(String className, ErrorCheck... expectations) {
     }
 
     private JavaFileObject loadExpectedFile(String resourceName) {
-        try {
-            var sourceLines = Files.readAllLines(
-                Paths.get(Objects.requireNonNull(getClass().getResource(resourceName)).toURI()),
-                UTF_8
-            );
-
-            String binaryName = resourceName
-                .replace('/', '.')
-                .replace(".java", "");
-            return forSourceLines(binaryName, sourceLines);
-        } catch (IOException e) {
-            throw new UncheckedIOException(e);
-        } catch (URISyntaxException e) {
-            throw new RuntimeException(e);
-        }
+        var sourceLines = ResourceUtil.lines(resourceName);
+
+        String binaryName = resourceName
+            .replace('/', '.')
+            .replace(".java", "");
+        return forSourceLines(binaryName, sourceLines);
     }
 
     private static ErrorCheck e(String error, int line, int column) {

core-test-utils/build.gradle

@@ -0,0 +1,18 @@
+apply plugin: 'java-library'
+
+description = 'Neo4j Graph Data Science :: Core Test Utils'
+
+group = 'org.neo4j.gds'
+
+dependencies {
+    api (
+        platform(dep.junit5bom),
+        dep.junit5jupiter,
+        [group: 'org.assertj',             name: 'assertj-core',            version: ver.'assertj'],
+        [group: 'org.hamcrest',            name: 'hamcrest-library',        version: ver.'hamcrest'],
+
+        // let annotation dependencies be transitive to avoid compiler warnings for users of this project on missing annotation methods
+        [group: 'org.jetbrains',           name: 'annotations',             version: ver.'jetbrains-annotations'],
+        [group: 'org.immutables',          name: 'value-annotations',       version: ver.'immutables'],
+    )
+}

test-utils/src/main/java/org/neo4j/gds/PrivateLookup.java renamed to core-test-utils/src/main/java/org/neo4j/gds/PrivateLookup.java

@@ -0,0 +1,61 @@
+/*
+ * Copyright (c) "Neo4j"
+ * Neo4j Sweden AB [http://neo4j.com]
+ *
+ * This file is part of Neo4j.
+ *
+ * Neo4j is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+package org.neo4j.gds;
+
+import java.io.IOException;
+import java.io.UncheckedIOException;
+import java.net.URI;
+import java.net.URISyntaxException;
+import java.nio.file.Files;
+import java.nio.file.Paths;
+import java.util.List;
+import java.util.Locale;
+import java.util.Objects;
+
+import static java.nio.charset.StandardCharsets.UTF_8;
+
+public final class ResourceUtil {
+
+    public static List<String> lines(String resourceName) {
+        var classLoader = Objects.requireNonNullElse(
+            Thread.currentThread().getContextClassLoader(),
+            ResourceUtil.class.getClassLoader()
+        );
+
+        var resourceUrl = classLoader.getResource(resourceName);
+        Objects.requireNonNull(resourceUrl, () -> String.format(Locale.ENGLISH, "The resource %s cannot be found.", resourceName));
+
+        final URI resourceUri;
+        try {
+            resourceUri = resourceUrl.toURI();
+        } catch (URISyntaxException e) {
+            throw new RuntimeException(e);
+        }
+
+        var resourcePath = Paths.get(resourceUri);
+        try {
+            return Files.readAllLines(resourcePath, UTF_8);
+        } catch (IOException e) {
+            throw new UncheckedIOException(e);
+        }
+    }
+
+    private ResourceUtil() {}
+}

core-test-utils/src/main/java/org/neo4j/gds/ResourceUtil.java

@@ -59,4 +59,3 @@ public void describeTo(final Description description) {
     }
 
 }
-

test-utils/src/main/java/org/neo4j/gds/assertj/ConditionFactory.java renamed to core-test-utils/src/main/java/org/neo4j/gds/assertj/ConditionFactory.java

@@ -39,13 +39,12 @@
 import java.net.InetSocketAddress;
 import java.net.ServerSocket;
 import java.util.Arrays;
+import java.util.Locale;
 import java.util.Objects;
 import java.util.Random;
 import java.util.stream.IntStream;
 import java.util.stream.Stream;
 
-import static org.neo4j.gds.utils.StringFormatting.formatWithLocale;
-
 public class PortFinder implements ParameterResolver, TestInstancePostProcessor {
 
     @Target({ElementType.PARAMETER, ElementType.TYPE, ElementType.FIELD})
@@ -97,7 +96,8 @@ private void setValueToField(Object testInstance, ExtensionContext context, Fiel
                 trySetValueToField(testInstance, context, field);
             } catch (SecurityException | InaccessibleObjectException | IllegalAccessException illegalAccessException) {
                 throw new ExtensionConfigurationException(
-                    formatWithLocale(
+                    String.format(
+                        Locale.ENGLISH,
                         "Field %s cannot be set, please make it either public or accessible to reflection.",
                         field.getName()
                     ));
@@ -112,7 +112,7 @@ private void trySetValueToField(Object testInstance, ExtensionContext extensionC
 
         if (existingValue != null && !Objects.equals(existingValue, 0)) {
             throw new ExtensionConfigurationException(
-                formatWithLocale("Field %s should not have any manually assigned value.", field.getName()));
+                String.format(Locale.ENGLISH,"Field %s should not have any manually assigned value.", field.getName()));
         }
 
         var annotation = field.getAnnotation(FreePort.class);

test-utils/src/main/java/org/neo4j/gds/assertj/Extractors.java renamed to core-test-utils/src/main/java/org/neo4j/gds/assertj/Extractors.java

@@ -19,25 +19,30 @@
  */
 package org.neo4j.gds.datasets;
 
-import org.apache.commons.io.IOUtils;
-
+import java.io.BufferedReader;
 import java.io.IOException;
+import java.io.InputStreamReader;
 import java.nio.charset.Charset;
 import java.nio.file.Path;
+import java.util.stream.Collectors;
 
 public final class EnvironmentReporting {
     private EnvironmentReporting() {}
 
     public static String diskUsage() throws IOException {
         Process p = new ProcessBuilder("df", "-h").start();
-        String stdout = IOUtils.toString(p.getInputStream(), Charset.defaultCharset());
+        String stdout = new BufferedReader(new InputStreamReader(p.getInputStream(), Charset.defaultCharset()))
+            .lines()
+            .collect(Collectors.joining(System.lineSeparator()));
         String diskUsage = "$ df -h\n" + stdout;
         return asMultilineCloudWatchLogMessageIfAppropriate(diskUsage);
     }
 
     public static String directoryContents(Path directory) throws IOException {
         Process p = new ProcessBuilder("ls", "-l", directory.toAbsolutePath().toString()).start();
-        String stdout = IOUtils.toString(p.getInputStream(), Charset.defaultCharset());
+        String stdout = new BufferedReader(new InputStreamReader(p.getInputStream(), Charset.defaultCharset()))
+            .lines()
+            .collect(Collectors.joining(System.lineSeparator()));
         String directoryContents = "$ ls -l " + directory + "\n" + stdout;
         return asMultilineCloudWatchLogMessageIfAppropriate(directoryContents);
     }