langtools/test/com/sun/javadoc/testSourceTab/TestSourceTab.java
author jjg
Wed, 16 Apr 2014 16:17:09 -0700
changeset 23971 f5ff1f5a8dee
parent 5520 86e4b9a9da40
child 24065 fc4022e50129
permissions -rw-r--r--
8031649: Clean up javadoc tests Reviewed-by: jjg Contributed-by: neil.toda@oracle.com
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
06bc494ca11e Initial load
duke
parents:
diff changeset
    30
 * @library ../lib/
06bc494ca11e Initial load
duke
parents:
diff changeset
    31
 * @build JavadocTester
06bc494ca11e Initial load
duke
parents:
diff changeset
    32
 * @build TestSourceTab
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
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    40
    private static final String BUG_ID = "4510979";
1752
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
    41
    private static final String TMP_SRC_DIR = "tmpSrc";
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    42
    private static final String OUTPUT_DIR1 = BUG_ID + "-tabLengthEight";
06bc494ca11e Initial load
duke
parents:
diff changeset
    43
    private static final String OUTPUT_DIR2 = BUG_ID + "-tabLengthFour";
06bc494ca11e Initial load
duke
parents:
diff changeset
    44
    private static final String[][] TEST = NO_TEST;
06bc494ca11e Initial load
duke
parents:
diff changeset
    45
    private static final String[][] NEGATED_TEST = NO_TEST;
1752
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
    46
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    47
    //Run Javadoc on a source file with that is indented with a single tab per line
06bc494ca11e Initial load
duke
parents:
diff changeset
    48
    private static final String[] ARGS1 =
06bc494ca11e Initial load
duke
parents:
diff changeset
    49
        new String[] {
1752
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
    50
            "-d", OUTPUT_DIR1, "-sourcepath", TMP_SRC_DIR,
23971
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 5520
diff changeset
    51
            "-notimestamp", "-linksource", TMP_SRC_DIR + "/SingleTab/C.java"
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    52
        };
1752
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
    53
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    54
    //Run Javadoc on a source file with that is indented with a two tab per line
06bc494ca11e Initial load
duke
parents:
diff changeset
    55
    //If we double the tabs and decrease the tab length by a half, the output should
06bc494ca11e Initial load
duke
parents:
diff changeset
    56
    //be the same as the one generated above.
06bc494ca11e Initial load
duke
parents:
diff changeset
    57
    private static final String[] ARGS2 =
06bc494ca11e Initial load
duke
parents:
diff changeset
    58
        new String[] {
1752
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
    59
            "-d", OUTPUT_DIR2, "-sourcepath", TMP_SRC_DIR,
23971
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 5520
diff changeset
    60
            "-notimestamp", "-sourcetab", "4", TMP_SRC_DIR + "/DoubleTab/C.java"
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    61
        };
1752
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
    62
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    63
    //Files to diff
06bc494ca11e Initial load
duke
parents:
diff changeset
    64
    private static final String[][] FILES_TO_DIFF = {
23971
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 5520
diff changeset
    65
        {OUTPUT_DIR1 + "/src-html/C.html",
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 5520
diff changeset
    66
         OUTPUT_DIR2 + "/src-html/C.html"
1752
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
    67
        },
23971
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 5520
diff changeset
    68
        {OUTPUT_DIR1 + "/C.html",
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 5520
diff changeset
    69
         OUTPUT_DIR2 + "/C.html"
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    70
        }
1752
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
    71
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    72
    };
1752
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
    73
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    74
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    75
     * The entry point of the test.
06bc494ca11e Initial load
duke
parents:
diff changeset
    76
     * @param args the array of command line arguments.
06bc494ca11e Initial load
duke
parents:
diff changeset
    77
     */
1752
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
    78
    public static void main(String[] args) throws IOException {
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    79
        TestSourceTab tester = new TestSourceTab();
06bc494ca11e Initial load
duke
parents:
diff changeset
    80
        run(tester, ARGS1, TEST, NEGATED_TEST);
06bc494ca11e Initial load
duke
parents:
diff changeset
    81
        run(tester, ARGS2, TEST, NEGATED_TEST);
06bc494ca11e Initial load
duke
parents:
diff changeset
    82
        tester.runDiffs(FILES_TO_DIFF);
06bc494ca11e Initial load
duke
parents:
diff changeset
    83
    }
1752
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
    TestSourceTab() throws IOException {
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
    86
        initTabs(new File(SRC_DIR), new File(TMP_SRC_DIR));
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
    87
    }
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
    88
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
    89
    void initTabs(File from, File to) throws IOException {
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
    90
        for (File f: from.listFiles()) {
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
    91
            File t = new File(to, f.getName());
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
    92
            if (f.isDirectory()) {
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
    93
                initTabs(f, t);
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
    94
            } else if (f.getName().endsWith(".java")) {
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
    95
                write(t, read(f).replace("\\t", "\t"));
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
    }
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
    99
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
   100
    String read(File f) throws IOException {
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
   101
        StringBuilder sb = new StringBuilder();
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
   102
        BufferedReader in = new BufferedReader(new FileReader(f));
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
   103
        try {
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
   104
            String line;
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
   105
            while ((line = in.readLine()) != null) {
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
   106
                sb.append(line);
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
   107
                sb.append("\n");
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
   108
            }
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
   109
        } finally {
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
   110
            in.close();
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
   111
        }
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
   112
        return sb.toString();
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
   113
    }
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
   114
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
   115
    void write(File f, String s) throws IOException {
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
   116
        f.getParentFile().mkdirs();
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
   117
        Writer out = new FileWriter(f);
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
   118
        try {
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
   119
            out.write(s);
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
   120
        } finally {
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
   121
            out.close();
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
   122
        }
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
   123
    }
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
   124
10
06bc494ca11e Initial load
duke
parents:
diff changeset
   125
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
   126
     * {@inheritDoc}
06bc494ca11e Initial load
duke
parents:
diff changeset
   127
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
   128
    public String getBugId() {
06bc494ca11e Initial load
duke
parents:
diff changeset
   129
        return BUG_ID;
06bc494ca11e Initial load
duke
parents:
diff changeset
   130
    }
1752
d4e9cfa1e8ac 6778638: javadoc regression tests require tabs
jjg
parents: 10
diff changeset
   131
10
06bc494ca11e Initial load
duke
parents:
diff changeset
   132
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
   133
     * {@inheritDoc}
06bc494ca11e Initial load
duke
parents:
diff changeset
   134
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
   135
    public String getBugName() {
06bc494ca11e Initial load
duke
parents:
diff changeset
   136
        return getClass().getName();
06bc494ca11e Initial load
duke
parents:
diff changeset
   137
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   138
}