langtools/test/com/sun/javadoc/testSourceTab/TestSourceTab.java
author lana
Wed, 30 Jul 2014 11:49:49 -0700
changeset 25700 85d68faca425
parent 24399 af1a0220d0fa
child 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
/*
23971
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 5520
diff changeset
     2
 * Copyright (c) 2002, 2014, 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
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    31
 * @build JavadocTester
06bc494ca11e Initial load
duke
parents:
diff changeset
    32
 * @run main TestSourceTab
06bc494ca11e Initial load
duke
parents:
diff changeset
    33
 */
06bc494ca11e Initial load
duke
parents:
diff changeset
    34
1752
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
    35
import java.io.*;
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
    36
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    37
public class TestSourceTab extends JavadocTester {
1752
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
    38
24399
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 24072
diff changeset
    39
    public static void main(String... args) throws Exception {
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    40
        TestSourceTab tester = new TestSourceTab();
24399
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 24072
diff changeset
    41
        tester.runTests();
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    42
    }
1752
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
    43
24399
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 24072
diff changeset
    44
    @Test
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 24072
diff changeset
    45
    void test() throws Exception {
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 24072
diff changeset
    46
        String tmpSrcDir = "tmpSrc";
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 24072
diff changeset
    47
        String outdir1 = "out-tabLengthEight";
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 24072
diff changeset
    48
        String outdir2 = "out-tabLengthFour";
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 24072
diff changeset
    49
        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
    50
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 24072
diff changeset
    51
        // 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
    52
        javadoc("-d", outdir1,
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 24072
diff changeset
    53
                "-sourcepath", tmpSrcDir,
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 24072
diff changeset
    54
                "-notimestamp",
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 24072
diff changeset
    55
                "-linksource",
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 24072
diff changeset
    56
                tmpSrcDir + "/SingleTab/C.java");
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 24072
diff changeset
    57
        checkExit(Exit.OK);
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 24072
diff changeset
    58
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 24072
diff changeset
    59
        // 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
    60
        // 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
    61
        // 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
    62
        javadoc("-d", outdir2,
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 24072
diff changeset
    63
                "-sourcepath", tmpSrcDir,
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 24072
diff changeset
    64
                "-notimestamp",
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 24072
diff changeset
    65
                "-sourcetab", "4",
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 24072
diff changeset
    66
                tmpSrcDir + "/DoubleTab/C.java");
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 24072
diff changeset
    67
        checkExit(Exit.OK);
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 24072
diff changeset
    68
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 24072
diff changeset
    69
        diff(outdir1, outdir2,
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 24072
diff changeset
    70
                "src-html/C.html",
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 24072
diff changeset
    71
                "C.html");
1752
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
    72
    }
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
    void initTabs(File from, File to) throws IOException {
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
    75
        for (File f: from.listFiles()) {
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
    76
            File t = new File(to, f.getName());
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
    77
            if (f.isDirectory()) {
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
    78
                initTabs(f, t);
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
    79
            } else if (f.getName().endsWith(".java")) {
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
    80
                write(t, read(f).replace("\\t", "\t"));
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
    81
            }
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
    String read(File f) throws IOException {
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
    86
        StringBuilder sb = new StringBuilder();
24399
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 24072
diff changeset
    87
        try (BufferedReader in = new BufferedReader(new FileReader(f))) {
1752
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
    88
            String line;
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
    89
            while ((line = in.readLine()) != null) {
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
    90
                sb.append(line);
24399
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 24072
diff changeset
    91
                sb.append(NL);
1752
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
    92
            }
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
        return sb.toString();
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
    95
    }
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
    void write(File f, String s) throws IOException {
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
    98
        f.getParentFile().mkdirs();
24399
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 24072
diff changeset
    99
        try (Writer out = new FileWriter(f)) {
1752
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
   100
            out.write(s);
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
   101
        }
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
   102
    }
10
06bc494ca11e Initial load
duke
parents:
diff changeset
   103
}