1 ///////////////////////////////////////////////////////////////////////////////
2 // Name: tests/streams/zlibstream.cpp
3 // Purpose: Test wxZlibInputStream/wxZlibOutputStream
4 // Author: Hans Van Leemputten
6 // Copyright: (c) 2004 Hans Van Leemputten
7 // Licence: wxWidgets licence
8 ///////////////////////////////////////////////////////////////////////////////
10 // For compilers that support precompilation, includes "wx/wx.h".
18 // for all others, include the necessary headers
23 #include "wx/zstream.h"
24 #include "wx/wfstream.h"
25 #include "wx/mstream.h"
26 #include "wx/txtstrm.h"
27 #include "wx/buffer.h"
33 #define WXTEST_WITH_GZIP_CONDITION(testMethod) \
34 WXTEST_WITH_CONDITION( COMPOSE_TEST_NAME(zlibStream), wxZlibInputStream::CanHandleGZip() && wxZlibOutputStream::CanHandleGZip(), testMethod )
36 #define DATABUFFER_SIZE 1024
38 static const wxString FILENAME_GZ
= _T("zlibtest.gz");
40 ///////////////////////////////////////////////////////////////////////////////
43 // Try to fully test wxZlibInputStream and wxZlibOutputStream
45 class zlibStream
: public BaseStreamTestCase
<wxZlibInputStream
, wxZlibOutputStream
>
49 virtual ~zlibStream();
51 CPPUNIT_TEST_SUITE(zlibStream
);
52 // Base class stream tests the zlibstream supports.
53 CPPUNIT_TEST_FAIL(Input_GetSize
);
54 CPPUNIT_TEST(Input_GetC
);
55 CPPUNIT_TEST(Input_Read
);
56 CPPUNIT_TEST(Input_Eof
);
57 CPPUNIT_TEST(Input_LastRead
);
58 CPPUNIT_TEST(Input_CanRead
);
59 CPPUNIT_TEST_FAIL(Input_SeekI
);
60 CPPUNIT_TEST(Input_TellI
);
61 CPPUNIT_TEST(Input_Peek
);
62 CPPUNIT_TEST(Input_Ungetch
);
64 CPPUNIT_TEST(Output_PutC
);
65 CPPUNIT_TEST(Output_Write
);
66 CPPUNIT_TEST(Output_LastWrite
);
67 CPPUNIT_TEST_FAIL(Output_SeekO
);
68 CPPUNIT_TEST(Output_TellO
);
70 // Other test specific for zlib stream test case.
71 CPPUNIT_TEST(TestStream_NoHeader_Default
);
72 CPPUNIT_TEST(TestStream_NoHeader_NoComp
);
73 CPPUNIT_TEST(TestStream_NoHeader_SpeedComp
);
74 CPPUNIT_TEST(TestStream_NoHeader_BestComp
);
75 CPPUNIT_TEST(TestStream_NoHeader_Dictionary
);
76 CPPUNIT_TEST(TestStream_ZLib_Default
);
77 CPPUNIT_TEST(TestStream_ZLib_NoComp
);
78 CPPUNIT_TEST(TestStream_ZLib_SpeedComp
);
79 CPPUNIT_TEST(TestStream_ZLib_BestComp
);
80 WXTEST_WITH_GZIP_CONDITION(TestStream_GZip_Default
);
81 WXTEST_WITH_GZIP_CONDITION(TestStream_GZip_NoComp
);
82 WXTEST_WITH_GZIP_CONDITION(TestStream_GZip_SpeedComp
);
83 WXTEST_WITH_GZIP_CONDITION(TestStream_GZip_BestComp
);
84 WXTEST_WITH_GZIP_CONDITION(TestStream_GZip_Dictionary
);
85 WXTEST_WITH_GZIP_CONDITION(TestStream_ZLibGZip
);
86 CPPUNIT_TEST(Decompress_BadData
);
87 CPPUNIT_TEST(Decompress_wx251_zlib114_Data_NoHeader
);
88 CPPUNIT_TEST(Decompress_wx251_zlib114_Data_ZLib
);
89 WXTEST_WITH_GZIP_CONDITION(Decompress_gzip135Data
);
90 CPPUNIT_TEST_SUITE_END();
93 // Test different stream construct settings.
94 void TestStream_NoHeader_Default();
95 void TestStream_NoHeader_NoComp();
96 void TestStream_NoHeader_SpeedComp();
97 void TestStream_NoHeader_BestComp();
98 void TestStream_NoHeader_Dictionary();
99 void TestStream_ZLib_Default();
100 void TestStream_ZLib_NoComp();
101 void TestStream_ZLib_SpeedComp();
102 void TestStream_ZLib_BestComp();
103 void TestStream_GZip_Default();
104 void TestStream_GZip_NoComp();
105 void TestStream_GZip_SpeedComp();
106 void TestStream_GZip_BestComp();
107 void TestStream_GZip_Dictionary();
108 void TestStream_ZLibGZip();
109 // Try to decompress bad data.
110 void Decompress_BadData();
111 // Decompress data that was compress by an external app.
112 // (like test wx 2.4.2, 2.5.1 and gzip data)
113 // Note: This test is limited in testing range!
114 void Decompress_wx251_zlib114_Data_NoHeader();
115 void Decompress_wx251_zlib114_Data_ZLib();
116 void Decompress_gzip135Data();
119 const char *GetDataBuffer();
120 const unsigned char *GetCompressedData();
121 void doTestStreamData(int input_flag
, int output_flag
, int compress_level
, const wxMemoryBuffer
*buf
= NULL
);
122 void doDecompress_ExternalData(const unsigned char *data
, const char *value
, size_t data_size
, size_t value_size
, int flag
= wxZLIB_AUTO
);
125 // Implement base class functions.
126 virtual wxZlibInputStream
*DoCreateInStream();
127 virtual wxZlibOutputStream
*DoCreateOutStream();
128 virtual void DoDeleteInStream();
129 virtual void DoDeleteOutStream();
131 // Helper that can be used to create new wx compatibility tests...
132 // Otherwise not used by the tests.
133 void genExtTestData(wxTextOutputStream
&out
, const char *buf
, int flag
);
136 char m_DataBuffer
[DATABUFFER_SIZE
];
137 size_t m_SizeCompressedData
;
138 unsigned char *m_pCompressedData
;
139 wxMemoryBuffer m_Dictionary
;
141 // Used by the base Creat[In|Out]Stream and Delete[In|Out]Stream.
142 wxMemoryInputStream
*m_pTmpMemInStream
;
143 wxMemoryOutputStream
*m_pTmpMemOutStream
;
146 zlibStream::zlibStream()
147 :m_SizeCompressedData(0),
148 m_pCompressedData(NULL
),
149 m_pTmpMemInStream(NULL
),
150 m_pTmpMemOutStream(NULL
)
152 // Init the data buffer.
153 for (size_t i
= 0; i
< DATABUFFER_SIZE
; i
++)
154 m_DataBuffer
[i
] = (i
% 0xFF);
156 m_Dictionary
.AppendData(m_DataBuffer
, sizeof(m_DataBuffer
) / 2);
158 // Set extra base config settings.
159 m_bSimpleTellITest
= true;
160 m_bSimpleTellOTest
= true;
162 /* Example code on how to produce test data...
164 wxFFileOutputStream fstream_out(_T("gentest.cpp"));
165 wxTextOutputStream out( fstream_out );
167 genExtTestData(out, "zlib data created with wxWidgets 2.5.x [March 27], wxZLIB_NO_HEADER, zlib 1.1.4", wxZLIB_NO_HEADER);
168 genExtTestData(out, "zlib data created with wxWidgets 2.5.x [March 27], wxZLIB_ZLIB, zlib 1.1.4", wxZLIB_ZLIB);
173 zlibStream::~zlibStream()
175 delete[] m_pCompressedData
;
177 delete m_pTmpMemInStream
;
178 delete m_pTmpMemOutStream
;
181 void zlibStream::TestStream_NoHeader_Default()
183 doTestStreamData(wxZLIB_NO_HEADER
, wxZLIB_NO_HEADER
, wxZ_DEFAULT_COMPRESSION
);
185 void zlibStream::TestStream_NoHeader_NoComp()
187 doTestStreamData(wxZLIB_NO_HEADER
, wxZLIB_NO_HEADER
, wxZ_NO_COMPRESSION
);
189 void zlibStream::TestStream_NoHeader_SpeedComp()
191 doTestStreamData(wxZLIB_NO_HEADER
, wxZLIB_NO_HEADER
, wxZ_BEST_SPEED
);
193 void zlibStream::TestStream_NoHeader_BestComp()
195 doTestStreamData(wxZLIB_NO_HEADER
, wxZLIB_NO_HEADER
, wxZ_BEST_COMPRESSION
);
197 void zlibStream::TestStream_NoHeader_Dictionary()
199 doTestStreamData(wxZLIB_NO_HEADER
, wxZLIB_NO_HEADER
, wxZ_DEFAULT_COMPRESSION
, &m_Dictionary
);
202 void zlibStream::TestStream_ZLib_Default()
204 doTestStreamData(wxZLIB_ZLIB
, wxZLIB_ZLIB
, wxZ_DEFAULT_COMPRESSION
);
206 void zlibStream::TestStream_ZLib_NoComp()
208 doTestStreamData(wxZLIB_ZLIB
, wxZLIB_ZLIB
, wxZ_NO_COMPRESSION
);
210 void zlibStream::TestStream_ZLib_SpeedComp()
212 doTestStreamData(wxZLIB_ZLIB
, wxZLIB_ZLIB
, wxZ_BEST_SPEED
);
214 void zlibStream::TestStream_ZLib_BestComp()
216 doTestStreamData(wxZLIB_ZLIB
, wxZLIB_ZLIB
, wxZ_BEST_COMPRESSION
);
219 void zlibStream::TestStream_GZip_Default()
221 doTestStreamData(wxZLIB_GZIP
, wxZLIB_GZIP
, wxZ_DEFAULT_COMPRESSION
);
223 void zlibStream::TestStream_GZip_NoComp()
225 doTestStreamData(wxZLIB_GZIP
, wxZLIB_GZIP
, wxZ_NO_COMPRESSION
);
227 void zlibStream::TestStream_GZip_SpeedComp()
229 doTestStreamData(wxZLIB_GZIP
, wxZLIB_GZIP
, wxZ_BEST_SPEED
);
231 void zlibStream::TestStream_GZip_BestComp()
233 doTestStreamData(wxZLIB_GZIP
, wxZLIB_GZIP
, wxZ_BEST_COMPRESSION
);
235 void zlibStream::TestStream_GZip_Dictionary()
237 doTestStreamData(wxZLIB_GZIP
, wxZLIB_GZIP
, wxZ_DEFAULT_COMPRESSION
, &m_Dictionary
);
240 void zlibStream::TestStream_ZLibGZip()
242 // Only use default compression level, as this test is
243 // for testing if the streams can determine the stream type info them self...
244 doTestStreamData(wxZLIB_AUTO
, wxZLIB_ZLIB
, wxZ_DEFAULT_COMPRESSION
);
245 doTestStreamData(wxZLIB_AUTO
, wxZLIB_GZIP
, wxZ_DEFAULT_COMPRESSION
);
248 void zlibStream::Decompress_BadData()
250 // Setup the bad data stream and the zlib stream.
251 wxMemoryInputStream
memstream_in(GetDataBuffer(), DATABUFFER_SIZE
);
252 CPPUNIT_ASSERT(memstream_in
.IsOk());
253 wxZlibInputStream
zstream_in(memstream_in
);
254 CPPUNIT_ASSERT(zstream_in
.IsOk()); // We did not yet read from the stream
255 // so it should still be OK.
256 // Try to force the stream to go to bad status.
257 CPPUNIT_ASSERT(!zstream_in
.Eof());
258 if (zstream_in
.IsOk())
261 // Because of the bad data in the input stream the zlib
262 // stream should be marked as NOT OK.
263 CPPUNIT_ASSERT(!zstream_in
.IsOk());
266 void zlibStream::Decompress_wx251_zlib114_Data_NoHeader()
268 const unsigned char data
[] = {171,202,201,76,82,72,73,44,73,84,72,46,74,77,44,73,77,81,40,207,44,201,80,40,175,8,207,76,73,79,45,41,86,48,210,51,213,171,80,136,246,77,44,74,206,80,48,50,143,213,1,202,69,249,120,58,197,251,249,199,123,184,58,186,184,6,233,40,84,129,12,49,212,51,212,51,1,0,32};
269 const char *value
= "zlib data created with wxWidgets 2.5.x [March 27], wxZLIB_NO_HEADER, zlib 1.1.4";
270 const size_t data_size
= sizeof(data
);
271 const size_t value_size
= strlen(value
);
272 // We need to specify wxZLIB_NO_HEADER because wxZLIB_AUTO can't find it his self.
273 doDecompress_ExternalData(data
, value
, data_size
, value_size
, wxZLIB_NO_HEADER
);
276 void zlibStream::Decompress_wx251_zlib114_Data_ZLib()
278 const unsigned char data
[] = {120,156,171,202,201,76,82,72,73,44,73,84,72,46,74,77,44,73,77,81,40,207,44,201,80,40,175,8,207,76,73,79,45,41,86,48,210,51,213,171,80,136,246,77,44,74,206,80,48,50,143,213,1,202,69,249,120,58,197,131,8,29,133,42,144,126,67,61,67,61,19,0,191,86,23,216};
279 const char *value
= "zlib data created with wxWidgets 2.5.x [March 27], wxZLIB_ZLIB, zlib 1.1.4";
280 const size_t data_size
= sizeof(data
);
281 const size_t value_size
= strlen(value
);
282 doDecompress_ExternalData(data
, value
, data_size
, value_size
);
285 void zlibStream::Decompress_gzip135Data()
287 // Compressed data was on the command line with gzip 1.3.5.
288 const unsigned char gzip135_data
[] = {31,139,8,0,177,248,112,64,4,3,115,206,207,45,40,74,45,46,78,77,81,72,73,44,73,84,72,46,74,77,44,1,114,202,51,75,50,20,220,253,66,21,210,171,50,11,20,12,245,140,245,76,185,0,1,107,16,80,44,0,0,0,0};
289 const char *gzip135_value
= "Compressed data created with GNU gzip 1.3.5\n";
290 // Size of the value and date items.
291 const size_t data_size
= sizeof(gzip135_data
);
292 const size_t value_size
= strlen(gzip135_value
);
294 // Perform a generic data test on the data.
295 doDecompress_ExternalData(gzip135_data
, gzip135_value
, data_size
, value_size
);
298 const char *zlibStream::GetDataBuffer()
303 const unsigned char *zlibStream::GetCompressedData()
305 if (!m_pCompressedData
)
307 // Construct the compressed data live.
308 wxMemoryOutputStream memstream_out
;
310 const char *buf
= "01234567890123456789012345678901234567890123456789"; /* = 50 */
311 wxZlibOutputStream
zstream_out(memstream_out
);
312 zstream_out
.Write(buf
, strlen(buf
));
316 m_SizeCompressedData
= memstream_out
.GetSize();
317 m_pCompressedData
= new unsigned char[m_SizeCompressedData
];
318 memstream_out
.CopyTo(m_pCompressedData
, m_SizeCompressedData
);
321 CPPUNIT_ASSERT(m_pCompressedData
!= NULL
);
322 return m_pCompressedData
;
325 void zlibStream::doTestStreamData(int input_flag
, int output_flag
, int compress_level
, const wxMemoryBuffer
*buf
)
331 { // Part one: Create a compressed file.
332 wxFileOutputStream
fstream_out(FILENAME_GZ
);
333 CPPUNIT_ASSERT(fstream_out
.IsOk());
335 wxZlibOutputStream
zstream_out(fstream_out
, compress_level
, output_flag
);
336 CPPUNIT_ASSERT_MESSAGE("Could not create the output stream", zstream_out
.IsOk());
339 zstream_out
.SetDictionary(*buf
);
341 // Next: Compress some data so the file is containing something.
342 zstream_out
.Write(GetDataBuffer(), DATABUFFER_SIZE
);
345 // Next thing is required by zlib versions pre 1.2.0.
346 if (input_flag
== wxZLIB_NO_HEADER
)
347 fstream_out
.PutC(' ');
350 { // Part two: Verify that the compressed data when uncompressed
351 // matches the original data.
352 wxFileInputStream
fstream_in(FILENAME_GZ
);
353 CPPUNIT_ASSERT(fstream_in
.IsOk());
354 wxZlibInputStream
zstream_in(fstream_in
, input_flag
);
355 CPPUNIT_ASSERT_MESSAGE("Could not create the input stream", zstream_in
.IsOk());
358 zstream_in
.SetDictionary(*buf
);
360 // Next: Check char per char if the returned data is valid.
361 const char *pbuf
= GetDataBuffer();
362 for (fail_pos
= 0; !zstream_in
.Eof(); fail_pos
++)
364 last_value
= zstream_in
.GetC();
365 if (zstream_in
.LastRead() != 1 ||
366 last_value
!= pbuf
[fail_pos
])
370 bWasEOF
= zstream_in
.Eof();
373 // Remove the temp file...
374 ::wxRemoveFile(FILENAME_GZ
);
376 // Check state of the verify action.
377 if (fail_pos
!= DATABUFFER_SIZE
|| !bWasEOF
)
380 msg
<< _T("Wrong data item at pos ") << fail_pos
381 << _T(" (Org_val ") << GetDataBuffer()[fail_pos
]
382 << _T(" != Zlib_val ") << last_value
383 << _T("), with compression level ") << compress_level
;
384 CPPUNIT_FAIL(string(msg
.mb_str()));
388 void zlibStream::doDecompress_ExternalData(const unsigned char *data
, const char *value
, size_t data_size
, size_t value_size
, int flag
)
390 // See that the input is ok.
391 wxASSERT(data
!= NULL
);
392 wxASSERT(value
!= NULL
);
393 wxASSERT(data_size
> 0);
394 wxASSERT(value_size
> 0);
396 // Quickly try to see if the data is valid.
399 case wxZLIB_NO_HEADER
:
402 if (!(data_size
>= 1 && data
[0] == 0x78))
403 wxLogError(_T("zlib data seems to not be zlib data!"));
406 if (!(data_size
>= 2 && data
[0] == 0x1F && data
[1] == 0x8B))
407 wxLogError(_T("gzip data seems to not be gzip data!"));
410 if (!(data_size
>= 1 && data
[0] == 0x78) ||
411 !(data_size
>= 2 && data
[0] == 0x1F && data
[1] == 0x8B))
412 wxLogError(_T("Data seems to not be zlib or gzip data!"));
414 wxLogError(_T("Unknown flag, skipping quick test."));
417 // Creat the needed streams.
418 wxMemoryInputStream
memstream_in(data
, data_size
);
419 CPPUNIT_ASSERT(memstream_in
.IsOk());
420 wxZlibInputStream
zstream_in(memstream_in
, flag
);
421 CPPUNIT_ASSERT(zstream_in
.IsOk());
423 bool bValueEq
= true;
425 for (i
= 0; !zstream_in
.Eof(); i
++)
427 char last_value
= zstream_in
.GetC();
429 // First check if it is a valid read.
430 if (zstream_in
.LastRead() == 1)
433 if (last_value
!= value
[i
])
441 // If the read failed and turned the stream to Eof we stop reading.
442 if (zstream_in
.Eof())
445 CPPUNIT_ASSERT_MESSAGE("Stream is no longer ok!", zstream_in
.IsOk());
448 // Don't go over the end of the value buffer...
451 // And if we do then try to see how long the stream actually is.
452 while (!zstream_in
.Eof())
454 // Move one item along in the stream.
455 (void)zstream_in
.GetC();
458 // Check if we are in an infinite loop by multiplying value_size
459 // by 5 to have a *much* bigger range then the real range.
460 // Note: Incase you ask your self, why 5, the answer is no reason...
461 // it is not to big and not to small a size, nothing more
462 // nothing less to it.
463 if (i
> (value_size
*5))
465 // Note: Please make sure Input_Eof test passed.
466 CPPUNIT_FAIL("Infinite stream detected, breaking the infinite loop");
473 CPPUNIT_ASSERT_MESSAGE("Could not decompress the compressed data, original and restored value did not match.",
474 i
== value_size
&& bValueEq
);
477 wxZlibInputStream
*zlibStream::DoCreateInStream()
479 const unsigned char *buf
= GetCompressedData();
480 m_pTmpMemInStream
= new wxMemoryInputStream(buf
, m_SizeCompressedData
);
481 CPPUNIT_ASSERT(m_pTmpMemInStream
->IsOk());
482 wxZlibInputStream
*pzstream_in
= new wxZlibInputStream(*m_pTmpMemInStream
);
483 CPPUNIT_ASSERT(pzstream_in
->IsOk());
486 wxZlibOutputStream
*zlibStream::DoCreateOutStream()
488 m_pTmpMemOutStream
= new wxMemoryOutputStream();
489 CPPUNIT_ASSERT(m_pTmpMemOutStream
->IsOk());
490 wxZlibOutputStream
*pzstream_out
= new wxZlibOutputStream(*m_pTmpMemOutStream
);
491 CPPUNIT_ASSERT(pzstream_out
->IsOk());
494 void zlibStream::DoDeleteInStream()
496 delete m_pTmpMemInStream
;
497 m_pTmpMemInStream
= NULL
;
499 void zlibStream::DoDeleteOutStream()
501 delete m_pTmpMemOutStream
;
502 m_pTmpMemOutStream
= NULL
;
506 void zlibStream::genExtTestData(wxTextOutputStream
&out
, const char *buf
, int flag
)
512 wxMemoryOutputStream memstream_out
;
514 wxZlibOutputStream
zstream_out(memstream_out
, wxZ_DEFAULT_COMPRESSION
, flag
);
515 zstream_out
.Write(buf
, strlen(buf
));
517 if (flag
== wxZLIB_NO_HEADER
)
518 memstream_out
.PutC(' ');
520 size
= memstream_out
.GetSize();
521 data
= new unsigned char[size
];
522 memstream_out
.CopyTo(data
, size
);
525 out
<< _T("void zlibStream::Decompress_wxXXXData()") << _T("\n");
526 out
<< _T("{") << _T("\n") << _T(" const unsigned char data[] = {");
529 for (i
= 0; i
< size
; i
++)
532 out
<< wxString::Format(_T("%d,"), data
[i
]);
534 out
<< wxString::Format(_T("%d"), data
[i
]);
538 out
<< _T("};") << _T("\n");
539 out
<< _T(" const char *value = \"") << wxString(buf
, wxConvUTF8
) << _T("\";") << _T("\n");
540 out
<< _T(" const size_t data_size = sizeof(data);") << _T("\n");
541 out
<< _T(" const size_t value_size = strlen(value);") << _T("\n");
542 out
<< _T(" doDecompress_ExternalData(data, value, data_size, value_size);") << _T("\n");
543 out
<< _T("}") << _T("\n");
547 // Register the stream sub suite, by using some stream helper macro.
548 // Note: Don't forget to connect it to the base suite (See: bstream.cpp => StreamCase::suite())
549 STREAM_TEST_SUBSUITE_NAMED_REGISTRATION(zlibStream
)