test/com/sun/javadoc/MetaTag/MetaTag.java

Thu, 15 Dec 2011 15:47:47 -0800

author
katleman
date
Thu, 15 Dec 2011 15:47:47 -0800
changeset 1153
29a512337b79
parent 798
4868a36f6fd8
child 1410
bfec2a1cc869
permissions
-rw-r--r--

Added tag jdk8-b16 for changeset ec2c0973cc31

duke@1 1 /*
ohair@798 2 * Copyright (c) 2002, 2010, Oracle and/or its affiliates. All rights reserved.
duke@1 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1 4 *
duke@1 5 * This code is free software; you can redistribute it and/or modify it
duke@1 6 * under the terms of the GNU General Public License version 2 only, as
duke@1 7 * published by the Free Software Foundation.
duke@1 8 *
duke@1 9 * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1 10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1 11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
duke@1 12 * version 2 for more details (a copy is included in the LICENSE file that
duke@1 13 * accompanied this code).
duke@1 14 *
duke@1 15 * You should have received a copy of the GNU General Public License version
duke@1 16 * 2 along with this work; if not, write to the Free Software Foundation,
duke@1 17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1 18 *
ohair@554 19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@554 20 * or visit www.oracle.com if you need additional information or have any
ohair@554 21 * questions.
duke@1 22 */
duke@1 23
duke@1 24 import java.text.SimpleDateFormat;
duke@1 25 import java.util.Date;
duke@1 26
duke@1 27 import com.sun.tools.doclets.formats.html.ConfigurationImpl;
duke@1 28 import com.sun.tools.doclets.internal.toolkit.Configuration;
duke@1 29
duke@1 30 /*
duke@1 31 * @test
duke@1 32 * @bug 4034096 4764726 6235799
duke@1 33 * @summary Add support for HTML keywords via META tag for
duke@1 34 * class and member names to improve API search
duke@1 35 * @author dkramer
duke@1 36 * @library ../lib/
duke@1 37 * @build JavadocTester
duke@1 38 * @build MetaTag
duke@1 39 * @run main MetaTag
duke@1 40 */
duke@1 41
duke@1 42 public class MetaTag extends JavadocTester {
duke@1 43
duke@1 44 //Test information.
duke@1 45 private static final String BUG_ID = "4034096-4764726-6235799";
duke@1 46 private static final String OUTPUT_DIR = "docs-" + BUG_ID;
duke@1 47 private static final SimpleDateFormat m_dateFormat = new SimpleDateFormat("yyyy-MM-dd");
duke@1 48
duke@1 49 //Javadoc arguments.
duke@1 50 private static final String[] ARGS = new String[] {
duke@1 51 "-d", OUTPUT_DIR,
duke@1 52 "-sourcepath", SRC_DIR,
duke@1 53 "-keywords",
duke@1 54 "-doctitle", "Sample Packages",
duke@1 55 "p1", "p2"
duke@1 56 };
duke@1 57
duke@1 58 private static final String[] ARGS_NO_TIMESTAMP_NO_KEYWORDS = new String[] {
duke@1 59 "-d", OUTPUT_DIR + "-2",
duke@1 60 "-sourcepath", SRC_DIR,
duke@1 61 "-notimestamp",
duke@1 62 "-doctitle", "Sample Packages",
duke@1 63 "p1", "p2"
duke@1 64 };
duke@1 65
duke@1 66 //Input for string search tests.
duke@1 67 private static final String[][] TEST = {
duke@1 68
duke@1 69 { OUTPUT_DIR + FS + "p1" + FS + "C1.html",
bpatel@766 70 "<meta name=\"keywords\" content=\"p1.C1 class\">" },
duke@1 71
duke@1 72 { OUTPUT_DIR + FS + "p1" + FS + "C1.html",
bpatel@766 73 "<meta name=\"keywords\" content=\"field1\">" },
duke@1 74
duke@1 75 { OUTPUT_DIR + FS + "p1" + FS + "C1.html",
bpatel@766 76 "<meta name=\"keywords\" content=\"field2\">" },
duke@1 77
duke@1 78 { OUTPUT_DIR + FS + "p1" + FS + "C1.html",
bpatel@766 79 "<meta name=\"keywords\" content=\"method1()\">" },
duke@1 80
duke@1 81 { OUTPUT_DIR + FS + "p1" + FS + "C1.html",
bpatel@766 82 "<meta name=\"keywords\" content=\"method2()\">" },
duke@1 83
duke@1 84 { OUTPUT_DIR + FS + "p1" + FS + "package-summary.html",
bpatel@766 85 "<meta name=\"keywords\" content=\"p1 package\">" },
duke@1 86
duke@1 87 { OUTPUT_DIR + FS + "overview-summary.html",
bpatel@766 88 "<meta name=\"keywords\" content=\"Overview, Sample Packages\">" },
duke@1 89
duke@1 90 //NOTE: Hopefully, this regression test is not run at midnight. If the output
duke@1 91 //was generated yesterday and this test is run today, the test will fail.
duke@1 92 {OUTPUT_DIR + FS + "overview-summary.html",
bpatel@766 93 "<meta name=\"date\" "
bpatel@766 94 + "content=\"" + m_dateFormat.format(new Date()) + "\">"},
duke@1 95 };
duke@1 96
duke@1 97 private static final String[][] NEGATED_TEST = NO_TEST;
duke@1 98
duke@1 99 private static final String[][] TEST2 = NO_TEST;
duke@1 100 private static final String[][] NEGATED_TEST2 = {
duke@1 101 //No keywords when -keywords is not used.
duke@1 102 { OUTPUT_DIR + "-2" + FS + "p1" + FS + "C1.html",
duke@1 103 "<META NAME=\"keywords\" CONTENT=\"p1.C1 class\">" },
duke@1 104
duke@1 105 { OUTPUT_DIR + "-2" + FS + "p1" + FS + "C1.html",
duke@1 106 "<META NAME=\"keywords\" CONTENT=\"field1\">" },
duke@1 107
duke@1 108 { OUTPUT_DIR + "-2" + FS + "p1" + FS + "C1.html",
duke@1 109 "<META NAME=\"keywords\" CONTENT=\"field2\">" },
duke@1 110
duke@1 111 { OUTPUT_DIR + "-2" + FS + "p1" + FS + "C1.html",
duke@1 112 "<META NAME=\"keywords\" CONTENT=\"method1()\">" },
duke@1 113
duke@1 114 { OUTPUT_DIR + "-2" + FS + "p1" + FS + "C1.html",
duke@1 115 "<META NAME=\"keywords\" CONTENT=\"method2()\">" },
duke@1 116
duke@1 117 { OUTPUT_DIR + "-2" + FS + "p1" + FS + "package-summary.html",
duke@1 118 "<META NAME=\"keywords\" CONTENT=\"p1 package\">" },
duke@1 119
duke@1 120 { OUTPUT_DIR + "-2" + FS + "overview-summary.html",
duke@1 121 "<META NAME=\"keywords\" CONTENT=\"Overview Summary, Sample Packages\">" },
duke@1 122
duke@1 123 //The date metatag should not show up when -notimestamp is used.
duke@1 124
duke@1 125 //NOTE: Hopefully, this regression test is not run at midnight. If the output
duke@1 126 //was generated yesterday and this test is run today, the test will fail.
duke@1 127 {OUTPUT_DIR + "-2" + FS + "overview-summary.html",
duke@1 128 "<META NAME=\"date\" "
duke@1 129 + "CONTENT=\"" + m_dateFormat.format(new Date()) + "\">"},
duke@1 130 };
duke@1 131
duke@1 132 /**
duke@1 133 * The entry point of the test.
duke@1 134 * @param args the array of command line arguments.
duke@1 135 */
duke@1 136 public static void main(String[] args) {
duke@1 137 MetaTag tester = new MetaTag();
duke@1 138 Configuration config = ConfigurationImpl.getInstance();
duke@1 139 boolean defaultKeywordsSetting = config.keywords;
duke@1 140 boolean defaultTimestampSetting = config.notimestamp;
duke@1 141 run(tester, ARGS, TEST, NEGATED_TEST);
duke@1 142 //Variable needs to be reset because Configuration is a singleton.
duke@1 143 config.keywords = defaultKeywordsSetting;
duke@1 144 config.notimestamp = defaultTimestampSetting;
duke@1 145 run(tester, ARGS_NO_TIMESTAMP_NO_KEYWORDS, TEST2, NEGATED_TEST2);
duke@1 146 tester.printSummary();
duke@1 147 }
duke@1 148
duke@1 149 /**
duke@1 150 * {@inheritDoc}
duke@1 151 */
duke@1 152 public String getBugId() {
duke@1 153 return BUG_ID;
duke@1 154 }
duke@1 155
duke@1 156 /**
duke@1 157 * {@inheritDoc}
duke@1 158 */
duke@1 159 public String getBugName() {
duke@1 160 return getClass().getName();
duke@1 161 }
duke@1 162 }

mercurial