2010-12-15 04:51:48 -05:00
|
|
|
#ifndef WX_TESTPREC_INCLUDED
|
|
|
|
#define WX_TESTPREC_INCLUDED 1
|
|
|
|
|
2004-11-22 00:00:19 -05:00
|
|
|
#include "wx/wxprec.h"
|
2012-03-12 10:57:44 -04:00
|
|
|
#include "wx/evtloop.h"
|
2017-11-30 15:52:46 -05:00
|
|
|
|
|
|
|
// This needs to be included before catch.hpp to be taken into account.
|
|
|
|
#include "testdate.h"
|
|
|
|
|
Replace CppUnit with Catch for unit tests
Drop the legacy CppUnit testing framework used for the unit tests.
Replacing it with Catch has the advantage of not requiring CppUnit
libraries to be installed on the system in order to be able to run
tests (Catch is header-only and a copy of it is now included in the
main repository itself) and, in the future, of being able to write
the tests in a much more natural way.
For now, however, avoid changing the existing tests code as much as
[reasonably] possible to avoid introducing bugs in them and provide
the CppUnit compatibility macros in the new wx/catch_cppunit.h header
which allow to preserve the 99% of the existing code unchanged. Some
of the required changes are:
- Decompose asserts using "a && b" conditions into multiple asserts
checking "a" and "b" independently. This would have been better
even with CppUnit (to know which part of condition exactly failed)
and is required with Catch.
- Use extra parentheses around such conditions when they can't be
easily decomposed in the arrays test, due to the use of macros.
This is not ideal from the point of view of messages given when
the tests fail but will do for now.
- Rewrite asserts using "a || b" as a combination of condition
checks and assert macros. Again, this is better anyhow, and is
required with Catch. Incidentally, this allowed to fix a bug in
the "exec" unit test which didn't leave enough time for the new
process to be launched before trying to kill it.
- Remove multiple CPPUNIT_TEST_SUITE_NAMED_REGISTRATION() macros,
our emulation of this macro can be used only once.
- Provide string conversions using Catch-specific StringMaker for
a couple of types.
- Replace custom wxImage comparison with a Catch-specific matcher
class.
- Remove most of test running logic from test.cpp, in particular don't
parse command line ourselves any longer but use Catch built-in
command line parser. This is a source of a minor regression:
previously, both "Foo" and "FooTestCase" could be used as the name of
the test to run, but now only the latter is accepted.
2017-11-01 14:15:24 -04:00
|
|
|
#include "wx/catch_cppunit.h"
|
2006-03-31 12:42:26 -05:00
|
|
|
|
2010-08-22 18:16:05 -04:00
|
|
|
// Custom test macro that is only defined when wxUIActionSimulator is available
|
|
|
|
// this allows the tests that do not rely on it to run on platforms that don't
|
|
|
|
// support it.
|
|
|
|
//
|
2017-11-05 11:50:09 -05:00
|
|
|
// Unfortunately, currently too many of the UI tests fail on non-MSW platforms,
|
|
|
|
// so they're disabled there by default. This really, really needs to be fixed,
|
|
|
|
// but for now having the UI tests always failing is not helpful as it prevents
|
|
|
|
// other test failures from being noticed, so disable them there.
|
|
|
|
#if wxUSE_UIACTIONSIMULATOR
|
|
|
|
#define WXUISIM_TEST(test) if ( EnableUITests() ) { CPPUNIT_TEST(test) }
|
2010-08-22 18:16:05 -04:00
|
|
|
#else
|
2017-11-05 11:50:09 -05:00
|
|
|
#define WXUISIM_TEST(test)
|
2010-08-22 18:16:05 -04:00
|
|
|
#endif
|
|
|
|
|
2006-03-31 12:42:26 -05:00
|
|
|
// define wxHAVE_U_ESCAPE if the compiler supports \uxxxx character constants
|
2014-05-15 18:32:17 -04:00
|
|
|
#if defined(__VISUALC__) || \
|
2006-03-31 12:42:26 -05:00
|
|
|
(defined(__GNUC__) && (__GNUC__ >= 3))
|
|
|
|
#define wxHAVE_U_ESCAPE
|
2009-06-06 19:24:57 -04:00
|
|
|
|
|
|
|
// and disable warning that using them results in with MSVC 8+
|
|
|
|
#if wxCHECK_VISUALC_VERSION(8)
|
|
|
|
// universal-character-name encountered in source
|
|
|
|
#pragma warning(disable:4428)
|
|
|
|
#endif
|
2006-03-31 12:42:26 -05:00
|
|
|
#endif
|
2008-12-20 21:28:55 -05:00
|
|
|
|
2018-08-02 14:49:23 -04:00
|
|
|
// Define wxUSING_MANTISSA_SIZE_3 for certain versions of MinGW and MSVC.
|
|
|
|
// These use a CRT which prints the exponent with a minimum of 3
|
|
|
|
// digits instead of 2.
|
2010-10-03 13:16:00 -04:00
|
|
|
//
|
2018-08-02 14:49:23 -04:00
|
|
|
// This happens for all MSVC compilers before version 14 (VS2015).
|
|
|
|
// And for MinGW when it does not define or set __USE_MINGW_ANSI_STDIO.
|
|
|
|
// Since MinGW 5.0.4 it uses at least 2 digits for the exponent:
|
|
|
|
// https://sourceforge.net/p/mingw-w64/mailman/message/36333746/
|
|
|
|
|
|
|
|
#if (defined(__MINGW64_VERSION_MAJOR) && (__MINGW64_VERSION_MAJOR > 5 || \
|
|
|
|
(__MINGW64_VERSION_MAJOR == 5 && __MINGW64_VERSION_MINOR >= 0) || \
|
|
|
|
(__MINGW64_VERSION_MAJOR == 5 && __MINGW64_VERSION_MINOR == 0 && __MINGW64_VERSION_BUGFIX >= 4)))
|
|
|
|
#define wxMINGW_WITH_FIXED_MANTISSA
|
|
|
|
#endif
|
|
|
|
#if (defined(__VISUALC__) && !wxCHECK_VISUALC_VERSION(14)) || \
|
|
|
|
(defined(__MINGW32__) && !defined(wxMINGW_WITH_FIXED_MANTISSA) && \
|
|
|
|
(!defined(__USE_MINGW_ANSI_STDIO) || !__USE_MINGW_ANSI_STDIO))
|
|
|
|
#define wxDEFAULT_MANTISSA_SIZE_3
|
2010-10-03 13:16:00 -04:00
|
|
|
#endif
|
|
|
|
|
2020-05-10 17:05:41 -04:00
|
|
|
// Many tests use wide characters or wide strings inside Catch macros, which
|
|
|
|
// requires converting them to string if the check fails. This falls back to
|
2020-05-14 17:49:57 -04:00
|
|
|
// std::ostream::operator<<() by default, which never worked correctly, as there
|
2020-05-10 17:05:41 -04:00
|
|
|
// never was any overload for wchar_t and so it used something else, but in C++
|
|
|
|
// 20 this overload is explicitly deleted, so it results in compile-time error.
|
|
|
|
//
|
|
|
|
// Hence define this specialization to allow compiling such comparisons.
|
|
|
|
namespace Catch
|
|
|
|
{
|
|
|
|
|
|
|
|
template <>
|
|
|
|
struct StringMaker<wchar_t>
|
|
|
|
{
|
|
|
|
static std::string convert(wchar_t wc)
|
|
|
|
{
|
|
|
|
if ( wc < 0x7f )
|
|
|
|
return std::string(static_cast<char>(wc), 1);
|
|
|
|
|
2019-10-22 06:34:29 -04:00
|
|
|
return wxString::Format(wxASCII_STR("U+%06X"), wc).ToStdString(wxConvLibc);
|
2020-05-10 17:05:41 -04:00
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
} // namespace Catch
|
|
|
|
|
|
|
|
|
2008-12-20 21:28:55 -05:00
|
|
|
// thrown when assert fails in debug build
|
2009-03-25 06:42:11 -04:00
|
|
|
class TestAssertFailure
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
TestAssertFailure(const wxString& file,
|
|
|
|
int line,
|
|
|
|
const wxString& func,
|
|
|
|
const wxString& cond,
|
|
|
|
const wxString& msg)
|
|
|
|
: m_file(file),
|
|
|
|
m_line(line),
|
|
|
|
m_func(func),
|
|
|
|
m_cond(cond),
|
|
|
|
m_msg(msg)
|
|
|
|
{
|
|
|
|
}
|
|
|
|
|
|
|
|
const wxString m_file;
|
|
|
|
const int m_line;
|
|
|
|
const wxString m_func;
|
|
|
|
const wxString m_cond;
|
|
|
|
const wxString m_msg;
|
|
|
|
|
|
|
|
wxDECLARE_NO_ASSIGN_CLASS(TestAssertFailure);
|
|
|
|
};
|
2008-12-20 21:28:55 -05:00
|
|
|
|
|
|
|
// macro to use for the functions which are supposed to fail an assertion
|
2009-03-21 19:36:37 -04:00
|
|
|
#if wxDEBUG_LEVEL
|
2008-12-20 21:28:55 -05:00
|
|
|
// some old cppunit versions don't define CPPUNIT_ASSERT_THROW so roll our
|
|
|
|
// own
|
2015-04-03 10:31:23 -04:00
|
|
|
#define WX_ASSERT_FAILS_WITH_ASSERT_MESSAGE(msg, code) \
|
|
|
|
wxSTATEMENT_MACRO_BEGIN \
|
2008-12-20 21:28:55 -05:00
|
|
|
bool throwsAssert = false; \
|
2015-04-03 10:31:23 -04:00
|
|
|
try { code ; } \
|
2008-12-20 21:28:55 -05:00
|
|
|
catch ( const TestAssertFailure& ) { throwsAssert = true; } \
|
|
|
|
if ( !throwsAssert ) \
|
2015-04-03 10:31:23 -04:00
|
|
|
CPPUNIT_FAIL(msg); \
|
|
|
|
wxSTATEMENT_MACRO_END
|
|
|
|
|
|
|
|
#define WX_ASSERT_FAILS_WITH_ASSERT(code) \
|
|
|
|
WX_ASSERT_FAILS_WITH_ASSERT_MESSAGE( \
|
|
|
|
"expected assertion not generated", code)
|
|
|
|
|
2008-12-20 21:28:55 -05:00
|
|
|
#else
|
2011-04-05 18:29:58 -04:00
|
|
|
// there are no assertions in this build so we can't do anything (we used
|
|
|
|
// to check that the condition failed but this didn't work well as in
|
|
|
|
// normal build with wxDEBUG_LEVEL != 0 we can pass something not
|
|
|
|
// evaluating to a bool at all but it then would fail to compile in
|
|
|
|
// wxDEBUG_LEVEL == 0 case, so just don't do anything at all now).
|
|
|
|
#define WX_ASSERT_FAILS_WITH_ASSERT(cond)
|
2008-12-20 21:28:55 -05:00
|
|
|
#endif
|
|
|
|
|
2009-01-16 11:21:50 -05:00
|
|
|
// these functions can be used to hook into wxApp event processing and are
|
|
|
|
// currently used by the events propagation test
|
2009-01-16 12:19:16 -05:00
|
|
|
class WXDLLIMPEXP_FWD_BASE wxEvent;
|
|
|
|
|
2009-01-16 11:21:50 -05:00
|
|
|
typedef int (*FilterEventFunc)(wxEvent&);
|
|
|
|
typedef bool (*ProcessEventFunc)(wxEvent&);
|
|
|
|
|
|
|
|
extern void SetFilterEventFunc(FilterEventFunc func);
|
|
|
|
extern void SetProcessEventFunc(ProcessEventFunc func);
|
2009-06-01 07:30:50 -04:00
|
|
|
|
|
|
|
extern bool IsNetworkAvailable();
|
2010-06-06 14:52:28 -04:00
|
|
|
|
2012-06-01 12:21:06 -04:00
|
|
|
extern bool IsAutomaticTest();
|
|
|
|
|
2019-07-17 08:37:19 -04:00
|
|
|
extern bool IsRunningUnderXVFB();
|
|
|
|
|
2020-04-07 08:30:01 -04:00
|
|
|
#ifdef __LINUX__
|
|
|
|
extern bool IsRunningInLXC();
|
|
|
|
#endif // __LINUX__
|
|
|
|
|
2010-10-03 13:15:46 -04:00
|
|
|
// Helper class setting the locale to the given one for its lifetime.
|
|
|
|
class LocaleSetter
|
2010-06-06 14:52:28 -04:00
|
|
|
{
|
|
|
|
public:
|
2013-07-14 21:31:47 -04:00
|
|
|
LocaleSetter(const char *loc)
|
|
|
|
: m_locOld(wxStrdupA(setlocale(LC_ALL, NULL)))
|
|
|
|
{
|
|
|
|
setlocale(LC_ALL, loc);
|
|
|
|
}
|
|
|
|
|
|
|
|
~LocaleSetter()
|
|
|
|
{
|
|
|
|
setlocale(LC_ALL, m_locOld);
|
|
|
|
free(m_locOld);
|
|
|
|
}
|
2010-06-06 14:52:28 -04:00
|
|
|
|
|
|
|
private:
|
2013-07-14 21:31:47 -04:00
|
|
|
char * const m_locOld;
|
2010-10-03 13:15:46 -04:00
|
|
|
|
|
|
|
wxDECLARE_NO_COPY_CLASS(LocaleSetter);
|
|
|
|
};
|
|
|
|
|
|
|
|
// An even simpler helper for setting the locale to "C" one during its lifetime.
|
|
|
|
class CLocaleSetter : private LocaleSetter
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
CLocaleSetter() : LocaleSetter("C") { }
|
|
|
|
|
|
|
|
private:
|
2010-06-06 14:52:28 -04:00
|
|
|
wxDECLARE_NO_COPY_CLASS(CLocaleSetter);
|
|
|
|
};
|
2010-09-11 06:18:05 -04:00
|
|
|
|
2016-06-29 12:22:05 -04:00
|
|
|
#if wxUSE_GUI
|
|
|
|
|
2017-11-05 11:50:09 -05:00
|
|
|
// Return true if the UI tests are enabled, used by WXUISIM_TEST().
|
|
|
|
extern bool EnableUITests();
|
|
|
|
|
2016-06-29 12:22:05 -04:00
|
|
|
// Helper function deleting the window without asserts (and hence exceptions
|
|
|
|
// thrown from its dtor!) even if it has mouse capture.
|
|
|
|
void DeleteTestWindow(wxWindow* win);
|
|
|
|
|
|
|
|
#endif // wxUSE_GUI
|
|
|
|
|
Replace CppUnit with Catch for unit tests
Drop the legacy CppUnit testing framework used for the unit tests.
Replacing it with Catch has the advantage of not requiring CppUnit
libraries to be installed on the system in order to be able to run
tests (Catch is header-only and a copy of it is now included in the
main repository itself) and, in the future, of being able to write
the tests in a much more natural way.
For now, however, avoid changing the existing tests code as much as
[reasonably] possible to avoid introducing bugs in them and provide
the CppUnit compatibility macros in the new wx/catch_cppunit.h header
which allow to preserve the 99% of the existing code unchanged. Some
of the required changes are:
- Decompose asserts using "a && b" conditions into multiple asserts
checking "a" and "b" independently. This would have been better
even with CppUnit (to know which part of condition exactly failed)
and is required with Catch.
- Use extra parentheses around such conditions when they can't be
easily decomposed in the arrays test, due to the use of macros.
This is not ideal from the point of view of messages given when
the tests fail but will do for now.
- Rewrite asserts using "a || b" as a combination of condition
checks and assert macros. Again, this is better anyhow, and is
required with Catch. Incidentally, this allowed to fix a bug in
the "exec" unit test which didn't leave enough time for the new
process to be launched before trying to kill it.
- Remove multiple CPPUNIT_TEST_SUITE_NAMED_REGISTRATION() macros,
our emulation of this macro can be used only once.
- Provide string conversions using Catch-specific StringMaker for
a couple of types.
- Replace custom wxImage comparison with a Catch-specific matcher
class.
- Remove most of test running logic from test.cpp, in particular don't
parse command line ourselves any longer but use Catch built-in
command line parser. This is a source of a minor regression:
previously, both "Foo" and "FooTestCase" could be used as the name of
the test to run, but now only the latter is accepted.
2017-11-01 14:15:24 -04:00
|
|
|
// Convenience macro which registers a test case using just its "base" name,
|
|
|
|
// i.e. without the common "TestCase" suffix, as its tag.
|
|
|
|
#define wxREGISTER_UNIT_TEST(testclass) \
|
|
|
|
wxREGISTER_UNIT_TEST_WITH_TAGS(testclass ## TestCase, "[" #testclass "]")
|
2010-12-15 04:51:48 -05:00
|
|
|
|
|
|
|
#endif
|