langtools/test/tools/javac/doclint/DocLintFormatTest.java
author duke
Wed, 05 Jul 2017 23:01:50 +0200
changeset 44228 e46434c65a2b
parent 43145 35ee451a5fd3
permissions -rw-r--r--
Merge
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
43145
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
     1
/*
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
     2
 * Copyright (c) 2012, 2017, Oracle and/or its affiliates. All rights reserved.
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
     4
 *
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
     7
 * published by the Free Software Foundation.
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
     8
 *
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
     9
 * This code is distributed in the hope that it will be useful, but WITHOUT
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    10
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    11
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    12
 * version 2 for more details (a copy is included in the LICENSE file that
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    13
 * accompanied this code).
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    14
 *
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    15
 * You should have received a copy of the GNU General Public License version
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    16
 * 2 along with this work; if not, write to the Free Software Foundation,
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    17
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    18
 *
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    19
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    20
 * or visit www.oracle.com if you need additional information or have any
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    21
 * questions.
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    22
 */
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    23
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    24
/*
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    25
 * @test
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    26
 * @bug 8172474
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    27
 * @summary javac should enable doclint checking for HTML 5
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    28
 * @library /tools/lib
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    29
 * @modules jdk.compiler/com.sun.tools.javac.api
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    30
 *          jdk.compiler/com.sun.tools.javac.main
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    31
 * @build toolbox.ToolBox toolbox.JavacTask
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    32
 * @run main DocLintFormatTest
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    33
 */
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    34
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    35
import java.nio.file.Files;
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    36
import java.nio.file.Path;
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    37
import java.nio.file.Paths;
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    38
import java.util.List;
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    39
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    40
import toolbox.JavacTask;
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    41
import toolbox.Task;
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    42
import toolbox.ToolBox;
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    43
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    44
public class DocLintFormatTest {
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    45
    public static void main(String... args) throws Exception {
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    46
        new DocLintFormatTest().run();
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    47
    }
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    48
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    49
    private ToolBox tb = new ToolBox();
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    50
    private Path src = Paths.get("src");
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    51
    private Path classes = Paths.get("classes");
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    52
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    53
    void run() throws Exception {
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    54
        Files.createDirectories(classes);
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    55
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    56
        tb.writeJavaFiles(src,
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    57
            //        1         2
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    58
            //2345678901234567890
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    59
            "/** This is an <tt>HTML 4</tt> comment. */ public class Test4 { }",
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    60
            "/** This is an <mark>HTML 5</mark> comment. */ public class Test5 { }"
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    61
        );
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    62
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    63
        test(src.resolve("Test4.java"), "html4");
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    64
        test(src.resolve("Test4.java"), "html5",
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    65
                "Test4.java:1:16: compiler.err.proc.messager: tag not supported in the generated HTML version: tt");
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    66
        test(src.resolve("Test5.java"), "html4",
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    67
                "Test5.java:1:16: compiler.err.proc.messager: tag not supported in the generated HTML version: mark");
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    68
        test(src.resolve("Test5.java"), "html5");
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    69
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    70
        if (errors > 0) {
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    71
            throw new Exception(errors + " errors occurred");
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    72
        }
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    73
    }
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    74
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    75
    void test(Path file, String format, String... expect) {
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    76
        System.err.println("Test: " + format + " " + file);
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    77
        List<String> output = new JavacTask(tb)
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    78
                  .outdir(classes)
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    79
                  .options("-XDrawDiagnostics", "-Xdoclint", "--doclint-format", format)
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    80
                  .files(file)
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    81
                  .run(expect.length == 0 ? Task.Expect.SUCCESS : Task.Expect.FAIL)
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    82
                  .writeAll()
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    83
                  .getOutputLines(Task.OutputKind.DIRECT);
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    84
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    85
        if (expect.length == 0) {
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    86
            if (!(output.size() == 1 && output.get(0).isEmpty())) {
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    87
                error("All output unexpected.");
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    88
            }
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    89
        } else {
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    90
            for (String e : expect) {
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    91
                if (!output.contains(e)) {
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    92
                    error("expected output not found: " + e);
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    93
                }
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    94
            }
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    95
        }
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    96
    }
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    97
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    98
    void error(String message) {
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
    99
        System.err.println("Error: " + message);
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
   100
        errors++;
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
   101
    }
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
   102
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
   103
    private int errors = 0;
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
   104
}
35ee451a5fd3 8172474: javac should enable doclint checking for HTML 5
jjg
parents:
diff changeset
   105