/*

 * Copyright (c) 2012, 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.

 *

 * 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.

 */

/*

 * @test

 * @bug 8015912

 * @summary find API dependencies

 * @build m.Bar m.Foo m.Gee b.B c.C c.I d.D e.E f.F g.G

 * @run main APIDeps

 */

import java.io.File;

import java.io.IOException;

import java.io.PrintWriter;

import java.io.StringWriter;

import java.nio.file.Path;

import java.nio.file.Paths;

import java.util.*;

import java.util.regex.*;

public class APIDeps {

    private static boolean symbolFileExist = initProfiles();

    private static boolean initProfiles() {

        // check if ct.sym exists; if not use the profiles.properties file

        Path home = Paths.get(System.getProperty("java.home"));

        if (home.endsWith("jre")) {

            home = home.getParent();

        }

        Path ctsym = home.resolve("lib").resolve("ct.sym");

        boolean symbolExists = ctsym.toFile().exists();

        if (!symbolExists) {

            Path testSrcProfiles =

                Paths.get(System.getProperty("test.src", "."), "profiles.properties");

            if (!testSrcProfiles.toFile().exists())

                throw new Error(testSrcProfiles + " does not exist");

            System.out.format("%s doesn't exist.%nUse %s to initialize profiles info%n",

                ctsym, testSrcProfiles);

            System.setProperty("jdeps.profiles", testSrcProfiles.toString());

        }

        return symbolExists;

    }

    public static void main(String... args) throws Exception {

        int errors = 0;

        errors += new APIDeps().run();

        if (errors > 0)

            throw new Exception(errors + " errors found");

    }

    int run() throws IOException {

        File testDir = new File(System.getProperty("test.classes", "."));

        String testDirBasename = testDir.toPath().getFileName().toString();

        File mDir = new File(testDir, "m");

        // all dependencies

        test(new File(mDir, "Bar.class"),

             new String[] {"java.lang.Object", "java.lang.String",

                           "java.util.Set", "java.util.HashSet",

                           "java.lang.management.ManagementFactory",

                           "java.lang.management.RuntimeMXBean",

                           "b.B", "c.C", "d.D", "f.F", "g.G"},

             new String[] {"compact1", "compact3", testDirBasename},

             new String[] {"-classpath", testDir.getPath(), "-verbose", "-P"});

        test(new File(mDir, "Foo.class"),

             new String[] {"c.I", "e.E", "f.F", "m.Bar"},

             new String[] {testDirBasename},

             new String[] {"-classpath", testDir.getPath(), "-verbose", "-P"});

        test(new File(mDir, "Gee.class"),

             new String[] {"g.G", "sun.misc.Lock"},

             new String[] {testDirBasename, "JDK internal API"},

             new String[] {"-classpath", testDir.getPath(), "-verbose"});

        // parse only APIs

        test(mDir,

             new String[] {"java.lang.Object", "java.lang.String",

                           "java.util.Set",

                           "c.C", "d.D", "c.I", "e.E", "m.Bar"},

             new String[] {"compact1", testDirBasename, mDir.getName()},

             new String[] {"-classpath", testDir.getPath(), "-verbose", "-P", "-apionly"});

        return errors;

    }

    void test(File file, String[] expect, String[] profiles) {

        test(file, expect, profiles, new String[0]);

    }

    void test(File file, String[] expect, String[] profiles, String[] options) {

        List<String> args = new ArrayList<>(Arrays.asList(options));

        if (file != null) {

            args.add(file.getPath());

        }

        checkResult("api-dependencies", expect, profiles,

                    jdeps(args.toArray(new String[0])));

    }

    Map<String,String> jdeps(String... args) {

        StringWriter sw = new StringWriter();

        PrintWriter pw = new PrintWriter(sw);

        System.err.println("jdeps " + Arrays.toString(args));

        int rc = com.sun.tools.jdeps.Main.run(args, pw);

        pw.close();

        String out = sw.toString();

        if (!out.isEmpty())

            System.err.println(out);

        if (rc != 0)

            throw new Error("jdeps failed: rc=" + rc);

        return findDeps(out);

    }

    // Pattern used to parse lines

    private static Pattern linePattern = Pattern.compile(".*\r?\n");

    private static Pattern pattern = Pattern.compile("\\s+ -> (\\S+) +(.*)");

    // Use the linePattern to break the given String into lines, applying

    // the pattern to each line to see if we have a match

    private static Map<String,String> findDeps(String out) {

        Map<String,String> result = new HashMap<>();

        Matcher lm = linePattern.matcher(out);  // Line matcher

        Matcher pm = null;                      // Pattern matcher

        int lines = 0;

        while (lm.find()) {

            lines++;

            CharSequence cs = lm.group();       // The current line

            if (pm == null)

                pm = pattern.matcher(cs);

            else

                pm.reset(cs);

            if (pm.find())

                result.put(pm.group(1), pm.group(2).trim());

            if (lm.end() == out.length())

                break;

        }

        return result;

    }

    void checkResult(String label, String[] expect, Collection<String> found) {

        List<String> list = Arrays.asList(expect);

        if (!isEqual(list, found))

            error("Unexpected " + label + " found: '" + found + "', expected: '" + list + "'");

    }

    void checkResult(String label, String[] expect, String[] profiles, Map<String,String> result) {

        // check the dependencies

        checkResult(label, expect, result.keySet());

        // check profile information

        Set<String> values = new TreeSet<>();

        String internal = "JDK internal API";

        for (String s: result.values()) {

            if (s.startsWith(internal)){

                values.add(internal);

            } else {

                values.add(s);

            }

        }

        checkResult(label, profiles, values);

    }

    boolean isEqual(List<String> expected, Collection<String> found) {

        if (expected.size() != found.size())

            return false;

        List<String> list = new ArrayList<>(found);

        list.removeAll(expected);

        return list.isEmpty();

    }

    void error(String msg) {

        System.err.println("Error: " + msg);

        errors++;

    }

    int errors;

}