Add native unit test to test resource inclusion from path with space

Author: zakkak

substratevm/mx.substratevm/suite.py

@@ -946,6 +946,24 @@
             "jacoco" : "exclude",
         },
 
+        "com.oracle.svm.test.with.space": {
+            "subDir": "src",
+            "sourceDirs": ["src"],
+            "dependencies": [
+                "mx:JUNIT_TOOL",
+                "sdk:NATIVEIMAGE",
+            ],
+            "checkstyle": "com.oracle.svm.test",
+            "workingSets": "SVM",
+            "annotationProcessors": [
+                "compiler:GRAAL_PROCESSOR",
+                "SVM_PROCESSOR",
+            ],
+            "javaCompliance" : "21+",
+            "spotbugs": "false",
+            "jacoco" : "exclude",
+        },
+
         "com.oracle.svm.configure.test": {
             "subDir": "src",
             "sourceDirs": ["src"],
@@ -1992,6 +2010,19 @@
           "testDistribution" : True,
         },
 
+        "SVM_TESTS WITH SPACE" : {
+            "subDir": "src",
+            "relpath" : True,
+            "dependencies" : [
+                "com.oracle.svm.test.with.space",
+            ],
+            "distDependencies": [
+                "sdk:NATIVEIMAGE",
+                "mx:JUNIT_TOOL",
+            ],
+            "testDistribution" : True,
+        },
+
         "POLYGLOT_NATIVE_API" : {
             "subDir": "src",
             "dependencies": [

substratevm/src/com.oracle.svm.test.with.space/src/META-INF/native-image/com.oracle.svm.test.with.space/native-image.properties

@@ -0,0 +1,3 @@
+Args= \
+  --initialize-at-run-time=com.oracle.svm.test.with.space \
+  --features=com.oracle.svm.test.with.space.NativeImageResourceUtils$TestFeature

substratevm/src/com.oracle.svm.test.with.space/src/com/oracle/svm/test/with/space/NativeImageResourceTest.java

@@ -0,0 +1,48 @@
+/*
+ * Copyright (c) 2022, 2023, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.  Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code 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
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+package com.oracle.svm.test.with.space;
+
+import static com.oracle.svm.test.with.space.NativeImageResourceUtils.RESOURCE_FILE_IN_JAR_WITH_SPACE;
+import static com.oracle.svm.test.with.space.NativeImageResourceUtils.resourceNameToPath;
+import static com.oracle.svm.test.with.space.NativeImageResourceUtils.resourceNameToURL;
+
+import java.net.URL;
+import java.nio.file.Path;
+
+import org.junit.Assert;
+import org.junit.Test;
+
+public class NativeImageResourceTest {
+
+    @Test
+    @SuppressWarnings("deprecation")
+    public void accessFileFromJarWithSpaceInName() {
+        URL url = resourceNameToURL(RESOURCE_FILE_IN_JAR_WITH_SPACE, true);
+        Assert.assertNotNull("URL is null!", url);
+        Path path = resourceNameToPath(RESOURCE_FILE_IN_JAR_WITH_SPACE, true);
+        Assert.assertNotNull("Path is null!", path);
+    }
+}

substratevm/src/com.oracle.svm.test.with.space/src/com/oracle/svm/test/with/space/NativeImageResourceUtils.java

@@ -0,0 +1,75 @@
+/*
+ * Copyright (c) 2022, 2023, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.  Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code 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
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+package com.oracle.svm.test.with.space;
+
+import java.net.URI;
+import java.net.URISyntaxException;
+import java.net.URL;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+
+import org.graalvm.nativeimage.hosted.Feature;
+import org.graalvm.nativeimage.hosted.RuntimeResourceAccess;
+import org.junit.Assert;
+
+public class NativeImageResourceUtils {
+
+    public static final String ROOT_DIRECTORY = "/";
+    public static final String RESOURCE_DIR = "/resources";
+    public static final String RESOURCE_FILE_IN_JAR_WITH_SPACE = RESOURCE_DIR + "/resource-in-jar-with-space.txt";
+
+    // Register resources.
+    public static final class TestFeature implements Feature {
+        @Override
+        public void beforeAnalysis(BeforeAnalysisAccess access) {
+            // Remove leading / for the resource patterns
+            Module resourceModule = TestFeature.class.getModule();
+            RuntimeResourceAccess.addResource(resourceModule, RESOURCE_DIR.substring(1));
+            RuntimeResourceAccess.addResource(resourceModule, RESOURCE_FILE_IN_JAR_WITH_SPACE.substring(1));
+        }
+    }
+
+    public static URL resourceNameToURL(String resourceName, boolean failIfNotExists) {
+        URL resource = NativeImageResourceUtils.class.getResource(resourceName);
+        Assert.assertFalse("Resource " + resourceName + " is not found!", resource == null && failIfNotExists);
+        return resource;
+    }
+
+    public static URI resourceNameToURI(String resourceName, boolean failIfNotExists) {
+        try {
+            URL url = resourceNameToURL(resourceName, failIfNotExists);
+            return url != null ? url.toURI() : null;
+        } catch (URISyntaxException e) {
+            Assert.fail("Bad URI syntax!");
+        }
+        return null;
+    }
+
+    public static Path resourceNameToPath(String resourceName, boolean failIfNotExists) {
+        URI uri = resourceNameToURI(resourceName, failIfNotExists);
+        return uri != null ? Paths.get(uri) : null;
+    }
+}

substratevm/src/com.oracle.svm.test.with.space/src/resources/resource-in-jar-with-space.txt

@@ -0,0 +1 @@
+I am in a jar with spaces in its name!