unit_test_utils.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2018 KiCad Developers, see AUTHORS.txt for contributors.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, you may find one here:
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * or you may search the http://www.gnu.org website for the version 2 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
 */
 
#ifndef UNIT_TEST_UTILS__H
#define UNIT_TEST_UTILS__H
 
#define BOOST_NO_AUTO_PTR
 
#include <boost/test/unit_test.hpp>
#include <turtle/mock.hpp>
 
#include <qa_utils/wx_utils/wx_assert.h>
 
#include <functional>
#include <optional>
#include <set>
 
#include <wx/gdicmn.h>
 
#if BOOST_VERSION >= 105900
#define HAVE_EXPECTED_FAILURES
#endif
 
#undef BOOST_TEST
 
 
#if BOOST_VERSION < 105900
 
/*
 * BOOST_TEST_INFO is not available before 1.59. It's not critical for
 * test pass/fail, it's just info, so just pass along to a logging
 * function.
 *
 * This can be removed when our minimum boost version is 1.59 or higher.
 */
#define BOOST_TEST_INFO( A ) BOOST_TEST_MESSAGE( A )
 
/*
 *
 * BOOST_TEST_CONTEXT provides scoped info, but again, only after 1.59.
 * Replacing with a call to BOOST_TEST_MESSAGE will work, and the
 * scoping will still work for newer boosts.
 *
 * This can be removed when our minimum boost version is 1.59 or higher.
 */
#define BOOST_TEST_CONTEXT( A ) BOOST_TEST_MESSAGE( A );
 
#endif
 
/*
 * Boost hides the configuration point for print_log_value in different
 * namespaces between < 1.59 and >= 1.59.
 *
 * The macros can be used to open and close the right level of namespacing
 * based on the version.
 *
 * We could just use a conditionally defined namespace alias, but that
 * doesn't work in GCC <7 (GCC bug #56480)
 *
 * From Boost 1.64, this should be done with boost_test_print_type,
 * and these defines can be removed once all logging functions use that.
 */
#if BOOST_VERSION >= 105900
#define BOOST_TEST_PRINT_NAMESPACE_OPEN \
 boost \
 { \
 namespace test_tools \
 { \
 namespace tt_detail
#define BOOST_TEST_PRINT_NAMESPACE_CLOSE }}
#else
#define BOOST_TEST_PRINT_NAMESPACE_OPEN \
 boost \
 { \
 namespace test_tools
#define BOOST_TEST_PRINT_NAMESPACE_CLOSE }
#endif
 
#if BOOST_VERSION < 106400
 
namespace BOOST_TEST_PRINT_NAMESPACE_OPEN
{
template <>
struct print_log_value<std::nullptr_t>
{
 inline void operator()( std::ostream& os, std::nullptr_t const& p )
 {
 os << "nullptr";
 }
};
}
BOOST_TEST_PRINT_NAMESPACE_CLOSE
 
#endif
 
 
template<class T>
struct PRINTABLE_OPT
{
 PRINTABLE_OPT( const std::optional<T>& aOpt ) : m_Opt( aOpt ){};
 PRINTABLE_OPT( const T& aVal ) : m_Opt( aVal ){};
 
 std::optional<T> m_Opt;
};
 
 
#define KI_CHECK_OPT_EQUAL( lhs, rhs ) \
 BOOST_CHECK_EQUAL( PRINTABLE_OPT( lhs ), PRINTABLE_OPT( rhs ) )
 
 
template <class T>
inline std::ostream& operator<<( std::ostream& aOs, const PRINTABLE_OPT<T>& aOptional )
{
 if( aOptional.m_Opt.has_value() )
 aOs << *aOptional.m_Opt;
 else
 aOs << "nullopt";
 
 return aOs;
}
 
 
template <class L, class R>
inline bool operator==( const PRINTABLE_OPT<L>& aLhs, const PRINTABLE_OPT<R>& aRhs )
{
 if( !aLhs.m_Opt.has_value() && !aRhs.m_Opt.has_value() )
 return true; // both nullopt
 
 return aLhs.m_Opt.has_value() && aRhs.m_Opt.has_value() && *aLhs.m_Opt == *aRhs.m_Opt;
}
 
 
template <class L, class R>
inline bool operator!=( const PRINTABLE_OPT<L>& aLhs, const PRINTABLE_OPT<R>& aRhs )
{
 return !( aLhs == aRhs );
}
 
 
namespace BOOST_TEST_PRINT_NAMESPACE_OPEN
{
 
template <typename T>
struct print_log_value<std::vector<T>>
{
 inline void operator()( std::ostream& os, std::vector<T> const& aVec )
 {
 os << "std::vector size " << aVec.size() << " [";
 
 for( const auto& i : aVec )
 {
 os << "\n ";
 print_log_value<T>()( os, i );
 }
 
 os << "]";
 }
};
 
template <typename K, typename V>
struct print_log_value<std::map<K, V>>
{
 inline void operator()( std::ostream& os, std::map<K, V> const& aMap )
 {
 os << "std::map size " << aMap.size() << " [";
 
 for( const auto& [key, value] : aMap )
 {
 os << "\n ";
 print_log_value<K>()( os, key );
 os << " = ";
 print_log_value<K>()( os, value );
 }
 
 os << "]";
 }
};
 
template <typename K, typename V>
struct print_log_value<std::pair<K, V>>
{
 inline void operator()( std::ostream& os, std::pair<K, V> const& aPair )
 {
 os << "[";
 print_log_value<K>()( os, aPair.first );
 os << ", ";
 print_log_value<K>()( os, aPair.second );
 os << "]";
 }
};
 
template <>
struct print_log_value<wxPoint>
{
 void operator()( std::ostream& os, wxPoint const& aVec );
};
 
}
BOOST_TEST_PRINT_NAMESPACE_CLOSE
 
 
namespace KI_TEST
{
 
template <typename EXP_CONT> using EXP_OBJ = typename EXP_CONT::value_type;
template <typename FOUND_CONT> using FOUND_OBJ = typename FOUND_CONT::value_type;
 
template <typename EXP_OBJ, typename FOUND_OBJ>
using MATCH_PRED = std::function<bool( const EXP_OBJ&, const FOUND_OBJ& )>;
 
template <typename EXP_CONT, typename FOUND_CONT, typename MATCH_PRED>
void CheckUnorderedMatches( const EXP_CONT& aExpected, const FOUND_CONT& aFound,
 MATCH_PRED aMatchPredicate )
{
 using EXP_OBJ = typename EXP_CONT::value_type;
 
 // set of object we've already found
 std::set<const EXP_OBJ*> matched;
 
 // fill the set of object that match
 for( const auto& found : aFound )
 {
 for( const auto& expected : aExpected )
 {
 if( aMatchPredicate( expected, found ) )
 {
 matched.insert( &expected );
 break;
 }
 }
 }
 
 // first check every expected object was "found"
 for( const EXP_OBJ& exp : aExpected )
 {
 BOOST_CHECK_MESSAGE( matched.count( &exp ) > 0, "Expected item was not found. Expected: \n"
 << exp );
 }
 
 // check every "found" object was expected
 for( const EXP_OBJ* found : matched )
 {
 const bool was_expected = std::find_if( aExpected.begin(), aExpected.end(),
 [found]( const EXP_OBJ& aObj )
 {
 return &aObj == found;
 } ) != aExpected.end();
 
 BOOST_CHECK_MESSAGE( was_expected, "Found item was not expected. Found: \n" << *found );
 }
}
 
 
template <typename T>
bool CollectionHasNoDuplicates( const T& aCollection )
{
 T sorted = aCollection;
 std::sort( sorted.begin(), sorted.end() );
 
 return std::adjacent_find( sorted.begin(), sorted.end() ) == sorted.end();
}
 
 
#ifdef DEBUG
#define CHECK_WX_ASSERT( STATEMENT ) BOOST_CHECK_THROW( STATEMENT, KI_TEST::WX_ASSERT_ERROR );
#else
#define CHECK_WX_ASSERT( STATEMENT )
#endif
 
std::string GetEeschemaTestDataDir();
 
} // namespace KI_TEST
 
#endif // UNIT_TEST_UTILS__H