langtools/test/jdk/javadoc/tool/example/Tester.java
author ksrini
Thu, 24 Nov 2016 20:48:52 -0800
changeset 42277 2668b0bc7ad7
permissions -rw-r--r--
8164316: Refine the Doclet APIs Reviewed-by: jjg
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
42277
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
     1
/*
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
     2
 * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
     4
 *
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
     7
 * published by the Free Software Foundation.
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
     8
 *
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
     9
 * This code is distributed in the hope that it will be useful, but WITHOUT
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    10
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    11
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    12
 * version 2 for more details (a copy is included in the LICENSE file that
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    13
 * accompanied this code).
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    14
 *
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    15
 * You should have received a copy of the GNU General Public License version
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    16
 * 2 along with this work; if not, write to the Free Software Foundation,
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    17
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    18
 *
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    19
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    20
 * or visit www.oracle.com if you need additional information or have any
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    21
 * questions.
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    22
 */
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    23
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    24
/*
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    25
 * @test
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    26
 * @bug 8164316
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    27
 * @summary tests the example used in package-info.java and doclet options.
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    28
 * @modules
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    29
 *      jdk.javadoc/jdk.javadoc.internal.api
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    30
 *      jdk.javadoc/jdk.javadoc.internal.tool
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    31
 *      jdk.compiler/com.sun.tools.javac.api
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    32
 *      jdk.compiler/com.sun.tools.javac.main
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    33
 * @library /tools/lib
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    34
 * @build toolbox.ToolBox toolbox.TestRunner Example
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    35
 * @run main Tester
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    36
 */
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    37
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    38
import java.io.File;
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    39
import java.util.Arrays;
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    40
import java.util.ArrayList;
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    41
import java.util.List;
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    42
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    43
import toolbox.*;
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    44
import toolbox.Task.Expect;
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    45
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    46
import static toolbox.Task.OutputKind.*;
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    47
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    48
public class Tester extends TestRunner {
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    49
    final ToolBox tb;
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    50
    final File testFile;
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    51
    final File testSrc;
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    52
    final Class<?> docletClass;
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    53
    final static String OV_FN = "overview.html";
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    54
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    55
    Tester() {
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    56
        super(System.err);
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    57
        testSrc = new File(System.getProperty("test.src"));
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    58
        testFile = new File(testSrc, "Example.java");
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    59
        tb = new ToolBox();
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    60
           ClassLoader cl = Tester.class.getClassLoader();
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    61
        try {
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    62
            docletClass = cl.loadClass("Example");
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    63
        } catch (ClassNotFoundException cfe) {
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    64
            throw new Error(cfe);
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    65
        }
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    66
    }
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    67
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    68
    public static void main(String... args) throws Exception {
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    69
        new Tester().runTests();
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    70
    }
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    71
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    72
    private Task.Result execTask(String... extraArgs) {
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    73
        return execTask(false, extraArgs);
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    74
    }
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    75
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    76
    private Task.Result execTask(boolean isNegative, String... extraArgs) {
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    77
        JavadocTask et = new JavadocTask(tb, Task.Mode.API);
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    78
        et.docletClass(docletClass);
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    79
        List<String> args = new ArrayList<>();
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    80
        args.add("-sourcepath");
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    81
        args.add(testSrc.getAbsolutePath());
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    82
        args.add(testFile.getAbsolutePath());
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    83
        args.addAll(Arrays.asList(extraArgs));
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    84
        //args.forEach((a -> System.err.println("arg: " + a)));
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    85
        System.err.println(Arrays.asList(extraArgs));
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    86
        Task.Result result = isNegative
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    87
                ? et.options(args).run(Expect.FAIL)
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    88
                : et.options(args).run();
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    89
        return result;
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    90
    }
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    91
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    92
    void assertPresence(String regex, List<String> output) throws Exception {
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    93
        List<String> foundList = tb.grep(regex, output);
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    94
        if (foundList.isEmpty()) {
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    95
            throw new Exception("Not found, expected: " + regex);
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    96
        }
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    97
    }
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    98
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
    99
    @Test
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
   100
    public void testOption() throws Exception {
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
   101
        Task.Result result = execTask("-overviewfile", OV_FN);
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
   102
        assertPresence("overviewfile: " + OV_FN, result.getOutputLines(DIRECT));
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
   103
    }
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
   104
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
   105
    @Test
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
   106
    public void testOptionAlias() throws Exception {
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
   107
        Task.Result result = execTask("-overview-file", OV_FN);
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
   108
        assertPresence("overviewfile: " + OV_FN, result.getOutputLines(DIRECT));
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
   109
    }
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
   110
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
   111
    @Test
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
   112
    public void testOptionAliasDoubleDash() throws Exception {
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
   113
        Task.Result result = execTask("--over-view-file", OV_FN);
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
   114
        assertPresence("overviewfile: " + OV_FN, result.getOutputLines(DIRECT));
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
   115
    }
2668b0bc7ad7 8164316: Refine the Doclet APIs
ksrini
parents:
diff changeset
   116
}