1 /*
   2  * Copyright (c) 2017, 2018, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.
   8  *
   9  * This code is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12  * version 2 for more details (a copy is included in the LICENSE file that
  13  * accompanied this code).
  14  *
  15  * You should have received a copy of the GNU General Public License version
  16  * 2 along with this work; if not, write to the Free Software Foundation,
  17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  18  *
  19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  20  * or visit www.oracle.com if you need additional information or have any
  21  * questions.
  22  */
  23 
  24 
  25 package org.graalvm.compiler.core.test;
  26 
  27 import java.io.IOException;
  28 import java.nio.file.DirectoryStream;
  29 import java.nio.file.Files;
  30 import java.nio.file.Path;
  31 
  32 import jdk.internal.vm.compiler.collections.EconomicMap;
  33 import org.graalvm.compiler.debug.DebugOptions;
  34 import org.graalvm.compiler.debug.DebugOptions.PrintGraphTarget;
  35 import org.graalvm.compiler.options.OptionKey;
  36 import org.graalvm.compiler.options.OptionValues;
  37 import org.junit.Test;
  38 
  39 /**
  40  * Check that setting the dump path results in files ending up in the right directory with matching
  41  * names.
  42  */
  43 public class DumpPathTest extends GraalCompilerTest {
  44 
  45     public static Object snippet() {
  46         return new String("snippet");
  47     }
  48 
  49     @Test
  50     public void testDump() throws IOException {
  51         assumeManagementLibraryIsLoadable();
  52         Path dumpDirectoryPath = Files.createTempDirectory("DumpPathTest");
  53         String[] extensions = new String[]{".cfg", ".bgv", ".graph-strings"};
  54         EconomicMap<OptionKey<?>, Object> overrides = OptionValues.newOptionMap();
  55         overrides.put(DebugOptions.DumpPath, dumpDirectoryPath.toString());
  56         overrides.put(DebugOptions.PrintGraph, PrintGraphTarget.File);
  57         overrides.put(DebugOptions.PrintCanonicalGraphStrings, true);
  58         overrides.put(DebugOptions.Dump, "*");
  59 
  60         // Generate dump files.
  61         test(new OptionValues(getInitialOptions(), overrides), "snippet");
  62         // Check that Ideal files got created, in the right place.
  63         checkForFiles(dumpDirectoryPath, extensions);
  64 
  65         // Clean up the generated files.
  66         scrubDirectory(dumpDirectoryPath);
  67     }
  68 
  69     /**
  70      * Check that the given directory contains file or directory names with all the given
  71      * extensions.
  72      */
  73     private static void checkForFiles(Path directoryPath, String[] extensions) throws IOException {
  74         String[] paths = new String[extensions.length];
  75         try (DirectoryStream<Path> stream = Files.newDirectoryStream(directoryPath)) {
  76             for (Path filePath : stream) {
  77                 String fileName = filePath.getFileName().toString();
  78                 for (int i = 0; i < extensions.length; i++) {
  79                     String extension = extensions[i];
  80                     if (fileName.endsWith(extensions[i])) {
  81                         assertTrue(paths[i] == null, "multiple files found for %s in %s", extension, directoryPath);
  82                         paths[i] = fileName.replace(extensions[i], "");
  83                     }
  84                 }
  85             }
  86         }
  87         for (int i = 0; i < paths.length; i++) {
  88             assertTrue(paths[i] != null, "missing file for extension %s in %s", extensions[i], directoryPath);
  89         }
  90         // Ensure that all file names are the same.
  91         for (int i = 1; i < paths.length; i++) {
  92             assertTrue(paths[0].equals(paths[i]), paths[0] + " != " + paths[i]);
  93         }
  94     }
  95 
  96     /**
  97      * Remove the temporary directory.
  98      */
  99     private static void scrubDirectory(Path directoryPath) {
 100         try {
 101             try (DirectoryStream<Path> stream = Files.newDirectoryStream(directoryPath)) {
 102                 for (Path filePath : stream) {
 103                     if (Files.isRegularFile(filePath)) {
 104                         Files.delete(filePath);
 105                     } else if (Files.isDirectory(filePath)) {
 106                         scrubDirectory(filePath);
 107                     }
 108                 }
 109             }
 110             Files.delete(directoryPath);
 111         } catch (IOException ioe) {
 112             ioe.printStackTrace();
 113         }
 114     }
 115 }