7
mirror of https://gitlab.com/kicad/code/kicad.git synced 2024-11-22 04:04:41 +00:00
kicad/qa/tests/eeschema/lib_field_test_utils.h
John Beard 5b772dde13 QA: Use modern Boost test print customisation point
Since Boost 1.64, you can use the boost_test_print_type
customisation point to provide test printing for types.
Move all test printing functions to this, and scrap the
fiddly Boost version handling to deal with older Boosts
(KiCad is now at minver 1.71).
2024-08-14 11:24:26 +01:00

109 lines
3.2 KiB
C++

/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2019 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
*/
/**
* @file
* Test utils (e.g. print helpers and test predicates for SCH_FIELD objects
*/
#ifndef QA_EESCHEMA_LIB_FIELD_TEST_UTILS__H
#define QA_EESCHEMA_LIB_FIELD_TEST_UTILS__H
#include <qa_utils/wx_utils/unit_test_utils.h>
#include <template_fieldnames.h>
#include <sch_field.h>
std::ostream& boost_test_print_type( std::ostream& os, SCH_FIELD const& f )
{
os << "SCH_FIELD[ " << f.GetCanonicalName() << " ]";
return os;
}
std::ostream& boost_test_print_type( std::ostream& os, std::vector<SCH_FIELD> const& f )
{
os << "SCH_FIELDS[ " << f.size() << " ]";
return os;
}
namespace KI_TEST
{
/**
* Predicate to check a field name is as expected
* @param aField SCH_FIELD to check the name
* @param aExpectedName the expected field name
* @param aExpectedId the expected field id
* @return true if match
*/
bool FieldNameIdMatches( const SCH_FIELD& aField, const std::string& aExpectedName, int aExpectedId )
{
bool ok = true;
const auto gotName = aField.GetCanonicalName();
if( gotName != aExpectedName )
{
BOOST_TEST_INFO( "Field name: got '" << gotName << "', expected '" << aExpectedName );
ok = false;
}
const int gotId = aField.GetId();
if( gotId != aExpectedId )
{
BOOST_TEST_INFO( "Field ID: got '" << gotId << "', expected '" << aExpectedId );
ok = false;
}
return ok;
}
/**
* Predicate to check that the mandatory fields look sensible
*/
bool AreDefaultFieldsCorrect( const std::vector<SCH_FIELD>& aFields )
{
const unsigned expectedCount = MANDATORY_FIELD_T::MANDATORY_FIELDS;
if( aFields.size() < expectedCount )
{
BOOST_TEST_INFO( "Expected at least " << expectedCount << " fields, got " << aFields.size() );
return false;
}
bool ok = true;
ok &= FieldNameIdMatches( aFields[0], "Reference", MANDATORY_FIELD_T::REFERENCE_FIELD );
ok &= FieldNameIdMatches( aFields[1], "Value", MANDATORY_FIELD_T::VALUE_FIELD );
ok &= FieldNameIdMatches( aFields[2], "Footprint", MANDATORY_FIELD_T::FOOTPRINT_FIELD );
ok &= FieldNameIdMatches( aFields[3], "Datasheet", MANDATORY_FIELD_T::DATASHEET_FIELD );
return ok;
}
} // namespace KI_TEST
#endif // QA_EESCHEMA_LIB_FIELD_TEST_UTILS__H