1 /*
   2  * Copyright (c) 2012, 2016, 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  * @test
  26  * @bug 8015912 8029216 8048063 8050804
  27  * @summary Test -apionly and -jdkinternals options
  28  * @library lib
  29  * @modules java.base/sun.security.x509
  30  *          java.management
  31  *          jdk.jdeps/com.sun.tools.classfile
  32  *          jdk.jdeps/com.sun.tools.jdeps
  33  * @run main APIDeps
  34  */
  35 
  36 import java.io.File;
  37 import java.io.IOException;
  38 import java.io.PrintWriter;
  39 import java.io.StringWriter;
  40 import java.nio.file.*;
  41 import java.util.*;
  42 import java.util.regex.*;
  43 import java.util.stream.Collectors;
  44 
  45 public class APIDeps {
  46     public static void main(String... args) throws Exception {
  47         int errors = 0;
  48         errors += new APIDeps().run();
  49         if (errors > 0)
  50             throw new Exception(errors + " errors found");
  51     }
  52 
  53     private static final Path dest = Paths.get(System.getProperty("test.classes", "."), "tmp");
  54     private static final String[] srcDirs = new String[] {
  55             "m", "b", "c", "d", "e", "f", "g"
  56     };
  57     void setup(Path dest) throws IOException {
  58         CompilerUtils.cleanDir(dest);
  59         Files.createDirectories(dest);
  60         Path testsrc = Paths.get(System.getProperty("test.src"));
  61         List<String> options = new ArrayList<>();
  62 
  63         // add --add-exports
  64         String testModules = System.getProperty("test.modules", "");
  65         List<String> addExports = new ArrayList<>();
  66         for (String s : testModules.split("\\s+")) {
  67             if (s.isEmpty()) continue;
  68             if (s.indexOf('/') != -1)
  69                 addExports.add("--add-exports=" + s.trim() + "=ALL-UNNAMED");
  70         }
  71         options.addAll(addExports);
  72 
  73         for (String dir : srcDirs) {
  74             Path source = testsrc.resolve(dir);
  75             boolean ok = CompilerUtils.compile(source, dest, options.toArray(new String[0]));
  76             if (!ok) {
  77                 throw new RuntimeException("compilation fails");
  78             }
  79         }
  80     }
  81 
  82     int run() throws IOException {
  83         // compile classes in a separate directory for analysis
  84         setup(dest);
  85 
  86         File testDir = dest.toFile();
  87         String testDirBasename = testDir.toPath().getFileName().toString();
  88         File mDir = new File(testDir, "m");
  89         // all dependencies
  90         test(new File(mDir, "Bar.class"),
  91              new String[] {"java.lang.Object", "java.lang.String",
  92                            "java.util.Set", "java.util.HashSet",
  93                            "java.lang.management.ManagementFactory",
  94                            "java.lang.management.RuntimeMXBean",
  95                            "b.B", "c.C", "d.D", "f.F", "g.G"},
  96              new String[] {"compact1", "compact3", testDirBasename},
  97              new String[] {"-classpath", testDir.getPath(), "-verbose", "-P"});
  98         test(new File(mDir, "Foo.class"),
  99              new String[] {"c.I", "e.E", "f.F"},
 100              new String[] {testDirBasename},
 101              new String[] {"-classpath", testDir.getPath(), "-verbose:class", "-P"});
 102         test(new File(mDir, "Foo.class"),
 103              new String[] {"c.I", "e.E", "f.F", "m.Bar"},
 104              new String[] {testDirBasename},
 105              new String[] {"-classpath", testDir.getPath(), "-verbose:class", "-filter:none", "-P"});
 106         test(new File(mDir, "Gee.class"),
 107              new String[] {"g.G", "sun.security.x509.X509CertInfo", "com.sun.tools.classfile.ClassFile",
 108                            "com.sun.management.ThreadMXBean", "com.sun.source.tree.BinaryTree"},
 109              new String[] {testDirBasename, "JDK internal API", "compact3", ""},
 110              new String[] {"-classpath", testDir.getPath(), "-verbose", "-P"});
 111 
 112         // -jdkinternals
 113         test(new File(mDir, "Gee.class"),
 114              new String[] {"sun.security.x509.X509CertInfo", "com.sun.tools.classfile.ClassFile"},
 115              new String[] {"JDK internal API"},
 116              new String[] {"-jdkinternals", "-quiet"});
 117         // -jdkinternals parses all classes on -classpath and the input arguments
 118         test(new File(mDir, "Gee.class"),
 119              new String[] {"com.sun.tools.classfile.ClassFile",
 120                            "sun.security.x509.X509CertInfo"},
 121              new String[] {"JDK internal API"},
 122              // use -classpath tmp/a with no use of JDK internal API
 123              new String[] {"-classpath", dest.resolve("a").toString(), "-jdkinternals", "-quiet"});
 124 
 125         // parse only APIs
 126         test(mDir,
 127              new String[] {"java.lang.Object", "java.lang.String",
 128                            "java.util.Set",
 129                            "c.C", "d.D", "c.I", "e.E"},
 130              new String[] {"compact1", testDirBasename},
 131              new String[] {"-classpath", testDir.getPath(), "-verbose:class", "-P", "-apionly"});
 132 
 133         test(mDir,
 134              new String[] {"java.lang.Object", "java.lang.String",
 135                            "java.util.Set",
 136                            "c.C", "d.D", "c.I", "e.E", "m.Bar"},
 137              new String[] {"compact1", testDirBasename, mDir.getName()},
 138              new String[] {"-classpath", testDir.getPath(), "-verbose", "-P", "--api-only"});
 139         return errors;
 140     }
 141 
 142     void test(File file, String[] expect, String[] profiles) {
 143         test(file, expect, profiles, new String[0]);
 144     }
 145 
 146     void test(File file, String[] expect, String[] profiles, String[] options) {
 147         List<String> args = new ArrayList<>(Arrays.asList(options));
 148         if (file != null) {
 149             args.add(file.getPath());
 150         }
 151         checkResult("api-dependencies", expect, profiles,
 152                     jdeps(args.toArray(new String[0])));
 153     }
 154 
 155     Map<String,String> jdeps(String... args) {
 156         StringWriter sw = new StringWriter();
 157         PrintWriter pw = new PrintWriter(sw);
 158         System.err.println("jdeps " + Arrays.stream(args)
 159             .collect(Collectors.joining(" ")));
 160         int rc = com.sun.tools.jdeps.Main.run(args, pw);
 161         pw.close();
 162         String out = sw.toString();
 163         if (!out.isEmpty())
 164             System.err.println(out);
 165         if (rc != 0)
 166             throw new Error("jdeps failed: rc=" + rc);
 167         return findDeps(out);
 168     }
 169 
 170     // Pattern used to parse lines
 171     private static Pattern linePattern = Pattern.compile(".*\r?\n");
 172     private static Pattern pattern = Pattern.compile("\\s+ -> (\\S+) +(.*)");
 173 
 174     // Use the linePattern to break the given String into lines, applying
 175     // the pattern to each line to see if we have a match
 176     private static Map<String,String> findDeps(String out) {
 177         Map<String,String> result = new HashMap<>();
 178         Matcher lm = linePattern.matcher(out);  // Line matcher
 179         Matcher pm = null;                      // Pattern matcher
 180         int lines = 0;
 181         while (lm.find()) {
 182             lines++;
 183             CharSequence cs = lm.group();       // The current line
 184             if (pm == null)
 185                 pm = pattern.matcher(cs);
 186             else
 187                 pm.reset(cs);
 188             if (pm.find())
 189                 result.put(pm.group(1), pm.group(2).trim());
 190             if (lm.end() == out.length())
 191                 break;
 192         }
 193         return result;
 194     }
 195 
 196     void checkResult(String label, String[] expect, Collection<String> found) {
 197         List<String> list = Arrays.asList(expect);
 198         if (!isEqual(list, found))
 199             error("Unexpected " + label + " found: '" + found + "', expected: '" + list + "'");
 200     }
 201 
 202     void checkResult(String label, String[] expect, String[] profiles, Map<String,String> result) {
 203         // check the dependencies
 204         checkResult(label, expect, result.keySet());
 205         // check profile information
 206         Set<String> values = new TreeSet<>();
 207         String internal = "JDK internal API";
 208         for (String s: result.values()) {
 209             if (s.startsWith(internal)){
 210                 values.add(internal);
 211             } else {
 212                 values.add(s);
 213             }
 214         }
 215         checkResult(label, profiles, values);
 216     }
 217 
 218     boolean isEqual(List<String> expected, Collection<String> found) {
 219         if (expected.size() != found.size())
 220             return false;
 221 
 222         List<String> list = new ArrayList<>(found);
 223         list.removeAll(expected);
 224         return list.isEmpty();
 225     }
 226 
 227     void error(String msg) {
 228         System.err.println("Error: " + msg);
 229         errors++;
 230     }
 231 
 232     int errors;
 233 
 234 }