[GR-44870] Ensure bundle temp directory gets deleted in case of SIGTERM.

PullRequest: graal/14100

Author: olpaw

substratevm/src/com.oracle.svm.driver/src/com/oracle/svm/driver/BundleSupport.java

@@ -41,6 +41,7 @@
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collections;
+import java.util.Enumeration;
 import java.util.HashMap;
 import java.util.HashSet;
 import java.util.List;
@@ -50,6 +51,7 @@
 import java.util.Optional;
 import java.util.Properties;
 import java.util.Set;
+import java.util.concurrent.atomic.AtomicBoolean;
 import java.util.function.Predicate;
 import java.util.jar.Attributes;
 import java.util.jar.JarEntry;
@@ -194,7 +196,7 @@ private BundleSupport(NativeImage nativeImage) {
         loadBundle = false;
         writeBundle = true;
         try {
-            rootDir = Files.createTempDirectory(BUNDLE_TEMP_DIR_PREFIX);
+            rootDir = createBundleRootDir();
             bundleProperties = new BundleProperties();
 
             Path inputDir = rootDir.resolve("input");
@@ -223,15 +225,17 @@ private BundleSupport(NativeImage nativeImage, String bundleFilenameArg) {
         updateBundleLocation(Path.of(bundleFilenameArg), false);
 
         try {
-            rootDir = Files.createTempDirectory(BUNDLE_TEMP_DIR_PREFIX);
+            rootDir = createBundleRootDir();
             bundleProperties = new BundleProperties();
 
             outputDir = rootDir.resolve("output");
             String originalOutputDirName = outputDir.getFileName().toString() + ORIGINAL_DIR_EXTENSION;
 
             Path bundleFilePath = bundlePath.resolve(bundleName + BUNDLE_FILE_EXTENSION);
             try (JarFile archive = new JarFile(bundleFilePath.toFile())) {
-                archive.stream().forEach(jarEntry -> {
+                Enumeration<JarEntry> jarEntries = archive.entries();
+                while (jarEntries.hasMoreElements() && !deleteBundleRoot.get()) {
+                    JarEntry jarEntry = jarEntries.nextElement();
                     Path bundleEntry = rootDir.resolve(jarEntry.getName());
                     if (bundleEntry.startsWith(outputDir)) {
                         /* Extract original output to different path */
@@ -246,12 +250,17 @@ private BundleSupport(NativeImage nativeImage, String bundleFilenameArg) {
                     } catch (IOException e) {
                         throw NativeImage.showError("Unable to copy " + jarEntry.getName() + " from bundle " + bundleEntry + " to " + bundleEntry, e);
                     }
-                });
+                }
             }
         } catch (IOException e) {
             throw NativeImage.showError("Unable to expand bundle directory layout from bundle file " + bundleName + BUNDLE_FILE_EXTENSION, e);
         }
 
+        if (deleteBundleRoot.get()) {
+            /* Abort image build request without error message and exit with 0 */
+            throw NativeImage.showError(null, null, 0);
+        }
+
         bundleProperties.loadAndVerify();
 
         try {
@@ -280,10 +289,12 @@ private BundleSupport(NativeImage nativeImage, String bundleFilenameArg) {
             throw NativeImage.showError("Failed to read bundle-file " + pathSubstitutionsFile, e);
         }
         Path environmentFile = stageDir.resolve("environment.json");
-        try (Reader reader = Files.newBufferedReader(environmentFile)) {
-            new EnvironmentParser(nativeImage.imageBuilderEnvironment).parseAndRegister(reader);
-        } catch (IOException e) {
-            throw NativeImage.showError("Failed to read bundle-file " + environmentFile, e);
+        if (Files.isReadable(environmentFile)) {
+            try (Reader reader = Files.newBufferedReader(environmentFile)) {
+                new EnvironmentParser(nativeImage.imageBuilderEnvironment).parseAndRegister(reader);
+            } catch (IOException e) {
+                throw NativeImage.showError("Failed to read bundle-file " + environmentFile, e);
+            }
         }
 
         Path buildArgsFile = stageDir.resolve("build.json");
@@ -296,6 +307,17 @@ private BundleSupport(NativeImage nativeImage, String bundleFilenameArg) {
         }
     }
 
+    private final AtomicBoolean deleteBundleRoot = new AtomicBoolean();
+
+    private Path createBundleRootDir() throws IOException {
+        Path bundleRoot = Files.createTempDirectory(BUNDLE_TEMP_DIR_PREFIX);
+        Runtime.getRuntime().addShutdownHook(new Thread(() -> {
+            deleteBundleRoot.set(true);
+            nativeImage.deleteAllFiles(bundleRoot);
+        }));
+        return bundleRoot;
+    }
+
     public List<String> getNativeImageArgs() {
         return nativeImageArgs;
     }
@@ -486,9 +508,9 @@ private void copyFile(Path sourceFile, Path target, boolean overwrite) {
     void complete() {
         boolean writeOutput;
         try (Stream<Path> pathOutputFiles = Files.list(imagePathOutputDir); Stream<Path> auxiliaryOutputFiles = Files.list(auxiliaryOutputDir)) {
-            writeOutput = pathOutputFiles.findAny().isPresent() || auxiliaryOutputFiles.findAny().isPresent();
+            writeOutput = (pathOutputFiles.findAny().isPresent() || auxiliaryOutputFiles.findAny().isPresent()) && !deleteBundleRoot.get();
         } catch (IOException e) {
-            throw NativeImage.showError("Unable to determine if bundle output should be written.");
+            writeOutput = false;
         }
 
         /*
@@ -517,7 +539,6 @@ void complete() {
             }
         } finally {
             nativeImage.showNewline();
-            nativeImage.deleteAllFiles(rootDir);
         }
     }
 

substratevm/src/com.oracle.svm.driver/src/com/oracle/svm/driver/NativeImage.java

@@ -1560,6 +1560,12 @@ private static void sanitizeJVMEnvironment(Map<String, String> environment, Map<
             } else {
                 environment.forEach((key, val) -> {
                     if (keyMapper.apply(key).equals(keyMapper.apply(entry.getKey()))) {
+                        /*
+                         * Record key as it was given by -E<key-name> (by using `entry.getKey()`
+                         * instead of `key`) to allow creating bundles on Windows that will also
+                         * work on Linux. `System.getEnv(val)` is case-insensitive on Windows but
+                         * not on Linux.
+                         */
                         restrictedEnvironment.put(entry.getKey(), val);
                         /* Capture found value for storing vars in bundle */
                         entry.setValue(val);