/* * This program source code file is part of KiCad, a free EDA CAD application. * * Copyright (C) 2019-2023 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 suite for LIB_SYMBOL */ #include // Code under test #include #include #include "lib_field_test_utils.h" class TEST_LIB_SYMBOL_FIXTURE { public: TEST_LIB_SYMBOL_FIXTURE() : m_part_no_data( "part_name", nullptr ) { } ///< Part with no extra data set LIB_SYMBOL m_part_no_data; }; /** * Declare the test suite */ BOOST_FIXTURE_TEST_SUITE( LibPart, TEST_LIB_SYMBOL_FIXTURE ) /** * Check that we can get the basic properties out as expected */ BOOST_AUTO_TEST_CASE( DefaultProperties ) { BOOST_CHECK_EQUAL( m_part_no_data.GetName(), "part_name" ); // Didn't set a library, so this is empty BOOST_CHECK_EQUAL( m_part_no_data.GetLibraryName(), "" ); BOOST_CHECK_EQUAL( m_part_no_data.GetLib(), nullptr ); // only get the root BOOST_CHECK_EQUAL( m_part_no_data.IsRoot(), true ); BOOST_CHECK_EQUAL( m_part_no_data.IsAlias(), false ); BOOST_CHECK_EQUAL( m_part_no_data.SharedPtr().use_count(), 2 ); // no sub units BOOST_CHECK_EQUAL( m_part_no_data.GetUnitCount(), 1 ); BOOST_CHECK_EQUAL( m_part_no_data.IsMulti(), false ); // no conversion BOOST_CHECK_EQUAL( m_part_no_data.HasConversion(), false ); } /** * Check the drawings on a "blank" LIB_SYMBOL */ BOOST_AUTO_TEST_CASE( DefaultDrawings ) { // default drawings exist BOOST_CHECK_EQUAL( m_part_no_data.GetDrawItems().size(), MANDATORY_FIELDS ); BOOST_CHECK_EQUAL( m_part_no_data.GetAllLibPins().size(), 0 ); } /** * Check the default fields are present as expected */ BOOST_AUTO_TEST_CASE( DefaultFields ) { std::vector fields; m_part_no_data.GetFields( fields ); // Should get the 4 default fields BOOST_CHECK_PREDICATE( KI_TEST::AreDefaultFieldsCorrect, ( fields ) ); // but no more (we didn't set them) BOOST_CHECK_EQUAL( fields.size(), MANDATORY_FIELD_T::MANDATORY_FIELDS ); // also check the default field accessors BOOST_CHECK_PREDICATE( KI_TEST::FieldNameIdMatches, ( m_part_no_data.GetReferenceField() )( "Reference" )( MANDATORY_FIELD_T::REFERENCE_FIELD ) ); BOOST_CHECK_PREDICATE( KI_TEST::FieldNameIdMatches, ( m_part_no_data.GetValueField() )( "Value" )( MANDATORY_FIELD_T::VALUE_FIELD ) ); BOOST_CHECK_PREDICATE( KI_TEST::FieldNameIdMatches, ( m_part_no_data.GetFootprintField() )( "Footprint" )( MANDATORY_FIELD_T::FOOTPRINT_FIELD ) ); BOOST_CHECK_PREDICATE( KI_TEST::FieldNameIdMatches, ( m_part_no_data.GetDatasheetField() )( "Datasheet" )( MANDATORY_FIELD_T::DATASHEET_FIELD) ); BOOST_CHECK_PREDICATE( KI_TEST::FieldNameIdMatches, ( m_part_no_data.GetDescriptionField() )( "Description" )( MANDATORY_FIELD_T::DESCRIPTION_FIELD) ); } /** * Test adding fields to a LIB_SYMBOL */ BOOST_AUTO_TEST_CASE( AddedFields ) { std::vector fields; m_part_no_data.GetFields( fields ); // Ctor takes non-const ref (?!) const std::string newFieldName = "new_field"; wxString nonConstNewFieldName = newFieldName; fields.push_back( LIB_FIELD( 42, nonConstNewFieldName ) ); // fairly roundabout way to add a field, but it is what it is m_part_no_data.SetFields( fields ); // Should get the 4 default fields BOOST_CHECK_PREDICATE( KI_TEST::AreDefaultFieldsCorrect, ( fields ) ); // and our new one BOOST_REQUIRE_EQUAL( fields.size(), MANDATORY_FIELD_T::MANDATORY_FIELDS + 1 ); BOOST_CHECK_PREDICATE( KI_TEST::FieldNameIdMatches, ( fields[MANDATORY_FIELD_T::MANDATORY_FIELDS] )( newFieldName )( 42 ) ); // Check by-id lookup LIB_FIELD* gotNewField = m_part_no_data.GetFieldById( 42 ); BOOST_REQUIRE_NE( gotNewField, nullptr ); BOOST_CHECK_PREDICATE( KI_TEST::FieldNameIdMatches, ( *gotNewField )( newFieldName )( 42 ) ); // Check by-name lookup gotNewField = m_part_no_data.FindField( newFieldName ); BOOST_REQUIRE_NE( gotNewField, nullptr ); BOOST_CHECK_PREDICATE( KI_TEST::FieldNameIdMatches, ( *gotNewField )( newFieldName )( 42 ) ); } /** * Test adding draw items to a LIB_SYMBOL */ BOOST_AUTO_TEST_CASE( AddedDrawItems ) { } struct TEST_LIB_SYMBOL_SUBREF_CASE { int m_index; bool m_addSep; std::string m_expSubRef; }; /** * Test the subreference indexing */ BOOST_AUTO_TEST_CASE( SubReference ) { const std::vector cases = { { 1, false, "A", }, { 2, false, "B", }, { 26, false, "Z", }, { 27, false, "AA", }, { 28, false, "AB", }, { 53, false, "BA", }, { 79, false, "CA", }, { 105, false, "DA", }, { 131, false, "EA", }, { 157, false, "FA", }, { 183, false, "GA", }, { 209, false, "HA", }, { 235, false, "IA", }, { 261, false, "JA", }, { 287, false, "KA", }, { 313, false, "LA", }, { 339, false, "MA", }, { 365, false, "NA", }, { 391, false, "OA", }, { 417, false, "PA", }, { 443, false, "QA", }, { 469, false, "RA", }, { 495, false, "SA", }, { 521, false, "TA", }, { 547, false, "UA", }, { 573, false, "VA", }, { 599, false, "WA", }, { 625, false, "XA", }, { 651, false, "YA", }, { 677, false, "ZA", }, { 702, false, "ZZ", }, { 703, false, "AAA", }, { 728, false, "AAZ", }, { // haven't configured a separator, so should be nothing 1, true, "A", }, }; for( const auto& c : cases ) { BOOST_TEST_CONTEXT( "Subref: " << c.m_index << ", " << c.m_addSep << " -> '" << c.m_expSubRef << "'" ) { const auto subref = m_part_no_data.SubReference( c.m_index, c.m_addSep ); BOOST_CHECK_EQUAL( subref, c.m_expSubRef ); } } } /** * Check the compare method. */ BOOST_AUTO_TEST_CASE( Compare ) { // Identical root part to m_part_no_data sans time stamp. LIB_SYMBOL testPart( "part_name" ); // Self comparison test. BOOST_CHECK_EQUAL( m_part_no_data.Compare( m_part_no_data ), 0 ); // Test for identical LIB_SYMBOL. BOOST_CHECK_EQUAL( m_part_no_data.Compare( testPart ), 0 ); // Test name. testPart.SetName( "tart_name" ); BOOST_CHECK( m_part_no_data.Compare( testPart ) < 0 ); testPart.SetName( "cart_name" ); BOOST_CHECK( m_part_no_data.Compare( testPart ) > 0 ); testPart.SetName( "part_name" ); // LIB_ID comparison tests. LIB_ID id = testPart.GetLibId(); id.SetLibItemName( "tart_name" ); testPart.SetLibId( id ); BOOST_CHECK( m_part_no_data.Compare( testPart ) < 0 ); id.SetLibItemName( "cart_name" ); testPart.SetLibId( id ); BOOST_CHECK( m_part_no_data.Compare( testPart ) > 0 ); id.SetLibItemName( "part_name" ); testPart.SetLibId( id ); // Unit count comparison tests. testPart.SetUnitCount( 2 ); BOOST_CHECK( m_part_no_data.Compare( testPart ) < 0 ); testPart.SetUnitCount( 1 ); m_part_no_data.SetUnitCount( 2 ); BOOST_CHECK( m_part_no_data.Compare( testPart ) > 0 ); m_part_no_data.SetUnitCount( 1 ); // Options flag comparison tests. testPart.SetPower(); BOOST_CHECK( m_part_no_data.Compare( testPart ) < 0 ); testPart.SetNormal(); m_part_no_data.SetPower(); BOOST_CHECK( m_part_no_data.Compare( testPart ) > 0 ); m_part_no_data.SetNormal(); // Draw item list size comparison tests. testPart.AddDrawItem( new LIB_SHAPE( &testPart, SHAPE_T::RECT ) ); m_part_no_data.AddDrawItem( new LIB_SHAPE( &m_part_no_data, SHAPE_T::RECT ) ); BOOST_CHECK_EQUAL( m_part_no_data.Compare( testPart ), 0 ); m_part_no_data.RemoveDrawItem( &m_part_no_data.GetDrawItems()[LIB_SHAPE_T].front() ); BOOST_CHECK( m_part_no_data.Compare( testPart ) < 0 ); testPart.RemoveDrawItem( &testPart.GetDrawItems()[LIB_SHAPE_T].front() ); m_part_no_data.AddDrawItem( new LIB_SHAPE( &m_part_no_data, SHAPE_T::RECT ) ); BOOST_CHECK( m_part_no_data.Compare( testPart ) > 0 ); m_part_no_data.RemoveDrawItem( &m_part_no_data.GetDrawItems()[LIB_SHAPE_T].front() ); // Draw item list contents comparison tests. testPart.AddDrawItem( new LIB_SHAPE( &testPart, SHAPE_T::RECT ) ); m_part_no_data.AddDrawItem( new LIB_SHAPE( &m_part_no_data, SHAPE_T::ARC ) ); BOOST_CHECK( m_part_no_data.Compare( testPart ) > 0 ); m_part_no_data.RemoveDrawItem( &m_part_no_data.GetDrawItems()[LIB_SHAPE_T].front() ); testPart.RemoveDrawItem( &testPart.GetDrawItems()[LIB_SHAPE_T].front() ); m_part_no_data.AddDrawItem( new LIB_PIN( &m_part_no_data ) ); BOOST_CHECK( m_part_no_data.Compare( testPart ) > 0 ); m_part_no_data.RemoveDrawItem( &m_part_no_data.GetDrawItems()[LIB_PIN_T].front() ); // Footprint filter array comparison tests. wxArrayString footPrintFilters; BOOST_CHECK( m_part_no_data.GetFPFilters() == footPrintFilters ); footPrintFilters.Add( "b" ); testPart.SetFPFilters( footPrintFilters ); BOOST_CHECK( m_part_no_data.Compare( testPart ) < 0 ); m_part_no_data.SetFPFilters( footPrintFilters ); footPrintFilters.Clear(); testPart.SetFPFilters( footPrintFilters ); BOOST_CHECK( m_part_no_data.Compare( testPart ) > 0 ); footPrintFilters.Clear(); m_part_no_data.SetFPFilters( footPrintFilters ); testPart.SetFPFilters( footPrintFilters ); // Description string tests. m_part_no_data.SetDescription( "b" ); testPart.SetDescription( "b" ); BOOST_CHECK_EQUAL( m_part_no_data.Compare( testPart ), 0 ); m_part_no_data.SetDescription( "a" ); BOOST_CHECK( m_part_no_data.Compare( testPart ) < 0 ); m_part_no_data.SetDescription( "c" ); BOOST_CHECK( m_part_no_data.Compare( testPart ) > 0 ); m_part_no_data.SetDescription( wxEmptyString ); testPart.SetDescription( wxEmptyString ); // Key word string tests. m_part_no_data.SetKeyWords( "b" ); testPart.SetKeyWords( "b" ); BOOST_CHECK_EQUAL( m_part_no_data.Compare( testPart ), 0 ); m_part_no_data.SetKeyWords( "a" ); BOOST_CHECK( m_part_no_data.Compare( testPart ) < 0 ); m_part_no_data.SetKeyWords( "c" ); BOOST_CHECK( m_part_no_data.Compare( testPart ) > 0 ); m_part_no_data.SetKeyWords( wxEmptyString ); testPart.SetKeyWords( wxEmptyString ); // Pin name offset comparison tests. testPart.SetPinNameOffset( testPart.GetPinNameOffset() + 1 ); BOOST_CHECK( m_part_no_data.Compare( testPart ) < 0 ); testPart.SetPinNameOffset( testPart.GetPinNameOffset() - 2 ); BOOST_CHECK( m_part_no_data.Compare( testPart ) > 0 ); testPart.SetPinNameOffset( testPart.GetPinNameOffset() + 1 ); // Units locked flag comparison tests. testPart.LockUnits( true ); BOOST_CHECK( m_part_no_data.Compare( testPart ) < 0 ); testPart.LockUnits( false ); m_part_no_data.LockUnits( true ); BOOST_CHECK( m_part_no_data.Compare( testPart ) > 0 ); m_part_no_data.LockUnits( false ); // Include in BOM support tests. testPart.SetExcludedFromBOM( true ); BOOST_CHECK( m_part_no_data.Compare( testPart ) > 0 ); testPart.SetExcludedFromBOM( false ); m_part_no_data.SetExcludedFromBOM( true ); BOOST_CHECK( m_part_no_data.Compare( testPart ) < 0 ); m_part_no_data.SetExcludedFromBOM( false ); // Include on board support tests. testPart.SetExcludedFromBoard( true ); BOOST_CHECK( m_part_no_data.Compare( testPart ) > 0 ); testPart.SetExcludedFromBoard( false ); m_part_no_data.SetExcludedFromBoard( true ); BOOST_CHECK( m_part_no_data.Compare( testPart ) < 0 ); m_part_no_data.SetExcludedFromBoard( false ); // Show pin names flag comparison tests. m_part_no_data.SetShowPinNames( false ); BOOST_CHECK( m_part_no_data.Compare( testPart ) < 0 ); m_part_no_data.SetShowPinNames( true ); testPart.SetShowPinNames( false ); BOOST_CHECK( m_part_no_data.Compare( testPart ) > 0 ); testPart.SetShowPinNames( true ); // Show pin numbers flag comparison tests. m_part_no_data.SetShowPinNumbers( false ); BOOST_CHECK( m_part_no_data.Compare( testPart ) < 0 ); m_part_no_data.SetShowPinNumbers( true ); testPart.SetShowPinNumbers( false ); BOOST_CHECK( m_part_no_data.Compare( testPart ) > 0 ); testPart.SetShowPinNumbers( true ); // Time stamp comparison tests. // Check to see if we broke the copy ctor. LIB_SYMBOL* copy = new LIB_SYMBOL( testPart ); BOOST_CHECK( testPart.Compare( *copy ) == 0 ); } /** * Check the fetch unit items code. */ BOOST_AUTO_TEST_CASE( GetUnitItems ) { // There are no unit draw items in the empty LIB_SYMBOL object. BOOST_CHECK( m_part_no_data.GetUnitDrawItems( 1, 1 ).size() == 0 ); // A single unique unit with 1 pin common to all units and all body styles. LIB_PIN* pin1 = new LIB_PIN( &m_part_no_data ); m_part_no_data.AddDrawItem( pin1 ); BOOST_CHECK( m_part_no_data.GetUnitDrawItems( 0, 0 ).size() == 1 ); // A single unique unit with 1 pin in unit 1 and common to all body styles. pin1->SetUnit( 1 ); BOOST_CHECK( m_part_no_data.GetUnitDrawItems( 1, 0 ).size() == 1 ); // A single unique unit with 1 pin in unit 1 and body style 1. pin1->SetConvert( 1 ); BOOST_CHECK( m_part_no_data.GetUnitDrawItems( 1, 1 ).size() == 1 ); // Two unique units with pin 1 assigned to unit 1 and body style 1 and pin 2 assigned to // unit 2 and body style 1. LIB_PIN* pin2 = new LIB_PIN( &m_part_no_data ); m_part_no_data.SetUnitCount( 2 ); pin2->SetUnit( 2 ); pin2->SetConvert( 2 ); pin2->SetNumber( "4" ); m_part_no_data.AddDrawItem( pin2 ); BOOST_CHECK( m_part_no_data.GetUnitDrawItems( 2, 2 ).size() == 1 ); // Make pin 1 body style common to all units. pin1->SetConvert( 0 ); BOOST_CHECK( m_part_no_data.GetUnitDrawItems( 1, 1 ).size() == 0 ); BOOST_CHECK( m_part_no_data.GetUnitDrawItems( 2, 1 ).size() == 1 ); m_part_no_data.RemoveDrawItem( pin2 ); m_part_no_data.RemoveDrawItem( pin1 ); m_part_no_data.RemoveDrawItem( &*m_part_no_data.GetDrawItems().begin() ); } /** * Check the fetch unit draw items code. */ BOOST_AUTO_TEST_CASE( GetUnitDrawItems ) { // There are no unit draw items in the empty LIB_SYMBOL object. BOOST_CHECK( m_part_no_data.GetUnitDrawItems().size() == 0 ); // A single unique unit with 1 pin common to all units and all body styles. LIB_PIN* pin1 = new LIB_PIN( &m_part_no_data ); pin1->SetNumber( "1" ); m_part_no_data.AddDrawItem( pin1 ); std::vector units = m_part_no_data.GetUnitDrawItems(); BOOST_CHECK( units.size() == 1 ); BOOST_CHECK( units[0].m_unit == 0 ); BOOST_CHECK( units[0].m_convert == 0 ); BOOST_CHECK( units[0].m_items[0] == pin1 ); } /** * Check inheritance support. */ BOOST_AUTO_TEST_CASE( Inheritance ) { std::unique_ptr parent = std::make_unique( "parent" ); BOOST_CHECK( parent->IsRoot() ); std::unique_ptr ref = std::make_unique( *parent ); std::unique_ptr child = std::make_unique( "child", parent.get() ); BOOST_CHECK( child->IsAlias() ); std::unique_ptr grandChild = std::make_unique( "grandchild", child.get() ); BOOST_CHECK( grandChild->IsAlias() ); LIB_SYMBOL_SPTR parentRef = child->GetParent().lock(); BOOST_CHECK( parentRef ); BOOST_CHECK( parentRef == parent->SharedPtr() ); BOOST_CHECK_EQUAL( parent->SharedPtr().use_count(), 3 ); LIB_SYMBOL_SPTR childRef = grandChild->GetParent().lock(); BOOST_CHECK( childRef ); BOOST_CHECK( childRef == child->SharedPtr() ); BOOST_CHECK_EQUAL( child->SharedPtr().use_count(), 3 ); BOOST_CHECK_EQUAL( child->GetUnitCount(), 1 ); parent->SetUnitCount( 4 ); BOOST_CHECK_EQUAL( child->GetUnitCount(), 4 ); parent->SetUnitCount( 1 ); LIB_FIELD* field = new LIB_FIELD( MANDATORY_FIELDS, "Manufacturer" ); field->SetText( "Manufacturer" ); child->AddField( field ); ref->SetName( "child" ); field = new LIB_FIELD( MANDATORY_FIELDS, "Manufacturer" ); field->SetText( "Manufacturer" ); ref->AddField( field ); BOOST_CHECK( *ref == *child->Flatten() ); ref->SetName( "grandchild" ); field = new LIB_FIELD( MANDATORY_FIELDS + 1, "MPN" ); field->SetText( "123456" ); ref->AddField( field ); field = new LIB_FIELD( MANDATORY_FIELDS + 1, "MPN" ); field->SetText( "123456" ); grandChild->AddField( field ); BOOST_CHECK( *ref == *grandChild->Flatten() ); child->SetParent(); BOOST_CHECK_EQUAL( child->GetUnitCount(), 1 ); parentRef.reset(); BOOST_CHECK_EQUAL( parent->SharedPtr().use_count(), 2 ); } /** * Check the copy constructor. */ BOOST_AUTO_TEST_CASE( CopyConstructor ) { std::shared_ptr copy = std::make_shared( m_part_no_data ); BOOST_CHECK( m_part_no_data == *copy.get() ); } BOOST_AUTO_TEST_SUITE_END()