1 /*
   2  * Copyright (c) 2000, 2010, 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 import java.io.*;
  25 import java.util.*;
  26 
  27 /*
  28  * @test
  29  * @bug     4202914 4363318 6991528
  30  * @summary Basic test of serialization of stack trace information
  31  * @author  Josh Bloch
  32  */
  33 
  34 public class StackTraceSerialization {
  35     public static void main(String args[]) throws Exception {
  36         testWithSetStackTrace();
  37         testWithFillInStackTrace();
  38     }
  39 
  40     private static void testWithSetStackTrace() throws Exception {
  41         Throwable t = new Throwable();
  42 
  43         t.setStackTrace(new StackTraceElement[]
  44             {new StackTraceElement("foo", "bar", "baz", -1)});
  45 
  46         if (!equal(t, reconstitute(t)))
  47             throw new Exception("Unequal Throwables with set stacktrace");
  48     }
  49 
  50     private static void assertEmptyStackTrace(Throwable t) {
  51         if (t.getStackTrace().length != 0)
  52             throw new AssertionError("Nonempty stacktrace.");
  53     }
  54 
  55     private static void testWithFillInStackTrace() throws Exception {
  56         Throwable original = null;
  57         try {
  58             a();
  59         } catch(HighLevelException e) {
  60             original = e;
  61         }
  62 
  63         if (!equal(original, reconstitute(original)))
  64             throw new Exception("Unequal Throwables with filled-in stacktrace");
  65     }
  66 
  67 
  68     /**
  69      * Serialize the argument and return the deserialized result.
  70      */
  71     private static Throwable reconstitute(Throwable t) throws Exception {
  72         Throwable result = null;
  73 
  74         try(ByteArrayOutputStream bout = new ByteArrayOutputStream();
  75             ObjectOutputStream out = new ObjectOutputStream(bout)) {
  76             out.writeObject(t);
  77             out.flush();
  78             try(ByteArrayInputStream bin =
  79                 new ByteArrayInputStream(bout.toByteArray());
  80                 ObjectInputStream in = new ObjectInputStream(bin)) {
  81                 result = (Throwable) in.readObject();
  82             }
  83         }
  84 
  85         return result;
  86     }
  87 
  88     /**
  89      * Returns true if e1 and e2 have equal stack traces and their
  90      * causes are recursively equal (by the same definition) and their
  91      * suppressed exception information is equals.  Returns false or
  92      * throws NullPointerExeption otherwise.
  93      */
  94     private static boolean equal(Throwable t1, Throwable t2) {
  95         return t1==t2 ||
  96             (Arrays.equals(t1.getStackTrace(), t2.getStackTrace()) &&
  97              equal(t1.getCause(), t2.getCause()) &&
  98              Objects.equals(t1.getSuppressed(), t2.getSuppressed()));
  99     }
 100 
 101     static void a() throws HighLevelException {
 102         try {
 103             b();
 104         } catch(MidLevelException e) {
 105             throw new HighLevelException(e);
 106         }
 107     }
 108     static void b() throws MidLevelException {
 109         c();
 110     }
 111     static void c() throws MidLevelException {
 112         try {
 113             d();
 114         } catch(LowLevelException e) {
 115             throw new MidLevelException(e);
 116         }
 117     }
 118     static void d() throws LowLevelException {
 119        e();
 120     }
 121     static void e() throws LowLevelException {
 122         throw new LowLevelException();
 123     }
 124 
 125     private static final String OUR_CLASS  = StackTraceSerialization.class.getName();
 126     private static final String OUR_FILE_NAME = "StackTraceSerialization.java";
 127 
 128     private static void check(StackTraceElement e, String methodName, int n) {
 129         if (!e.getClassName().equals(OUR_CLASS))
 130             throw new RuntimeException("Class: " + e);
 131         if (!e.getMethodName().equals(methodName))
 132             throw new RuntimeException("Method name: " + e);
 133         if (!e.getFileName().equals(OUR_FILE_NAME))
 134             throw new RuntimeException("File name: " + e);
 135         if (e.getLineNumber() != n)
 136             throw new RuntimeException("Line number: " + e);
 137     }
 138 }
 139 
 140 class HighLevelException extends Exception {
 141     HighLevelException(Throwable cause) { super(cause); }
 142 }
 143 
 144 class MidLevelException extends Exception {
 145     MidLevelException(Throwable cause)  { super(cause); }
 146 }
 147 
 148 class LowLevelException extends Exception {
 149 }