File: QuietOption.java

package info (click to toggle)
openjdk-17 17.0.17~5ea-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 764,780 kB
  • sloc: java: 5,318,220; xml: 1,291,711; cpp: 1,202,338; ansic: 428,731; asm: 404,978; objc: 20,861; sh: 14,753; javascript: 10,743; python: 6,402; makefile: 2,405; perl: 357; awk: 351; sed: 172; jsp: 24; csh: 3
file content (131 lines) | stat: -rw-r--r-- 4,364 bytes parent folder | download | duplicates (11)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
/*
 * Copyright (c) 2015, 2020, 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 8035473 8182765
 * @summary make sure tool is quiet when told to, and chatty otherwise
 */


import java.io.BufferedReader;
import java.io.File;
import java.io.InputStreamReader;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;

/**
 * Dummy javadoc comment.
 */
public class QuietOption {

    final File javadoc;
    final File testSrc;
    final String thisClassName;

    /**
     * Dummy javadoc comment.
     */
    public QuietOption() {
        File javaHome = new File(System.getProperty("java.home"));
        if (javaHome.getName().endsWith("jre"))
            javaHome = javaHome.getParentFile();
        javadoc = new File(new File(javaHome, "bin"), "javadoc");
        testSrc = new File(System.getProperty("test.src"));
        thisClassName = QuietOption.class.getName();
    }

    /**
     * Dummy javadoc comment.
     * @param args dummy
     * @throws Exception if error
     */
    public static void main(String... args) throws Exception {
        QuietOption test = new QuietOption();
        test.run1();
        test.run2();
    }

    // make sure javadoc is quiet
    void run1() throws Exception {
        List<String> output = doTest(javadoc.getPath(),
                "-classpath", ".", // insulates us from ambient classpath
                "-quiet",
                new File(testSrc, thisClassName + ".java").getPath());

        if (!output.isEmpty()) {
            // Remove any lines that might have been generated by the runtime
            Iterator<String> iter = output.iterator();
            while (iter.hasNext()) {
                String line = iter.next();
                if (line.matches("^Picked up .*JAVA.*OPTIONS:.*")) {
                    System.out.println("IGNORING: " + line);
                    iter.remove();
                }
            }
        }

        if (!output.isEmpty()) {
            System.out.println(output);
            throw new Exception("run1: Shhh!, very chatty javadoc!.");
        }
    }

    // make sure javadoc is chatty
    void run2() throws Exception {
        List<String> output = doTest(javadoc.getPath(),
                "-classpath", ".", // insulates us from ambient classpath
                new File(testSrc, thisClassName + ".java").getPath());

        if (output.isEmpty()) {
            System.out.println(output);
            throw new Exception("run2: speak up and please be heard!.");
        }
    }

    /**
     * More dummy comments.
     */
    List<String> doTest(String... args) throws Exception {
        List<String> output = new ArrayList<>();
        // run javadoc in separate process to ensure doclet executed under
        // normal user conditions w.r.t. classloader
        Process p = new ProcessBuilder()
                .command(args)
                .redirectErrorStream(true)
                .start();
        try (BufferedReader in = new BufferedReader(new InputStreamReader(p.getInputStream()))) {
            String line = in.readLine();
            while (line != null) {
                output.add(line.trim());
                line = in.readLine();
            }
        }
        int rc = p.waitFor();
        if (rc != 0) {
            throw new Exception("javadoc failed, rc:" + rc);
        }
        return output;
    }
}