/*

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

 * @summary Test all aspects of sjavac.

 * @bug 8004658 8042441 8042699 8054461 8054474 8054465

 *

 * @build Wrapper

 * @run main Wrapper SJavac

 */

import java.util.*;

import java.io.*;

import java.nio.file.*;

import java.nio.file.attribute.*;

import java.nio.charset.*;

import com.sun.tools.sjavac.Main;

public class SJavac {

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

        try {

            SJavac s = new SJavac();

            s.test();

        } finally {

            System.out.println("\ntest complete\n");

        }

    }

    FileSystem defaultfs = FileSystems.getDefault();

    String serverArg = "--server:"

            + "portfile=testportfile,"

            + "background=false";

    // Where to put generated sources that will

    // test aspects of sjavac, ie JTWork/scratch/gensrc

    Path gensrc;

    // More gensrc dirs are used to test merging of serveral source roots.

    Path gensrc2;

    Path gensrc3;

    // Where to put compiled classes.

    Path bin;

    // Where to put c-header files.

    Path headers;

    // Remember the previous bin and headers state here.

    Map<String,Long> previous_bin_state;

    Map<String,Long> previous_headers_state;

    public void test() throws Exception {

        gensrc = defaultfs.getPath("gensrc");

        gensrc2 = defaultfs.getPath("gensrc2");

        gensrc3 = defaultfs.getPath("gensrc3");

        bin = defaultfs.getPath("bin");

        headers = defaultfs.getPath("headers");

        Files.createDirectory(gensrc);

        Files.createDirectory(gensrc2);

        Files.createDirectory(gensrc3);

        Files.createDirectory(bin);

        Files.createDirectory(headers);

        initialCompile();

        incrementalCompileNoChanges();

        incrementalCompileDroppingClasses();

        incrementalCompileWithChange();

        incrementalCompileDropAllNatives();

        incrementalCompileAddNative();

        incrementalCompileChangeNative();

        compileWithOverrideSource();

        compileWithInvisibleSources();

        compileCircularSources();

        compileExcludingDependency();

        incrementalCompileTestFullyQualifiedRef();

        compileWithAtFile();

        testStateDir();

        testPermittedArtifact();

        delete(gensrc);

        delete(gensrc2);

        delete(gensrc3);

        delete(bin);

        delete(headers);

    }

    void initialCompile() throws Exception {

        System.out.println("\nInitial compile of gensrc.");

        System.out.println("----------------------------");

        populate(gensrc,

            "alfa/omega/AINT.java",

            "package alfa.omega; public interface AINT { void aint(); }",

            "alfa/omega/A.java",

            "package alfa.omega; public class A implements AINT { "+

                 "public final static int DEFINITION = 17; public void aint() { } }",

            "alfa/omega/AA.java",

            "package alfa.omega;"+

            "// A package private class, not contributing to the public api.\n"+

            "class AA {"+

            "   // A properly nested static inner class.\n"+

            "    static class AAA { }\n"+

            "    // A properly nested inner class.\n"+

            "    class AAAA { }\n"+

            "    Runnable foo() {\n"+

            "        // A proper anonymous class.\n"+

            "        return new Runnable() { public void run() { } };\n"+

            "    }\n"+

            "    AAA aaa;\n"+

            "    AAAA aaaa;\n"+

            "    AAAAA aaaaa;\n"+

            "}\n"+

            "class AAAAA {\n"+

            "    // A bad auxiliary class, but no one is referencing it\n"+

            "    // from outside of this source file, therefore it is ok.\n"+

            "}\n",

            "beta/BINT.java",

            "package beta;public interface BINT { void foo(); }",

            "beta/B.java",

            "package beta; import alfa.omega.A; public class B {"+

            "private int b() { return A.DEFINITION; } native void foo(); }");

        compile("gensrc", "-d", "bin", "-h", "headers", "-j", "1",

                serverArg, "--log=debug");

        previous_bin_state = collectState(bin);

        previous_headers_state = collectState(headers);

    }

    void incrementalCompileNoChanges() throws Exception {

        System.out.println("\nTesting that no change in sources implies no change in binaries.");

        System.out.println("------------------------------------------------------------------");

        compile("gensrc", "-d", "bin", "-h", "headers", "-j", "1",

                serverArg, "--log=debug");

        Map<String,Long> new_bin_state = collectState(bin);

        verifyEqual(new_bin_state, previous_bin_state);

        Map<String,Long> new_headers_state = collectState(headers);

        verifyEqual(previous_headers_state, new_headers_state);

    }

    void incrementalCompileDroppingClasses() throws Exception {

        System.out.println("\nTesting that deleting AA.java deletes all");

        System.out.println("generated inner class as well as AA.class");

        System.out.println("-----------------------------------------");

        removeFrom(gensrc, "alfa/omega/AA.java");

        compile("gensrc", "-d", "bin", "-h", "headers", "-j", "1",

                serverArg, "--log=debug");

        Map<String,Long> new_bin_state = collectState(bin);

        verifyThatFilesHaveBeenRemoved(previous_bin_state, new_bin_state,

                                       "bin/alfa/omega/AA$1.class",

                                       "bin/alfa/omega/AA$AAAA.class",

                                       "bin/alfa/omega/AA$AAA.class",

                                       "bin/alfa/omega/AAAAA.class",

                                       "bin/alfa/omega/AA.class");

        previous_bin_state = new_bin_state;

        Map<String,Long> new_headers_state = collectState(headers);

        verifyEqual(previous_headers_state, new_headers_state);

    }

    void incrementalCompileWithChange() throws Exception {

        System.out.println("\nNow update the A.java file with a new timestamps and");

        System.out.println("new final static definition. This should trigger a recompile,");

        System.out.println("not only of alfa, but also beta.");

        System.out.println("But check that the generated native header was not updated!");

        System.out.println("Since we did not modify the native api of B.");

        System.out.println("-------------------------------------------------------------");

        populate(gensrc,"alfa/omega/A.java",

                       "package alfa.omega; public class A implements AINT { "+

                 "public final static int DEFINITION = 18; public void aint() { } private void foo() { } }");

        compile("gensrc", "-d", "bin", "-h", "headers", "-j", "1",

                serverArg, "--log=debug");

        Map<String,Long> new_bin_state = collectState(bin);

        verifyNewerFiles(previous_bin_state, new_bin_state,

                         "bin/alfa/omega/A.class",

                         "bin/alfa/omega/AINT.class",

                         "bin/beta/B.class",

                         "bin/beta/BINT.class",

                         "bin/javac_state");

        previous_bin_state = new_bin_state;

        Map<String,Long> new_headers_state = collectState(headers);

        verifyEqual(new_headers_state, previous_headers_state);

    }

    void incrementalCompileDropAllNatives() throws Exception {

        System.out.println("\nNow update the B.java file with one less native method,");

        System.out.println("ie it has no longer any methods!");

        System.out.println("Verify that beta_B.h is removed!");

        System.out.println("---------------------------------------------------------");

        populate(gensrc,"beta/B.java",

                       "package beta; import alfa.omega.A; public class B {"+

                       "private int b() { return A.DEFINITION; } }");

        compile("gensrc", "-d", "bin", "-h", "headers", "-j", "1",

                serverArg, "--log=debug");

        Map<String,Long> new_bin_state = collectState(bin);

        verifyNewerFiles(previous_bin_state, new_bin_state,

                         "bin/beta/B.class",

                         "bin/beta/BINT.class",

                         "bin/javac_state");

        previous_bin_state = new_bin_state;

        Map<String,Long> new_headers_state = collectState(headers);

        verifyThatFilesHaveBeenRemoved(previous_headers_state, new_headers_state,

                                       "headers/beta_B.h");

        previous_headers_state = new_headers_state;

    }

    void incrementalCompileAddNative() throws Exception {

        System.out.println("\nNow update the B.java file with a final static annotated with @Native.");

        System.out.println("Verify that beta_B.h is added again!");

        System.out.println("------------------------------------------------------------------------");

        populate(gensrc,"beta/B.java",

                       "package beta; import alfa.omega.A; public class B {"+

                       "private int b() { return A.DEFINITION; } "+

                 "@java.lang.annotation.Native final static int alfa = 42; }");

        compile("gensrc", "-d", "bin", "-h", "headers", "-j", "1",

                serverArg, "--log=debug");

        Map<String,Long> new_bin_state = collectState(bin);

        verifyNewerFiles(previous_bin_state, new_bin_state,

                         "bin/beta/B.class",

                         "bin/beta/BINT.class",

                         "bin/javac_state");

        previous_bin_state = new_bin_state;

        Map<String,Long> new_headers_state = collectState(headers);

        verifyThatFilesHaveBeenAdded(previous_headers_state, new_headers_state,

                                     "headers/beta_B.h");

        previous_headers_state = new_headers_state;

    }

    void incrementalCompileChangeNative() throws Exception {

        System.out.println("\nNow update the B.java file with a new value for the final static"+

                           " annotated with @Native.");

        System.out.println("Verify that beta_B.h is rewritten again!");

        System.out.println("-------------------------------------------------------------------");

        populate(gensrc,"beta/B.java",

                       "package beta; import alfa.omega.A; public class B {"+

                       "private int b() { return A.DEFINITION; } "+

                 "@java.lang.annotation.Native final static int alfa = 43; }");

        compile("gensrc", "-d", "bin", "-h", "headers", "-j", "1",

                serverArg, "--log=debug");

        Map<String,Long> new_bin_state = collectState(bin);

        verifyNewerFiles(previous_bin_state, new_bin_state,

                         "bin/beta/B.class",

                         "bin/beta/BINT.class",

                         "bin/javac_state");

        previous_bin_state = new_bin_state;

        Map<String,Long> new_headers_state = collectState(headers);

        verifyNewerFiles(previous_headers_state, new_headers_state,

                         "headers/beta_B.h");

        previous_headers_state = new_headers_state;

    }

    void compileWithOverrideSource() throws Exception {

        System.out.println("\nNow verify that we can override sources to be compiled.");

        System.out.println("Compile gensrc and gensrc2. However do not compile broken beta.B in gensrc,");

        System.out.println("only compile ok beta.B in gensrc2.");

        System.out.println("---------------------------------------------------------------------------");

        delete(gensrc);

        delete(gensrc2);

        delete(bin);

        previous_bin_state = collectState(bin);

        populate(gensrc,"alfa/omega/A.java",

                 "package alfa.omega; import beta.B; import gamma.C; public class A { B b; C c; }",

                 "beta/B.java",

                 "package beta; public class B { broken",

                 "gamma/C.java",

                 "package gamma; public class C { }");

        populate(gensrc2,

                 "beta/B.java",

                 "package beta; public class B { }");

        compile("-x", "beta", "gensrc", "gensrc2", "-d", "bin", "-h", "headers", "-j", "1",

                serverArg);

        Map<String,Long> new_bin_state = collectState(bin);

        verifyThatFilesHaveBeenAdded(previous_bin_state, new_bin_state,

                                     "bin/alfa/omega/A.class",

                                     "bin/beta/B.class",

                                     "bin/gamma/C.class",

                                     "bin/javac_state");

        System.out.println("----- Compile with exluded beta went well!");

        delete(bin);

        compileExpectFailure("gensrc", "gensrc2", "-d", "bin", "-h", "headers", "-j", "1",

                             serverArg);

        System.out.println("----- Compile without exluded beta failed, as expected! Good!");

        delete(bin);

    }

    void compileWithInvisibleSources() throws Exception {

        System.out.println("\nNow verify that we can make sources invisible to linking (sourcepath).");

        System.out.println("Compile gensrc and link against gensrc2 and gensrc3, however");

        System.out.println("gensrc2 contains broken code in beta.B, thus we must exclude that package");

        System.out.println("fortunately gensrc3 contains a proper beta.B.");

        System.out.println("------------------------------------------------------------------------");

        // Start with a fresh gensrcs and bin.

        delete(gensrc);

        delete(gensrc2);

        delete(gensrc3);

        delete(bin);

        previous_bin_state = collectState(bin);

        populate(gensrc,"alfa/omega/A.java",

                 "package alfa.omega; import beta.B; import gamma.C; public class A { B b; C c; }");

        populate(gensrc2,"beta/B.java",

                 "package beta; public class B { broken",

                 "gamma/C.java",

                 "package gamma; public class C { }");

        populate(gensrc3, "beta/B.java",

                 "package beta; public class B { }");

        compile("gensrc", "-x", "beta", "-sourcepath", "gensrc2",

                "-sourcepath", "gensrc3", "-d", "bin", "-h", "headers", "-j", "1",

                serverArg);

        System.out.println("The first compile went well!");

        Map<String,Long> new_bin_state = collectState(bin);

        verifyThatFilesHaveBeenAdded(previous_bin_state, new_bin_state,

                                     "bin/alfa/omega/A.class",

                                     "bin/javac_state");

        System.out.println("----- Compile with exluded beta went well!");

        delete(bin);

        compileExpectFailure("gensrc", "-sourcepath", "gensrc2", "-sourcepath", "gensrc3",

                             "-d", "bin", "-h", "headers", "-j", "1",

                             serverArg);

        System.out.println("----- Compile without exluded beta failed, as expected! Good!");

        delete(bin);

    }

    void compileCircularSources() throws Exception {

        System.out.println("\nNow verify that circular sources split on multiple cores can be compiled.");

        System.out.println("---------------------------------------------------------------------------");

        // Start with a fresh gensrcs and bin.

        delete(gensrc);

        delete(gensrc2);

        delete(gensrc3);

        delete(bin);

        previous_bin_state = collectState(bin);

        populate(gensrc,"alfa/omega/A.java",

                 "package alfa.omega; public class A { beta.B b; }",

                 "beta/B.java",

                 "package beta; public class B { gamma.C c; }",

                 "gamma/C.java",

                 "package gamma; public class C { alfa.omega.A a; }");

        compile("gensrc", "-d", "bin", "-h", "headers", "-j", "3",

                serverArg,"--log=debug");

        Map<String,Long> new_bin_state = collectState(bin);

        verifyThatFilesHaveBeenAdded(previous_bin_state, new_bin_state,

                                     "bin/alfa/omega/A.class",

                                     "bin/beta/B.class",

                                     "bin/gamma/C.class",

                                     "bin/javac_state");

        delete(bin);

    }

    /**

     * Tests compiling class A that depends on class B without compiling class B

     * @throws Exception If test fails

     */

    void compileExcludingDependency() throws Exception {

        System.out.println("\nVerify that excluding classes from compilation but not from linking works.");

        System.out.println("---------------------------------------------------------------------------");

        delete(gensrc);

        delete(bin);

        previous_bin_state = collectState(bin);

        populate(gensrc,

                 "alfa/omega/A.java",

                 "package alfa.omega; public class A { beta.B b; }",

                 "beta/B.java",

                 "package beta; public class B { }");

        compile("-x", "beta", "-src", "gensrc", "-x", "alfa/omega", "-sourcepath", "gensrc",

                "-d", "bin", serverArg);

        Map<String,Long> new_bin_state = collectState(bin);

        verifyThatFilesHaveBeenAdded(previous_bin_state, new_bin_state,

                                     "bin/alfa/omega/A.class",

                                     "bin/javac_state");

    }

    void incrementalCompileTestFullyQualifiedRef() throws Exception {

        System.out.println("\nVerify that \"alfa.omega.A a;\" does create a proper dependency.");

        System.out.println("----------------------------------------------------------------");

        populate(gensrc,

                 "alfa/omega/A.java",

                 "package alfa.omega; public class A { "+

                 "  public final static int DEFINITION = 18; "+

                 "  public void hello() { }"+

                 "}",

                 "beta/B.java",

                 "package beta; public class B { "+

                 "  public void world() { alfa.omega.A a; }"+

                 "}");

        compile("gensrc", "-d", "bin", "-j", "1",

                serverArg, "--log=debug");

        Map<String,Long> previous_bin_state = collectState(bin);

        // Change pubapi of A, this should trigger a recompile of B.

        populate(gensrc,

                 "alfa/omega/A.java",

                 "package alfa.omega; public class A { "+

                 "  public final static int DEFINITION = 19; "+

                 "  public void hello() { }"+

                 "}");

        compile("gensrc", "-d", "bin", "-j", "1",

                serverArg, "--log=debug");

        Map<String,Long> new_bin_state = collectState(bin);

        verifyNewerFiles(previous_bin_state, new_bin_state,

                         "bin/alfa/omega/A.class",

                         "bin/beta/B.class",

                         "bin/javac_state");

    }

   /**

     * Tests @atfile

     * @throws Exception If test fails

     */

    void compileWithAtFile() throws Exception {

        System.out.println("\nTest @atfile with command line content.");

        System.out.println("---------------------------------------");

        delete(gensrc);

        delete(gensrc2);

        delete(bin);

        populate(gensrc,

                 "list.txt",

                 "-if */alfa/omega/A.java\n-if */beta/B.java\ngensrc\n-d bin\n",

                 "alfa/omega/A.java",

                 "package alfa.omega; import beta.B; public class A { B b; }",

                 "beta/B.java",

                 "package beta; public class B { }",

                 "beta/C.java",

                 "broken");

        previous_bin_state = collectState(bin);

        compile("@gensrc/list.txt", "--server:portfile=testserver,background=false");

        Map<String,Long> new_bin_state = collectState(bin);

        verifyThatFilesHaveBeenAdded(previous_bin_state, new_bin_state,

                         "bin/javac_state",

                         "bin/alfa/omega/A.class",

                         "bin/beta/B.class");

    }

    /**

     * Tests storing javac_state into another directory.

     * @throws Exception If test fails

     */

    void testStateDir() throws Exception {

        System.out.println("\nVerify that --state-dir=bar works.");

        System.out.println("----------------------------------");

        Path bar = defaultfs.getPath("bar");

        Files.createDirectory(bar);

        delete(gensrc);

        delete(bin);

        delete(bar);