// Name: test.cpp
// Purpose: Test program for wxWidgets
// 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"
#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
+#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;
+
+// ----------------------------------------------------------------------------
+// helper classes
+// ----------------------------------------------------------------------------
+
// exception class for MSVC debug CRT assertion failures
#ifdef wxUSE_VC_CRTDBG
#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()
{
throw;
}
#if wxDEBUG_LEVEL
- catch ( TestAssertFailure& e )
+ 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
{
return functor();
}
- catch ( std::exception& e )
+ catch ( std::exception& )
{
// cppunit deals with the standard exceptions itself, let it do as
// it output more details (especially for std::exception-derived
virtual void startTest(CppUnit::Test *test)
{
- std::cout << test->getName () << " ";
+ 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();
- if ( m_timing )
- std::cout << " (in "<< m_watch.Time() << " ms )";
- std::cout << "\n";
+ 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
virtual void OnInitCmdLine(wxCmdLineParser& parser);
virtual bool OnCmdLineParsed(wxCmdLineParser& parser);
virtual bool OnInit();
- virtual int OnRun();
virtual int OnExit();
// used by events propagation test
void SetFilterEventFunc(FilterEventFunc f) { m_filterEventFunc = f; }
void SetProcessEventFunc(ProcessEventFunc f) { m_processEventFunc = f; }
+ // In console applications we run the tests directly from the overridden
+ // OnRun(), but in the GUI ones we run them when we get the first call to
+ // our EVT_IDLE handler to ensure that we do everything from inside the
+ // main event loop. This is especially important under wxOSX/Cocoa where
+ // the main event loop is different from the others but it's also safer to
+ // do it like this in the other ports as we test the GUI code in the same
+ // context as it's used usually, in normal programs, and it might behave
+ // differently without the event loop.
+#if wxUSE_GUI
+ void OnIdle(wxIdleEvent& event)
+ {
+ if ( m_runTests )
+ {
+ m_runTests = false;
+
+#ifdef __WXOSX__
+ // we need to wait until the window is activated and fully ready
+ // otherwise no events can be posted
+ wxEventLoopBase* const loop = wxEventLoop::GetActive();
+ if ( loop )
+ {
+ loop->DispatchTimeout(1000);
+ loop->Yield();
+ }
+#endif // __WXOSX__
+
+ m_exitcode = RunTests();
+ ExitMainLoop();
+ }
+
+ event.Skip();
+ }
+#else // !wxUSE_GUI
+ virtual int OnRun()
+ {
+ m_exitcode = RunTests();
+ return m_exitcode;
+ }
+#endif // wxUSE_GUI/!wxUSE_GUI
+
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);
+ }
+
+ int RunTests();
+
+ // flag telling us whether we should run tests from our EVT_IDLE handler
+ bool m_runTests;
+
// command lines options/parameters
bool m_list;
bool m_longlist;
bool m_detail;
bool m_timing;
wxArrayString m_registries;
+ wxLocale *m_locale;
// event handling hooks
FilterEventFunc m_filterEventFunc;
ProcessEventFunc m_processEventFunc;
+
+ // the program exit code
+ int m_exitcode;
};
IMPLEMENT_APP_NO_MAIN(TestApp)
+
+// ----------------------------------------------------------------------------
+// global functions
+// ----------------------------------------------------------------------------
+
#ifdef wxUSE_VC_CRTDBG
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
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();
+
+ username.MakeLower();
+ s_isAutomatic = username.Matches("buildslave*") ||
+ username.Matches("sandbox*");
+ }
+
+ return s_isAutomatic == 1;
+}
+
+// helper of RunTests(): 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_runTests = true;
+
m_filterEventFunc = NULL;
m_processEventFunc = NULL;
+
+ m_locale = NULL;
+
+ m_exitcode = EXIT_SUCCESS;
}
// Init
if ( !TestAppBase::OnInit() )
return false;
- cout << "Test program for wxWidgets\n"
- << "build: " << WX_BUILD_OPTIONS_SIGNATURE << std::endl;
+#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 << "\n"
+ << "running under " << wxGetOsDescription()
+ << " as " << wxGetUserId() << std::endl;
+
+ 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
- new wxFrame(NULL, wxID_ANY, "Hidden wx test frame");
+ wxTestableFrame* frame = new wxTestableFrame();
+ frame->Show();
+
+ Connect(wxEVT_IDLE, wxIdleEventHandler(TestApp::OnIdle));
#endif // wxUSE_GUI
return true;
"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",
+ 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
bool TestApp::OnCmdLineParsed(wxCmdLineParser& parser)
{
if (parser.GetParamCount())
+ {
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("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_timing = parser.Found(_T("timing"));
- m_detail = !m_timing && parser.Found(_T("detail"));
+ 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::ProcessEvent(event);
}
-extern void SetFilterEventFunc(FilterEventFunc func)
-{
- wxGetApp().SetFilterEventFunc(func);
-}
-
-extern void SetProcessEventFunc(ProcessEventFunc func)
-{
- wxGetApp().SetProcessEventFunc(func);
-}
-
// Run
//
-int TestApp::OnRun()
+int TestApp::RunTests()
{
+#if wxUSE_LOG
+ // Switch off logging unless --verbose
+ bool verbose = wxLog::GetVerbose();
+ wxLog::EnableLogging(verbose);
+#else
+ bool verbose = false;
+#endif
+
CppUnit::TextTestRunner runner;
- for (size_t i = 0; i < m_registries.size(); i++)
+ if ( m_registries.empty() )
{
- 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)
-
- auto_ptr<Test> test(reg.empty() ?
- TestFactoryRegistry::getRegistry().makeTest() :
- TestFactoryRegistry::getRegistry(string(reg.mb_str())).makeTest());
-
- TestSuite *suite = dynamic_cast<TestSuite*>(test.get());
-
- if (suite && suite->countTestCases() == 0)
- wxLogError(_T("No such test suite: %s"), reg);
- else if (m_list)
- List(test.get());
- else
- runner.addTest(test.release());
+ // 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 )
runner.setOutputter(new CppUnit::CompilerOutputter(&runner.result(), cout));
-#if wxUSE_LOG
- // Switch off logging unless --verbose
- bool verbose = wxLog::GetVerbose();
- wxLog::EnableLogging(verbose);
-#else
- 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
// giving "uncaught exception of unknown type" messages
runner.eventManager().pushProtector(new wxUnitTestProtector);
- return runner.run("", false, true, !verbose) ? EXIT_SUCCESS : EXIT_FAILURE;
+ 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();
#endif // wxUSE_GUI
- return 0;
+ return m_exitcode;
}
// List the tests
projects / wxWidgets.git / blobdiff