jdk8-mips64-public/langtools: test/com/sun/javadoc/AuthorDD/AuthorDD.java@90af8d87741f (annotated)

test/com/sun/javadoc/AuthorDD/AuthorDD.java@90af8d87741f (annotated)

test/com/sun/javadoc/AuthorDD/AuthorDD.java

Wed, 01 Dec 2010 11:02:38 -0800

author: bpatel
date: Wed, 01 Dec 2010 11:02:38 -0800
changeset 766: 90af8d87741f
parent 554: 9d9f26857129
child 798: 4868a36f6fd8
permissions: -rw-r--r--

6851834: Javadoc doclet needs a structured approach to generate the output HTML.
Reviewed-by: jjg

 /*
  * Copyright (c) 2002, 2008, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
  * under the terms of the GNU General Public License version 2 only, as
  * published by the Free Software Foundation.
  *
  * This code is distributed in the hope that it will be useful, but WITHOUT
  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  * version 2 for more details (a copy is included in the LICENSE file that
  * accompanied this code).
  *
  * You should have received a copy of the GNU General Public License version
  * 2 along with this work; if not, write to the Free Software Foundation,
  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  *
  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  * or visit www.oracle.com if you need additional information or have any
  * questions.
  */
 /*
  * @test
  * @bug 4651598
  * @summary Javadoc wrongly inserts </DD> tags when using multiple @author tags
  * @author dkramer
  * @run main AuthorDD
  */
 import com.sun.javadoc.*;
 import java.util.*;
 import java.io.*;
 /**
  * Runs javadoc and runs regression tests on the resulting HTML.
  * It reads each file, complete with newlines, into a string to easily
  * find strings that contain newlines.
  */
 public class AuthorDD
 {
     private static final String BUGID = "4651598";
     private static final String BUGNAME = "AuthorDD";
     private static final String FS = System.getProperty("file.separator");
     private static final String PS = System.getProperty("path.separator");
     private static final String NL = System.getProperty("line.separator");
     // Subtest number.  Needed because runResultsOnHTML is run twice, and subtestNum
     // should increment across subtest runs.
     public static int subtestNum = 0;
     public static int numSubtestsPassed = 0;
     // Entry point
     public static void main(String[] args) {
         // Directory that contains source files that javadoc runs on
         String srcdir = System.getProperty("test.src", ".");
         // Test for all cases except the split index page
         runJavadoc(new String[] {"-d", BUGID,
                                  "-author",
                                  "-version",
                                  "-sourcepath", srcdir,
                                  "p1"});
         runTestsOnHTML(testArray);
         printSummary();
     }
     /** Run javadoc */
     public static void runJavadoc(String[] javadocArgs) {
         if (com.sun.tools.javadoc.Main.execute(AuthorDD.class.getClassLoader(),
                                                javadocArgs) != 0) {
             throw new Error("Javadoc failed to execute");
         }
     }
     /**
      * Assign value for [ stringToFind, filename ]
      * NOTE: The standard doclet uses the same separator "\n" for all OS's
      */
     private static final String[][] testArray = {
              // Test single @since tag:
             { "<dt><span class=\"strong\">Since:</span></dt>"+NL+"  <dd>JDK 1.0</dd>",
                                   BUGID + FS + "p1" + FS + "C1.html" },
             // Test multiple @author tags:
             { "<dt><span class=\"strong\">Author:</span></dt>"+NL+"  <dd>Doug Kramer, Jamie, Neal</dd>",
                                   BUGID + FS + "p1" + FS + "C1.html" },
         };
     public static void runTestsOnHTML(String[][] testArray) {
         for (int i = 0; i < testArray.length; i++) {
             subtestNum += 1;
             // Read contents of file into a string
             String fileString = readFileToString(testArray[i][1]);
             // Get string to find
             String stringToFind = testArray[i][0];
             // Find string in file's contents
             if (findString(fileString, stringToFind) == -1) {
                 System.out.println("\nSub-test " + (subtestNum)
                     + " for bug " + BUGID + " (" + BUGNAME + ") FAILED\n"
                     + "when searching for:\n"
                     + stringToFind);
             } else {
                 numSubtestsPassed += 1;
                 System.out.println("\nSub-test " + (subtestNum) + " passed:\n" + stringToFind);
             }
         }
     }
     public static void printSummary() {
         if ( numSubtestsPassed == subtestNum ) {
             System.out.println("\nAll " + numSubtestsPassed + " subtests passed");
         } else {
             throw new Error("\n" + (subtestNum - numSubtestsPassed) + " of " + (subtestNum)
                              + " subtests failed for bug " + BUGID + " (" + BUGNAME + ")\n");
         }
     }
     // Read the file into a String
     public static String readFileToString(String filename) {
         try {
             File file = new File(filename);
             if ( !file.exists() ) {
                 System.out.println("\nFILE DOES NOT EXIST: " + filename);
             }
             BufferedReader in = new BufferedReader(new FileReader(file));
             // Create an array of characters the size of the file
             char[] allChars = new char[(int)file.length()];
             // Read the characters into the allChars array
             in.read(allChars, 0, (int)file.length());
             in.close();
             // Convert to a string
             String allCharsString = new String(allChars);
             return allCharsString;
         } catch (FileNotFoundException e) {
             System.err.println(e);
             return "";
         } catch (IOException e) {
             System.err.println(e);
             return "";
         }
     }
     public static int findString(String fileString, String stringToFind) {
         return fileString.indexOf(stringToFind);
     }
 }

Mercurial > jdk8-mips64-public > langtools / annotate

test/com/sun/javadoc/AuthorDD/AuthorDD.java@90af8d87741f (annotated)

test/com/sun/javadoc/AuthorDD/AuthorDD.java