Support for undoable application of custom properties, and customisation of propertie...

[wxWidgets.git] / tests / test.cpp

diff --git a/tests/test.cpp b/tests/test.cpp
index 54f56612f62b56ea5c5aac52e6da93b6bf6ebe2f..983bc4f3ce2eb2326046d95a315ef40c9417f377 100644 (file)
--- a/tests/test.cpp
+++ b/tests/test.cpp
@@ -4,9 +4,13 @@
 // Author:      Mike Wetherell
 // RCS-ID:      $Id$
 // Copyright:   (c) 2004 Mike Wetherell
 // 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"
 // For compilers that support precompilation, includes "wx/wx.h"
 // and "wx/cppunit.h"
 #include "testprec.h"


@@ -24,29 +28,49 @@
 #ifdef __VISUALC__
     #pragma warning(disable:4100)
 #endif
 #ifdef __VISUALC__
     #pragma warning(disable:4100)
 #endif

+

 #include <cppunit/TestListener.h>
 #include <cppunit/TestListener.h>

-#ifdef __VISUALC__
-    #pragma warning(default:4100)
-#endif

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

+#include <cppunit/TestResultCollector.h>
+
+#ifdef __VISUALC__
+    #pragma warning(default:4100)
+#endif

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

+#include <exception>

 #include <iostream>
 
 #ifdef __WXMSW__
     #include "wx/msw/msvcrt.h"
 #endif
 
 #include <iostream>
 
 #ifdef __WXMSW__
     #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 namespace std;
 
 using CppUnit::Test;
 using CppUnit::TestSuite;
 using CppUnit::TestFactoryRegistry;
 

+
+// ----------------------------------------------------------------------------
+// helper classes
+// ----------------------------------------------------------------------------
+

 // exception class for MSVC debug CRT assertion failures
 #ifdef wxUSE_VC_CRTDBG
 
 // exception class for MSVC debug CRT assertion failures
 #ifdef wxUSE_VC_CRTDBG
 


@@ -61,6 +85,58 @@ struct CrtAssertFailure
 
 #endif // wxUSE_VC_CRTDBG
 
 
 #endif // wxUSE_VC_CRTDBG
 

+#if wxDEBUG_LEVEL
+
+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;
+    if ( !wxIsMainThread() )
+    {
+        // Exceptions thrown from worker threads are not caught currently and
+        // so we'd just die without any useful information -- abort instead.
+        abortReason = "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.
+        abortReason = "while handling an exception";
+    }
+    else // Can "safely" throw from here.
+    {
+        throw TestAssertFailure(file, line, func, cond, msg);
+    }
+
+    wxFprintf(stderr, "%s %s -- aborting.",
+              FormatAssertMessage(file, line, func, cond, msg),
+              abortReason);
+    fflush(stderr);
+    _exit(-1);
+}
+
+#endif // wxDEBUG_LEVEL
+

 // this function should only be called from a catch clause
 static string GetExceptionMessage()
 {
 // this function should only be called from a catch clause
 static string GetExceptionMessage()
 {


@@ -73,9 +149,8 @@ static string GetExceptionMessage()
 #if wxDEBUG_LEVEL
     catch ( TestAssertFailure& e )
     {
 #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;
+        msg << FormatAssertMessage(e.m_file, e.m_line, e.m_func,
+                                   e.m_cond, e.m_msg);

     }
 #endif // wxDEBUG_LEVEL
 #ifdef wxUSE_VC_CRTDBG
     }
 #endif // wxDEBUG_LEVEL
 #ifdef wxUSE_VC_CRTDBG


@@ -153,7 +228,7 @@ public:
         m_watch.Pause();
         wxPrintf(GetResultStr(m_result));
         if (m_timing)
         m_watch.Pause();
         wxPrintf(GetResultStr(m_result));
         if (m_timing)

-            wxPrintf("  %6d ms", m_watch.Time());
+            wxPrintf("  %6ld ms", m_watch.Time());

         wxPrintf("\n");
     }
 
         wxPrintf("\n");
     }
 


@@ -216,12 +291,25 @@ public:
 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;
     wxArrayString m_registries;
     // command lines options/parameters
     bool m_list;
     bool m_longlist;
     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;
 
     // event handling hooks
     FilterEventFunc m_filterEventFunc;


@@ -230,6 +318,11 @@ private:
 
 IMPLEMENT_APP_NO_MAIN(TestApp)
 
 
 IMPLEMENT_APP_NO_MAIN(TestApp)
 

+
+// ----------------------------------------------------------------------------
+// global functions
+// ----------------------------------------------------------------------------
+

 #ifdef wxUSE_VC_CRTDBG
 
 static int TestCrtReportHook(int reportType, char *message, int *)
 #ifdef wxUSE_VC_CRTDBG
 
 static int TestCrtReportHook(int reportType, char *message, int *)


@@ -242,19 +335,6 @@ static int TestCrtReportHook(int reportType, char *message, int *)
 
 #endif // wxUSE_VC_CRTDBG
 
 
 #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
 int main(int argc, char **argv)
 {
     // tests can be ran non-interactively so make sure we don't show any assert


@@ -281,12 +361,73 @@ int main(int argc, char **argv)
     return -1;
 }
 
     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;
+}
+
+// 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;
+}
+
+
+// ----------------------------------------------------------------------------
+// TestApp
+// ----------------------------------------------------------------------------
+

 TestApp::TestApp()
   : m_list(false),
     m_longlist(false)
 {
     m_filterEventFunc = NULL;
     m_processEventFunc = NULL;
 TestApp::TestApp()
   : m_list(false),
     m_longlist(false)
 {
     m_filterEventFunc = NULL;
     m_processEventFunc = NULL;

+
+    m_locale = NULL;
+    m_eventloop = NULL;

 }
 
 // Init
 }
 
 // Init


@@ -296,12 +437,20 @@ bool TestApp::OnInit()
     if ( !TestAppBase::OnInit() )
         return false;
 
     if ( !TestAppBase::OnInit() )
         return false;
 

-    cout << "Test program for wxWidgets\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;
 
 #if wxUSE_GUI
     // create a hidden parent window to be used as parent for the GUI controls
          << "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");
+    wxTestableFrame* frame = new wxTestableFrame();
+    frame->Show();
+
+    m_eventloop = new wxEventLoop;
+    wxEventLoop::SetActive(m_eventloop);

 #endif // wxUSE_GUI
 
     return true;
 #endif // wxUSE_GUI
 
     return true;


@@ -324,8 +473,11 @@ void TestApp::OnInitCmdLine(wxCmdLineParser& parser)
             "print the test case names, run them",
             wxCMD_LINE_VAL_NONE, 0 },
         { wxCMD_LINE_SWITCH, "t", "timing",
             "print the test case names, run them",
             wxCMD_LINE_VAL_NONE, 0 },
         { wxCMD_LINE_SWITCH, "t", "timing",

-            "print names and mesure running time of individual test, run them",
+            "print names and measure running time of individual test, run them",

             wxCMD_LINE_VAL_NONE, 0 },
             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


@@ -339,15 +491,33 @@ 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++)
             m_registries.push_back(parser.GetParam(i));
         for (size_t i = 0; i < parser.GetParamCount(); i++)
             m_registries.push_back(parser.GetParam(i));

-    else
-        m_registries.push_back("");
+    }

 
 

-    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);
 }


@@ -369,20 +539,17 @@ bool TestApp::ProcessEvent(wxEvent& event)
     return TestAppBase::ProcessEvent(event);
 }
 
     return TestAppBase::ProcessEvent(event);
 }
 

-extern void SetFilterEventFunc(FilterEventFunc func)
-{
-    wxGetApp().SetFilterEventFunc(func);
-}
-
-extern void SetProcessEventFunc(ProcessEventFunc func)
-{
-    wxGetApp().SetProcessEventFunc(func);
-}
-

 // Run
 //
 int TestApp::OnRun()
 {
 // 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
     bool verbose = wxLog::GetVerbose();
 #if wxUSE_LOG
     // Switch off logging unless --verbose
     bool verbose = wxLog::GetVerbose();


@@ -393,28 +560,40 @@ int TestApp::OnRun()
 
     CppUnit::TextTestRunner runner;
 
 
     CppUnit::TextTestRunner runner;
 

-    for (size_t i = 0; i < m_registries.size(); i++)
+    if ( m_registries.empty() )

     {
     {

-        wxString reg = m_registries[i];
-        // allow the user to specify the name of the testcase "in short form"
-        // (all wx test cases end with TestCase postfix)
-        if (!reg.empty() && !reg.EndsWith("TestCase"))
-            reg += "TestCase";
+        // 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());

 
 

-        string stdreg(reg.mb_str());
+        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);

 
 

-        auto_ptr<Test> test(reg.empty() ?
-            TestFactoryRegistry::getRegistry().makeTest() :
-            TestFactoryRegistry::getRegistry(stdreg).makeTest());
+            if ( !test && !reg.EndsWith("TestCase") )
+            {
+                test = GetTestByName(reg + "TestCase");
+            }

 
 

-        TestSuite *suite = dynamic_cast<TestSuite*>(test.get());
+            if ( !test )
+            {
+                cerr << "No such test suite: " << string(reg.mb_str()) << endl;
+                return 2;
+            }

 
 

-        if (suite && suite->countTestCases() == 0)
-            cerr << "No such test suite: " << stdreg << endl;
-        else if (m_list)
-            List(test.get());
-        else
-            runner.addTest(test.release());
+            AddTest(runner, test);
+        }

     }
 
     if ( m_list )
     }
 
     if ( m_list )


@@ -439,13 +618,19 @@ int TestApp::OnRun()
     runner.eventManager().pushProtector(new wxUnitTestProtector);
 
     bool printProgress = !(verbose || m_detail || m_timing);
     runner.eventManager().pushProtector(new wxUnitTestProtector);
 
     bool printProgress = !(verbose || m_detail || m_timing);

-    return runner.run("", false, true, printProgress) ? EXIT_SUCCESS : EXIT_FAILURE;
+    runner.run("", false, true, printProgress);
+
+    return runner.result().testFailures() == 0 ? EXIT_SUCCESS : EXIT_FAILURE;

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

+    delete m_locale;
+

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

+    wxEventLoop::SetActive(NULL);
+    delete m_eventloop;

 #endif // wxUSE_GUI
 
     return 0;
 #endif // wxUSE_GUI
 
     return 0;