X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/1f25eb3aa94958a329714b8793439f131176610e..22a3b6e4b2010f425a54708e46b1b463bd2817a7:/tests/test.cpp diff --git a/tests/test.cpp b/tests/test.cpp index 00c21251f2..6619dd21c5 100644 --- a/tests/test.cpp +++ b/tests/test.cpp @@ -4,9 +4,13 @@ // Author: Mike Wetherell // RCS-ID: $Id$ // Copyright: (c) 2004 Mike Wetherell -// Licence: wxWidgets licence +// Licence: wxWindows licence /////////////////////////////////////////////////////////////////////////////// +// ---------------------------------------------------------------------------- +// headers +// ---------------------------------------------------------------------------- + // For compilers that support precompilation, includes "wx/wx.h" // and "wx/cppunit.h" #include "testprec.h" @@ -20,83 +24,505 @@ #include "wx/wx.h" #endif +#include "wx/beforestd.h" +#ifdef __VISUALC__ + #pragma warning(disable:4100) +#endif + +#include +#include +#include +#include +#include +#include + +#ifdef __VISUALC__ + #pragma warning(default:4100) +#endif +#include "wx/afterstd.h" + #include "wx/cmdline.h" +#include #include +#ifdef __WINDOWS__ + #include "wx/msw/msvcrt.h" +#endif + +#ifdef __WXOSX__ + #include "wx/osx/private.h" +#endif + +#if wxUSE_GUI + #include "testableframe.h" +#endif + +#include "wx/socket.h" +#include "wx/evtloop.h" + +using namespace std; + using CppUnit::Test; using CppUnit::TestSuite; using CppUnit::TestFactoryRegistry; -using CppUnit::TextUi::TestRunner; -using CppUnit::CompilerOutputter; -using std::string; -using std::vector; -using std::auto_ptr; -using std::cout; + +// ---------------------------------------------------------------------------- +// helper classes +// ---------------------------------------------------------------------------- + +// exception class for MSVC debug CRT assertion failures +#ifdef wxUSE_VC_CRTDBG + +struct CrtAssertFailure +{ + CrtAssertFailure(const char *message) : m_msg(message) { } + + const wxString m_msg; + + wxDECLARE_NO_ASSIGN_CLASS(CrtAssertFailure); +}; + +#endif // wxUSE_VC_CRTDBG + +#if wxDEBUG_LEVEL + +// Information about the last not yet handled assertion. +static wxString s_lastAssertMessage; + +static wxString FormatAssertMessage(const wxString& file, + int line, + const wxString& func, + const wxString& cond, + const wxString& msg) +{ + wxString str; + str << "wxWidgets assert: " << cond << " failed " + "at " << file << ":" << line << " in " << func + << " with message '" << msg << "'"; + return str; +} + +static void TestAssertHandler(const wxString& file, + int line, + const wxString& func, + const wxString& cond, + const wxString& msg) +{ + // Determine whether we can safely throw an exception to just make the test + // fail or whether we need to abort (in this case "msg" will contain the + // explanation why did we decide to do it). + wxString abortReason; + + const wxString + assertMessage = FormatAssertMessage(file, line, func, cond, msg); + + if ( !wxIsMainThread() ) + { + // Exceptions thrown from worker threads are not caught currently and + // so we'd just die without any useful information -- abort instead. + abortReason << assertMessage << "in a worker thread."; + } + else if ( uncaught_exception() ) + { + // Throwing while already handling an exception would result in + // terminate() being called and we wouldn't get any useful information + // about why the test failed then. + if ( s_lastAssertMessage.empty() ) + { + abortReason << assertMessage << "while handling an exception"; + } + else // In this case the exception is due to a previous assert. + { + abortReason << s_lastAssertMessage << "\n and another " + << assertMessage << " while handling it."; + } + } + else // Can "safely" throw from here. + { + // Remember this in case another assert happens while handling this + // exception: we want to show the original assert as it's usually more + // useful to determine the real root of the problem. + s_lastAssertMessage = assertMessage; + + throw TestAssertFailure(file, line, func, cond, msg); + } + + wxFputs(abortReason, stderr); + fflush(stderr); + _exit(-1); +} + +#endif // wxDEBUG_LEVEL + +// this function should only be called from a catch clause +static string GetExceptionMessage() +{ + wxString msg; + + try + { + throw; + } +#if wxDEBUG_LEVEL + catch ( TestAssertFailure& ) + { + msg = s_lastAssertMessage; + s_lastAssertMessage.clear(); + } +#endif // wxDEBUG_LEVEL +#ifdef wxUSE_VC_CRTDBG + catch ( CrtAssertFailure& e ) + { + msg << "CRT assert failure: " << e.m_msg; + } +#endif // wxUSE_VC_CRTDBG + catch ( std::exception& e ) + { + msg << "std::exception: " << e.what(); + } + catch ( ... ) + { + msg = "Unknown exception caught."; + } + + return string(msg.mb_str()); +} + +// Protector adding handling of wx-specific (this includes MSVC debug CRT in +// this context) exceptions +class wxUnitTestProtector : public CppUnit::Protector +{ +public: + virtual bool protect(const CppUnit::Functor &functor, + const CppUnit::ProtectorContext& context) + { + try + { + return functor(); + } + catch ( std::exception& ) + { + // cppunit deals with the standard exceptions itself, let it do as + // it output more details (especially for std::exception-derived + // CppUnit::Exception) than we do + throw; + } + catch ( ... ) + { + reportError(context, CppUnit::Message("Uncaught exception", + GetExceptionMessage())); + } + + return false; + } +}; + +// Displays the test name before starting to execute it: this helps with +// diagnosing where exactly does a test crash or hang when/if it does. +class DetailListener : public CppUnit::TestListener +{ +public: + DetailListener(bool doTiming = false): + CppUnit::TestListener(), + m_timing(doTiming) + { + } + + virtual void startTest(CppUnit::Test *test) + { + printf(" %-60s ", test->getName().c_str()); + m_result = RESULT_OK; + m_watch.Start(); + } + + virtual void addFailure(const CppUnit::TestFailure& failure) + { + m_result = failure.isError() ? RESULT_ERROR : RESULT_FAIL; + } + + virtual void endTest(CppUnit::Test * WXUNUSED(test)) + { + m_watch.Pause(); + printf("%s", GetResultStr(m_result)); + if (m_timing) + printf(" %6ld ms", m_watch.Time()); + printf("\n"); + } + +protected : + enum ResultType + { + RESULT_OK = 0, + RESULT_FAIL, + RESULT_ERROR, + RESULT_MAX + }; + + const char* GetResultStr(ResultType type) const + { + static const char *resultTypeNames[] = + { + " OK", + "FAIL", + " ERR" + }; + + wxCOMPILE_TIME_ASSERT( WXSIZEOF(resultTypeNames) == RESULT_MAX, + ResultTypeNamesMismatch ); + + return resultTypeNames[type]; + } + + bool m_timing; + wxStopWatch m_watch; + ResultType m_result; +}; + +#if wxUSE_GUI + typedef wxApp TestAppBase; +#else + typedef wxAppConsole TestAppBase; +#endif // The application class // -class TestApp : public wxAppConsole +class TestApp : public TestAppBase { public: TestApp(); // standard overrides - void OnInitCmdLine(wxCmdLineParser& parser); - bool OnCmdLineParsed(wxCmdLineParser& parser); - bool OnInit(); - int OnRun(); + virtual void OnInitCmdLine(wxCmdLineParser& parser); + virtual bool OnCmdLineParsed(wxCmdLineParser& parser); + virtual bool OnInit(); + virtual int OnRun(); + virtual int OnExit(); + + // used by events propagation test + virtual int FilterEvent(wxEvent& event); + virtual bool ProcessEvent(wxEvent& event); + + void SetFilterEventFunc(FilterEventFunc f) { m_filterEventFunc = f; } + void SetProcessEventFunc(ProcessEventFunc f) { m_processEventFunc = f; } private: void List(Test *test, const string& parent = "") const; + // call List() if m_list or runner.addTest() otherwise + void AddTest(CppUnit::TestRunner& runner, Test *test) + { + if (m_list) + List(test); + else + runner.addTest(test); + } + // command lines options/parameters bool m_list; bool m_longlist; - vector m_registries; + bool m_detail; + bool m_timing; + wxArrayString m_registries; + wxLocale *m_locale; + + // event loop for GUI tests + wxEventLoop* m_eventloop; + + // event handling hooks + FilterEventFunc m_filterEventFunc; + ProcessEventFunc m_processEventFunc; }; -IMPLEMENT_APP_CONSOLE(TestApp) +IMPLEMENT_APP_NO_MAIN(TestApp) + + +// ---------------------------------------------------------------------------- +// global functions +// ---------------------------------------------------------------------------- + +#ifdef wxUSE_VC_CRTDBG + +static int TestCrtReportHook(int reportType, char *message, int *) +{ + if ( reportType != _CRT_ASSERT ) + return FALSE; + + throw CrtAssertFailure(message); +} + +#endif // wxUSE_VC_CRTDBG + +int main(int argc, char **argv) +{ + // tests can be ran non-interactively so make sure we don't show any assert + // dialog boxes -- neither our own nor from MSVC debug CRT -- which would + // prevent them from completing + +#if wxDEBUG_LEVEL + wxSetAssertHandler(TestAssertHandler); +#endif // wxDEBUG_LEVEL + +#ifdef wxUSE_VC_CRTDBG + _CrtSetReportHook(TestCrtReportHook); +#endif // wxUSE_VC_CRTDBG + + try + { + return wxEntry(argc, argv); + } + catch ( ... ) + { + cerr << "\n" << GetExceptionMessage() << endl; + } + + return -1; +} + +extern void SetFilterEventFunc(FilterEventFunc func) +{ + wxGetApp().SetFilterEventFunc(func); +} + +extern void SetProcessEventFunc(ProcessEventFunc func) +{ + wxGetApp().SetProcessEventFunc(func); +} + +extern bool IsNetworkAvailable() +{ + // NOTE: we could use wxDialUpManager here if it was in wxNet; since it's in + // wxCore we use a simple rough test: + + wxSocketBase::Initialize(); + + wxIPV4address addr; + if (!addr.Hostname("www.google.com") || !addr.Service("www")) + { + wxSocketBase::Shutdown(); + return false; + } + + wxSocketClient sock; + sock.SetTimeout(10); // 10 secs + bool online = sock.Connect(addr); + + wxSocketBase::Shutdown(); + + return online; +} + +extern bool IsAutomaticTest() +{ + static int s_isAutomatic = -1; + if ( s_isAutomatic == -1 ) + { + // Allow setting an environment variable to emulate buildslave user for + // testing. + wxString username; + if ( !wxGetEnv("WX_TEST_USER", &username) ) + username = wxGetUserId(); + + s_isAutomatic = username.Lower().Matches("buildslave*"); + } + + return s_isAutomatic == 1; +} + +// helper of OnRun(): gets the test with the given name, returning NULL (and +// not an empty test suite) if there is no such test +static Test *GetTestByName(const wxString& name) +{ + Test * + test = TestFactoryRegistry::getRegistry(string(name.mb_str())).makeTest(); + if ( test ) + { + TestSuite * const suite = dynamic_cast(test); + if ( !suite || !suite->countTestCases() ) + { + // it's a bogus test, don't use it + delete test; + test = NULL; + } + } + + return test; +} + + +// ---------------------------------------------------------------------------- +// TestApp +// ---------------------------------------------------------------------------- TestApp::TestApp() : m_list(false), m_longlist(false) { + m_filterEventFunc = NULL; + m_processEventFunc = NULL; + + m_locale = NULL; + m_eventloop = NULL; } // Init // bool TestApp::OnInit() { - cout << "Test program for wxWidgets\n" - << "build: " << WX_BUILD_OPTIONS_SIGNATURE << std::endl; + if ( !TestAppBase::OnInit() ) + return false; -#if !wxUSE_WXVSNPRINTF - cout << "\n"; - cout << "WARNING: VsnprintfTestCase will test the system vsnprintf() function\n"; - cout << " instead of the wxWidgets wxVsnprintf_ implementation!" << std::endl; - cout << "\n"; +#if wxUSE_GUI + cout << "Test program for wxWidgets GUI features\n" +#else + cout << "Test program for wxWidgets non-GUI features\n" #endif + << "build: " << WX_BUILD_OPTIONS_SIGNATURE << std::endl; - return wxAppConsole::OnInit(); -}; + if ( m_detail ) + { + // Output some important information about the test environment. + cout << "Running under " << wxGetOsDescription() << ", " + "locale is " << setlocale(LC_ALL, NULL) << std::endl; + } + +#if wxUSE_GUI + // create a hidden parent window to be used as parent for the GUI controls + wxTestableFrame* frame = new wxTestableFrame(); + frame->Show(); + + m_eventloop = new wxEventLoop; + wxEventLoop::SetActive(m_eventloop); +#endif // wxUSE_GUI + + return true; +} // The table of command line options // void TestApp::OnInitCmdLine(wxCmdLineParser& parser) { - wxAppConsole::OnInitCmdLine(parser); + TestAppBase::OnInitCmdLine(parser); static const wxCmdLineEntryDesc cmdLineDesc[] = { - { wxCMD_LINE_SWITCH, _T("l"), _T("list"), - _T("list the test suites, do not run them"), + { wxCMD_LINE_SWITCH, "l", "list", + "list the test suites, do not run them", + wxCMD_LINE_VAL_NONE, 0 }, + { wxCMD_LINE_SWITCH, "L", "longlist", + "list the test cases, do not run them", + wxCMD_LINE_VAL_NONE, 0 }, + { wxCMD_LINE_SWITCH, "d", "detail", + "print the test case names, run them", wxCMD_LINE_VAL_NONE, 0 }, - { wxCMD_LINE_SWITCH, _T("L"), _T("longlist"), - _T("list the test cases, do not run them"), + { wxCMD_LINE_SWITCH, "t", "timing", + "print names and measure running time of individual test, run them", wxCMD_LINE_VAL_NONE, 0 }, - { wxCMD_LINE_PARAM, "", "", _T("REGISTRY"), wxCMD_LINE_VAL_STRING, + { wxCMD_LINE_OPTION, "", "locale", + "locale to use when running the program", + wxCMD_LINE_VAL_STRING, 0 }, + { wxCMD_LINE_PARAM, NULL, NULL, "REGISTRY", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL | wxCMD_LINE_PARAM_MULTIPLE }, - { wxCMD_LINE_NONE , "", "", "", wxCMD_LINE_VAL_NONE, 0 } + wxCMD_LINE_DESC_END }; parser.SetDesc(cmdLineDesc); @@ -107,40 +533,64 @@ void TestApp::OnInitCmdLine(wxCmdLineParser& parser) bool TestApp::OnCmdLineParsed(wxCmdLineParser& parser) { if (parser.GetParamCount()) + { for (size_t i = 0; i < parser.GetParamCount(); i++) - m_registries.push_back(string(parser.GetParam(i).mb_str())); - else - m_registries.push_back(""); + m_registries.push_back(parser.GetParam(i)); + } + + m_longlist = parser.Found("longlist"); + m_list = m_longlist || parser.Found("list"); + m_timing = parser.Found("timing"); + m_detail = !m_timing && parser.Found("detail"); + + wxString loc; + if ( parser.Found("locale", &loc) ) + { + const wxLanguageInfo * const info = wxLocale::FindLanguageInfo(loc); + if ( !info ) + { + cerr << "Locale \"" << string(loc.mb_str()) << "\" is unknown.\n"; + return false; + } - m_longlist = parser.Found(_T("longlist")); - m_list = m_longlist || parser.Found(_T("list")); + m_locale = new wxLocale(info->Language); + if ( !m_locale->IsOk() ) + { + cerr << "Using locale \"" << string(loc.mb_str()) << "\" failed.\n"; + return false; + } + } - return wxAppConsole::OnCmdLineParsed(parser); + return TestAppBase::OnCmdLineParsed(parser); } -// Run -// -int TestApp::OnRun() +// Event handling +int TestApp::FilterEvent(wxEvent& event) { - TestRunner runner; + if ( m_filterEventFunc ) + return (*m_filterEventFunc)(event); - for (size_t i = 0; i < m_registries.size(); i++) { - auto_ptr test(m_registries[i].empty() ? - TestFactoryRegistry::getRegistry().makeTest() : - TestFactoryRegistry::getRegistry(m_registries[i]).makeTest()); + return TestAppBase::FilterEvent(event); +} - TestSuite *suite = dynamic_cast(test.get()); +bool TestApp::ProcessEvent(wxEvent& event) +{ + if ( m_processEventFunc ) + return (*m_processEventFunc)(event); - if (suite && suite->countTestCases() == 0) - wxLogError(_T("No such test suite: %s"), - wxString(m_registries[i].c_str(), wxConvUTF8).c_str()); - else if (m_list) - List(test.get()); - else - runner.addTest(test.release()); - } + return TestAppBase::ProcessEvent(event); +} - runner.setOutputter(new CompilerOutputter(&runner.result(), cout)); +// Run +// +int TestApp::OnRun() +{ +#if wxUSE_GUI +#ifdef __WXOSX__ + // make sure there's always an autorelease pool ready + wxMacAutoreleasePool autoreleasepool; +#endif +#endif #if wxUSE_LOG // Switch off logging unless --verbose @@ -150,9 +600,82 @@ int TestApp::OnRun() bool verbose = false; #endif - return ( m_list || runner.run("", false, true, !verbose) ) - ? EXIT_SUCCESS - : EXIT_FAILURE; + CppUnit::TextTestRunner runner; + + if ( m_registries.empty() ) + { + // run or list all tests which use the CPPUNIT_TEST_SUITE_REGISTRATION() macro + // (i.e. those registered in the "All tests" registry); if there are other + // tests not registered with the CPPUNIT_TEST_SUITE_REGISTRATION() macro + // then they won't be listed/run! + AddTest(runner, TestFactoryRegistry::getRegistry().makeTest()); + + if (m_list) + { + cout << "\nNote that the list above is not complete as it doesn't include the \n"; + cout << "tests disabled by default.\n"; + } + } + else // run only the selected tests + { + for (size_t i = 0; i < m_registries.size(); i++) + { + const wxString reg = m_registries[i]; + Test *test = GetTestByName(reg); + + if ( !test && !reg.EndsWith("TestCase") ) + { + test = GetTestByName(reg + "TestCase"); + } + + if ( !test ) + { + cerr << "No such test suite: " << string(reg.mb_str()) << endl; + return 2; + } + + AddTest(runner, test); + } + } + + if ( m_list ) + return EXIT_SUCCESS; + + runner.setOutputter(new CppUnit::CompilerOutputter(&runner.result(), cout)); + + // there is a bug + // (http://sf.net/tracker/index.php?func=detail&aid=1649369&group_id=11795&atid=111795) + // in some versions of cppunit: they write progress dots to cout (and not + // cerr) and don't flush it so all the dots appear at once at the end which + // is not very useful so unbuffer cout to work around this + cout.setf(ios::unitbuf); + + // add detail listener if needed + DetailListener detailListener(m_timing); + if ( m_detail || m_timing ) + runner.eventManager().addListener(&detailListener); + + // finally ensure that we report our own exceptions nicely instead of + // giving "uncaught exception of unknown type" messages + runner.eventManager().pushProtector(new wxUnitTestProtector); + + bool printProgress = !(verbose || m_detail || m_timing); + runner.run("", false, true, printProgress); + + return runner.result().testFailures() == 0 ? EXIT_SUCCESS : EXIT_FAILURE; +} + +int TestApp::OnExit() +{ + delete m_locale; + +#if wxUSE_GUI + delete GetTopWindow(); + wxEventLoop::SetActive(NULL); + delete m_eventloop; +#endif // wxUSE_GUI + + return 0; } // List the tests