8255148: Confusing log output: SSLSocket duplex close failed

Reviewed-by: mullan

Author: Evan Whelan

src/java.base/share/classes/sun/security/ssl/SSLSocketImpl.java

@@ -587,7 +587,7 @@ public void close() throws IOException {
         } catch (IOException ioe) {
             // ignore the exception
             if (SSLLogger.isOn && SSLLogger.isOn("ssl")) {
-                SSLLogger.warning("SSLSocket duplex close failed", ioe);
+                SSLLogger.warning("SSLSocket duplex close failed. Debug info only. Exception details:", ioe);
             }
         } finally {
             if (!isClosed()) {
@@ -597,7 +597,7 @@ public void close() throws IOException {
                 } catch (IOException ioe) {
                     // ignore the exception
                     if (SSLLogger.isOn && SSLLogger.isOn("ssl")) {
-                        SSLLogger.warning("SSLSocket close failed", ioe);
+                        SSLLogger.warning("SSLSocket close failed. Debug info only. Exception details:", ioe);
                     }
                 } finally {
                     tlsIsClosed = true;
@@ -1134,7 +1134,7 @@ public void close() throws IOException {
             } catch (IOException ioe) {
                 // ignore the exception
                 if (SSLLogger.isOn && SSLLogger.isOn("ssl")) {
-                    SSLLogger.warning("input stream close failed", ioe);
+                    SSLLogger.warning("input stream close failed. Debug info only. Exception details:", ioe);
                 }
             }
         }
@@ -1329,7 +1329,7 @@ public void close() throws IOException {
             } catch (IOException ioe) {
                 // ignore the exception
                 if (SSLLogger.isOn && SSLLogger.isOn("ssl")) {
-                    SSLLogger.warning("output stream close failed", ioe);
+                    SSLLogger.warning("output stream close failed. Debug info only. Exception details:", ioe);
                 }
             }
         }

test/jdk/sun/security/ssl/SSLSocketImpl/IgnorableExceptionMessages.java

@@ -0,0 +1,102 @@
+/*
+ * Copyright (c) 2021, 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 8255148
+ * @library /test/lib /javax/net/ssl/templates ../../
+ * @summary Checks for clarified exception messages for non-fatal SSLSocketImpl exceptions which
+ *          can be ignored by the user
+ * @run main IgnorableExceptionMessages
+ */
+
+/*
+ * This test runs in another process so we can monitor the debug
+ * results. The OutputAnalyzer must see correct debug output to return a
+ * success.
+ */
+
+import jdk.test.lib.process.OutputAnalyzer;
+import jdk.test.lib.process.ProcessTools;
+
+import javax.net.ssl.SSLHandshakeException;
+import java.io.BufferedReader;
+import java.io.InputStreamReader;
+import java.net.URL;
+import java.util.List;
+
+public class IgnorableExceptionMessages extends SSLSocketTemplate {
+    public static void main(String[] args) throws Exception {
+        if (args.length > 0) {
+            // A non-empty set of arguments occurs when the "runTest" argument
+            // is passed to the test via ProcessTools::executeTestJvm.
+            //
+            // This is done because an OutputAnalyzer is unable to read
+            // the output of the current running JVM, and must therefore create
+            // a test JVM. When this case occurs, it will inherit all specified
+            // properties passed to the test JVM - debug flags, tls version, etc.
+            new IgnorableExceptionMessages().run();
+        } else {
+            String clientTLSVersion = "-Djdk.tls.client.protocols=TLSv1.2";
+            String javaxDebugFlag = "-Djavax.net.debug=all";
+            String className = "IgnorableExceptionMessages";
+            String extraArgument = "runTest"; // Triggers the test JVM to execute when args.length > 0
+            List<String> jvmArgs = List.of(
+                    clientTLSVersion,
+                    javaxDebugFlag,
+                    className,
+                    extraArgument);
+
+            OutputAnalyzer output = ProcessTools.executeTestJvm(jvmArgs);
+
+            if (output.getExitValue() != 0) {
+                output.asLines().forEach(System.out::println); // No need to dump the output unless the test fails
+                throw new RuntimeException("Test JVM process failed");
+            }
+
+            try {
+                output.shouldContain("SSLSocket duplex close failed. Debug info only. Exception details:");
+            } catch (Exception ex) {
+                output.asLines().forEach(System.out::println); // No need to dump the output unless the test fails
+                throw ex;
+            }
+        }
+    }
+
+    @Override
+    protected void runClientApplication(int serverPort) throws Exception {
+        String urlString = "https://localhost:" + serverPort + "/";
+        URL url = new URL(urlString);
+
+        try {
+            new BufferedReader(new InputStreamReader(url.openStream()));
+            for(int i = 0; i < 10; i++) {
+                Thread.sleep(1000);
+                System.gc();
+            }
+        } catch (SSLHandshakeException sslEx) {
+            System.out.println(sslEx.getCause());
+            System.out.println(sslEx.getMessage());
+        }
+    }
+}