kicad-source-mirror/qa/tests/eeschema/test_connectivity_algo.cpp

/*
 * 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, you may find one here:
 * https://www.gnu.org/licenses/gpl-3.0.en.html
 * or you may search the http://www.gnu.org website for the version 32 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
 */


#include <qa_utils/wx_utils/unit_test_utils.h>
#include <schematic_utils/schematic_file_util.h>

#include <connection_graph.h>
#include <schematic.h>
#include <sch_sheet.h>
#include <sch_screen.h>
#include <sch_symbol.h>
#include <sch_pin.h>
#include <settings/settings_manager.h>
#include <locale_io.h>

struct CONNECTIVITY_TEST_FIXTURE
{
    CONNECTIVITY_TEST_FIXTURE()
    { }

    SETTINGS_MANAGER           m_settingsManager;
    std::unique_ptr<SCHEMATIC> m_schematic;
};

BOOST_FIXTURE_TEST_CASE( CheckNetCounts, CONNECTIVITY_TEST_FIXTURE )
{
    LOCALE_IO dummy;

    std::vector<std::pair<wxString, int>> tests =
    {
        { "issue18092/issue18092",                   1  }
    };

    for( auto&[ name, nets] : tests )
    {
        KI_TEST::LoadSchematic( m_settingsManager, name, m_schematic );

        SCH_SHEET_LIST sheets = m_schematic->BuildSheetListSortedByPageNumbers();
        CONNECTION_GRAPH* graph = m_schematic->ConnectionGraph();

        BOOST_CHECK( nets == graph->GetNetMap().size() );

    }
}


/**
 * Test for issue #17771: Bus implicit connection not working across hierarchy.
 *
 * The schematic has a hierarchy where bus members should connect through implicit
 * bus connections. The bug was that V.Z1 connects through to the root but V.Z2 does not,
 * because the intermediate net W.X.Y.Z1 is explicitly labeled on the "sub" sheet while
 * W.X.Y.Z2 relies on implicit bus member expansion.
 *
 * Expected: Both nets should connect properly:
 *   - m.X.Y.Z1 (TP101/TP102 on root) should connect to V.Z1/V.Z2 (TP401/TP402 on sub3)
 */
BOOST_FIXTURE_TEST_CASE( Issue17771, CONNECTIVITY_TEST_FIXTURE )
{
    LOCALE_IO dummy;

    KI_TEST::LoadSchematic( m_settingsManager, "issue17771/issue1771", m_schematic );

    SCH_SHEET_LIST sheets = m_schematic->BuildSheetListSortedByPageNumbers();
    CONNECTION_GRAPH* graph = m_schematic->ConnectionGraph();

    // Find test points and their net connections
    // TP101 and TP401 should be on the same net (m.X.Y.Z1)
    // TP102 and TP402 should be on the same net (m.X.Y.Z2)
    std::map<wxString, int> tpNetCodes;  // Test point reference -> net code

    for( const auto& [key, subgraphs] : graph->GetNetMap() )
    {
        for( CONNECTION_SUBGRAPH* subgraph : subgraphs )
        {
            for( SCH_ITEM* item : subgraph->GetItems() )
            {
                if( item->Type() == SCH_PIN_T )
                {
                    SCH_PIN* pin = static_cast<SCH_PIN*>( item );
                    SCH_SYMBOL* symbol = dynamic_cast<SCH_SYMBOL*>( pin->GetParentSymbol() );

                    if( symbol )
                    {
                        wxString ref = symbol->GetRef( &subgraph->GetSheet() );

                        if( ref == "TP101" || ref == "TP102" ||
                            ref == "TP401" || ref == "TP402" )
                        {
                            tpNetCodes[ref] = key.Netcode;
                        }
                    }
                }
            }
        }
    }

    // Verify we found all test points
    BOOST_REQUIRE_MESSAGE( tpNetCodes.count( "TP101" ),
                           "TP101 should be found in netlist" );
    BOOST_REQUIRE_MESSAGE( tpNetCodes.count( "TP102" ),
                           "TP102 should be found in netlist" );
    BOOST_REQUIRE_MESSAGE( tpNetCodes.count( "TP401" ),
                           "TP401 should be found in netlist" );
    BOOST_REQUIRE_MESSAGE( tpNetCodes.count( "TP402" ),
                           "TP402 should be found in netlist" );

    // TP101 and TP401 should be on the same net (m.X.Y.Z1 path)
    BOOST_CHECK_MESSAGE( tpNetCodes["TP101"] == tpNetCodes["TP401"],
                         "TP101 and TP401 should be on the same net (m.X.Y.Z1)" );

    // TP102 and TP402 should be on the same net (m.X.Y.Z2 path)
    // This is the bug - without the fix, these will be on different nets
    BOOST_CHECK_MESSAGE( tpNetCodes["TP102"] == tpNetCodes["TP402"],
                         "TP102 and TP402 should be on the same net (m.X.Y.Z2)" );
}