1 /*
   2  * Copyright (c) 2011, 2016, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.
   8  *
   9  * This code is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12  * version 2 for more details (a copy is included in the LICENSE file that
  13  * accompanied this code).
  14  *
  15  * You should have received a copy of the GNU General Public License version
  16  * 2 along with this work; if not, write to the Free Software Foundation,
  17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  18  *
  19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  20  * or visit www.oracle.com if you need additional information or have any
  21  * questions.
  22  */
  23 
  24 /*
  25  * @test
  26  * @bug 6964914
  27  * @summary javadoc does not output number of warnings using user written doclet
  28  */
  29 
  30 import java.io.*;
  31 import java.util.*;
  32 
  33 /**
  34  * Dummy javadoc comment.
  35  * @author jjg
  36  * @see DoesNotExist
  37  */
  38 public class TestStdDoclet {
  39     public static void main(String... args) throws Exception {
  40         new TestStdDoclet().run();
  41     }
  42 
  43     /**
  44      * More dummy comments.
  45      * @throws DoesNotExist   oops, javadoc does not see this
  46      * @see DoesNotExist
  47      */
  48     void run() throws Exception {
  49         File javaHome = new File(System.getProperty("java.home"));
  50         File javadoc = new File(new File(javaHome, "bin"), "javadoc");
  51         File testSrc = new File(System.getProperty("test.src"));
  52 
  53         // run javadoc in separate process to ensure doclet executed under
  54         // normal user conditions w.r.t. classloader
  55         String thisClassName = TestStdDoclet.class.getName();
  56         List<String> cmdArgs = new ArrayList<>();
  57         cmdArgs.add(javadoc.getPath());
  58         cmdArgs.addAll(Arrays.asList(
  59                 "-classpath", ".", // insulates us from ambient classpath
  60                 "-Xdoclint:none",
  61                 "-package",
  62                 new File(testSrc, thisClassName + ".java").getPath()
  63         ));
  64         Process p = new ProcessBuilder()
  65             .command(cmdArgs)
  66             .redirectErrorStream(true)
  67             .start();
  68 
  69         int actualDocletWarnCount = 0;
  70         int reportedDocletWarnCount = 0;
  71         BufferedReader in = new BufferedReader(new InputStreamReader(p.getInputStream()));
  72         try {
  73             String line;
  74             while ((line = in.readLine()) != null) {
  75                 System.err.println(line);
  76                 if (line.contains("DoesNotExist"))
  77                     actualDocletWarnCount++;
  78                 if (line.matches("[0-9]+ warning(s)?"))
  79                     reportedDocletWarnCount =
  80                             Integer.valueOf(line.substring(0, line.indexOf(" ")));
  81                 }
  82         } finally {
  83             in.close();
  84         }
  85         int rc = p.waitFor();
  86         if (rc != 0)
  87             System.err.println("javadoc failed, rc:" + rc);
  88 
  89         int expectedDocletWarnCount = 2;
  90         checkEqual("actual", actualDocletWarnCount, "expected", expectedDocletWarnCount);
  91         checkEqual("actual", actualDocletWarnCount, "reported", reportedDocletWarnCount);
  92     }
  93 
  94     /**
  95      * Private method should not cause a warning.
  96      * @see DoesNotExist
  97      */
  98     private void checkEqual(String l1, int i1, String l2, int i2) throws Exception {
  99         if (i1 != i2)
 100             throw new Exception(l1 + " warn count, " + i1 + ", does not match "
 101                         + l2 + " warn count, " + i2);
 102     }
 103 
 104 }