langtools/test/com/sun/javadoc/JavascriptWinTitle/JavascriptWinTitle.java
author jgish
Tue, 16 Apr 2013 13:25:39 -0400
changeset 16821 a7d69ce6432c
parent 7681 1f0819a3341f
child 20614 994200acf1e4
permissions -rw-r--r--
8011347: JKD-8009824 has broken webrev with some ksh versions Reviewed-by: mduigou
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
10
06bc494ca11e Initial load
duke
parents:
diff changeset
     1
/*
7681
1f0819a3341f 6962318: Update copyright year
ohair
parents: 7614
diff changeset
     2
 * Copyright (c) 2002, 2010, 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
/*
06bc494ca11e Initial load
duke
parents:
diff changeset
    25
 * @test
06bc494ca11e Initial load
duke
parents:
diff changeset
    26
 * @bug 4645058 4747738 4855054
06bc494ca11e Initial load
duke
parents:
diff changeset
    27
 * @summary  Javascript IE load error when linked by -linkoffline
06bc494ca11e Initial load
duke
parents:
diff changeset
    28
 *           Window title shouldn't change when loading left frames (javascript)
06bc494ca11e Initial load
duke
parents:
diff changeset
    29
 * @author dkramer
06bc494ca11e Initial load
duke
parents:
diff changeset
    30
 * @run main JavascriptWinTitle
06bc494ca11e Initial load
duke
parents:
diff changeset
    31
 */
06bc494ca11e Initial load
duke
parents:
diff changeset
    32
06bc494ca11e Initial load
duke
parents:
diff changeset
    33
06bc494ca11e Initial load
duke
parents:
diff changeset
    34
import com.sun.javadoc.*;
06bc494ca11e Initial load
duke
parents:
diff changeset
    35
import java.util.*;
06bc494ca11e Initial load
duke
parents:
diff changeset
    36
import java.io.*;
06bc494ca11e Initial load
duke
parents:
diff changeset
    37
06bc494ca11e Initial load
duke
parents:
diff changeset
    38
06bc494ca11e Initial load
duke
parents:
diff changeset
    39
/**
06bc494ca11e Initial load
duke
parents:
diff changeset
    40
 * Runs javadoc and runs regression tests on the resulting HTML.
06bc494ca11e Initial load
duke
parents:
diff changeset
    41
 * It reads each file, complete with newlines, into a string to easily
06bc494ca11e Initial load
duke
parents:
diff changeset
    42
 * find strings that contain newlines.
06bc494ca11e Initial load
duke
parents:
diff changeset
    43
 */
06bc494ca11e Initial load
duke
parents:
diff changeset
    44
public class JavascriptWinTitle {
06bc494ca11e Initial load
duke
parents:
diff changeset
    45
06bc494ca11e Initial load
duke
parents:
diff changeset
    46
    private static final String BUGID = "4645058";
06bc494ca11e Initial load
duke
parents:
diff changeset
    47
    private static final String BUGNAME = "JavascriptWinTitle";
06bc494ca11e Initial load
duke
parents:
diff changeset
    48
    private static final String FS = System.getProperty("file.separator");
06bc494ca11e Initial load
duke
parents:
diff changeset
    49
    private static final String PS = System.getProperty("path.separator");
06bc494ca11e Initial load
duke
parents:
diff changeset
    50
    private static final String LS = System.getProperty("line.separator");
06bc494ca11e Initial load
duke
parents:
diff changeset
    51
    private static final String TMPDEST_DIR1 = "." + FS + "docs1" + FS;
06bc494ca11e Initial load
duke
parents:
diff changeset
    52
    private static final String TMPDEST_DIR2 = "." + FS + "docs2" + FS;
06bc494ca11e Initial load
duke
parents:
diff changeset
    53
06bc494ca11e Initial load
duke
parents:
diff changeset
    54
    // Subtest number.  Needed because runResultsOnHTML is run twice,
06bc494ca11e Initial load
duke
parents:
diff changeset
    55
    // and subtestNum should increment across subtest runs.
06bc494ca11e Initial load
duke
parents:
diff changeset
    56
    public static int subtestNum = 0;
06bc494ca11e Initial load
duke
parents:
diff changeset
    57
    public static int numSubtestsPassed = 0;
06bc494ca11e Initial load
duke
parents:
diff changeset
    58
06bc494ca11e Initial load
duke
parents:
diff changeset
    59
    // Entry point
06bc494ca11e Initial load
duke
parents:
diff changeset
    60
    public static void main(String[] args) {
06bc494ca11e Initial load
duke
parents:
diff changeset
    61
06bc494ca11e Initial load
duke
parents:
diff changeset
    62
        // Directory that contains source files that javadoc runs on
06bc494ca11e Initial load
duke
parents:
diff changeset
    63
        String srcdir = System.getProperty("test.src", ".");
06bc494ca11e Initial load
duke
parents:
diff changeset
    64
06bc494ca11e Initial load
duke
parents:
diff changeset
    65
        // Test for all cases except the split index page
06bc494ca11e Initial load
duke
parents:
diff changeset
    66
        runJavadoc(new String[] {"-d", TMPDEST_DIR1,
06bc494ca11e Initial load
duke
parents:
diff changeset
    67
                                 "-doctitle", "Document Title",
06bc494ca11e Initial load
duke
parents:
diff changeset
    68
                                 "-windowtitle", "Window Title",
06bc494ca11e Initial load
duke
parents:
diff changeset
    69
                                 "-overview", (srcdir + FS + "overview.html"),
06bc494ca11e Initial load
duke
parents:
diff changeset
    70
                                 "-linkoffline",
06bc494ca11e Initial load
duke
parents:
diff changeset
    71
                                    "http://java.sun.com/j2se/1.4/docs/api", srcdir,
06bc494ca11e Initial load
duke
parents:
diff changeset
    72
                                 "-sourcepath", srcdir,
06bc494ca11e Initial load
duke
parents:
diff changeset
    73
                                 "p1", "p2"});
06bc494ca11e Initial load
duke
parents:
diff changeset
    74
        runTestsOnHTML(testArray);
06bc494ca11e Initial load
duke
parents:
diff changeset
    75
06bc494ca11e Initial load
duke
parents:
diff changeset
    76
        printSummary();
06bc494ca11e Initial load
duke
parents:
diff changeset
    77
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
    78
06bc494ca11e Initial load
duke
parents:
diff changeset
    79
    /** Run javadoc */
06bc494ca11e Initial load
duke
parents:
diff changeset
    80
    public static void runJavadoc(String[] javadocArgs) {
06bc494ca11e Initial load
duke
parents:
diff changeset
    81
        if (com.sun.tools.javadoc.Main.execute(javadocArgs) != 0) {
06bc494ca11e Initial load
duke
parents:
diff changeset
    82
            throw new Error("Javadoc failed to execute");
06bc494ca11e Initial load
duke
parents:
diff changeset
    83
        }
06bc494ca11e Initial load
duke
parents:
diff changeset
    84
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
    85
06bc494ca11e Initial load
duke
parents:
diff changeset
    86
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    87
     * Assign value for [ stringToFind, filename ]
06bc494ca11e Initial load
duke
parents:
diff changeset
    88
     * NOTE: The standard doclet uses the same separator "\n" for all OS's
06bc494ca11e Initial load
duke
parents:
diff changeset
    89
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
    90
    private static final String[][] testArray = {
06bc494ca11e Initial load
duke
parents:
diff changeset
    91
06bc494ca11e Initial load
duke
parents:
diff changeset
    92
            // Test the javascript "type" attribute is present:
7614
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents: 5520
diff changeset
    93
            {  "<script type=\"text/javascript\">",
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    94
                     TMPDEST_DIR1 + "overview-summary.html"  },
06bc494ca11e Initial load
duke
parents:
diff changeset
    95
7614
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents: 5520
diff changeset
    96
            // Test onload is absent:
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents: 5520
diff changeset
    97
            {  "<body>",
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    98
                     TMPDEST_DIR1 + "overview-summary.html"  },
06bc494ca11e Initial load
duke
parents:
diff changeset
    99
06bc494ca11e Initial load
duke
parents:
diff changeset
   100
            // Test onload is present:
7614
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents: 5520
diff changeset
   101
            {  "<body>",
10
06bc494ca11e Initial load
duke
parents:
diff changeset
   102
                     TMPDEST_DIR1 + FS + "p1" + FS + "package-summary.html"  },
06bc494ca11e Initial load
duke
parents:
diff changeset
   103
06bc494ca11e Initial load
duke
parents:
diff changeset
   104
            // Test that "onload" is not present in BODY tag:
7614
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents: 5520
diff changeset
   105
            {   "<body>",
10
06bc494ca11e Initial load
duke
parents:
diff changeset
   106
                     TMPDEST_DIR1 + "overview-frame.html"  },
06bc494ca11e Initial load
duke
parents:
diff changeset
   107
06bc494ca11e Initial load
duke
parents:
diff changeset
   108
            // Test that "onload" is not present in BODY tag:
7614
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents: 5520
diff changeset
   109
            {   "<body>",
10
06bc494ca11e Initial load
duke
parents:
diff changeset
   110
                     TMPDEST_DIR1 + "allclasses-frame.html"  },
06bc494ca11e Initial load
duke
parents:
diff changeset
   111
06bc494ca11e Initial load
duke
parents:
diff changeset
   112
            // Test that "onload" is not present in BODY tag:
7614
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents: 5520
diff changeset
   113
            {   "<body>",
10
06bc494ca11e Initial load
duke
parents:
diff changeset
   114
                     TMPDEST_DIR1 + FS + "p1" + FS + "package-frame.html"  },
06bc494ca11e Initial load
duke
parents:
diff changeset
   115
06bc494ca11e Initial load
duke
parents:
diff changeset
   116
            // Test that win title javascript is followed by NOSCRIPT code.
7614
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents: 5520
diff changeset
   117
            {"<script type=\"text/javascript\"><!--" + LS +
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents: 5520
diff changeset
   118
                     "    if (location.href.indexOf('is-external=true') == -1) {" + LS +
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents: 5520
diff changeset
   119
                     "        parent.document.title=\"C (Window Title)\";" + LS +
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents: 5520
diff changeset
   120
                     "    }" + LS + "//-->" + LS + "</script>",
10
06bc494ca11e Initial load
duke
parents:
diff changeset
   121
             TMPDEST_DIR1 + FS + "p1" + FS + "C.html"
06bc494ca11e Initial load
duke
parents:
diff changeset
   122
            }
06bc494ca11e Initial load
duke
parents:
diff changeset
   123
06bc494ca11e Initial load
duke
parents:
diff changeset
   124
        };
06bc494ca11e Initial load
duke
parents:
diff changeset
   125
06bc494ca11e Initial load
duke
parents:
diff changeset
   126
    public static void runTestsOnHTML(String[][] testArray) {
06bc494ca11e Initial load
duke
parents:
diff changeset
   127
06bc494ca11e Initial load
duke
parents:
diff changeset
   128
        for (int i = 0; i < testArray.length; i++) {
06bc494ca11e Initial load
duke
parents:
diff changeset
   129
06bc494ca11e Initial load
duke
parents:
diff changeset
   130
            subtestNum += 1;
06bc494ca11e Initial load
duke
parents:
diff changeset
   131
06bc494ca11e Initial load
duke
parents:
diff changeset
   132
            // Read contents of file into a string
06bc494ca11e Initial load
duke
parents:
diff changeset
   133
            String fileString = readFileToString(testArray[i][1]);
06bc494ca11e Initial load
duke
parents:
diff changeset
   134
06bc494ca11e Initial load
duke
parents:
diff changeset
   135
            // Get string to find
06bc494ca11e Initial load
duke
parents:
diff changeset
   136
            String stringToFind = testArray[i][0];
06bc494ca11e Initial load
duke
parents:
diff changeset
   137
06bc494ca11e Initial load
duke
parents:
diff changeset
   138
            // Find string in file's contents
06bc494ca11e Initial load
duke
parents:
diff changeset
   139
            if (findString(fileString, stringToFind) == -1) {
06bc494ca11e Initial load
duke
parents:
diff changeset
   140
                System.out.println("\nSub-test " + (subtestNum)
06bc494ca11e Initial load
duke
parents:
diff changeset
   141
                    + " for bug " + BUGID + " (" + BUGNAME + ") FAILED\n"
06bc494ca11e Initial load
duke
parents:
diff changeset
   142
                    + "when searching for:\n"
06bc494ca11e Initial load
duke
parents:
diff changeset
   143
                    + stringToFind);
06bc494ca11e Initial load
duke
parents:
diff changeset
   144
            } else {
06bc494ca11e Initial load
duke
parents:
diff changeset
   145
                numSubtestsPassed += 1;
06bc494ca11e Initial load
duke
parents:
diff changeset
   146
                System.out.println("\nSub-test " + (subtestNum) + " passed:\n" + stringToFind);
06bc494ca11e Initial load
duke
parents:
diff changeset
   147
            }
06bc494ca11e Initial load
duke
parents:
diff changeset
   148
        }
06bc494ca11e Initial load
duke
parents:
diff changeset
   149
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   150
06bc494ca11e Initial load
duke
parents:
diff changeset
   151
    public static void printSummary() {
06bc494ca11e Initial load
duke
parents:
diff changeset
   152
        if ( numSubtestsPassed == subtestNum ) {
06bc494ca11e Initial load
duke
parents:
diff changeset
   153
            System.out.println("\nAll " + numSubtestsPassed + " subtests passed");
06bc494ca11e Initial load
duke
parents:
diff changeset
   154
        } else {
06bc494ca11e Initial load
duke
parents:
diff changeset
   155
            throw new Error("\n" + (subtestNum - numSubtestsPassed) + " of " + (subtestNum)
06bc494ca11e Initial load
duke
parents:
diff changeset
   156
                             + " subtests failed for bug " + BUGID + " (" + BUGNAME + ")\n");
06bc494ca11e Initial load
duke
parents:
diff changeset
   157
        }
06bc494ca11e Initial load
duke
parents:
diff changeset
   158
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   159
06bc494ca11e Initial load
duke
parents:
diff changeset
   160
    // Read the file into a String
06bc494ca11e Initial load
duke
parents:
diff changeset
   161
    public static String readFileToString(String filename) {
06bc494ca11e Initial load
duke
parents:
diff changeset
   162
        try {
06bc494ca11e Initial load
duke
parents:
diff changeset
   163
            File file = new File(filename);
06bc494ca11e Initial load
duke
parents:
diff changeset
   164
            if ( !file.exists() ) {
06bc494ca11e Initial load
duke
parents:
diff changeset
   165
                System.out.println("\nFILE DOES NOT EXIST: " + filename);
06bc494ca11e Initial load
duke
parents:
diff changeset
   166
            }
06bc494ca11e Initial load
duke
parents:
diff changeset
   167
            BufferedReader in = new BufferedReader(new FileReader(file));
06bc494ca11e Initial load
duke
parents:
diff changeset
   168
06bc494ca11e Initial load
duke
parents:
diff changeset
   169
            // Create an array of characters the size of the file
06bc494ca11e Initial load
duke
parents:
diff changeset
   170
            char[] allChars = new char[(int)file.length()];
06bc494ca11e Initial load
duke
parents:
diff changeset
   171
06bc494ca11e Initial load
duke
parents:
diff changeset
   172
            // Read the characters into the allChars array
06bc494ca11e Initial load
duke
parents:
diff changeset
   173
            in.read(allChars, 0, (int)file.length());
06bc494ca11e Initial load
duke
parents:
diff changeset
   174
            in.close();
06bc494ca11e Initial load
duke
parents:
diff changeset
   175
06bc494ca11e Initial load
duke
parents:
diff changeset
   176
            // Convert to a string
06bc494ca11e Initial load
duke
parents:
diff changeset
   177
            String allCharsString = new String(allChars);
06bc494ca11e Initial load
duke
parents:
diff changeset
   178
06bc494ca11e Initial load
duke
parents:
diff changeset
   179
            return allCharsString;
06bc494ca11e Initial load
duke
parents:
diff changeset
   180
06bc494ca11e Initial load
duke
parents:
diff changeset
   181
        } catch (FileNotFoundException e) {
06bc494ca11e Initial load
duke
parents:
diff changeset
   182
            System.err.println(e);
06bc494ca11e Initial load
duke
parents:
diff changeset
   183
            return "";
06bc494ca11e Initial load
duke
parents:
diff changeset
   184
        } catch (IOException e) {
06bc494ca11e Initial load
duke
parents:
diff changeset
   185
            System.err.println(e);
06bc494ca11e Initial load
duke
parents:
diff changeset
   186
            return "";
06bc494ca11e Initial load
duke
parents:
diff changeset
   187
        }
06bc494ca11e Initial load
duke
parents:
diff changeset
   188
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   189
06bc494ca11e Initial load
duke
parents:
diff changeset
   190
    public static int findString(String fileString, String stringToFind) {
06bc494ca11e Initial load
duke
parents:
diff changeset
   191
        return fileString.indexOf(stringToFind);
06bc494ca11e Initial load
duke
parents:
diff changeset
   192
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   193
}