adding API note

[wxWidgets.git] / tests / test.cpp

diff --git a/tests/test.cpp b/tests/test.cpp
index cc84f279253fa7207dab7922a47d4b37aecb59b6..667c2c0c3055e21bb510e0e323a0d772b14b2912 100644 (file)
--- a/tests/test.cpp
+++ b/tests/test.cpp
@@ -28,17 +28,102 @@
 #ifdef __VISUALC__
     #pragma warning(default:4100)
 #endif
 #ifdef __VISUALC__
     #pragma warning(default:4100)
 #endif

+#include <cppunit/Protector.h>

 #include <cppunit/Test.h>
 #include <cppunit/TestResult.h>
 #include <cppunit/Test.h>
 #include <cppunit/TestResult.h>

+#include <cppunit/TestFailure.h>

 #include "wx/afterstd.h"
 
 #include "wx/cmdline.h"
 #include <iostream>
 
 #include "wx/afterstd.h"
 
 #include "wx/cmdline.h"
 #include <iostream>
 

+#ifdef __WXMSW__
+    #include "wx/msw/msvcrt.h"
+#endif
+
+using namespace std;
+

 using CppUnit::Test;
 using CppUnit::TestSuite;
 using CppUnit::TestFactoryRegistry;
 
 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 ( 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.
 
 // 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.


@@ -53,25 +138,54 @@ public:
 
     virtual void startTest(CppUnit::Test *test)
     {
 
     virtual void startTest(CppUnit::Test *test)
     {

-        std::cout << test->getName () << " ";
+        wxPrintf("  %-60s  ", test->getName());
+        m_result = RESULT_OK;

         m_watch.Start();
     }
 
         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();
     virtual void endTest(CppUnit::Test * WXUNUSED(test))
     {
         m_watch.Pause();

-        if ( m_timing )
-            std::cout << " (in "<< m_watch.Time() << " ms )";
-        std::cout << "\n";
+        wxPrintf(GetResultStr(m_result));
+        if (m_timing)
+            wxPrintf("  %6d ms", m_watch.Time());
+        wxPrintf("\n");

     }
 
 protected :
     }
 
 protected :

+    enum ResultType
+    {
+        RESULT_OK = 0,
+        RESULT_FAIL,
+        RESULT_ERROR,
+        RESULT_MAX
+    };
+
+    wxString 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;
     bool m_timing;
     wxStopWatch m_watch;

+    ResultType m_result;

 };
 
 };
 

-using namespace std;
-

 #if wxUSE_GUI
     typedef wxApp TestAppBase;
 #else
 #if wxUSE_GUI
     typedef wxApp TestAppBase;
 #else


@@ -92,23 +206,99 @@ public:
     virtual int  OnRun();
     virtual int  OnExit();
 
     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;
 

+    // 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;
     bool m_detail;
     bool m_timing;
     // command lines options/parameters
     bool m_list;
     bool m_longlist;
     bool m_detail;
     bool m_timing;

-    vector<string> m_registries;
+    wxArrayString m_registries;
+    wxLocale *m_locale;
+
+    // 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;
+
+    m_locale = NULL;

 }
 
 // Init
 }
 
 // Init


@@ -148,6 +338,9 @@ void TestApp::OnInitCmdLine(wxCmdLineParser& parser)
         { wxCMD_LINE_SWITCH, "t", "timing",
             "print names and mesure running time of individual test, run them",
             wxCMD_LINE_VAL_NONE, 0 },
         { wxCMD_LINE_SWITCH, "t", "timing",
             "print names and mesure running time of individual test, run them",
             wxCMD_LINE_VAL_NONE, 0 },

+        { 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_DESC_END
         { wxCMD_LINE_PARAM, NULL, NULL, "REGISTRY", wxCMD_LINE_VAL_STRING,
             wxCMD_LINE_PARAM_OPTIONAL | wxCMD_LINE_PARAM_MULTIPLE },
         wxCMD_LINE_DESC_END


@@ -161,46 +354,88 @@ void TestApp::OnInitCmdLine(wxCmdLineParser& parser)
 bool TestApp::OnCmdLineParsed(wxCmdLineParser& parser)
 {
     if (parser.GetParamCount())
 bool TestApp::OnCmdLineParsed(wxCmdLineParser& parser)
 {
     if (parser.GetParamCount())

+    {

         for (size_t i = 0; i < parser.GetParamCount(); i++)
         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(_T("longlist"));
-    m_list = m_longlist || parser.Found(_T("list"));
-    m_timing = parser.Found(_T("timing"));
-    m_detail = !m_timing && parser.Found(_T("detail"));
+    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_locale = new wxLocale(info->Language);
+        if ( !m_locale->IsOk() )
+        {
+            cerr << "Using locale \"" << string(loc.mb_str()) << "\" failed.\n";
+            return false;
+        }
+    }

 
     return TestAppBase::OnCmdLineParsed(parser);
 }
 
 
     return TestAppBase::OnCmdLineParsed(parser);
 }
 

-// Run
-//
-int TestApp::OnRun()
+// Event handling
+int TestApp::FilterEvent(wxEvent& event)

 {
 {

-    CppUnit::TextTestRunner runner;
+    if ( m_filterEventFunc )
+        return (*m_filterEventFunc)(event);

 
 

-    for (size_t i = 0; i < m_registries.size(); i++) {
-        auto_ptr<Test> test(m_registries[i].empty() ?
-            TestFactoryRegistry::getRegistry().makeTest() :
-            TestFactoryRegistry::getRegistry(m_registries[i]).makeTest());
+    return TestAppBase::FilterEvent(event);
+}

 
 

-        TestSuite *suite = dynamic_cast<TestSuite*>(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);
+}

 
 

-    if ( m_list )
-        return EXIT_SUCCESS;
+extern void SetFilterEventFunc(FilterEventFunc func)
+{
+    wxGetApp().SetFilterEventFunc(func);
+}

 
 

-    runner.setOutputter(new CppUnit::CompilerOutputter(&runner.result(), cout));
+extern void SetProcessEventFunc(ProcessEventFunc func)
+{
+    wxGetApp().SetProcessEventFunc(func);
+}
+
+// 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<TestSuite *>(test);
+        if ( !suite || !suite->countTestCases() )
+        {
+            // it's a bogus test, don't use it
+            delete test;
+            test = NULL;
+        }
+    }
+
+    return test;
+}

 
 

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

 #if wxUSE_LOG
     // Switch off logging unless --verbose
     bool verbose = wxLog::GetVerbose();
 #if wxUSE_LOG
     // Switch off logging unless --verbose
     bool verbose = wxLog::GetVerbose();


@@ -209,6 +444,40 @@ int TestApp::OnRun()
     bool verbose = false;
 #endif
 
     bool verbose = false;
 #endif
 

+    CppUnit::TextTestRunner runner;
+
+    if ( m_registries.empty() )
+    {
+        // run or list all tests
+        AddTest(runner, TestFactoryRegistry::getRegistry().makeTest());
+    }
+    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
     // 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


@@ -221,11 +490,18 @@ int TestApp::OnRun()
     if ( m_detail || m_timing )
         runner.eventManager().addListener(&detailListener);
 
     if ( m_detail || m_timing )
         runner.eventManager().addListener(&detailListener);
 

-    return runner.run("", false, true, !verbose) ? EXIT_SUCCESS : EXIT_FAILURE;
+    // 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);
+    return runner.run("", false, true, printProgress) ? EXIT_SUCCESS : EXIT_FAILURE;

 }
 
 int TestApp::OnExit()
 {
 }
 
 int TestApp::OnExit()
 {

+    delete m_locale;
+

 #if wxUSE_GUI
     delete GetTopWindow();
 #endif // wxUSE_GUI
 #if wxUSE_GUI
     delete GetTopWindow();
 #endif // wxUSE_GUI