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