tests/test.cpp

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        test.cpp
   3 // Purpose:     Test program for wxWidgets
   4 // Author:      Mike Wetherell
   5 // RCS-ID:      $Id$
   6 // Copyright:   (c) 2004 Mike Wetherell
   7 // Licence:     wxWidgets licence
   8 ///////////////////////////////////////////////////////////////////////////////
   9
  10 // For compilers that support precompilation, includes "wx/wx.h"
  11 // and "wx/cppunit.h"
  12 #include "testprec.h"
  13
  14 #ifdef __BORLANDC__
  15     #pragma hdrstop
  16 #endif
  17
  18 // for all others, include the necessary headers
  19 #ifndef WX_PRECOMP
  20     #include "wx/wx.h"
  21 #endif
  22
  23 #include "wx/beforestd.h"
  24 #ifdef __VISUALC__
  25     #pragma warning(disable:4100)
  26 #endif
  27 #include <cppunit/TestListener.h>
  28 #ifdef __VISUALC__
  29     #pragma warning(default:4100)
  30 #endif
  31 #include <cppunit/Test.h>
  32 #include <cppunit/TestResult.h>
  33 #include "wx/afterstd.h"
  34
  35 #include "wx/cmdline.h"
  36 #include <iostream>
  37
  38 using CppUnit::Test;
  39 using CppUnit::TestSuite;
  40 using CppUnit::TestFactoryRegistry;
  41
  42
  43 // Displays the test name before starting to execute it: this helps with
  44 // diagnosing where exactly does a test crash or hang when/if it does.
  45 class DetailListener : public CppUnit::TestListener
  46 {
  47 public:
  48     DetailListener(bool doTiming = false):
  49         CppUnit::TestListener(),
  50         m_timing(doTiming)
  51     {
  52     }
  53
  54     virtual void startTest(CppUnit::Test *test)
  55     {
  56         std::cout << test->getName () << " ";
  57         m_watch.Start();
  58     }
  59
  60     virtual void endTest(CppUnit::Test * WXUNUSED(test))
  61     {
  62         m_watch.Pause();
  63         if ( m_timing )
  64             std::cout << " (in "<< m_watch.Time() << " ms )";
  65         std::cout << "\n";
  66     }
  67
  68 protected :
  69     bool m_timing;
  70     wxStopWatch m_watch;
  71 };
  72
  73 using namespace std;
  74
  75 #if wxUSE_GUI
  76     typedef wxApp TestAppBase;
  77 #else
  78     typedef wxAppConsole TestAppBase;
  79 #endif
  80
  81 // The application class
  82 //
  83 class TestApp : public TestAppBase
  84 {
  85 public:
  86     TestApp();
  87
  88     // standard overrides
  89     virtual void OnInitCmdLine(wxCmdLineParser& parser);
  90     virtual bool OnCmdLineParsed(wxCmdLineParser& parser);
  91     virtual bool OnInit();
  92     virtual int  OnRun();
  93     virtual int  OnExit();
  94
  95     // used by events propagation test
  96     virtual int FilterEvent(wxEvent& event);
  97     virtual bool ProcessEvent(wxEvent& event);
  98
  99     void SetFilterEventFunc(FilterEventFunc f) { m_filterEventFunc = f; }
 100     void SetProcessEventFunc(ProcessEventFunc f) { m_processEventFunc = f; }
 101
 102 #ifdef __WXDEBUG__
 103     virtual void OnAssertFailure(const wxChar *,
 104                                  int,
 105                                  const wxChar *,
 106                                  const wxChar *,
 107                                  const wxChar *)
 108     {
 109         throw TestAssertFailure();
 110     }
 111 #endif // __WXDEBUG__
 112
 113 private:
 114     void List(Test *test, const string& parent = "") const;
 115
 116     // command lines options/parameters
 117     bool m_list;
 118     bool m_longlist;
 119     bool m_detail;
 120     bool m_timing;
 121     wxArrayString m_registries;
 122
 123     // event handling hooks
 124     FilterEventFunc m_filterEventFunc;
 125     ProcessEventFunc m_processEventFunc;
 126 };
 127
 128 IMPLEMENT_APP_CONSOLE(TestApp)
 129
 130 TestApp::TestApp()
 131   : m_list(false),
 132     m_longlist(false)
 133 {
 134     m_filterEventFunc = NULL;
 135     m_processEventFunc = NULL;
 136 }
 137
 138 // Init
 139 //
 140 bool TestApp::OnInit()
 141 {
 142     if ( !TestAppBase::OnInit() )
 143         return false;
 144
 145     cout << "Test program for wxWidgets\n"
 146          << "build: " << WX_BUILD_OPTIONS_SIGNATURE << std::endl;
 147
 148 #if wxUSE_GUI
 149     // create a hidden parent window to be used as parent for the GUI controls
 150     new wxFrame(NULL, wxID_ANY, "Hidden wx test frame");
 151 #endif // wxUSE_GUI
 152
 153     return true;
 154 }
 155
 156 // The table of command line options
 157 //
 158 void TestApp::OnInitCmdLine(wxCmdLineParser& parser)
 159 {
 160     TestAppBase::OnInitCmdLine(parser);
 161
 162     static const wxCmdLineEntryDesc cmdLineDesc[] = {
 163         { wxCMD_LINE_SWITCH, "l", "list",
 164             "list the test suites, do not run them",
 165             wxCMD_LINE_VAL_NONE, 0 },
 166         { wxCMD_LINE_SWITCH, "L", "longlist",
 167             "list the test cases, do not run them",
 168             wxCMD_LINE_VAL_NONE, 0 },
 169         { wxCMD_LINE_SWITCH, "d", "detail",
 170             "print the test case names, run them",
 171             wxCMD_LINE_VAL_NONE, 0 },
 172         { wxCMD_LINE_SWITCH, "t", "timing",
 173             "print names and mesure running time of individual test, run them",
 174             wxCMD_LINE_VAL_NONE, 0 },
 175         { wxCMD_LINE_PARAM, NULL, NULL, "REGISTRY", wxCMD_LINE_VAL_STRING,
 176             wxCMD_LINE_PARAM_OPTIONAL | wxCMD_LINE_PARAM_MULTIPLE },
 177         wxCMD_LINE_DESC_END
 178     };
 179
 180     parser.SetDesc(cmdLineDesc);
 181 }
 182
 183 // Handle command line options
 184 //
 185 bool TestApp::OnCmdLineParsed(wxCmdLineParser& parser)
 186 {
 187     if (parser.GetParamCount())
 188         for (size_t i = 0; i < parser.GetParamCount(); i++)
 189             m_registries.push_back(parser.GetParam(i));
 190     else
 191         m_registries.push_back("");
 192
 193     m_longlist = parser.Found(_T("longlist"));
 194     m_list = m_longlist || parser.Found(_T("list"));
 195     m_timing = parser.Found(_T("timing"));
 196     m_detail = !m_timing && parser.Found(_T("detail"));
 197
 198     return TestAppBase::OnCmdLineParsed(parser);
 199 }
 200
 201 // Event handling
 202 int TestApp::FilterEvent(wxEvent& event)
 203 {
 204     if ( m_filterEventFunc )
 205         return (*m_filterEventFunc)(event);
 206
 207     return TestAppBase::FilterEvent(event);
 208 }
 209
 210 bool TestApp::ProcessEvent(wxEvent& event)
 211 {
 212     if ( m_processEventFunc )
 213         return (*m_processEventFunc)(event);
 214
 215     return TestAppBase::ProcessEvent(event);
 216 }
 217
 218 extern void SetFilterEventFunc(FilterEventFunc func)
 219 {
 220     wxGetApp().SetFilterEventFunc(func);
 221 }
 222
 223 extern void SetProcessEventFunc(ProcessEventFunc func)
 224 {
 225     wxGetApp().SetProcessEventFunc(func);
 226 }
 227
 228 // Run
 229 //
 230 int TestApp::OnRun()
 231 {
 232     CppUnit::TextTestRunner runner;
 233
 234     for (size_t i = 0; i < m_registries.size(); i++)
 235     {
 236         wxString reg = m_registries[i];
 237         if (!reg.empty() && !reg.EndsWith("TestCase"))
 238             reg += "TestCase";
 239         // allow the user to specify the name of the testcase "in short form"
 240         // (all wx test cases end with TestCase postfix)
 241
 242         auto_ptr<Test> test(reg.empty() ?
 243             TestFactoryRegistry::getRegistry().makeTest() :
 244             TestFactoryRegistry::getRegistry(string(reg.mb_str())).makeTest());
 245
 246         TestSuite *suite = dynamic_cast<TestSuite*>(test.get());
 247
 248         if (suite && suite->countTestCases() == 0)
 249             wxLogError(_T("No such test suite: %s"), reg);
 250         else if (m_list)
 251             List(test.get());
 252         else
 253             runner.addTest(test.release());
 254     }
 255
 256     if ( m_list )
 257         return EXIT_SUCCESS;
 258
 259     runner.setOutputter(new CppUnit::CompilerOutputter(&runner.result(), cout));
 260
 261 #if wxUSE_LOG
 262     // Switch off logging unless --verbose
 263     bool verbose = wxLog::GetVerbose();
 264     wxLog::EnableLogging(verbose);
 265 #else
 266     bool verbose = false;
 267 #endif
 268
 269     // there is a bug
 270     // (http://sf.net/tracker/index.php?func=detail&aid=1649369&group_id=11795&atid=111795)
 271     // in some versions of cppunit: they write progress dots to cout (and not
 272     // cerr) and don't flush it so all the dots appear at once at the end which
 273     // is not very useful so unbuffer cout to work around this
 274     cout.setf(ios::unitbuf);
 275
 276     // add detail listener if needed
 277     DetailListener detailListener(m_timing);
 278     if ( m_detail || m_timing )
 279         runner.eventManager().addListener(&detailListener);
 280
 281     return runner.run("", false, true, !verbose) ? EXIT_SUCCESS : EXIT_FAILURE;
 282 }
 283
 284 int TestApp::OnExit()
 285 {
 286 #if wxUSE_GUI
 287     delete GetTopWindow();
 288 #endif // wxUSE_GUI
 289
 290     return 0;
 291 }
 292
 293 // List the tests
 294 //
 295 void TestApp::List(Test *test, const string& parent /*=""*/) const
 296 {
 297     TestSuite *suite = dynamic_cast<TestSuite*>(test);
 298     string name;
 299
 300     if (suite) {
 301         // take the last component of the name and append to the parent
 302         name = test->getName();
 303         string::size_type i = name.find_last_of(".:");
 304         if (i != string::npos)
 305             name = name.substr(i + 1);
 306         name = parent + "." + name;
 307
 308         // drop the 1st component from the display and indent
 309         if (parent != "") {
 310             string::size_type j = i = name.find('.', 1);
 311             while ((j = name.find('.', j + 1)) != string::npos)
 312                 cout << "  ";
 313             cout << "  " << name.substr(i + 1) << "\n";
 314         }
 315
 316         typedef vector<Test*> Tests;
 317         typedef Tests::const_iterator Iter;
 318
 319         const Tests& tests = suite->getTests();
 320
 321         for (Iter it = tests.begin(); it != tests.end(); ++it)
 322             List(*it, name);
 323     }
 324     else if (m_longlist) {
 325         string::size_type i = 0;
 326         while ((i = parent.find('.', i + 1)) != string::npos)
 327             cout << "  ";
 328         cout << "  " << test->getName() << "\n";
 329     }
 330 }