/*

 * Copyright (c) 2016, 2018, 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 8154119 8154262 8156077 8157987 8154261 8154817 8135291 8155995 8162363

 *      8168766 8168688 8162674 8160196 8175799 8174974 8176778 8177562 8175218

 *      8175823 8166306 8178043 8181622 8183511 8169819 8074407 8183037 8191464

 * @summary Test modules support in javadoc.

 * @author bpatel

 * @library ../lib

 * @modules jdk.javadoc/jdk.javadoc.internal.tool

 * @build JavadocTester

 * @run main TestModules

 */

public class TestModules extends JavadocTester {

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

        TestModules tester = new TestModules();

        tester.runTests();

    }

    /**

     * Test generated module pages for HTML 4.

     */

    @Test

    void testHtml4() {

                "-overview", testSrc("overview.html"),

                "--module-source-path", testSrc,

                "--module", "moduleA,moduleB",

                "testpkgmdlA", "testpkgmdlB");

        checkExit(Exit.OK);

        checkDescription(true);

        checkNoDescription(false);

        checkOverviewSummaryModules();

        checkModuleLink();

        checkModuleClickThroughLinks();

        checkModuleClickThrough(true);

        checkModuleFilesAndLinks(true);

        checkModulesInSearch(true);

        checkOverviewFrame(true);

    }

    /**

     * Test generated module pages for HTML 5.

     */

    @Test

    void testHtml5() {

                "-overview", testSrc("overview.html"),

                "--module-source-path", testSrc,

                "--module", "moduleA,moduleB",

                "testpkgmdlA", "testpkgmdlB");

        checkExit(Exit.OK);

        checkHtml5Description(true);

        checkHtml5NoDescription(false);

        checkHtml5OverviewSummaryModules();

        checkModuleLink();

        checkModuleClickThroughLinks();

        checkModuleClickThrough(true);

        checkModuleFilesAndLinks(true);

        checkModulesInSearch(true);

        checkOverviewFrame(true);

    }

    /**

     * Test generated module pages for HTML 4 with -nocomment option.

     */

    @Test

    void testHtml4NoComment() {

                "-overview", testSrc("overview.html"),

                "--module-source-path", testSrc,

                "--module", "moduleA,moduleB",

                "testpkgmdlA", "testpkgmdlB");

        checkExit(Exit.OK);

        checkDescription(false);

        checkNoDescription(true);

        checkModuleLink();

        checkModuleFilesAndLinks(true);

        checkOverviewFrame(true);

    }

    /**

     * Test generated module pages for HTML 5 with -nocomment option.

     */

    @Test

    void testHtml5NoComment() {

                "-overview", testSrc("overview.html"),

                "--module-source-path", testSrc,

                "--module", "moduleA,moduleB",

                "testpkgmdlA", "testpkgmdlB");

        checkExit(Exit.OK);

        checkHtml5Description(false);

        checkHtml5NoDescription(true);

        checkModuleLink();

        checkModuleFilesAndLinks(true);

        checkOverviewFrame(true);

    }

    /**

     * Test generated pages, in an unnamed module, for HTML 4.

     */

    @Test

    void testHtml4UnnamedModule() {

                "-overview", testSrc("overview.html"),

                "-sourcepath", testSrc,

                "testpkgnomodule", "testpkgnomodule1");

        checkExit(Exit.OK);

        checkOverviewSummaryPackages();

        checkModuleClickThrough(false);

        checkModuleFilesAndLinks(false);

        checkModulesInSearch(false);

        checkOverviewFrame(false);

    }

    /**

     * Test generated pages, in an unnamed module, for HTML 5.

     */

    @Test

    void testHtml5UnnamedModule() {

                "-overview", testSrc("overview.html"),

                "-sourcepath", testSrc,

                "testpkgnomodule", "testpkgnomodule1");

        checkExit(Exit.OK);

        checkHtml5OverviewSummaryPackages();

        checkModuleFilesAndLinks(false);

        checkModulesInSearch(false);

        checkOverviewFrame(false);

    }

    /**

     * Test generated module pages with javadoc tags.

     */

    @Test

    void testJDTagsInModules() {

                "-tag", "regular:a:Regular Tag:",

                "-tag", "moduletag:s:Module Tag:",

                "--module-source-path", testSrc,

                "--module", "moduletags,moduleB",

                "testpkgmdltags", "testpkgmdlB");

        checkExit(Exit.OK);

        checkModuleTags();

    }

    /**

     * Test generated module summary page.

     */

    @Test

    void testModuleSummary() {

                "--module-source-path", testSrc,

                "--module", "moduleA,moduleB",

                "testpkgmdlA", "testpkgmdlB", "moduleB/testpkg2mdlB");

        checkExit(Exit.OK);

        checkModuleSummary();

        checkNegatedModuleSummary();

    }

    /**

     * Test generated module summary page of an aggregating module.

     */

    @Test

    void testAggregatorModuleSummary() {

                "--module-source-path", testSrc,

                "--expand-requires", "transitive",

                "--module", "moduleT");

        checkExit(Exit.OK);

        checkAggregatorModuleSummary();

    }

    /**

     * Test generated module pages and pages with link to modules.

     */

    @Test

    void testModuleFilesAndLinks() {

                "--module-source-path", testSrc,

                "--module", "moduleA,moduleB",

                "testpkgmdlA", "testpkgmdlB");

        checkExit(Exit.OK);

        checkModuleFilesAndLinks(true);

        checkOverviewFrame(true);

    }

    /**

     * Test generated module pages for a deprecated module.

     */

    @Test

    void testModuleDeprecation() {

                "-tag", "regular:a:Regular Tag:",

                "-tag", "moduletag:s:Module Tag:",

                "--module-source-path", testSrc,

                "--module", "moduleA,moduleB,moduletags",

                "testpkgmdlA", "testpkgmdlB", "testpkgmdltags");

        checkExit(Exit.OK);

        checkModuleDeprecation(true);

    }

    /**

     * Test annotations on modules.

     */

    @Test

    void testModuleAnnotation() {

                "--module-source-path", testSrc,

                "--module", "moduleA,moduleB",

                "testpkgmdlA", "testpkgmdlB");

        checkExit(Exit.OK);

        checkModuleAnnotation();

    }

    /**

     * Test module summary pages in "api" mode.

     */

    @Test

    void testApiMode() {

                "-tag", "regular:a:Regular Tag:",

                "-tag", "moduletag:s:Module Tag:",

                "--module-source-path", testSrc,

                "--module", "moduleA,moduleB,moduleC,moduletags",

                "testpkgmdlA", "moduleA/concealedpkgmdlA", "testpkgmdlB", "testpkg2mdlB", "testpkgmdlC", "testpkgmdltags");

        checkExit(Exit.OK);

        checkModuleModeCommon();

        checkModuleModeApi(true);

        checkModuleModeAll(false);

        checkModuleFrameFiles(true);

        checkAllModulesLink(true);

    }

    /**

     * Test module summary pages in "all" mode.

     */

    @Test

    void testAllMode() {

                "-tag", "regular:a:Regular Tag:",

                "-tag", "moduletag:s:Module Tag:",

                "--module-source-path", testSrc,

                "--module", "moduleA,moduleB,moduleC,moduletags",

                "testpkgmdlA", "moduleA/concealedpkgmdlA", "testpkgmdlB", "testpkg2mdlB", "testpkgmdlC", "testpkgmdltags");

        checkExit(Exit.OK);

        checkModuleModeCommon();

        checkModuleModeApi(false);

        checkModuleModeAll(true);

        checkModuleFrameFiles(true);

        checkAllModulesLink(true);

    }

    /**

     * Test generated module summary page of a module with no exported package.

     */

    @Test

    void testModuleSummaryNoExportedPkgAll() {

                "-sourcepath", testSrc + "/moduleNoExport",

                "--module", "moduleNoExport",

                "testpkgmdlNoExport");

        checkExit(Exit.OK);

        checkModuleSummaryNoExported(true);

    }

    /**

     * Test generated module summary page of a module with no exported package.

     */

    @Test

    void testModuleSummaryNoExportedPkgApi() {

                "-sourcepath", testSrc + "/moduleNoExport",

                "--module", "moduleNoExport",

                "testpkgmdlNoExport");

        checkExit(Exit.OK);

        checkModuleSummaryNoExported(false);

    }

    /**

     * Test generated module pages for javadoc run for a single module having a single package.

     */

    @Test

    void testSingleModuleSinglePkg() {

        javadoc("-d", "out-singlemod",

                "--module-source-path", testSrc,

                "--module", "moduleC",

                "testpkgmdlC");

        checkExit(Exit.OK);

        checkModuleFrameFiles(false);

    }

    /**

     * Test generated module pages for javadoc run for a single module having multiple packages.

     */

    @Test

    void testSingleModuleMultiplePkg() {

                "--module-source-path", testSrc,

                "--module", "moduleB",

                "testpkg2mdlB", "testpkgmdlB");

        checkExit(Exit.OK);

        checkAllModulesLink(false);

    }

    /**

     * Test -group option for modules. The overview-summary.html page should group the modules accordingly.

     */

    @Test

    void testGroupOption() {

                "-tag", "regular:a:Regular Tag:",

                "-tag", "moduletag:s:Module Tag:",

                "--module-source-path", testSrc,

                "-group", "Module Group A", "moduleA*",

                "-group", "Module Group B & C", "moduleB*:moduleC*",

                "-group", "Java SE Modules", "java*",

                "--module", "moduleA,moduleB,moduleC,moduletags",

                "moduleA/concealedpkgmdlA", "testpkgmdlA", "testpkg2mdlB", "testpkgmdlB", "testpkgmdlC",

                "testpkgmdltags");