KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > junitx > extensions > SerializabilityTestCase


1 /*
2  * The JUnit-addons Software License, Version 1.0
3  * (based on the Apache Software License, Version 1.1)
4  *
5  * Copyright (c) 2002-2003 Vladimir R. Bossicard. All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright
12  * notice, this list of conditions and the following disclaimer.
13  *
14  * 2. Redistributions in binary form must reproduce the above copyright
15  * notice, this list of conditions and the following disclaimer in
16  * the documentation and/or other materials provided with the
17  * distribution.
18  *
19  * 3. The end-user documentation included with the redistribution, if
20  * any, must include the following acknowlegement:
21  * "This product includes software developed by Vladimir R.
22  * Bossicard as well as other contributors
23  * (http://junit-addons.sourceforge.net/)."
24  * Alternately, this acknowlegement may appear in the software itself,
25  * if and wherever such third-party acknowlegements normally appear.
26  *
27  * 4. The name "JUnit-addons" must not be used to endorse or promote
28  * products derived from this software without prior written
29  * permission. For written permission, please contact
30  * vbossica@users.sourceforge.net.
31  *
32  * 5. Products derived from this software may not be called "JUnit-addons"
33  * nor may "JUnit-addons" appear in their names without prior written
34  * permission of the project managers.
35  *
36  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
40  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
42  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
43  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
44  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
45  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
46  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47  * SUCH DAMAGE.
48  * ======================================================================
49  *
50  * This software consists of voluntary contributions made by many
51  * individuals. For more information on the JUnit-addons Project, please
52  * see <http://junit-addons.sourceforge.net/>.
53  */
54
55 package junitx.extensions;
56
57 import junit.framework.AssertionFailedError;
58 import junit.framework.TestCase;
59
60 import java.io.ByteArrayInputStream JavaDoc;
61 import java.io.ByteArrayOutputStream JavaDoc;
62 import java.io.ObjectInputStream JavaDoc;
63 import java.io.ObjectOutputStream JavaDoc;
64 import java.io.Serializable JavaDoc;
65
66 /**
67  * Extend me in order to test the serializability of a class. Override my
68  * {@link #createInstance() createInstance} methods to
69  * provide me with an object to test against. The object's class must
70  * implement {@link java.io.Serializable Serializable}.
71  *
72  * @see java.io.Serializable
73  * @version $Revision: 1.2 $ $Date: 2003/02/06 20:43:52 $
74  * @author <a HREF="mailto:pholser@yahoo.com">Paul Holser</a>
75  */
76 public abstract class SerializabilityTestCase
77         extends TestCase {
78
79     private Serializable JavaDoc obj;
80
81     /**
82      * Creates a new test.
83      *
84      * @param name name of the test
85      */
86     public SerializabilityTestCase(String JavaDoc name) {
87         super(name);
88     }
89
90     /**
91      * Creates and returns an instance of the class under test.
92      *
93      * @return a new instance of the class under test
94      * @throws Exception
95      */
96     protected abstract Serializable JavaDoc createInstance() throws Exception JavaDoc;
97
98     /**
99      * Sets up the test fixture.
100      *
101      * @throws Exception
102      */
103     protected void setUp()
104             throws Exception JavaDoc {
105         super.setUp();
106
107         obj = createInstance();
108
109         // We want these assertions to yield errors, not failures.
110 try {
111             assertNotNull("createInstance() returned null", obj);
112         } catch (AssertionFailedError ex) {
113             throw new IllegalArgumentException JavaDoc(ex.getMessage());
114         }
115     }
116
117     /**
118      * Verifies that an instance of the class under test can be serialized and
119      * deserialized without error.
120      */
121     public final void testSerializability()
122             throws Exception JavaDoc {
123         ByteArrayOutputStream JavaDoc baos = new ByteArrayOutputStream JavaDoc();
124         ObjectOutputStream JavaDoc oos = new ObjectOutputStream JavaDoc(baos);
125         oos.writeObject(obj);
126         oos.flush();
127         oos.close();
128
129         byte[] frozenChunk = baos.toByteArray();
130         baos.close();
131
132         ByteArrayInputStream JavaDoc bais = new ByteArrayInputStream JavaDoc(frozenChunk);
133         ObjectInputStream JavaDoc ois = new ObjectInputStream JavaDoc(bais);
134         Serializable JavaDoc thawed = (Serializable JavaDoc) ois.readObject();
135
136         checkThawedObject(obj, thawed);
137     }
138
139     /**
140      * Template method--override this to perform checks on the deserialized
141      * form of the object serialized in {@link #testSerializability}. If not
142      * overridden, this asserts that the pre-serialization and deserialized
143      * forms of the object compare equal via
144      * {@link java.lang.Object#equals(Object) equals}.
145      *
146      * @param expected the pre-serialization form of the object
147      * @param actual the deserialized form of the object
148      */
149     protected void checkThawedObject(Serializable JavaDoc expected,
150                                      Serializable JavaDoc actual)
151             throws Exception JavaDoc {
152         assertEquals("thawed object comparison", expected, actual);
153     }
154
155 }
156
Popular Tags