langtools/test/com/sun/javadoc/testDocFileDir/TestDocFileDir.java
author juh
Tue, 25 Jun 2013 14:31:29 -0700
changeset 18551 882a3948c6e6
parent 14368 6f4c62de6985
child 20238 a08610368936
permissions -rw-r--r--
8017325: Cleanup of the javadoc <code> tag in java.security.cert Summary: Convert javadoc <code>...</code> and <tt>...</tt> tags to {@code ...} Reviewed-by: darcy
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
10
06bc494ca11e Initial load
duke
parents:
diff changeset
     1
/*
14368
6f4c62de6985 8001664: refactor javadoc to use abstraction to handle files
jjg
parents: 5520
diff changeset
     2
 * Copyright (c) 2002, 2012, 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: 10
diff changeset
    19
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 10
diff changeset
    20
 * or visit www.oracle.com if you need additional information or have any
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 10
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
import java.io.File;
06bc494ca11e Initial load
duke
parents:
diff changeset
    25
06bc494ca11e Initial load
duke
parents:
diff changeset
    26
/*
06bc494ca11e Initial load
duke
parents:
diff changeset
    27
 * @test
06bc494ca11e Initial load
duke
parents:
diff changeset
    28
 * @bug 4258405 4973606
06bc494ca11e Initial load
duke
parents:
diff changeset
    29
 * @summary This test verifies that the doc-file directory does not
06bc494ca11e Initial load
duke
parents:
diff changeset
    30
 *          get overwritten when the sourcepath is equal to the destination
06bc494ca11e Initial load
duke
parents:
diff changeset
    31
 *          directory.
06bc494ca11e Initial load
duke
parents:
diff changeset
    32
 *          Also test that -docfilessubdirs and -excludedocfilessubdir both work.
06bc494ca11e Initial load
duke
parents:
diff changeset
    33
 * @author jamieh
06bc494ca11e Initial load
duke
parents:
diff changeset
    34
 * @library ../lib/
06bc494ca11e Initial load
duke
parents:
diff changeset
    35
 * @build JavadocTester
06bc494ca11e Initial load
duke
parents:
diff changeset
    36
 * @build TestDocFileDir
06bc494ca11e Initial load
duke
parents:
diff changeset
    37
 * @run main TestDocFileDir
06bc494ca11e Initial load
duke
parents:
diff changeset
    38
 */
06bc494ca11e Initial load
duke
parents:
diff changeset
    39
06bc494ca11e Initial load
duke
parents:
diff changeset
    40
public class TestDocFileDir extends JavadocTester {
06bc494ca11e Initial load
duke
parents:
diff changeset
    41
06bc494ca11e Initial load
duke
parents:
diff changeset
    42
    private static final String BUG_ID = "4258405-4973606";
06bc494ca11e Initial load
duke
parents:
diff changeset
    43
06bc494ca11e Initial load
duke
parents:
diff changeset
    44
    private static final String[][] TEST1 = {
06bc494ca11e Initial load
duke
parents:
diff changeset
    45
        {BUG_ID + "-1" + FS + "pkg" + FS + "doc-files" + FS + "testfile.txt",
06bc494ca11e Initial load
duke
parents:
diff changeset
    46
            "This doc file did not get trashed."}
06bc494ca11e Initial load
duke
parents:
diff changeset
    47
        };
06bc494ca11e Initial load
duke
parents:
diff changeset
    48
    private static final String[][] NEGATED_TEST1 = NO_TEST;
06bc494ca11e Initial load
duke
parents:
diff changeset
    49
06bc494ca11e Initial load
duke
parents:
diff changeset
    50
    private static final String[][] TEST2 = {
06bc494ca11e Initial load
duke
parents:
diff changeset
    51
        {BUG_ID + "-2" + FS + "pkg" + FS + "doc-files" + FS + "subdir-used1" +
06bc494ca11e Initial load
duke
parents:
diff changeset
    52
            FS + "testfile.txt",
06bc494ca11e Initial load
duke
parents:
diff changeset
    53
            "passed"
06bc494ca11e Initial load
duke
parents:
diff changeset
    54
        },
06bc494ca11e Initial load
duke
parents:
diff changeset
    55
        {BUG_ID + "-2" + FS + "pkg" + FS + "doc-files" + FS + "subdir-used2" +
06bc494ca11e Initial load
duke
parents:
diff changeset
    56
            FS + "testfile.txt",
06bc494ca11e Initial load
duke
parents:
diff changeset
    57
            "passed"
06bc494ca11e Initial load
duke
parents:
diff changeset
    58
        },
06bc494ca11e Initial load
duke
parents:
diff changeset
    59
    };
06bc494ca11e Initial load
duke
parents:
diff changeset
    60
    private static final String[][] NEGATED_TEST2 = {
06bc494ca11e Initial load
duke
parents:
diff changeset
    61
        {BUG_ID + "-2" + FS + "pkg" + FS + "doc-files" + FS + "subdir-excluded1" +
06bc494ca11e Initial load
duke
parents:
diff changeset
    62
            FS + "testfile.txt",
06bc494ca11e Initial load
duke
parents:
diff changeset
    63
            "passed"
06bc494ca11e Initial load
duke
parents:
diff changeset
    64
        },
06bc494ca11e Initial load
duke
parents:
diff changeset
    65
        {BUG_ID + "-2" + FS + "pkg" + FS + "doc-files" + FS + "subdir-excluded2" +
06bc494ca11e Initial load
duke
parents:
diff changeset
    66
            FS + "testfile.txt",
06bc494ca11e Initial load
duke
parents:
diff changeset
    67
            "passed"
06bc494ca11e Initial load
duke
parents:
diff changeset
    68
        },
06bc494ca11e Initial load
duke
parents:
diff changeset
    69
    };
06bc494ca11e Initial load
duke
parents:
diff changeset
    70
06bc494ca11e Initial load
duke
parents:
diff changeset
    71
    private static final String[][] TEST0 = {
06bc494ca11e Initial load
duke
parents:
diff changeset
    72
        {"pkg" + FS + "doc-files" + FS + "testfile.txt",
06bc494ca11e Initial load
duke
parents:
diff changeset
    73
            "This doc file did not get trashed."}
06bc494ca11e Initial load
duke
parents:
diff changeset
    74
        };
06bc494ca11e Initial load
duke
parents:
diff changeset
    75
    private static final String[][] NEGATED_TEST0 = {};
06bc494ca11e Initial load
duke
parents:
diff changeset
    76
06bc494ca11e Initial load
duke
parents:
diff changeset
    77
    //Output dir = Input Dir
06bc494ca11e Initial load
duke
parents:
diff changeset
    78
    private static final String[] ARGS1 =
06bc494ca11e Initial load
duke
parents:
diff changeset
    79
        new String[] {
14368
6f4c62de6985 8001664: refactor javadoc to use abstraction to handle files
jjg
parents: 5520
diff changeset
    80
            "-d", BUG_ID + "-1",
6f4c62de6985 8001664: refactor javadoc to use abstraction to handle files
jjg
parents: 5520
diff changeset
    81
            "-sourcepath",
6f4c62de6985 8001664: refactor javadoc to use abstraction to handle files
jjg
parents: 5520
diff changeset
    82
                "blah" + File.pathSeparator + BUG_ID + "-1" + File.pathSeparator + "blah",
6f4c62de6985 8001664: refactor javadoc to use abstraction to handle files
jjg
parents: 5520
diff changeset
    83
            "pkg"};
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    84
06bc494ca11e Initial load
duke
parents:
diff changeset
    85
    //Exercising -docfilessubdirs and -excludedocfilessubdir
06bc494ca11e Initial load
duke
parents:
diff changeset
    86
    private static final String[] ARGS2 =
06bc494ca11e Initial load
duke
parents:
diff changeset
    87
        new String[] {
14368
6f4c62de6985 8001664: refactor javadoc to use abstraction to handle files
jjg
parents: 5520
diff changeset
    88
            "-d", BUG_ID + "-2",
6f4c62de6985 8001664: refactor javadoc to use abstraction to handle files
jjg
parents: 5520
diff changeset
    89
            "-sourcepath", SRC_DIR,
6f4c62de6985 8001664: refactor javadoc to use abstraction to handle files
jjg
parents: 5520
diff changeset
    90
            "-docfilessubdirs",
6f4c62de6985 8001664: refactor javadoc to use abstraction to handle files
jjg
parents: 5520
diff changeset
    91
            "-excludedocfilessubdir", "subdir-excluded1:subdir-excluded2",
6f4c62de6985 8001664: refactor javadoc to use abstraction to handle files
jjg
parents: 5520
diff changeset
    92
            "pkg"};
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    93
06bc494ca11e Initial load
duke
parents:
diff changeset
    94
    //Output dir = "", Input dir = ""
06bc494ca11e Initial load
duke
parents:
diff changeset
    95
    private static final String[] ARGS0 =
06bc494ca11e Initial load
duke
parents:
diff changeset
    96
        new String[] {"pkg" + FS + "C.java"};
06bc494ca11e Initial load
duke
parents:
diff changeset
    97
06bc494ca11e Initial load
duke
parents:
diff changeset
    98
06bc494ca11e Initial load
duke
parents:
diff changeset
    99
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
   100
     * The entry point of the test.
06bc494ca11e Initial load
duke
parents:
diff changeset
   101
     * @param args the array of command line arguments.
06bc494ca11e Initial load
duke
parents:
diff changeset
   102
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
   103
    public static void main(String[] args) {
06bc494ca11e Initial load
duke
parents:
diff changeset
   104
        TestDocFileDir tester = new TestDocFileDir();
06bc494ca11e Initial load
duke
parents:
diff changeset
   105
        copyDir(SRC_DIR + FS + "pkg", ".");
06bc494ca11e Initial load
duke
parents:
diff changeset
   106
        run(tester, ARGS0, TEST0, NEGATED_TEST0);
06bc494ca11e Initial load
duke
parents:
diff changeset
   107
        copyDir(SRC_DIR + FS + "pkg", BUG_ID + "-1");
06bc494ca11e Initial load
duke
parents:
diff changeset
   108
        run(tester, ARGS1, TEST1, NEGATED_TEST1);
06bc494ca11e Initial load
duke
parents:
diff changeset
   109
        run(tester, ARGS2, TEST2, NEGATED_TEST2);
06bc494ca11e Initial load
duke
parents:
diff changeset
   110
        tester.printSummary();
06bc494ca11e Initial load
duke
parents:
diff changeset
   111
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   112
06bc494ca11e Initial load
duke
parents:
diff changeset
   113
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
   114
     * {@inheritDoc}
06bc494ca11e Initial load
duke
parents:
diff changeset
   115
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
   116
    public String getBugId() {
06bc494ca11e Initial load
duke
parents:
diff changeset
   117
        return BUG_ID;
06bc494ca11e Initial load
duke
parents:
diff changeset
   118
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   119
06bc494ca11e Initial load
duke
parents:
diff changeset
   120
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
   121
     * {@inheritDoc}
06bc494ca11e Initial load
duke
parents:
diff changeset
   122
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
   123
    public String getBugName() {
06bc494ca11e Initial load
duke
parents:
diff changeset
   124
        return getClass().getName();
06bc494ca11e Initial load
duke
parents:
diff changeset
   125
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   126
}