blob: 4dc1d212a1034b1f1d0f82bdc19a8c61dd6e7d37 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
<title>SerializationTestHelper xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<pre>
<a name="1" href="#1">1</a> <em class="jxr_comment">/*</em>
<a name="2" href="#2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</em>
<a name="3" href="#3">3</a> <em class="jxr_comment"> * contributor license agreements. See the NOTICE file distributed with</em>
<a name="4" href="#4">4</a> <em class="jxr_comment"> * this work for additional information regarding copyright ownership.</em>
<a name="5" href="#5">5</a> <em class="jxr_comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</em>
<a name="6" href="#6">6</a> <em class="jxr_comment"> * (the "License"); you may not use this file except in compliance with</em>
<a name="7" href="#7">7</a> <em class="jxr_comment"> * the License. You may obtain a copy of the License at</em>
<a name="8" href="#8">8</a> <em class="jxr_comment"> *</em>
<a name="9" href="#9">9</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a name="10" href="#10">10</a> <em class="jxr_comment"> *</em>
<a name="11" href="#11">11</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em>
<a name="12" href="#12">12</a> <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
<a name="13" href="#13">13</a> <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a name="14" href="#14">14</a> <em class="jxr_comment"> * See the License for the specific language governing permissions and</em>
<a name="15" href="#15">15</a> <em class="jxr_comment"> * limitations under the License.</em>
<a name="16" href="#16">16</a> <em class="jxr_comment"> */</em>
<a name="17" href="#17">17</a>
<a name="18" href="#18">18</a> <strong class="jxr_keyword">package</strong> org.apache.log4j.util;
<a name="19" href="#19">19</a>
<a name="20" href="#20">20</a> <strong class="jxr_keyword">import</strong> junit.framework.TestCase;
<a name="21" href="#21">21</a>
<a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> java.io.ByteArrayInputStream;
<a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> java.io.ByteArrayOutputStream;
<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> java.io.File;
<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> java.io.FileInputStream;
<a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> java.io.FileOutputStream;
<a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> java.io.IOException;
<a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> java.io.ObjectInputStream;
<a name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> java.io.ObjectOutputStream;
<a name="30" href="#30">30</a>
<a name="31" href="#31">31</a>
<a name="32" href="#32">32</a> <em class="jxr_javadoccomment">/**</em>
<a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * Utiities for serialization tests.</em>
<a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> *</em>
<a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * @author Curt Arnold</em>
<a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> */</em>
<a name="37" href="#37">37</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/apache/log4j/util/SerializationTestHelper.html">SerializationTestHelper</a> {
<a name="38" href="#38">38</a> <em class="jxr_javadoccomment">/**</em>
<a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * Private constructor.</em>
<a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> */</em>
<a name="41" href="#41">41</a> <strong class="jxr_keyword">private</strong> <a href="../../../../org/apache/log4j/util/SerializationTestHelper.html">SerializationTestHelper</a>() {
<a name="42" href="#42">42</a> }
<a name="43" href="#43">43</a>
<a name="44" href="#44">44</a> <em class="jxr_javadoccomment">/**</em>
<a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * Creates a clone by serializing object and</em>
<a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * deserializing byte stream.</em>
<a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * @param obj object to serialize and deserialize.</em>
<a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * @return clone</em>
<a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * @throws IOException on IO error.</em>
<a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * @throws ClassNotFoundException if class not found.</em>
<a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> */</em>
<a name="52" href="#52">52</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> Object serializeClone(<strong class="jxr_keyword">final</strong> Object obj)
<a name="53" href="#53">53</a> <strong class="jxr_keyword">throws</strong> IOException, ClassNotFoundException {
<a name="54" href="#54">54</a> ByteArrayOutputStream memOut = <strong class="jxr_keyword">new</strong> ByteArrayOutputStream();
<a name="55" href="#55">55</a> ObjectOutputStream objOut = <strong class="jxr_keyword">new</strong> ObjectOutputStream(memOut);
<a name="56" href="#56">56</a> objOut.writeObject(obj);
<a name="57" href="#57">57</a> objOut.close();
<a name="58" href="#58">58</a>
<a name="59" href="#59">59</a> ByteArrayInputStream src = <strong class="jxr_keyword">new</strong> ByteArrayInputStream(memOut.toByteArray());
<a name="60" href="#60">60</a> ObjectInputStream objIs = <strong class="jxr_keyword">new</strong> ObjectInputStream(src);
<a name="61" href="#61">61</a>
<a name="62" href="#62">62</a> <strong class="jxr_keyword">return</strong> objIs.readObject();
<a name="63" href="#63">63</a> }
<a name="64" href="#64">64</a>
<a name="65" href="#65">65</a> <em class="jxr_javadoccomment">/**</em>
<a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * Deserializes a specified file.</em>
<a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * @param witness serialization file, may not be null.</em>
<a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * @return deserialized object.</em>
<a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> * @throws Exception thrown on IO or deserialization exception.</em>
<a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> */</em>
<a name="71" href="#71">71</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> Object deserializeStream(<strong class="jxr_keyword">final</strong> String witness)
<a name="72" href="#72">72</a> <strong class="jxr_keyword">throws</strong> Exception {
<a name="73" href="#73">73</a> FileInputStream fileIs = <strong class="jxr_keyword">new</strong> FileInputStream(witness);
<a name="74" href="#74">74</a> ObjectInputStream objIs = <strong class="jxr_keyword">new</strong> ObjectInputStream(fileIs);
<a name="75" href="#75">75</a>
<a name="76" href="#76">76</a> <strong class="jxr_keyword">return</strong> objIs.readObject();
<a name="77" href="#77">77</a> }
<a name="78" href="#78">78</a>
<a name="79" href="#79">79</a> <em class="jxr_javadoccomment">/**</em>
<a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> * Checks the serialization of an object against an file</em>
<a name="81" href="#81">81</a> <em class="jxr_javadoccomment"> * containing the expected serialization.</em>
<a name="82" href="#82">82</a> <em class="jxr_javadoccomment"> *</em>
<a name="83" href="#83">83</a> <em class="jxr_javadoccomment"> * @param witness name of file containing expected serialization.</em>
<a name="84" href="#84">84</a> <em class="jxr_javadoccomment"> * @param obj object to be serialized.</em>
<a name="85" href="#85">85</a> <em class="jxr_javadoccomment"> * @param skip positions in serialized stream that should not be compared.</em>
<a name="86" href="#86">86</a> <em class="jxr_javadoccomment"> * @param endCompare position to stop comparison.</em>
<a name="87" href="#87">87</a> <em class="jxr_javadoccomment"> * @throws Exception thrown on IO or serialization exception.</em>
<a name="88" href="#88">88</a> <em class="jxr_javadoccomment"> */</em>
<a name="89" href="#89">89</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> assertSerializationEquals(
<a name="90" href="#90">90</a> <strong class="jxr_keyword">final</strong> String witness, <strong class="jxr_keyword">final</strong> Object obj, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong>[] skip,
<a name="91" href="#91">91</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> endCompare) <strong class="jxr_keyword">throws</strong> Exception {
<a name="92" href="#92">92</a> ByteArrayOutputStream memOut = <strong class="jxr_keyword">new</strong> ByteArrayOutputStream();
<a name="93" href="#93">93</a> ObjectOutputStream objOut = <strong class="jxr_keyword">new</strong> ObjectOutputStream(memOut);
<a name="94" href="#94">94</a> objOut.writeObject(obj);
<a name="95" href="#95">95</a> objOut.close();
<a name="96" href="#96">96</a>
<a name="97" href="#97">97</a> assertStreamEquals(witness, memOut.toByteArray(), skip, endCompare);
<a name="98" href="#98">98</a> }
<a name="99" href="#99">99</a>
<a name="100" href="#100">100</a> <em class="jxr_javadoccomment">/**</em>
<a name="101" href="#101">101</a> <em class="jxr_javadoccomment"> * Asserts the serialized form of an object.</em>
<a name="102" href="#102">102</a> <em class="jxr_javadoccomment"> * @param witness file name of expected serialization.</em>
<a name="103" href="#103">103</a> <em class="jxr_javadoccomment"> * @param actual byte array of actual serialization.</em>
<a name="104" href="#104">104</a> <em class="jxr_javadoccomment"> * @param skip positions to skip comparison.</em>
<a name="105" href="#105">105</a> <em class="jxr_javadoccomment"> * @param endCompare position to stop comparison.</em>
<a name="106" href="#106">106</a> <em class="jxr_javadoccomment"> * @throws IOException thrown on IO or serialization exception.</em>
<a name="107" href="#107">107</a> <em class="jxr_javadoccomment"> */</em>
<a name="108" href="#108">108</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> assertStreamEquals(
<a name="109" href="#109">109</a> <strong class="jxr_keyword">final</strong> String witness, <strong class="jxr_keyword">final</strong> byte[] actual, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong>[] skip,
<a name="110" href="#110">110</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> endCompare) <strong class="jxr_keyword">throws</strong> IOException {
<a name="111" href="#111">111</a> File witnessFile = <strong class="jxr_keyword">new</strong> File(witness);
<a name="112" href="#112">112</a>
<a name="113" href="#113">113</a> <strong class="jxr_keyword">if</strong> (witnessFile.exists()) {
<a name="114" href="#114">114</a> <strong class="jxr_keyword">int</strong> skipIndex = 0;
<a name="115" href="#115">115</a> byte[] expected = <strong class="jxr_keyword">new</strong> byte[actual.length];
<a name="116" href="#116">116</a> FileInputStream is = <strong class="jxr_keyword">new</strong> FileInputStream(witnessFile);
<a name="117" href="#117">117</a> <strong class="jxr_keyword">int</strong> bytesRead = is.read(expected);
<a name="118" href="#118">118</a> is.close();
<a name="119" href="#119">119</a>
<a name="120" href="#120">120</a> <strong class="jxr_keyword">if</strong>(bytesRead &lt; endCompare) {
<a name="121" href="#121">121</a> TestCase.assertEquals(bytesRead, actual.length);
<a name="122" href="#122">122</a> }
<a name="123" href="#123">123</a>
<a name="124" href="#124">124</a> <strong class="jxr_keyword">int</strong> endScan = actual.length;
<a name="125" href="#125">125</a>
<a name="126" href="#126">126</a> <strong class="jxr_keyword">if</strong> (endScan &gt; endCompare) {
<a name="127" href="#127">127</a> endScan = endCompare;
<a name="128" href="#128">128</a> }
<a name="129" href="#129">129</a>
<a name="130" href="#130">130</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i &lt; endScan; i++) {
<a name="131" href="#131">131</a> <strong class="jxr_keyword">if</strong> ((skipIndex &lt; skip.length) &amp;&amp; (skip[skipIndex] == i)) {
<a name="132" href="#132">132</a> skipIndex++;
<a name="133" href="#133">133</a> } <strong class="jxr_keyword">else</strong> {
<a name="134" href="#134">134</a> <strong class="jxr_keyword">if</strong> (expected[i] != actual[i]) {
<a name="135" href="#135">135</a> TestCase.assertEquals(
<a name="136" href="#136">136</a> <span class="jxr_string">"Difference at offset "</span> + i, expected[i], actual[i]);
<a name="137" href="#137">137</a> }
<a name="138" href="#138">138</a> }
<a name="139" href="#139">139</a> }
<a name="140" href="#140">140</a> } <strong class="jxr_keyword">else</strong> {
<a name="141" href="#141">141</a> <em class="jxr_comment">//</em>
<a name="142" href="#142">142</a> <em class="jxr_comment">// if the file doesn't exist then</em>
<a name="143" href="#143">143</a> <em class="jxr_comment">// assume that we are setting up and need to write it</em>
<a name="144" href="#144">144</a> FileOutputStream os = <strong class="jxr_keyword">new</strong> FileOutputStream(witnessFile);
<a name="145" href="#145">145</a> os.write(actual);
<a name="146" href="#146">146</a> os.close();
<a name="147" href="#147">147</a> TestCase.fail(<span class="jxr_string">"Writing witness file "</span> + witness);
<a name="148" href="#148">148</a> }
<a name="149" href="#149">149</a> }
<a name="150" href="#150">150</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>