]> git.saurik.com Git - wxWidgets.git/blobdiff - tests/test.cpp
No changes, just suppress an unused variable warning.
[wxWidgets.git] / tests / test.cpp
index 067af9edd172c4612be565a2b7afefb64310b44c..a2a04ed98c5db9e83e70a6613d1c7c0652c97204 100644 (file)
@@ -4,7 +4,7 @@
 // Author:      Mike Wetherell
 // RCS-ID:      $Id$
 // Copyright:   (c) 2004 Mike Wetherell
-// Licence:     wxWidgets licence
+// Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
 // ----------------------------------------------------------------------------
 #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 <cppunit/TestFailure.h>
+#include <cppunit/TestResultCollector.h>
+
+#ifdef __VISUALC__
+    #pragma warning(default:4100)
+#endif
 #include "wx/afterstd.h"
 
 #include "wx/cmdline.h"
+#include <exception>
 #include <iostream>
 
-#ifdef __WXMSW__
+#ifdef __WINDOWS__
     #include "wx/msw/msvcrt.h"
 #endif
 
     #include "wx/osx/private.h"
 #endif
 
+#if wxUSE_GUI
+    #include "testableframe.h"
+#endif
+
 #include "wx/socket.h"
+#include "wx/evtloop.h"
 
 using namespace std;
 
@@ -76,6 +85,76 @@ struct 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()
 {
@@ -86,11 +165,10 @@ static string GetExceptionMessage()
         throw;
     }
 #if wxDEBUG_LEVEL
-    catch ( TestAssertFailure& )
+    catch ( TestAssertFailure& )
     {
-        msg << "wxWidgets assert: " << e.m_cond << " failed "
-               "at " << e.m_file << ":" << e.m_line << " in " << e.m_func
-            << " with message '" << e.m_msg << "'";
+        msg = s_lastAssertMessage;
+        s_lastAssertMessage.clear();
     }
 #endif // wxDEBUG_LEVEL
 #ifdef wxUSE_VC_CRTDBG
@@ -153,7 +231,7 @@ public:
 
     virtual void startTest(CppUnit::Test *test)
     {
-        wxPrintf("  %-60s  ", test->getName());
+        printf("  %-60s  ", test->getName().c_str());
         m_result = RESULT_OK;
         m_watch.Start();
     }
@@ -166,10 +244,10 @@ public:
     virtual void endTest(CppUnit::Test * WXUNUSED(test))
     {
         m_watch.Pause();
-        wxPrintf(GetResultStr(m_result));
+        printf("%s", GetResultStr(m_result));
         if (m_timing)
-            wxPrintf("  %6d ms", m_watch.Time());
-        wxPrintf("\n");
+            printf("  %6ld ms", m_watch.Time());
+        printf("\n");
     }
 
 protected :
@@ -181,7 +259,7 @@ protected :
         RESULT_MAX
     };
 
-    wxString GetResultStr(ResultType type) const
+    const char* GetResultStr(ResultType type) const
     {
         static const char *resultTypeNames[] =
         {
@@ -248,6 +326,9 @@ private:
     wxArrayString m_registries;
     wxLocale *m_locale;
 
+    // event loop for GUI tests
+    wxEventLoop* m_eventloop;
+
     // event handling hooks
     FilterEventFunc m_filterEventFunc;
     ProcessEventFunc m_processEventFunc;
@@ -272,19 +353,6 @@ static int TestCrtReportHook(int reportType, char *message, int *)
 
 #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
@@ -336,6 +404,7 @@ extern bool IsNetworkAvailable()
     }
 
     wxSocketClient sock;
+    sock.SetTimeout(10);    // 10 secs
     bool online = sock.Connect(addr);
     
     wxSocketBase::Shutdown();
@@ -343,6 +412,23 @@ extern bool IsNetworkAvailable()
     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)
@@ -376,6 +462,7 @@ TestApp::TestApp()
     m_processEventFunc = NULL;
 
     m_locale = NULL;
+    m_eventloop = NULL;
 }
 
 // Init
@@ -394,7 +481,11 @@ bool TestApp::OnInit()
 
 #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;
@@ -417,7 +508,7 @@ void TestApp::OnInitCmdLine(wxCmdLineParser& parser)
             "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_OPTION, "", "locale",
             "locale to use when running the program",
@@ -506,8 +597,17 @@ int TestApp::OnRun()
 
     if ( m_registries.empty() )
     {
-        // run or list all tests
+        // 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
     {
@@ -553,7 +653,9 @@ int TestApp::OnRun()
     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()
@@ -562,6 +664,8 @@ int TestApp::OnExit()
 
 #if wxUSE_GUI
     delete GetTopWindow();
+    wxEventLoop::SetActive(NULL);
+    delete m_eventloop;
 #endif // wxUSE_GUI
 
     return 0;