2004-04-09 09:05:39 -04:00
|
|
|
/* ====================================================================
|
2004-08-23 04:52:54 -04:00
|
|
|
Copyright 2003-2004 Apache Software Foundation
|
2004-04-09 09:05:39 -04:00
|
|
|
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
|
|
you may not use this file except in compliance with the License.
|
|
|
|
You may obtain a copy of the License at
|
|
|
|
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
See the License for the specific language governing permissions and
|
|
|
|
limitations under the License.
|
|
|
|
==================================================================== */
|
2004-08-23 04:52:54 -04:00
|
|
|
|
2002-11-10 20:34:01 -05:00
|
|
|
package org.apache.poi.hssf.eventmodel;
|
|
|
|
|
|
|
|
import java.io.ByteArrayInputStream;
|
|
|
|
import java.util.Iterator;
|
|
|
|
|
|
|
|
import org.apache.poi.hssf.record.BOFRecord;
|
|
|
|
import org.apache.poi.hssf.record.EOFRecord;
|
|
|
|
import org.apache.poi.hssf.record.Record;
|
2003-03-07 10:49:04 -05:00
|
|
|
import org.apache.poi.hssf.record.UnknownRecord;
|
|
|
|
import org.apache.poi.hssf.record.ContinueRecord;
|
2005-08-18 03:06:44 -04:00
|
|
|
import org.apache.poi.hssf.record.TestcaseRecordInputStream;
|
2002-11-10 20:34:01 -05:00
|
|
|
|
|
|
|
import junit.framework.TestCase;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* enclosing_type describe the purpose here
|
|
|
|
*
|
|
|
|
* @author Andrew C. Oliver acoliver@apache.org
|
2003-03-07 10:49:04 -05:00
|
|
|
* @author Csaba Nagy (ncsaba at yahoo dot com)
|
2002-11-10 20:34:01 -05:00
|
|
|
*/
|
|
|
|
public class TestEventRecordFactory extends TestCase
|
|
|
|
{
|
|
|
|
boolean wascalled;
|
|
|
|
|
|
|
|
private EventRecordFactory factory;
|
|
|
|
/**
|
|
|
|
* Constructor for TestEventRecordFactory.
|
|
|
|
* @param arg0
|
|
|
|
*/
|
|
|
|
public TestEventRecordFactory(String arg0)
|
|
|
|
{
|
|
|
|
super(arg0);
|
|
|
|
}
|
|
|
|
|
|
|
|
public static void main(String[] args)
|
|
|
|
{
|
|
|
|
junit.textui.TestRunner.run(TestEventRecordFactory.class);
|
|
|
|
}
|
|
|
|
|
|
|
|
protected void setUp() throws Exception
|
|
|
|
{
|
|
|
|
super.setUp();
|
|
|
|
factory = new EventRecordFactory();
|
|
|
|
}
|
|
|
|
|
|
|
|
protected void tearDown() throws Exception
|
|
|
|
{
|
|
|
|
super.tearDown();
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* tests that a listener can be registered and that once
|
|
|
|
* registered can be returned as expected.
|
|
|
|
*/
|
|
|
|
public void testRegisterListener()
|
|
|
|
{
|
|
|
|
factory.registerListener(new ERFListener() {
|
|
|
|
public boolean processRecord(Record rec) {
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
},null);
|
|
|
|
|
|
|
|
Iterator i = factory.listeners();
|
|
|
|
assertTrue("iterator must have one",i.hasNext());
|
|
|
|
|
|
|
|
factory.registerListener(new ERFListener() {
|
|
|
|
public boolean processRecord(Record rec) {
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
},null);
|
|
|
|
|
|
|
|
i = factory.listeners();
|
|
|
|
|
|
|
|
i.next();
|
|
|
|
assertTrue("iterator must have two",i.hasNext());
|
|
|
|
factory = new EventRecordFactory();
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* tests that the records can be processed and properly return
|
|
|
|
* values.
|
|
|
|
*/
|
|
|
|
public void testProcessRecords()
|
|
|
|
{
|
|
|
|
byte[] bytes = null;
|
|
|
|
int offset = 0;
|
|
|
|
//boolean wascalled = false;
|
|
|
|
factory.registerListener(new ERFListener() {
|
|
|
|
public boolean processRecord(Record rec) {
|
|
|
|
wascalled = true;
|
|
|
|
assertTrue("must be BOFRecord got SID="+rec.getSid(),
|
|
|
|
(rec.getSid() == BOFRecord.sid));
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
}, new short[] {BOFRecord.sid});
|
|
|
|
|
|
|
|
BOFRecord bof = new BOFRecord();
|
|
|
|
bof.setBuild((short)0);
|
|
|
|
bof.setBuildYear((short)1999);
|
|
|
|
bof.setRequiredVersion(123);
|
|
|
|
bof.setType(BOFRecord.TYPE_WORKBOOK);
|
|
|
|
bof.setVersion((short)0x06);
|
|
|
|
bof.setHistoryBitMask(BOFRecord.HISTORY_MASK);
|
|
|
|
|
|
|
|
EOFRecord eof = new EOFRecord();
|
|
|
|
bytes = new byte[bof.getRecordSize() + eof.getRecordSize()];
|
|
|
|
offset = bof.serialize(offset,bytes);
|
|
|
|
offset = eof.serialize(offset,bytes);
|
|
|
|
|
|
|
|
factory.processRecords(new ByteArrayInputStream(bytes));
|
|
|
|
assertTrue("The record listener must be called",wascalled);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* tests that the create record function returns a properly
|
|
|
|
* constructed record in the simple case.
|
|
|
|
*/
|
|
|
|
public void testCreateRecord()
|
|
|
|
{
|
|
|
|
byte[] bytes = null;
|
|
|
|
byte[] nbytes = null;
|
|
|
|
Record[] records = null;
|
|
|
|
BOFRecord bof = new BOFRecord();
|
|
|
|
bof.setBuild((short)0);
|
|
|
|
bof.setBuildYear((short)1999);
|
|
|
|
bof.setRequiredVersion(123);
|
|
|
|
bof.setType(BOFRecord.TYPE_WORKBOOK);
|
|
|
|
bof.setVersion((short)0x06);
|
|
|
|
bof.setHistoryBitMask(BOFRecord.HISTORY_MASK);
|
|
|
|
|
|
|
|
bytes = bof.serialize();
|
|
|
|
nbytes = new byte[bytes.length - 4];
|
|
|
|
System.arraycopy(bytes,4,nbytes,0,nbytes.length);
|
|
|
|
|
2005-08-18 03:06:44 -04:00
|
|
|
records = factory.createRecord(new TestcaseRecordInputStream(bof.getSid(),(short)nbytes.length,nbytes));
|
2002-11-10 20:34:01 -05:00
|
|
|
|
|
|
|
assertTrue("record.length must be 1, was ="+records.length,records.length == 1);
|
|
|
|
assertTrue("record is the same", compareRec(bof,records[0]));
|
|
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Compare the serialized bytes of two records are equal
|
|
|
|
* @param first the first record to compare
|
|
|
|
* @param second the second record to compare
|
|
|
|
* @return boolean whether or not the record where equal
|
|
|
|
*/
|
|
|
|
private boolean compareRec(Record first, Record second)
|
|
|
|
{
|
|
|
|
boolean retval = true;
|
|
|
|
byte[] rec1 = first.serialize();
|
|
|
|
byte[] rec2 = second.serialize();
|
|
|
|
|
|
|
|
if (rec1.length == rec2.length) {
|
|
|
|
for (int k=0; k<rec1.length; k++) {
|
|
|
|
if (rec1[k] != rec2[k]) {
|
|
|
|
retval = false;
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
} else {
|
|
|
|
retval = false;
|
|
|
|
}
|
|
|
|
|
|
|
|
return retval;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
* tests that the create record function returns a properly
|
|
|
|
* constructed record in the case of a continued record.
|
|
|
|
* @todo - need a real world example to put in a unit test
|
|
|
|
*/
|
|
|
|
public void testCreateContinuedRecord()
|
|
|
|
{
|
|
|
|
// fail("not implemented");
|
|
|
|
}
|
|
|
|
|
2003-03-07 10:49:04 -05:00
|
|
|
|
|
|
|
/**
|
|
|
|
* TEST NAME: Test Creating ContinueRecords After Unknown Records From An InputStream <P>
|
|
|
|
* OBJECTIVE: Test that the RecordFactory given an InputStream
|
|
|
|
* constructs the expected records.<P>
|
|
|
|
* SUCCESS: Record factory creates the expected records.<P>
|
|
|
|
* FAILURE: The wrong records are created or contain the wrong values <P>
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
public void testContinuedUnknownRecord()
|
|
|
|
{
|
|
|
|
final byte[] data = new byte[]
|
|
|
|
{
|
|
|
|
0, -1, 0, 0, // an unknown record with 0 length
|
|
|
|
0x3C , 0, 3, 0, 1, 2, 3, // a continuation record with 3 bytes of data
|
|
|
|
0x3C , 0, 1, 0, 4 // one more continuation record with 1 byte of data
|
|
|
|
};
|
|
|
|
|
|
|
|
final int[] recCnt = { 0 };
|
|
|
|
final int[] offset = { 0 };
|
|
|
|
factory.registerListener(
|
|
|
|
new ERFListener() {
|
|
|
|
private String[] expectedRecordTypes = {
|
|
|
|
UnknownRecord.class.getName(),
|
|
|
|
ContinueRecord.class.getName(),
|
|
|
|
ContinueRecord.class.getName()
|
|
|
|
};
|
|
|
|
public boolean processRecord(Record rec)
|
|
|
|
{
|
|
|
|
// System.out.println(rec.toString());
|
|
|
|
assertEquals(
|
|
|
|
"Record type",
|
|
|
|
expectedRecordTypes[recCnt[0]],
|
|
|
|
rec.getClass().getName()
|
|
|
|
);
|
|
|
|
compareData(rec, "Record " + recCnt[0] + ": ");
|
|
|
|
recCnt[0]++;
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
private void compareData(Record record, String message) {
|
|
|
|
byte[] recData = record.serialize();
|
|
|
|
for (int i = 0; i < recData.length; i++) {
|
|
|
|
assertEquals(message + " data byte " + i, data[offset[0]++], recData[i]);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
},
|
|
|
|
new short[] {-256, 0x3C}
|
|
|
|
);
|
|
|
|
|
|
|
|
factory.processRecords(new ByteArrayInputStream(data));
|
|
|
|
assertEquals("nr. of processed records", 3, recCnt[0]);
|
|
|
|
assertEquals("nr. of processed bytes", data.length, offset[0]);
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2002-11-10 20:34:01 -05:00
|
|
|
}
|