1 /*
   2  * Copyright (c) 2017, 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.options.OptionKey;
  35 import org.graalvm.compiler.options.OptionValues;
  36 import org.junit.Test;
  37 
  38 /**
  39  * Check that setting the dump path results in files ending up in the right directory with matching
  40  * names.
  41  */
  42 public class DumpPathTest extends GraalCompilerTest {
  43 
  44     public static Object snippet() {
  45         return new String("snippet");
  46     }
  47 
  48     @Test
  49     public void testDump() throws IOException {
  50         assumeManagementLibraryIsLoadable();
  51         Path dumpDirectoryPath = Files.createTempDirectory("DumpPathTest");
  52         String[] extensions = new String[]{".cfg", ".bgv", ".graph-strings"};
  53         EconomicMap<OptionKey<?>, Object> overrides = OptionValues.newOptionMap();
  54         overrides.put(DebugOptions.DumpPath, dumpDirectoryPath.toString());
  55         overrides.put(DebugOptions.PrintGraphFile, true);
  56         overrides.put(DebugOptions.PrintCanonicalGraphStrings, true);
  57         overrides.put(DebugOptions.Dump, "*");
  58 
  59         // Generate dump files.
  60         test(new OptionValues(getInitialOptions(), overrides), "snippet");
  61         // Check that Ideal files got created, in the right place.
  62         checkForFiles(dumpDirectoryPath, extensions);
  63 
  64         // Clean up the generated files.
  65         scrubDirectory(dumpDirectoryPath);
  66     }
  67 
  68     /**
  69      * Check that the given directory contains file or directory names with all the given
  70      * extensions.
  71      */
  72     private static void checkForFiles(Path directoryPath, String[] extensions) throws IOException {
  73         String[] paths = new String[extensions.length];
  74         try (DirectoryStream<Path> stream = Files.newDirectoryStream(directoryPath)) {
  75             for (Path filePath : stream) {
  76                 String fileName = filePath.getFileName().toString();
  77                 for (int i = 0; i < extensions.length; i++) {
  78                     String extension = extensions[i];
  79                     if (fileName.endsWith(extensions[i])) {
  80                         assertTrue(paths[i] == null, "multiple files found for %s in %s", extension, directoryPath);
  81                         paths[i] = fileName.replace(extensions[i], "");
  82                     }
  83                 }
  84             }
  85         }
  86         for (int i = 0; i < paths.length; i++) {
  87             assertTrue(paths[i] != null, "missing file for extension %s in %s", extensions[i], directoryPath);
  88         }
  89         // Ensure that all file names are the same.
  90         for (int i = 1; i < paths.length; i++) {
  91             assertTrue(paths[0].equals(paths[i]), paths[0] + " != " + paths[i]);
  92         }
  93     }
  94 
  95     /**
  96      * Remove the temporary directory.
  97      */
  98     private static void scrubDirectory(Path directoryPath) {
  99         try {
 100             try (DirectoryStream<Path> stream = Files.newDirectoryStream(directoryPath)) {
 101                 for (Path filePath : stream) {
 102                     if (Files.isRegularFile(filePath)) {
 103                         Files.delete(filePath);
 104                     } else if (Files.isDirectory(filePath)) {
 105                         scrubDirectory(filePath);
 106                     }
 107                 }
 108             }
 109             Files.delete(directoryPath);
 110         } catch (IOException ioe) {
 111             ioe.printStackTrace();
 112         }
 113     }
 114 }