/*

 * Copyright (c) 2014, 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 8003562

 * @summary Basic tests for jdeps -dotoutput option

 * @build Test p.Foo p.Bar javax.activity.NotCompactProfile

 * @run main DotFileTest

 */

import java.io.File;

import java.io.IOException;

import java.io.PrintWriter;

import java.io.StringWriter;

import java.nio.file.DirectoryStream;

import java.nio.file.Files;

import java.nio.file.Path;

import java.nio.file.Paths;

import java.util.*;

import java.util.regex.*;

public class DotFileTest {

    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 DotFileTest().run();

        if (errors > 0)

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

    }

    final Path dir;

    final Path dotoutput;

    DotFileTest() {

        this.dir = Paths.get(System.getProperty("test.classes", "."));

        this.dotoutput = dir.resolve("dots");

    }

    int run() throws IOException {

        File testDir = dir.toFile();

        // test a .class file

        test(new File(testDir, "Test.class"),

             new String[] {"java.lang", "p"},

             new String[] {"compact1", "not found"});

        // test a directory

        // also test non-SE javax.activity class dependency

        test(new File(testDir, "p"),

             new String[] {"java.lang", "java.util", "java.lang.management", "javax.activity", "javax.crypto"},

             new String[] {"compact1", "compact1", "compact3", testDir.getName(), "compact1"},

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

        // test class-level dependency output

        test(new File(testDir, "Test.class"),

             new String[] {"java.lang.Object", "java.lang.String", "p.Foo", "p.Bar"},

             new String[] {"compact1", "compact1", "not found", "not found"},

             new String[] {"-verbose:class"});

        // test -filter:none option

        test(new File(testDir, "p"),

             new String[] {"java.lang", "java.util", "java.lang.management", "javax.activity", "javax.crypto", "p"},

             new String[] {"compact1", "compact1", "compact3", testDir.getName(), "compact1", "p"},

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

        // test -filter:archive option

        test(new File(testDir, "p"),

             new String[] {"java.lang", "java.util", "java.lang.management", "javax.activity", "javax.crypto"},

             new String[] {"compact1", "compact1", "compact3", testDir.getName(), "compact1"},

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

        // test -p option

        test(new File(testDir, "Test.class"),

             new String[] {"p.Foo", "p.Bar"},

             new String[] {"not found", "not found"},

             new String[] {"-verbose:class", "-p", "p"});

        // test -e option

        test(new File(testDir, "Test.class"),

             new String[] {"p.Foo", "p.Bar"},

             new String[] {"not found", "not found"},

             new String[] {"-verbose:class", "-e", "p\\..*"});

        test(new File(testDir, "Test.class"),

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

             new String[] {"compact1"},

             new String[] {"-verbose:package", "-e", "java\\.lang\\..*"});

        // test -classpath options

        test(new File(testDir, "Test.class"),

             new String[] {"java.lang.Object", "java.lang.String", "p.Foo", "p.Bar"},

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

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

        testSummary(new File(testDir, "Test.class"),

             new String[] {"java.base", testDir.getName()},

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

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

        testSummary(new File(testDir, "Test.class"),

             new String[] {"java.lang", "p"},

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

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

        return errors;

    }

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

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

    }

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

        throws IOException

    {

        Path dotfile = dotoutput.resolve(file.toPath().getFileName().toString() + ".dot");

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

        args.add("-dotoutput");

        args.add(dotoutput.toString());

        if (file != null) {

            args.add(file.getPath());

        }

        Map<String,String> result = jdeps(args, dotfile);

        checkResult("dependencies", expect, result.keySet());

        // with -P option

        List<String> argsWithDashP = new ArrayList<>();

        argsWithDashP.add("-dotoutput");

        argsWithDashP.add(dotoutput.toString());

        argsWithDashP.add("-P");

        argsWithDashP.addAll(args);

        result = jdeps(argsWithDashP, dotfile);

        checkResult("profiles", expect, profiles, result);

    }

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

        throws IOException

    {

        Path dotfile = dotoutput.resolve("summary.dot");

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

        args.add("-dotoutput");

        args.add(dotoutput.toString());

        if (file != null) {

            args.add(file.getPath());

        }

        Map<String,String> result = jdeps(args, dotfile);

        checkResult("dependencies", expect, result.keySet());

        // with -P option

        List<String> argsWithDashP = new ArrayList<>();

        argsWithDashP.add("-dotoutput");

        argsWithDashP.add(dotoutput.toString());

        argsWithDashP.add("-P");

        argsWithDashP.addAll(args);

        result = jdeps(argsWithDashP, dotfile);

        checkResult("profiles", expect, profiles, result);

    }

    Map<String,String> jdeps(List<String> args, Path dotfile) throws IOException {

        if (Files.exists(dotoutput)) {

            try (DirectoryStream<Path> stream = Files.newDirectoryStream(dotoutput)) {

                for (Path p : stream) {

                    Files.delete(p);

                }

            }

            Files.delete(dotoutput);

        }

        // invoke jdeps

        StringWriter sw = new StringWriter();

        PrintWriter pw = new PrintWriter(sw);

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

        int rc = com.sun.tools.jdeps.Main.run(args.toArray(new String[0]), pw);

        pw.close();

        String out = sw.toString();

        if (!out.isEmpty())

            System.err.println(out);

        if (rc != 0)

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

        // check output files

        if (Files.notExists(dotfile)) {

            throw new RuntimeException(dotfile + " doesn't exist");

        }

        return parse(dotfile);

    }

    private static Pattern pattern = Pattern.compile("(.*) -> +([^ ]*) (.*)");

    private Map<String,String> parse(Path outfile) throws IOException {

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

        for (String line : Files.readAllLines(outfile)) {

            line = line.replace('"', ' ').replace(';', ' ');

            Matcher pm = pattern.matcher(line);

            if (pm.find()) {

                String origin = pm.group(1).trim();

                String target = pm.group(2).trim();

                String module = pm.group(3).replace('(', ' ').replace(')', ' ').trim();

                result.put(target, module);

            }

        }

        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) {

        if (expect.length != profiles.length)

            error("Invalid expected names and profiles");

        // check the dependencies

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

        // check profile information

        checkResult(label, profiles, result.values());

        for (int i=0; i < expect.length; i++) {

            String profile = result.get(expect[i]);

            if (!profile.equals(profiles[i]))

                error("Unexpected profile: '" + profile + "', expected: '" + profiles[i] + "'");

        }

    }

    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;

}