test_schematic.cpp

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright The 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 3 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, see <https://www.gnu.org/licenses/>.
 */

#include <qa_utils/wx_utils/unit_test_utils.h>
#include "eeschema_test_utils.h"
 
#include <lib_symbol.h>
#include <sch_screen.h>
#include <sch_symbol.h>
#include <schematic.h>
#include <bus_alias.h>
#include <project.h>
#include <project/project_file.h>
#include <wildcards_and_files_ext.h>
 
 
class TEST_SCHEMATIC_FIXTURE : public KI_TEST::SCHEMATIC_TEST_FIXTURE
{
protected:
    wxFileName SchematicQAPath( const wxString& aRelativePath ) override;
};
 
 
wxFileName TEST_SCHEMATIC_FIXTURE::SchematicQAPath( const wxString& aRelativePath )
{
    wxFileName fn( KI_TEST::GetEeschemaTestDataDir() );
 
    wxString path = fn.GetFullPath();
    path += aRelativePath + wxT( "." ) + FILEEXT::KiCadSchematicFileExtension;
 
    return wxFileName( path );
}
 
 
BOOST_FIXTURE_TEST_SUITE( Schematic, TEST_SCHEMATIC_FIXTURE )
 
 
BOOST_AUTO_TEST_CASE( TestSchematicSharedByMultipleProjects )
{
    LoadSchematic( SchematicQAPath( "schematic_object_tests/not_shared_by_multiple_projects/"
                                     "not_shared_by_multiple_projects" ) );
 
    std::set<const SCH_SCREEN*> sharedScreens = m_schematic->GetSchematicsSharedByMultipleProjects();
 
    BOOST_CHECK( sharedScreens.empty() );
 
    LoadSchematic( SchematicQAPath( "schematic_object_tests/shared_by_multiple_projects/"
                                     "project_a/project_a" ) );
 
    sharedScreens = m_schematic->GetSchematicsSharedByMultipleProjects();
 
    BOOST_CHECK( !sharedScreens.empty() );
}
 
 
BOOST_AUTO_TEST_CASE( TestSchematicIsComplexHierarchy )
{
    LoadSchematic( SchematicQAPath( "netlists/group_bus_matching/group_bus_matching" ) );
 
    BOOST_CHECK( !m_schematic->IsComplexHierarchy() );
 
    LoadSchematic( SchematicQAPath( "netlists/complex_hierarchy/complex_hierarchy" ) );
 
    BOOST_CHECK( m_schematic->IsComplexHierarchy() );
}
 
 
BOOST_AUTO_TEST_CASE( BusAliasesKeepLastDefinitionAcrossReset )
{
    LoadSchematic( SchematicQAPath( "netlists/hierarchy_aliases/hierarchy_aliases" ) );
    auto original = m_schematic->GetBusAlias( wxS( "ALIAS1" ) );
    BOOST_REQUIRE( original );
    auto changed = original->Clone();
    changed->SetMembers( { wxS( "CHANGED" ) } );
 
    m_schematic->AddBusAlias( changed );
    BOOST_REQUIRE( m_schematic->GetBusAlias( original->GetName() ) );
    BOOST_CHECK( m_schematic->GetBusAlias( original->GetName() )->Members() == changed->Members() );
    BOOST_CHECK( m_schematic->Project().GetProjectFile().m_BusAliases.at( original->GetName() )
                 == changed->Members() );
    changed->SetMembers( original->Members() );
    BOOST_CHECK( m_schematic->GetBusAlias( original->GetName() )->Members() != changed->Members() );
    changed->SetMembers( { wxS( "CHANGED" ) } );
 
    m_schematic->AddBusAlias( original );
    BOOST_CHECK( m_schematic->GetAllBusAliases().back()->Members() == original->Members() );
    m_schematic->SetBusAliases( { original, changed, original } );
    BOOST_CHECK( m_schematic->GetAllBusAliases().back()->Members() == original->Members() );
    m_schematic->SetBusAliases( m_schematic->GetAllBusAliases() );
    BOOST_REQUIRE( m_schematic->GetBusAlias( original->GetName() ) );
 
    m_schematic->Reset();
    BOOST_REQUIRE( m_schematic->GetBusAlias( original->GetName() ) );
    BOOST_CHECK( m_schematic->GetBusAlias( original->GetName() )->Members() == original->Members() );
    m_schematic->SetBusAliases( {} );
    m_schematic->Reset();
    BOOST_CHECK( m_schematic->GetAllBusAliases().empty() );
    BOOST_CHECK( m_schematic->Project().GetProjectFile().m_BusAliases.empty() );
}
 
 
BOOST_AUTO_TEST_CASE( DestructionReleasesSharedHierarchySymbols )
{
    LoadSchematic( SchematicQAPath( "issue23840/BusAndVectors" ) );
    const SCH_SHEET_LIST sheets = m_schematic->BuildSheetListSortedByPageNumbers();
    BOOST_REQUIRE_EQUAL( sheets.size(), 3 );
    std::set<SCH_SCREEN*> screens;
 
    for( const SCH_SHEET_PATH& path : sheets )
        screens.insert( path.LastScreen() );
 
    BOOST_REQUIRE_EQUAL( screens.size(), 2 );
    std::vector<std::weak_ptr<LIB_SYMBOL>> symbols;
 
    for( SCH_SCREEN* screen : screens )
    {
        BOOST_REQUIRE( !screen->GetLibSymbols().empty() );
        symbols.emplace_back( screen->GetLibSymbols().begin()->second->SharedPtr() );
        auto items = screen->Items().OfType( SCH_SYMBOL_T );
        BOOST_REQUIRE( items.begin() != items.end() );
        const auto* symbol = static_cast<const SCH_SYMBOL*>( *items.begin() );
        BOOST_REQUIRE( symbol->GetLibSymbolRef() );
        symbols.emplace_back( symbol->GetLibSymbolRef()->SharedPtr() );
    }
 
    for( const std::weak_ptr<LIB_SYMBOL>& symbol : symbols )
        BOOST_REQUIRE( !symbol.expired() );
 
    m_schematic.reset();
 
    for( const std::weak_ptr<LIB_SYMBOL>& symbol : symbols )
        BOOST_CHECK( symbol.expired() );
}
 
 
BOOST_AUTO_TEST_SUITE_END()