ca527e17ec2cc441a049e311dcfd96bf36a32ce8
[wxWidgets.git] / tests / test.cpp
1 ///////////////////////////////////////////////////////////////////////////////
2 // Name: test.cpp
3 // Purpose: Test program for wxWidgets
4 // Author: Mike Wetherell
5 // RCS-ID: $Id$
6 // Copyright: (c) 2004 Mike Wetherell
7 // Licence: wxWidgets licence
8 ///////////////////////////////////////////////////////////////////////////////
9
10 // For compilers that support precompilation, includes "wx/wx.h"
11 // and "wx/cppunit.h"
12 #include "testprec.h"
13
14 #ifdef __BORLANDC__
15 #pragma hdrstop
16 #endif
17
18 // for all others, include the necessary headers
19 #ifndef WX_PRECOMP
20 #include "wx/wx.h"
21 #endif
22
23 #include "wx/beforestd.h"
24 #ifdef __VISUALC__
25 #pragma warning(disable:4100)
26 #endif
27 #include <cppunit/TestListener.h>
28 #ifdef __VISUALC__
29 #pragma warning(default:4100)
30 #endif
31 #include <cppunit/Protector.h>
32 #include <cppunit/Test.h>
33 #include <cppunit/TestResult.h>
34 #include <cppunit/TestFailure.h>
35 #include "wx/afterstd.h"
36
37 #include "wx/cmdline.h"
38 #include <iostream>
39
40 #ifdef __WXMSW__
41 #include "wx/msw/msvcrt.h"
42 #endif
43
44 using namespace std;
45
46 using CppUnit::Test;
47 using CppUnit::TestSuite;
48 using CppUnit::TestFactoryRegistry;
49
50 // exception class for MSVC debug CRT assertion failures
51 #ifdef wxUSE_VC_CRTDBG
52
53 struct CrtAssertFailure
54 {
55 CrtAssertFailure(const char *message) : m_msg(message) { }
56
57 const wxString m_msg;
58
59 wxDECLARE_NO_ASSIGN_CLASS(CrtAssertFailure);
60 };
61
62 #endif // wxUSE_VC_CRTDBG
63
64 // this function should only be called from a catch clause
65 static string GetExceptionMessage()
66 {
67 wxString msg;
68
69 try
70 {
71 throw;
72 }
73 #if wxDEBUG_LEVEL
74 catch ( TestAssertFailure& e )
75 {
76 msg << "wxWidgets assert: " << e.m_cond << " failed "
77 "at " << e.m_file << ":" << e.m_line << " in " << e.m_func
78 << " with message " << e.m_msg;
79 }
80 #endif // wxDEBUG_LEVEL
81 #ifdef wxUSE_VC_CRTDBG
82 catch ( CrtAssertFailure& e )
83 {
84 msg << "CRT assert failure: " << e.m_msg;
85 }
86 #endif // wxUSE_VC_CRTDBG
87 catch ( std::exception& e )
88 {
89 msg << "std::exception: " << e.what();
90 }
91 catch ( ... )
92 {
93 msg = "Unknown exception caught.";
94 }
95
96 return string(msg.mb_str());
97 }
98
99 // Protector adding handling of wx-specific (this includes MSVC debug CRT in
100 // this context) exceptions
101 class wxUnitTestProtector : public CppUnit::Protector
102 {
103 public:
104 virtual bool protect(const CppUnit::Functor &functor,
105 const CppUnit::ProtectorContext& context)
106 {
107 try
108 {
109 return functor();
110 }
111 catch ( std::exception& )
112 {
113 // cppunit deals with the standard exceptions itself, let it do as
114 // it output more details (especially for std::exception-derived
115 // CppUnit::Exception) than we do
116 throw;
117 }
118 catch ( ... )
119 {
120 reportError(context, CppUnit::Message("Uncaught exception",
121 GetExceptionMessage()));
122 }
123
124 return false;
125 }
126 };
127
128 // Displays the test name before starting to execute it: this helps with
129 // diagnosing where exactly does a test crash or hang when/if it does.
130 class DetailListener : public CppUnit::TestListener
131 {
132 public:
133 DetailListener(bool doTiming = false):
134 CppUnit::TestListener(),
135 m_timing(doTiming)
136 {
137 }
138
139 virtual void startTest(CppUnit::Test *test)
140 {
141 wxPrintf(" %-60s ", test->getName());
142 m_result = RESULT_OK;
143 m_watch.Start();
144 }
145
146 virtual void addFailure(const CppUnit::TestFailure& failure)
147 {
148 m_result = failure.isError() ? RESULT_ERROR : RESULT_FAIL;
149 }
150
151 virtual void endTest(CppUnit::Test * WXUNUSED(test))
152 {
153 m_watch.Pause();
154 wxPrintf(GetResultStr(m_result));
155 if (m_timing)
156 wxPrintf(" %6d ms", m_watch.Time());
157 wxPrintf("\n");
158 }
159
160 protected :
161 enum ResultType
162 {
163 RESULT_OK = 0,
164 RESULT_FAIL,
165 RESULT_ERROR,
166 RESULT_MAX
167 };
168
169 wxString GetResultStr(ResultType type) const
170 {
171 static const char *resultTypeNames[] =
172 {
173 " OK",
174 "FAIL",
175 " ERR"
176 };
177
178 wxCOMPILE_TIME_ASSERT( WXSIZEOF(resultTypeNames) == RESULT_MAX,
179 ResultTypeNamesMismatch );
180
181 return resultTypeNames[type];
182 }
183
184 bool m_timing;
185 wxStopWatch m_watch;
186 ResultType m_result;
187 };
188
189 #if wxUSE_GUI
190 typedef wxApp TestAppBase;
191 #else
192 typedef wxAppConsole TestAppBase;
193 #endif
194
195 // The application class
196 //
197 class TestApp : public TestAppBase
198 {
199 public:
200 TestApp();
201
202 // standard overrides
203 virtual void OnInitCmdLine(wxCmdLineParser& parser);
204 virtual bool OnCmdLineParsed(wxCmdLineParser& parser);
205 virtual bool OnInit();
206 virtual int OnRun();
207 virtual int OnExit();
208
209 // used by events propagation test
210 virtual int FilterEvent(wxEvent& event);
211 virtual bool ProcessEvent(wxEvent& event);
212
213 void SetFilterEventFunc(FilterEventFunc f) { m_filterEventFunc = f; }
214 void SetProcessEventFunc(ProcessEventFunc f) { m_processEventFunc = f; }
215
216 private:
217 void List(Test *test, const string& parent = "") const;
218
219 // command lines options/parameters
220 bool m_list;
221 bool m_longlist;
222 bool m_detail;
223 bool m_timing;
224 wxArrayString m_registries;
225 wxLocale *m_locale;
226
227 // event handling hooks
228 FilterEventFunc m_filterEventFunc;
229 ProcessEventFunc m_processEventFunc;
230 };
231
232 IMPLEMENT_APP_NO_MAIN(TestApp)
233
234 #ifdef wxUSE_VC_CRTDBG
235
236 static int TestCrtReportHook(int reportType, char *message, int *)
237 {
238 if ( reportType != _CRT_ASSERT )
239 return FALSE;
240
241 throw CrtAssertFailure(message);
242 }
243
244 #endif // wxUSE_VC_CRTDBG
245
246 #if wxDEBUG_LEVEL
247
248 static void TestAssertHandler(const wxString& file,
249 int line,
250 const wxString& func,
251 const wxString& cond,
252 const wxString& msg)
253 {
254 throw TestAssertFailure(file, line, func, cond, msg);
255 }
256
257 #endif // wxDEBUG_LEVEL
258
259 int main(int argc, char **argv)
260 {
261 // tests can be ran non-interactively so make sure we don't show any assert
262 // dialog boxes -- neither our own nor from MSVC debug CRT -- which would
263 // prevent them from completing
264
265 #if wxDEBUG_LEVEL
266 wxSetAssertHandler(TestAssertHandler);
267 #endif // wxDEBUG_LEVEL
268
269 #ifdef wxUSE_VC_CRTDBG
270 _CrtSetReportHook(TestCrtReportHook);
271 #endif // wxUSE_VC_CRTDBG
272
273 try
274 {
275 return wxEntry(argc, argv);
276 }
277 catch ( ... )
278 {
279 cerr << "\n" << GetExceptionMessage() << endl;
280 }
281
282 return -1;
283 }
284
285 TestApp::TestApp()
286 : m_list(false),
287 m_longlist(false)
288 {
289 m_filterEventFunc = NULL;
290 m_processEventFunc = NULL;
291
292 m_locale = NULL;
293 }
294
295 // Init
296 //
297 bool TestApp::OnInit()
298 {
299 if ( !TestAppBase::OnInit() )
300 return false;
301
302 cout << "Test program for wxWidgets\n"
303 << "build: " << WX_BUILD_OPTIONS_SIGNATURE << std::endl;
304
305 #if wxUSE_GUI
306 // create a hidden parent window to be used as parent for the GUI controls
307 new wxFrame(NULL, wxID_ANY, "Hidden wx test frame");
308 #endif // wxUSE_GUI
309
310 return true;
311 }
312
313 // The table of command line options
314 //
315 void TestApp::OnInitCmdLine(wxCmdLineParser& parser)
316 {
317 TestAppBase::OnInitCmdLine(parser);
318
319 static const wxCmdLineEntryDesc cmdLineDesc[] = {
320 { wxCMD_LINE_SWITCH, "l", "list",
321 "list the test suites, do not run them",
322 wxCMD_LINE_VAL_NONE, 0 },
323 { wxCMD_LINE_SWITCH, "L", "longlist",
324 "list the test cases, do not run them",
325 wxCMD_LINE_VAL_NONE, 0 },
326 { wxCMD_LINE_SWITCH, "d", "detail",
327 "print the test case names, run them",
328 wxCMD_LINE_VAL_NONE, 0 },
329 { wxCMD_LINE_SWITCH, "t", "timing",
330 "print names and mesure running time of individual test, run them",
331 wxCMD_LINE_VAL_NONE, 0 },
332 { wxCMD_LINE_OPTION, "", "locale",
333 "locale to use when running the program",
334 wxCMD_LINE_VAL_STRING, 0 },
335 { wxCMD_LINE_PARAM, NULL, NULL, "REGISTRY", wxCMD_LINE_VAL_STRING,
336 wxCMD_LINE_PARAM_OPTIONAL | wxCMD_LINE_PARAM_MULTIPLE },
337 wxCMD_LINE_DESC_END
338 };
339
340 parser.SetDesc(cmdLineDesc);
341 }
342
343 // Handle command line options
344 //
345 bool TestApp::OnCmdLineParsed(wxCmdLineParser& parser)
346 {
347 if (parser.GetParamCount())
348 {
349 for (size_t i = 0; i < parser.GetParamCount(); i++)
350 m_registries.push_back(parser.GetParam(i));
351 }
352 else
353 {
354 // FIXME: this is an ugly and unnecessary hack
355 m_registries.push_back("");
356 }
357
358 m_longlist = parser.Found("longlist");
359 m_list = m_longlist || parser.Found("list");
360 m_timing = parser.Found("timing");
361 m_detail = !m_timing && parser.Found("detail");
362
363 wxString loc;
364 if ( parser.Found("locale", &loc) )
365 {
366 const wxLanguageInfo * const info = wxLocale::FindLanguageInfo(loc);
367 if ( !info )
368 {
369 cerr << "Locale \"" << string(loc.mb_str()) << "\" is unknown.\n";
370 return false;
371 }
372
373 m_locale = new wxLocale(info->Language);
374 if ( !m_locale->IsOk() )
375 {
376 cerr << "Using locale \"" << string(loc.mb_str()) << "\" failed.\n";
377 return false;
378 }
379 }
380
381 return TestAppBase::OnCmdLineParsed(parser);
382 }
383
384 // Event handling
385 int TestApp::FilterEvent(wxEvent& event)
386 {
387 if ( m_filterEventFunc )
388 return (*m_filterEventFunc)(event);
389
390 return TestAppBase::FilterEvent(event);
391 }
392
393 bool TestApp::ProcessEvent(wxEvent& event)
394 {
395 if ( m_processEventFunc )
396 return (*m_processEventFunc)(event);
397
398 return TestAppBase::ProcessEvent(event);
399 }
400
401 extern void SetFilterEventFunc(FilterEventFunc func)
402 {
403 wxGetApp().SetFilterEventFunc(func);
404 }
405
406 extern void SetProcessEventFunc(ProcessEventFunc func)
407 {
408 wxGetApp().SetProcessEventFunc(func);
409 }
410
411 // helper of OnRun(): gets the test with the given name, returning NULL (and
412 // not an empty test suite) if there is no such test
413 static Test *GetTestByName(const wxString& name)
414 {
415 Test *
416 test = TestFactoryRegistry::getRegistry(string(name.mb_str())).makeTest();
417 if ( test )
418 {
419 TestSuite * const suite = dynamic_cast<TestSuite *>(test);
420 if ( !suite || !suite->countTestCases() )
421 {
422 // it's a bogus test, don't use it
423 delete test;
424 test = NULL;
425 }
426 }
427
428 return test;
429 }
430
431 // Run
432 //
433 int TestApp::OnRun()
434 {
435 #if wxUSE_LOG
436 // Switch off logging unless --verbose
437 bool verbose = wxLog::GetVerbose();
438 wxLog::EnableLogging(verbose);
439 #else
440 bool verbose = false;
441 #endif
442
443 CppUnit::TextTestRunner runner;
444
445 for (size_t i = 0; i < m_registries.size(); i++)
446 {
447 Test *test;
448
449 wxString reg = m_registries[i];
450 if ( reg.empty() )
451 {
452 // no test name, run all the tests
453 test = TestFactoryRegistry::getRegistry().makeTest();
454 }
455 else // test name specified, run just this test
456 {
457 test = GetTestByName(reg);
458
459 if ( !test && !reg.EndsWith("TestCase") )
460 {
461 test = GetTestByName(reg + "TestCase");
462 }
463
464 if ( !test )
465 {
466 cerr << "No such test suite: " << string(reg.mb_str()) << endl;
467 return 2;
468 }
469 }
470
471 if (m_list)
472 List(test);
473 else
474 runner.addTest(test);
475 }
476
477 if ( m_list )
478 return EXIT_SUCCESS;
479
480 runner.setOutputter(new CppUnit::CompilerOutputter(&runner.result(), cout));
481
482 // there is a bug
483 // (http://sf.net/tracker/index.php?func=detail&aid=1649369&group_id=11795&atid=111795)
484 // in some versions of cppunit: they write progress dots to cout (and not
485 // cerr) and don't flush it so all the dots appear at once at the end which
486 // is not very useful so unbuffer cout to work around this
487 cout.setf(ios::unitbuf);
488
489 // add detail listener if needed
490 DetailListener detailListener(m_timing);
491 if ( m_detail || m_timing )
492 runner.eventManager().addListener(&detailListener);
493
494 // finally ensure that we report our own exceptions nicely instead of
495 // giving "uncaught exception of unknown type" messages
496 runner.eventManager().pushProtector(new wxUnitTestProtector);
497
498 bool printProgress = !(verbose || m_detail || m_timing);
499 return runner.run("", false, true, printProgress) ? EXIT_SUCCESS : EXIT_FAILURE;
500 }
501
502 int TestApp::OnExit()
503 {
504 delete m_locale;
505
506 #if wxUSE_GUI
507 delete GetTopWindow();
508 #endif // wxUSE_GUI
509
510 return 0;
511 }
512
513 // List the tests
514 //
515 void TestApp::List(Test *test, const string& parent /*=""*/) const
516 {
517 TestSuite *suite = dynamic_cast<TestSuite*>(test);
518 string name;
519
520 if (suite) {
521 // take the last component of the name and append to the parent
522 name = test->getName();
523 string::size_type i = name.find_last_of(".:");
524 if (i != string::npos)
525 name = name.substr(i + 1);
526 name = parent + "." + name;
527
528 // drop the 1st component from the display and indent
529 if (parent != "") {
530 string::size_type j = i = name.find('.', 1);
531 while ((j = name.find('.', j + 1)) != string::npos)
532 cout << " ";
533 cout << " " << name.substr(i + 1) << "\n";
534 }
535
536 typedef vector<Test*> Tests;
537 typedef Tests::const_iterator Iter;
538
539 const Tests& tests = suite->getTests();
540
541 for (Iter it = tests.begin(); it != tests.end(); ++it)
542 List(*it, name);
543 }
544 else if (m_longlist) {
545 string::size_type i = 0;
546 while ((i = parent.find('.', i + 1)) != string::npos)
547 cout << " ";
548 cout << " " << test->getName() << "\n";
549 }
550 }