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.
This commit is contained in:
Vadim Zeitlin
2017-11-01 19:15:24 +01:00
parent 5520d56222
commit e70fc11ef1
85 changed files with 876 additions and 1718 deletions

View File

@@ -11,33 +11,54 @@
#include "wx/image.h"
CPPUNIT_NS_BEGIN
template <>
struct assertion_traits<wxImage>
namespace Catch
{
static bool equal(const wxImage& i1, const wxImage& i2)
template <>
struct StringMaker<wxImage>
{
if ( i1.GetWidth() != i2.GetWidth() )
return false;
static std::string convert(const wxImage& image)
{
return wxString::Format("image of size %d*%d with%s alpha",
image.GetWidth(),
image.GetHeight(),
image.HasAlpha() ? "" : "out")
.ToStdString();
}
};
}
if ( i1.GetHeight() != i2.GetHeight() )
return false;
return memcmp(i1.GetData(), i2.GetData(),
i1.GetWidth()*i1.GetHeight()*3) == 0;
class ImageRGBMatcher : public Catch::MatcherBase<wxImage>
{
public:
ImageRGBMatcher(const wxImage& image)
: m_image(image)
{
}
static std::string toString(const wxImage& image)
bool match(const wxImage& other) const wxOVERRIDE
{
return wxString::Format("image of size %d*%d with%s alpha",
image.GetWidth(),
image.GetHeight(),
image.HasAlpha() ? "" : "out")
.ToStdString();
if ( other.GetWidth() != m_image.GetWidth() )
return false;
if ( other.GetHeight() != m_image.GetHeight() )
return false;
return memcmp(other.GetData(), m_image.GetData(),
other.GetWidth()*other.GetHeight()*3) == 0;
}
std::string describe() const wxOVERRIDE
{
return "has same RGB data as " + Catch::toString(m_image);
}
private:
const wxImage m_image;
};
CPPUNIT_NS_END
inline ImageRGBMatcher RGBSameAs(const wxImage& image)
{
return ImageRGBMatcher(image);
}
#endif // _WX_TESTS_TESTIMAGE_H_