langtools/test/com/sun/javadoc/testSourceTab/TestSourceTab.java
author coleenp
Thu, 26 Nov 2015 00:00:25 +0000
changeset 34307 bd47d777584e
parent 30730 d3ce7619db2c
permissions -rw-r--r--
Merge
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1752
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
     1
/*
30730
d3ce7619db2c 8076543: Add @modules as needed to the langtools tests
akulyakh
parents: 24399
diff changeset
     2
 * Copyright (c) 2002, 2015, Oracle and/or its affiliates. All rights reserved.
10
06bc494ca11e Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
06bc494ca11e Initial load
duke
parents:
diff changeset
     4
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
06bc494ca11e Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
06bc494ca11e Initial load
duke
parents:
diff changeset
     7
 * published by the Free Software Foundation.
06bc494ca11e Initial load
duke
parents:
diff changeset
     8
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
     9
 * This code is distributed in the hope that it will be useful, but WITHOUT
06bc494ca11e Initial load
duke
parents:
diff changeset
    10
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
06bc494ca11e Initial load
duke
parents:
diff changeset
    11
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
06bc494ca11e Initial load
duke
parents:
diff changeset
    12
 * version 2 for more details (a copy is included in the LICENSE file that
06bc494ca11e Initial load
duke
parents:
diff changeset
    13
 * accompanied this code).
06bc494ca11e Initial load
duke
parents:
diff changeset
    14
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
    15
 * You should have received a copy of the GNU General Public License version
06bc494ca11e Initial load
duke
parents:
diff changeset
    16
 * 2 along with this work; if not, write to the Free Software Foundation,
06bc494ca11e Initial load
duke
parents:
diff changeset
    17
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
06bc494ca11e Initial load
duke
parents:
diff changeset
    18
 *
5520
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 1752
diff changeset
    19
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 1752
diff changeset
    20
 * or visit www.oracle.com if you need additional information or have any
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 1752
diff changeset
    21
 * questions.
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    22
 */
06bc494ca11e Initial load
duke
parents:
diff changeset
    23
06bc494ca11e Initial load
duke
parents:
diff changeset
    24
/*
06bc494ca11e Initial load
duke
parents:
diff changeset
    25
 * @test
06bc494ca11e Initial load
duke
parents:
diff changeset
    26
 * @bug 4510979
06bc494ca11e Initial load
duke
parents:
diff changeset
    27
 * @summary Test to make sure that the source documentation is indented properly
06bc494ca11e Initial load
duke
parents:
diff changeset
    28
 * when -linksourcetab is used.
06bc494ca11e Initial load
duke
parents:
diff changeset
    29
 * @author jamieh
24399
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 24072
diff changeset
    30
 * @library ../lib
30730
d3ce7619db2c 8076543: Add @modules as needed to the langtools tests
akulyakh
parents: 24399
diff changeset
    31
 * @modules jdk.javadoc
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    32
 * @build JavadocTester
06bc494ca11e Initial load
duke
parents:
diff changeset
    33
 * @run main TestSourceTab
06bc494ca11e Initial load
duke
parents:
diff changeset
    34
 */
06bc494ca11e Initial load
duke
parents:
diff changeset
    35
1752
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
    36
import java.io.*;
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
    37
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    38
public class TestSourceTab extends JavadocTester {
1752
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
    39
24399
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 24072
diff changeset
    40
    public static void main(String... args) throws Exception {
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    41
        TestSourceTab tester = new TestSourceTab();
24399
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 24072
diff changeset
    42
        tester.runTests();
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    43
    }
1752
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
    44
24399
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 24072
diff changeset
    45
    @Test
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 24072
diff changeset
    46
    void test() throws Exception {
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 24072
diff changeset
    47
        String tmpSrcDir = "tmpSrc";
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 24072
diff changeset
    48
        String outdir1 = "out-tabLengthEight";
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 24072
diff changeset
    49
        String outdir2 = "out-tabLengthFour";
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 24072
diff changeset
    50
        initTabs(new File(testSrc), new File(tmpSrcDir));
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 24072
diff changeset
    51
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 24072
diff changeset
    52
        // Run Javadoc on a source file with that is indented with a single tab per line
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 24072
diff changeset
    53
        javadoc("-d", outdir1,
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 24072
diff changeset
    54
                "-sourcepath", tmpSrcDir,
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 24072
diff changeset
    55
                "-notimestamp",
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 24072
diff changeset
    56
                "-linksource",
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 24072
diff changeset
    57
                tmpSrcDir + "/SingleTab/C.java");
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 24072
diff changeset
    58
        checkExit(Exit.OK);
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 24072
diff changeset
    59
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 24072
diff changeset
    60
        // Run Javadoc on a source file with that is indented with a two tab per line
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 24072
diff changeset
    61
        // If we double the tabs and decrease the tab length by a half, the output should
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 24072
diff changeset
    62
        // be the same as the one generated above.
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 24072
diff changeset
    63
        javadoc("-d", outdir2,
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 24072
diff changeset
    64
                "-sourcepath", tmpSrcDir,
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 24072
diff changeset
    65
                "-notimestamp",
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 24072
diff changeset
    66
                "-sourcetab", "4",
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 24072
diff changeset
    67
                tmpSrcDir + "/DoubleTab/C.java");
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 24072
diff changeset
    68
        checkExit(Exit.OK);
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 24072
diff changeset
    69
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 24072
diff changeset
    70
        diff(outdir1, outdir2,
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 24072
diff changeset
    71
                "src-html/C.html",
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 24072
diff changeset
    72
                "C.html");
1752
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
    73
    }
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
    74
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
    75
    void initTabs(File from, File to) throws IOException {
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
    76
        for (File f: from.listFiles()) {
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
    77
            File t = new File(to, f.getName());
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
    78
            if (f.isDirectory()) {
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
    79
                initTabs(f, t);
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
    80
            } else if (f.getName().endsWith(".java")) {
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
    81
                write(t, read(f).replace("\\t", "\t"));
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
    82
            }
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
    83
        }
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
    84
    }
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
    85
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
    86
    String read(File f) throws IOException {
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
    87
        StringBuilder sb = new StringBuilder();
24399
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 24072
diff changeset
    88
        try (BufferedReader in = new BufferedReader(new FileReader(f))) {
1752
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
    89
            String line;
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
    90
            while ((line = in.readLine()) != null) {
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
    91
                sb.append(line);
24399
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 24072
diff changeset
    92
                sb.append(NL);
1752
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
    93
            }
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
    94
        }
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
    95
        return sb.toString();
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
    96
    }
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
    97
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
    98
    void write(File f, String s) throws IOException {
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
    99
        f.getParentFile().mkdirs();
24399
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 24072
diff changeset
   100
        try (Writer out = new FileWriter(f)) {
1752
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
   101
            out.write(s);
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
   102
        }
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
   103
    }
10
06bc494ca11e Initial load
duke
parents:
diff changeset
   104
}