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:     wxWindows licence
   8 ///////////////////////////////////////////////////////////////////////////////
   9
  10 // ----------------------------------------------------------------------------
  11 // headers
  12 // ----------------------------------------------------------------------------
  13
  14 // For compilers that support precompilation, includes "wx/wx.h"
  15 // and "wx/cppunit.h"
  16 #include "testprec.h"
  17
  18 #ifdef __BORLANDC__
  19     #pragma hdrstop
  20 #endif
  21
  22 // for all others, include the necessary headers
  23 #ifndef WX_PRECOMP
  24     #include "wx/wx.h"
  25 #endif
  26
  27 #include "wx/beforestd.h"
  28 #ifdef __VISUALC__
  29     #pragma warning(disable:4100)
  30 #endif
  31
  32 #include <cppunit/TestListener.h>
  33 #include <cppunit/Protector.h>
  34 #include <cppunit/Test.h>
  35 #include <cppunit/TestResult.h>
  36 #include <cppunit/TestFailure.h>
  37 #include <cppunit/TestResultCollector.h>
  38
  39 #ifdef __VISUALC__
  40     #pragma warning(default:4100)
  41 #endif
  42 #include "wx/afterstd.h"
  43
  44 #include "wx/cmdline.h"
  45 #include <exception>
  46 #include <iostream>
  47
  48 #ifdef __WINDOWS__
  49     #include "wx/msw/msvcrt.h"
  50 #endif
  51
  52 #ifdef __WXOSX__
  53     #include "wx/osx/private.h"
  54 #endif
  55
  56 #if wxUSE_GUI
  57     #include "testableframe.h"
  58 #endif
  59
  60 #include "wx/socket.h"
  61 #include "wx/evtloop.h"
  62
  63 using namespace std;
  64
  65 using CppUnit::Test;
  66 using CppUnit::TestSuite;
  67 using CppUnit::TestFactoryRegistry;
  68
  69
  70 // ----------------------------------------------------------------------------
  71 // helper classes
  72 // ----------------------------------------------------------------------------
  73
  74 // exception class for MSVC debug CRT assertion failures
  75 #ifdef wxUSE_VC_CRTDBG
  76
  77 struct CrtAssertFailure
  78 {
  79     CrtAssertFailure(const char *message) : m_msg(message) { }
  80
  81     const wxString m_msg;
  82
  83     wxDECLARE_NO_ASSIGN_CLASS(CrtAssertFailure);
  84 };
  85
  86 #endif // wxUSE_VC_CRTDBG
  87
  88 #if wxDEBUG_LEVEL
  89
  90 // Information about the last not yet handled assertion.
  91 static wxString s_lastAssertMessage;
  92
  93 static wxString FormatAssertMessage(const wxString& file,
  94                                     int line,
  95                                     const wxString& func,
  96                                     const wxString& cond,
  97                                     const wxString& msg)
  98 {
  99     wxString str;
 100     str << "wxWidgets assert: " << cond << " failed "
 101            "at " << file << ":" << line << " in " << func
 102         << " with message '" << msg << "'";
 103     return str;
 104 }
 105
 106 static void TestAssertHandler(const wxString& file,
 107                               int line,
 108                               const wxString& func,
 109                               const wxString& cond,
 110                               const wxString& msg)
 111 {
 112     // Determine whether we can safely throw an exception to just make the test
 113     // fail or whether we need to abort (in this case "msg" will contain the
 114     // explanation why did we decide to do it).
 115     wxString abortReason;
 116
 117     const wxString
 118         assertMessage = FormatAssertMessage(file, line, func, cond, msg);
 119
 120     if ( !wxIsMainThread() )
 121     {
 122         // Exceptions thrown from worker threads are not caught currently and
 123         // so we'd just die without any useful information -- abort instead.
 124         abortReason << assertMessage << "in a worker thread.";
 125     }
 126     else if ( uncaught_exception() )
 127     {
 128         // Throwing while already handling an exception would result in
 129         // terminate() being called and we wouldn't get any useful information
 130         // about why the test failed then.
 131         if ( s_lastAssertMessage.empty() )
 132         {
 133             abortReason << assertMessage << "while handling an exception";
 134         }
 135         else // In this case the exception is due to a previous assert.
 136         {
 137             abortReason << s_lastAssertMessage << "\n  and another "
 138                         << assertMessage << " while handling it.";
 139         }
 140     }
 141     else // Can "safely" throw from here.
 142     {
 143         // Remember this in case another assert happens while handling this
 144         // exception: we want to show the original assert as it's usually more
 145         // useful to determine the real root of the problem.
 146         s_lastAssertMessage = assertMessage;
 147
 148         throw TestAssertFailure(file, line, func, cond, msg);
 149     }
 150
 151     wxFputs(abortReason, stderr);
 152     fflush(stderr);
 153     _exit(-1);
 154 }
 155
 156 #endif // wxDEBUG_LEVEL
 157
 158 // this function should only be called from a catch clause
 159 static string GetExceptionMessage()
 160 {
 161     wxString msg;
 162
 163     try
 164     {
 165         throw;
 166     }
 167 #if wxDEBUG_LEVEL
 168     catch ( TestAssertFailure& )
 169     {
 170         msg = s_lastAssertMessage;
 171         s_lastAssertMessage.clear();
 172     }
 173 #endif // wxDEBUG_LEVEL
 174 #ifdef wxUSE_VC_CRTDBG
 175     catch ( CrtAssertFailure& e )
 176     {
 177         msg << "CRT assert failure: " << e.m_msg;
 178     }
 179 #endif // wxUSE_VC_CRTDBG
 180     catch ( std::exception& e )
 181     {
 182         msg << "std::exception: " << e.what();
 183     }
 184     catch ( ... )
 185     {
 186         msg = "Unknown exception caught.";
 187     }
 188
 189     return string(msg.mb_str());
 190 }
 191
 192 // Protector adding handling of wx-specific (this includes MSVC debug CRT in
 193 // this context) exceptions
 194 class wxUnitTestProtector : public CppUnit::Protector
 195 {
 196 public:
 197     virtual bool protect(const CppUnit::Functor &functor,
 198                          const CppUnit::ProtectorContext& context)
 199     {
 200         try
 201         {
 202             return functor();
 203         }
 204         catch ( std::exception& )
 205         {
 206             // cppunit deals with the standard exceptions itself, let it do as
 207             // it output more details (especially for std::exception-derived
 208             // CppUnit::Exception) than we do
 209             throw;
 210         }
 211         catch ( ... )
 212         {
 213             reportError(context, CppUnit::Message("Uncaught exception",
 214                                                   GetExceptionMessage()));
 215         }
 216
 217         return false;
 218     }
 219 };
 220
 221 // Displays the test name before starting to execute it: this helps with
 222 // diagnosing where exactly does a test crash or hang when/if it does.
 223 class DetailListener : public CppUnit::TestListener
 224 {
 225 public:
 226     DetailListener(bool doTiming = false):
 227         CppUnit::TestListener(),
 228         m_timing(doTiming)
 229     {
 230     }
 231
 232     virtual void startTest(CppUnit::Test *test)
 233     {
 234         printf("  %-60s  ", test->getName().c_str());
 235         m_result = RESULT_OK;
 236         m_watch.Start();
 237     }
 238
 239     virtual void addFailure(const CppUnit::TestFailure& failure)
 240     {
 241         m_result = failure.isError() ? RESULT_ERROR : RESULT_FAIL;
 242     }
 243
 244     virtual void endTest(CppUnit::Test * WXUNUSED(test))
 245     {
 246         m_watch.Pause();
 247         printf("%s", GetResultStr(m_result));
 248         if (m_timing)
 249             printf("  %6ld ms", m_watch.Time());
 250         printf("\n");
 251     }
 252
 253 protected :
 254     enum ResultType
 255     {
 256         RESULT_OK = 0,
 257         RESULT_FAIL,
 258         RESULT_ERROR,
 259         RESULT_MAX
 260     };
 261
 262     const char* GetResultStr(ResultType type) const
 263     {
 264         static const char *resultTypeNames[] =
 265         {
 266             "  OK",
 267             "FAIL",
 268             " ERR"
 269         };
 270
 271         wxCOMPILE_TIME_ASSERT( WXSIZEOF(resultTypeNames) == RESULT_MAX,
 272                                ResultTypeNamesMismatch );
 273
 274         return resultTypeNames[type];
 275     }
 276
 277     bool m_timing;
 278     wxStopWatch m_watch;
 279     ResultType m_result;
 280 };
 281
 282 #if wxUSE_GUI
 283     typedef wxApp TestAppBase;
 284 #else
 285     typedef wxAppConsole TestAppBase;
 286 #endif
 287
 288 // The application class
 289 //
 290 class TestApp : public TestAppBase
 291 {
 292 public:
 293     TestApp();
 294
 295     // standard overrides
 296     virtual void OnInitCmdLine(wxCmdLineParser& parser);
 297     virtual bool OnCmdLineParsed(wxCmdLineParser& parser);
 298     virtual bool OnInit();
 299     virtual int  OnRun();
 300     virtual int  OnExit();
 301
 302     // used by events propagation test
 303     virtual int FilterEvent(wxEvent& event);
 304     virtual bool ProcessEvent(wxEvent& event);
 305
 306     void SetFilterEventFunc(FilterEventFunc f) { m_filterEventFunc = f; }
 307     void SetProcessEventFunc(ProcessEventFunc f) { m_processEventFunc = f; }
 308
 309 private:
 310     void List(Test *test, const string& parent = "") const;
 311
 312     // call List() if m_list or runner.addTest() otherwise
 313     void AddTest(CppUnit::TestRunner& runner, Test *test)
 314     {
 315         if (m_list)
 316             List(test);
 317         else
 318             runner.addTest(test);
 319     }
 320
 321     // command lines options/parameters
 322     bool m_list;
 323     bool m_longlist;
 324     bool m_detail;
 325     bool m_timing;
 326     wxArrayString m_registries;
 327     wxLocale *m_locale;
 328
 329     // event loop for GUI tests
 330     wxEventLoop* m_eventloop;
 331
 332     // event handling hooks
 333     FilterEventFunc m_filterEventFunc;
 334     ProcessEventFunc m_processEventFunc;
 335 };
 336
 337 IMPLEMENT_APP_NO_MAIN(TestApp)
 338
 339
 340 // ----------------------------------------------------------------------------
 341 // global functions
 342 // ----------------------------------------------------------------------------
 343
 344 #ifdef wxUSE_VC_CRTDBG
 345
 346 static int TestCrtReportHook(int reportType, char *message, int *)
 347 {
 348     if ( reportType != _CRT_ASSERT )
 349         return FALSE;
 350
 351     throw CrtAssertFailure(message);
 352 }
 353
 354 #endif // wxUSE_VC_CRTDBG
 355
 356 int main(int argc, char **argv)
 357 {
 358     // tests can be ran non-interactively so make sure we don't show any assert
 359     // dialog boxes -- neither our own nor from MSVC debug CRT -- which would
 360     // prevent them from completing
 361
 362 #if wxDEBUG_LEVEL
 363     wxSetAssertHandler(TestAssertHandler);
 364 #endif // wxDEBUG_LEVEL
 365
 366 #ifdef wxUSE_VC_CRTDBG
 367     _CrtSetReportHook(TestCrtReportHook);
 368 #endif // wxUSE_VC_CRTDBG
 369
 370     try
 371     {
 372         return wxEntry(argc, argv);
 373     }
 374     catch ( ... )
 375     {
 376         cerr << "\n" << GetExceptionMessage() << endl;
 377     }
 378
 379     return -1;
 380 }
 381
 382 extern void SetFilterEventFunc(FilterEventFunc func)
 383 {
 384     wxGetApp().SetFilterEventFunc(func);
 385 }
 386
 387 extern void SetProcessEventFunc(ProcessEventFunc func)
 388 {
 389     wxGetApp().SetProcessEventFunc(func);
 390 }
 391
 392 extern bool IsNetworkAvailable()
 393 {
 394     // NOTE: we could use wxDialUpManager here if it was in wxNet; since it's in
 395     //       wxCore we use a simple rough test:
 396
 397     wxSocketBase::Initialize();
 398
 399     wxIPV4address addr;
 400     if (!addr.Hostname("www.google.com") || !addr.Service("www"))
 401     {
 402         wxSocketBase::Shutdown();
 403         return false;
 404     }
 405
 406     wxSocketClient sock;
 407     sock.SetTimeout(10);    // 10 secs
 408     bool online = sock.Connect(addr);
 409
 410     wxSocketBase::Shutdown();
 411
 412     return online;
 413 }
 414
 415 extern bool IsAutomaticTest()
 416 {
 417     static int s_isAutomatic = -1;
 418     if ( s_isAutomatic == -1 )
 419     {
 420         // Allow setting an environment variable to emulate buildslave user for
 421         // testing.
 422         wxString username;
 423         if ( !wxGetEnv("WX_TEST_USER", &username) )
 424             username = wxGetUserId();
 425
 426         username.MakeLower();
 427         s_isAutomatic = username.Matches("buildslave*") ||
 428                             username.Matches("sandbox*");
 429     }
 430
 431     return s_isAutomatic == 1;
 432 }
 433
 434 // helper of OnRun(): gets the test with the given name, returning NULL (and
 435 // not an empty test suite) if there is no such test
 436 static Test *GetTestByName(const wxString& name)
 437 {
 438     Test *
 439       test = TestFactoryRegistry::getRegistry(string(name.mb_str())).makeTest();
 440     if ( test )
 441     {
 442         TestSuite * const suite = dynamic_cast<TestSuite *>(test);
 443         if ( !suite || !suite->countTestCases() )
 444         {
 445             // it's a bogus test, don't use it
 446             delete test;
 447             test = NULL;
 448         }
 449     }
 450
 451     return test;
 452 }
 453
 454
 455 // ----------------------------------------------------------------------------
 456 // TestApp
 457 // ----------------------------------------------------------------------------
 458
 459 TestApp::TestApp()
 460   : m_list(false),
 461     m_longlist(false)
 462 {
 463     m_filterEventFunc = NULL;
 464     m_processEventFunc = NULL;
 465
 466     m_locale = NULL;
 467     m_eventloop = NULL;
 468 }
 469
 470 // Init
 471 //
 472 bool TestApp::OnInit()
 473 {
 474     if ( !TestAppBase::OnInit() )
 475         return false;
 476
 477 #if wxUSE_GUI
 478     cout << "Test program for wxWidgets GUI features\n"
 479 #else
 480     cout << "Test program for wxWidgets non-GUI features\n"
 481 #endif
 482          << "build: " << WX_BUILD_OPTIONS_SIGNATURE << "\n"
 483          << "running under " << wxGetOsDescription()
 484          << " as " << wxGetUserId() << std::endl;
 485
 486     if ( m_detail )
 487     {
 488         // Output some important information about the test environment.
 489         cout << "Running under " << wxGetOsDescription() << ", "
 490                 "locale is " << setlocale(LC_ALL, NULL) << std::endl;
 491     }
 492
 493 #if wxUSE_GUI
 494     // create a hidden parent window to be used as parent for the GUI controls
 495     wxTestableFrame* frame = new wxTestableFrame();
 496     frame->Show();
 497
 498     m_eventloop = new wxEventLoop;
 499     wxEventLoop::SetActive(m_eventloop);
 500
 501 #ifdef __WXOSX__
 502     // we need to wait until the window is activated and fully ready
 503     // otherwise no events can be posted
 504     m_eventloop->DispatchTimeout(1000);
 505     m_eventloop->Yield();
 506 #endif
 507
 508 #endif // wxUSE_GUI
 509
 510     return true;
 511 }
 512
 513 // The table of command line options
 514 //
 515 void TestApp::OnInitCmdLine(wxCmdLineParser& parser)
 516 {
 517     TestAppBase::OnInitCmdLine(parser);
 518
 519     static const wxCmdLineEntryDesc cmdLineDesc[] = {
 520         { wxCMD_LINE_SWITCH, "l", "list",
 521             "list the test suites, do not run them",
 522             wxCMD_LINE_VAL_NONE, 0 },
 523         { wxCMD_LINE_SWITCH, "L", "longlist",
 524             "list the test cases, do not run them",
 525             wxCMD_LINE_VAL_NONE, 0 },
 526         { wxCMD_LINE_SWITCH, "d", "detail",
 527             "print the test case names, run them",
 528             wxCMD_LINE_VAL_NONE, 0 },
 529         { wxCMD_LINE_SWITCH, "t", "timing",
 530             "print names and measure running time of individual test, run them",
 531             wxCMD_LINE_VAL_NONE, 0 },
 532         { wxCMD_LINE_OPTION, "", "locale",
 533             "locale to use when running the program",
 534             wxCMD_LINE_VAL_STRING, 0 },
 535         { wxCMD_LINE_PARAM, NULL, NULL, "REGISTRY", wxCMD_LINE_VAL_STRING,
 536             wxCMD_LINE_PARAM_OPTIONAL | wxCMD_LINE_PARAM_MULTIPLE },
 537         wxCMD_LINE_DESC_END
 538     };
 539
 540     parser.SetDesc(cmdLineDesc);
 541 }
 542
 543 // Handle command line options
 544 //
 545 bool TestApp::OnCmdLineParsed(wxCmdLineParser& parser)
 546 {
 547     if (parser.GetParamCount())
 548     {
 549         for (size_t i = 0; i < parser.GetParamCount(); i++)
 550             m_registries.push_back(parser.GetParam(i));
 551     }
 552
 553     m_longlist = parser.Found("longlist");
 554     m_list = m_longlist || parser.Found("list");
 555     m_timing = parser.Found("timing");
 556     m_detail = !m_timing && parser.Found("detail");
 557
 558     wxString loc;
 559     if ( parser.Found("locale", &loc) )
 560     {
 561         const wxLanguageInfo * const info = wxLocale::FindLanguageInfo(loc);
 562         if ( !info )
 563         {
 564             cerr << "Locale \"" << string(loc.mb_str()) << "\" is unknown.\n";
 565             return false;
 566         }
 567
 568         m_locale = new wxLocale(info->Language);
 569         if ( !m_locale->IsOk() )
 570         {
 571             cerr << "Using locale \"" << string(loc.mb_str()) << "\" failed.\n";
 572             return false;
 573         }
 574     }
 575
 576     return TestAppBase::OnCmdLineParsed(parser);
 577 }
 578
 579 // Event handling
 580 int TestApp::FilterEvent(wxEvent& event)
 581 {
 582     if ( m_filterEventFunc )
 583         return (*m_filterEventFunc)(event);
 584
 585     return TestAppBase::FilterEvent(event);
 586 }
 587
 588 bool TestApp::ProcessEvent(wxEvent& event)
 589 {
 590     if ( m_processEventFunc )
 591         return (*m_processEventFunc)(event);
 592
 593     return TestAppBase::ProcessEvent(event);
 594 }
 595
 596 // Run
 597 //
 598 int TestApp::OnRun()
 599 {
 600 #if wxUSE_GUI
 601 #ifdef __WXOSX__
 602     // make sure there's always an autorelease pool ready
 603     wxMacAutoreleasePool autoreleasepool;
 604 #endif
 605 #endif
 606
 607 #if wxUSE_LOG
 608     // Switch off logging unless --verbose
 609     bool verbose = wxLog::GetVerbose();
 610     wxLog::EnableLogging(verbose);
 611 #else
 612     bool verbose = false;
 613 #endif
 614
 615     CppUnit::TextTestRunner runner;
 616
 617     if ( m_registries.empty() )
 618     {
 619         // run or list all tests which use the CPPUNIT_TEST_SUITE_REGISTRATION() macro
 620         // (i.e. those registered in the "All tests" registry); if there are other
 621         // tests not registered with the CPPUNIT_TEST_SUITE_REGISTRATION() macro
 622         // then they won't be listed/run!
 623         AddTest(runner, TestFactoryRegistry::getRegistry().makeTest());
 624
 625         if (m_list)
 626         {
 627             cout << "\nNote that the list above is not complete as it doesn't include the \n";
 628             cout << "tests disabled by default.\n";
 629         }
 630     }
 631     else // run only the selected tests
 632     {
 633         for (size_t i = 0; i < m_registries.size(); i++)
 634         {
 635             const wxString reg = m_registries[i];
 636             Test *test = GetTestByName(reg);
 637
 638             if ( !test && !reg.EndsWith("TestCase") )
 639             {
 640                 test = GetTestByName(reg + "TestCase");
 641             }
 642
 643             if ( !test )
 644             {
 645                 cerr << "No such test suite: " << string(reg.mb_str()) << endl;
 646                 return 2;
 647             }
 648
 649             AddTest(runner, test);
 650         }
 651     }
 652
 653     if ( m_list )
 654         return EXIT_SUCCESS;
 655
 656     runner.setOutputter(new CppUnit::CompilerOutputter(&runner.result(), cout));
 657
 658     // there is a bug
 659     // (http://sf.net/tracker/index.php?func=detail&aid=1649369&group_id=11795&atid=111795)
 660     // in some versions of cppunit: they write progress dots to cout (and not
 661     // cerr) and don't flush it so all the dots appear at once at the end which
 662     // is not very useful so unbuffer cout to work around this
 663     cout.setf(ios::unitbuf);
 664
 665     // add detail listener if needed
 666     DetailListener detailListener(m_timing);
 667     if ( m_detail || m_timing )
 668         runner.eventManager().addListener(&detailListener);
 669
 670     // finally ensure that we report our own exceptions nicely instead of
 671     // giving "uncaught exception of unknown type" messages
 672     runner.eventManager().pushProtector(new wxUnitTestProtector);
 673
 674     bool printProgress = !(verbose || m_detail || m_timing);
 675     runner.run("", false, true, printProgress);
 676
 677     return runner.result().testFailures() == 0 ? EXIT_SUCCESS : EXIT_FAILURE;
 678 }
 679
 680 int TestApp::OnExit()
 681 {
 682     delete m_locale;
 683
 684 #if wxUSE_GUI
 685     delete GetTopWindow();
 686     wxEventLoop::SetActive(NULL);
 687     delete m_eventloop;
 688 #endif // wxUSE_GUI
 689
 690     return 0;
 691 }
 692
 693 // List the tests
 694 //
 695 void TestApp::List(Test *test, const string& parent /*=""*/) const
 696 {
 697     TestSuite *suite = dynamic_cast<TestSuite*>(test);
 698     string name;
 699
 700     if (suite) {
 701         // take the last component of the name and append to the parent
 702         name = test->getName();
 703         string::size_type i = name.find_last_of(".:");
 704         if (i != string::npos)
 705             name = name.substr(i + 1);
 706         name = parent + "." + name;
 707
 708         // drop the 1st component from the display and indent
 709         if (parent != "") {
 710             string::size_type j = i = name.find('.', 1);
 711             while ((j = name.find('.', j + 1)) != string::npos)
 712                 cout << "  ";
 713             cout << "  " << name.substr(i + 1) << "\n";
 714         }
 715
 716         typedef vector<Test*> Tests;
 717         typedef Tests::const_iterator Iter;
 718
 719         const Tests& tests = suite->getTests();
 720
 721         for (Iter it = tests.begin(); it != tests.end(); ++it)
 722             List(*it, name);
 723     }
 724     else if (m_longlist) {
 725         string::size_type i = 0;
 726         while ((i = parent.find('.', i + 1)) != string::npos)
 727             cout << "  ";
 728         cout << "  " << test->getName() << "\n";
 729     }
 730 }