don't crash in wxFAIL and wxCHECK if assertion handler is NULL

[wxWidgets.git] / tests / test.cpp

diff --git a/tests/test.cpp b/tests/test.cpp
index ae856107fad3411ec71a39709cee971d5a8c5b74..fe22ad10cd28aa633423b69c6e87650de45b2375 100644 (file)
--- a/tests/test.cpp
+++ b/tests/test.cpp
@@ -7,13 +7,9 @@
 // Licence:     wxWidgets licence
 ///////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWidgets licence
 ///////////////////////////////////////////////////////////////////////////////
 

-#if defined(__GNUG__) && !defined(__APPLE__)
-    #pragma implementation
-    #pragma interface
-#endif
-
-// For compilers that support precompilation, includes "wx/wx.h".
-#include "wx/wxprec.h"
+// For compilers that support precompilation, includes "wx/wx.h"
+// and "wx/cppunit.h"
+#include "testprec.h"

 
 #ifdef __BORLANDC__
     #pragma hdrstop
 
 #ifdef __BORLANDC__
     #pragma hdrstop


@@ -24,25 +20,159 @@
     #include "wx/wx.h"
 #endif
 
     #include "wx/wx.h"
 #endif
 

+#include "wx/beforestd.h"
+#ifdef __VISUALC__
+    #pragma warning(disable:4100)
+#endif
+#include <cppunit/TestListener.h>
+#ifdef __VISUALC__
+    #pragma warning(default:4100)
+#endif
+#include <cppunit/Protector.h>
+#include <cppunit/Test.h>
+#include <cppunit/TestResult.h>
+#include "wx/afterstd.h"
+

 #include "wx/cmdline.h"
 #include "wx/cmdline.h"

-#include "wx/cppunit.h"

 #include <iostream>
 
 #include <iostream>
 

+#ifdef __WXMSW__
+    #include "wx/msw/msvcrt.h"
+#endif
+

 using namespace std;
 using namespace std;

-using namespace CppUnit;
+
+using CppUnit::Test;
+using CppUnit::TestSuite;
+using CppUnit::TestFactoryRegistry;
+
+// 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
+
+// this function should only be called from a catch clause
+static string GetExceptionMessage()
+{
+    wxString msg;
+
+    try
+    {
+        throw;
+    }
+#if wxDEBUG_LEVEL
+    catch ( TestAssertFailure& e )
+    {
+        msg << "wxWidgets assert: " << e.m_cond << " failed "
+               "at " << e.m_file << ":" << e.m_line << " in " << e.m_func
+            << " with message " << e.m_msg;
+    }
+#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 ( ... )
+        {
+            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)
+    {
+        std::cout << test->getName () << " ";
+        m_watch.Start();
+    }
+
+    virtual void endTest(CppUnit::Test * WXUNUSED(test))
+    {
+        m_watch.Pause();
+        if ( m_timing )
+            std::cout << " (in "<< m_watch.Time() << " ms )";
+        std::cout << "\n";
+    }
+
+protected :
+    bool m_timing;
+    wxStopWatch m_watch;
+};
+
+#if wxUSE_GUI
+    typedef wxApp TestAppBase;
+#else
+    typedef wxAppConsole TestAppBase;
+#endif

 
 // The application class
 //
 
 // The application class
 //

-class TestApp : public wxAppConsole
+class TestApp : public TestAppBase

 {
 public:
     TestApp();
 
     // standard overrides
 {
 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;
 
 private:
     void List(Test *test, const string& parent = "") const;


@@ -50,42 +180,116 @@ private:
     // command lines options/parameters
     bool m_list;
     bool m_longlist;
     // command lines options/parameters
     bool m_list;
     bool m_longlist;

-    vector<string> m_registries;
+    bool m_detail;
+    bool m_timing;
+    wxArrayString m_registries;
+
+    // event handling hooks
+    FilterEventFunc m_filterEventFunc;
+    ProcessEventFunc m_processEventFunc;

 };
 
 };
 

-IMPLEMENT_APP_CONSOLE(TestApp)
+IMPLEMENT_APP_NO_MAIN(TestApp)
+
+#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
+
+#if wxDEBUG_LEVEL
+
+static void TestAssertHandler(const wxString& file,
+                              int line,
+                              const wxString& func,
+                              const wxString& cond,
+                              const wxString& msg)
+{
+    throw TestAssertFailure(file, line, func, cond, msg);
+}
+
+#endif // wxDEBUG_LEVEL
+
+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;
+}

 
 TestApp::TestApp()
   : m_list(false),
     m_longlist(false)
 {
 
 TestApp::TestApp()
   : m_list(false),
     m_longlist(false)
 {

+    m_filterEventFunc = NULL;
+    m_processEventFunc = NULL;

 }
 
 // Init
 //
 bool TestApp::OnInit()
 {
 }
 
 // Init
 //
 bool TestApp::OnInit()
 {

+    if ( !TestAppBase::OnInit() )
+        return false;
+

     cout << "Test program for wxWidgets\n"
     cout << "Test program for wxWidgets\n"

-         << "build: " << WX_BUILD_OPTIONS_SIGNATURE << endl;
-    return wxAppConsole::OnInit();
-};
+         << "build: " << WX_BUILD_OPTIONS_SIGNATURE << std::endl;
+
+#if wxUSE_GUI
+    // create a hidden parent window to be used as parent for the GUI controls
+    new wxFrame(NULL, wxID_ANY, "Hidden wx test frame");
+#endif // wxUSE_GUI
+
+    return true;
+}

 
 // The table of command line options
 //
 void TestApp::OnInitCmdLine(wxCmdLineParser& parser)
 {
 
 // The table of command line options
 //
 void TestApp::OnInitCmdLine(wxCmdLineParser& parser)
 {

-    wxAppConsole::OnInitCmdLine(parser);
+    TestAppBase::OnInitCmdLine(parser);

 
     static const wxCmdLineEntryDesc cmdLineDesc[] = {
 
     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_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 mesure running time of individual test, run them",

             wxCMD_LINE_VAL_NONE, 0 },
             wxCMD_LINE_VAL_NONE, 0 },

-        { wxCMD_LINE_PARAM, 0, 0, _T("REGISTRY"), wxCMD_LINE_VAL_STRING,
+        { wxCMD_LINE_PARAM, NULL, NULL, "REGISTRY", wxCMD_LINE_VAL_STRING,

             wxCMD_LINE_PARAM_OPTIONAL | wxCMD_LINE_PARAM_MULTIPLE },
             wxCMD_LINE_PARAM_OPTIONAL | wxCMD_LINE_PARAM_MULTIPLE },

-        { wxCMD_LINE_NONE , 0, 0, 0, wxCMD_LINE_VAL_NONE, 0 }
+        wxCMD_LINE_DESC_END

     };
 
     parser.SetDesc(cmdLineDesc);
     };
 
     parser.SetDesc(cmdLineDesc);


@@ -97,51 +301,112 @@ bool TestApp::OnCmdLineParsed(wxCmdLineParser& parser)
 {
     if (parser.GetParamCount())
         for (size_t i = 0; i < parser.GetParamCount(); i++)
 {
     if (parser.GetParamCount())
         for (size_t i = 0; i < parser.GetParamCount(); i++)

-            m_registries.push_back(string(parser.GetParam(i).mb_str()));
+            m_registries.push_back(parser.GetParam(i));

     else
         m_registries.push_back("");
     else
         m_registries.push_back("");

- 
+

     m_longlist = parser.Found(_T("longlist"));
     m_list = m_longlist || parser.Found(_T("list"));
     m_longlist = parser.Found(_T("longlist"));
     m_list = m_longlist || parser.Found(_T("list"));

+    m_timing = parser.Found(_T("timing"));
+    m_detail = !m_timing && parser.Found(_T("detail"));
+
+    return TestAppBase::OnCmdLineParsed(parser);
+}

 
 

-    return wxAppConsole::OnCmdLineParsed(parser);
+// Event handling
+int TestApp::FilterEvent(wxEvent& event)
+{
+    if ( m_filterEventFunc )
+        return (*m_filterEventFunc)(event);
+
+    return TestAppBase::FilterEvent(event);
+}
+
+bool TestApp::ProcessEvent(wxEvent& event)
+{
+    if ( m_processEventFunc )
+        return (*m_processEventFunc)(event);
+
+    return TestAppBase::ProcessEvent(event);
+}
+
+extern void SetFilterEventFunc(FilterEventFunc func)
+{
+    wxGetApp().SetFilterEventFunc(func);
+}
+
+extern void SetProcessEventFunc(ProcessEventFunc func)
+{
+    wxGetApp().SetProcessEventFunc(func);

 }
 
 }
 

-#include "wx/uri.h"

 // Run
 //
 int TestApp::OnRun()
 {
 // Run
 //
 int TestApp::OnRun()
 {

-    TextUi::TestRunner runner;
+    CppUnit::TextTestRunner runner;
+
+    for (size_t i = 0; i < m_registries.size(); i++)
+    {
+        wxString reg = m_registries[i];
+        if (!reg.empty() && !reg.EndsWith("TestCase"))
+            reg += "TestCase";
+        // allow the user to specify the name of the testcase "in short form"
+        // (all wx test cases end with TestCase postfix)

 
 

-    for (size_t i = 0; i < m_registries.size(); i++) {
-        auto_ptr<Test> test(m_registries[i].empty() ?
+        auto_ptr<Test> test(reg.empty() ?

             TestFactoryRegistry::getRegistry().makeTest() :
             TestFactoryRegistry::getRegistry().makeTest() :

-            TestFactoryRegistry::getRegistry(m_registries[i]).makeTest());
+            TestFactoryRegistry::getRegistry(string(reg.mb_str())).makeTest());

 
         TestSuite *suite = dynamic_cast<TestSuite*>(test.get());
 
         if (suite && suite->countTestCases() == 0)
 
         TestSuite *suite = dynamic_cast<TestSuite*>(test.get());
 
         if (suite && suite->countTestCases() == 0)

-            wxLogError(_T("No such test suite: %s"),
-                wxString(m_registries[i].c_str(), wxConvUTF8).c_str());
+            wxLogError(_T("No such test suite: %s"), reg);

         else if (m_list)
             List(test.get());
         else
             runner.addTest(test.release());
     }
 
         else if (m_list)
             List(test.get());
         else
             runner.addTest(test.release());
     }
 

-#if wxUSE_LOG
-    // Switch off logging unless --verbose
-    wxLog::EnableLogging(wxLog::GetVerbose());
-#endif // wxUSE_LOG
+    if ( m_list )
+        return EXIT_SUCCESS;
+
+    runner.setOutputter(new CppUnit::CompilerOutputter(&runner.result(), cout));

 
 

-    return m_list || runner.run("", false, true, 

 #if wxUSE_LOG
 #if wxUSE_LOG

-        !wxLog::GetVerbose()
+    // Switch off logging unless --verbose
+    bool verbose = wxLog::GetVerbose();
+    wxLog::EnableLogging(verbose);

 #else
 #else

-        true
-#endif // wxUSE_LOG
-    ) ? EXIT_SUCCESS : EXIT_FAILURE;
+    bool verbose = false;
+#endif
+
+    // 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);
+
+    return runner.run("", false, true, !verbose) ? EXIT_SUCCESS : EXIT_FAILURE;
+}
+
+int TestApp::OnExit()
+{
+#if wxUSE_GUI
+    delete GetTopWindow();
+#endif // wxUSE_GUI
+
+    return 0;

 }
 
 // List the tests
 }
 
 // List the tests


@@ -155,7 +420,9 @@ void TestApp::List(Test *test, const string& parent /*=""*/) const
         // take the last component of the name and append to the parent
         name = test->getName();
         string::size_type i = name.find_last_of(".:");
         // take the last component of the name and append to the parent
         name = test->getName();
         string::size_type i = name.find_last_of(".:");

-        name = parent + "." + (i != string::npos ? name.substr(i + 1) : name);
+        if (i != string::npos)
+            name = name.substr(i + 1);
+        name = parent + "." + name;

 
         // drop the 1st component from the display and indent
         if (parent != "") {
 
         // drop the 1st component from the display and indent
         if (parent != "") {