test_zone_filler.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 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
 */
 
#include <qa_utils/wx_utils/unit_test_utils.h>
#include <boost/test/data/test_case.hpp>
 
#include <pcbnew_utils/board_test_utils.h>
#include <board.h>
#include <board_design_settings.h>
#include <pad.h>
#include <pcb_track.h>
#include <footprint.h>
#include <zone.h>
#include <drc/drc_item.h>
#include <settings/settings_manager.h>
#include <geometry/shape_poly_set.h>
#include <advanced_config.h>
 
 
struct ZONE_FILL_TEST_FIXTURE
{
    ZONE_FILL_TEST_FIXTURE()
    { }
 
    SETTINGS_MANAGER       m_settingsManager;
    std::unique_ptr<BOARD> m_board;
};
 
 
int delta = KiROUND( 0.006 * pcbIUScale.IU_PER_MM );
 
 
BOOST_FIXTURE_TEST_CASE( BasicZoneFills, ZONE_FILL_TEST_FIXTURE )
{
    KI_TEST::LoadBoard( m_settingsManager, "zone_filler", m_board );
 
    BOARD_DESIGN_SETTINGS& bds = m_board->GetDesignSettings();
 
    KI_TEST::FillZones( m_board.get() );
 
    // Now that the zones are filled we're going to increase the size of -some- pads and
    // tracks so that they generate DRC errors.  The test then makes sure that those errors
    // are generated, and that the other pads and tracks do -not- generate errors.
 
    for( PAD* pad : m_board->Footprints()[0]->Pads() )
    {
        if( pad->GetNumber() == "2" || pad->GetNumber() == "4" || pad->GetNumber() == "6" )
        {
            pad->SetSize( PADSTACK::ALL_LAYERS,
                          pad->GetSize( PADSTACK::ALL_LAYERS ) + VECTOR2I( delta, delta ) );
        }
    }
 
    int  ii = 0;
    KIID arc8;
    KIID arc12;
 
    for( PCB_TRACK* track : m_board->Tracks() )
    {
        if( track->Type() == PCB_ARC_T )
        {
            ii++;
 
            if( ii == 8 )
            {
                arc8 = track->m_Uuid;
                track->SetWidth( track->GetWidth() + delta + delta );
            }
            else if( ii == 12 )
            {
                arc12 = track->m_Uuid;
                track->Move( VECTOR2I( -delta, -delta ) );
            }
        }
    }
 
    bool foundPad2Error = false;
    bool foundPad4Error = false;
    bool foundPad6Error = false;
    bool foundArc8Error = false;
    bool foundArc12Error = false;
    bool foundOtherError = false;
 
    bds.m_DRCEngine->InitEngine( wxFileName() );     // Just to be sure to be sure
 
    bds.m_DRCEngine->SetViolationHandler(
            [&]( const std::shared_ptr<DRC_ITEM>& aItem, const VECTOR2I& aPos, int aLayer,
                 const std::function<void( PCB_MARKER* )>& aPathGenerator )
            {
                if( aItem->GetErrorCode() == DRCE_CLEARANCE )
                {
                    BOARD_ITEM* item_a = m_board->ResolveItem( aItem->GetMainItemID() );
                    PAD*        pad_a = dynamic_cast<PAD*>( item_a );
                    PCB_TRACK*  trk_a = dynamic_cast<PCB_TRACK*>( item_a );
 
                    BOARD_ITEM* item_b = m_board->ResolveItem( aItem->GetAuxItemID() );
                    PAD*        pad_b = dynamic_cast<PAD*>( item_b );
                    PCB_TRACK*  trk_b = dynamic_cast<PCB_TRACK*>( item_b );
 
                    if(      pad_a && pad_a->GetNumber() == "2" ) foundPad2Error = true;
                    else if( pad_a && pad_a->GetNumber() == "4" ) foundPad4Error = true;
                    else if( pad_a && pad_a->GetNumber() == "6" ) foundPad6Error = true;
                    else if( pad_b && pad_b->GetNumber() == "2" ) foundPad2Error = true;
                    else if( pad_b && pad_b->GetNumber() == "4" ) foundPad4Error = true;
                    else if( pad_b && pad_b->GetNumber() == "6" ) foundPad6Error = true;
                    else if( trk_a && trk_a->m_Uuid == arc8 )     foundArc8Error = true;
                    else if( trk_a && trk_a->m_Uuid == arc12 )    foundArc12Error = true;
                    else if( trk_b && trk_b->m_Uuid == arc8 )     foundArc8Error = true;
                    else if( trk_b && trk_b->m_Uuid == arc12 )    foundArc12Error = true;
                    else                                          foundOtherError = true;
 
                }
            } );
 
    bds.m_DRCEngine->RunTests( EDA_UNITS::MM, true, false );
 
    BOOST_CHECK_EQUAL( foundPad2Error, true );
    BOOST_CHECK_EQUAL( foundPad4Error, true );
    BOOST_CHECK_EQUAL( foundPad6Error, true );
    BOOST_CHECK_EQUAL( foundArc8Error, true );
    BOOST_CHECK_EQUAL( foundArc12Error, true );
    BOOST_CHECK_EQUAL( foundOtherError, false );
}
 
 
BOOST_FIXTURE_TEST_CASE( NotchedZones, ZONE_FILL_TEST_FIXTURE )
{
    KI_TEST::LoadBoard( m_settingsManager, "notched_zones", m_board );
 
    // Older algorithms had trouble where the filleted zones intersected and left notches.
    // See:
    //   https://gitlab.com/kicad/code/kicad/-/issues/2737
    //   https://gitlab.com/kicad/code/kicad/-/issues/2752
    SHAPE_POLY_SET frontCopper;
 
    KI_TEST::FillZones( m_board.get() );
 
    frontCopper = SHAPE_POLY_SET();
 
    for( ZONE* zone : m_board->Zones() )
    {
        if( zone->GetLayerSet().Contains( F_Cu ) )
        {
            frontCopper.BooleanAdd( *zone->GetFilledPolysList( F_Cu ) );
        }
    }
 
    BOOST_CHECK_EQUAL( frontCopper.OutlineCount(), 2 );
}
 
 
static const std::vector<wxString> RegressionZoneFillTests_tests = {
    "issue18",
    "issue2568",
    "issue3812",
    "issue5102",
    "issue5313",
    "issue5320",
    "issue5567",
    "issue5830",
    "issue6039",
    "issue6260",
    "issue6284",
    "issue7086",
    "issue14294",   // Bad Clipper2 fill
    "fill_bad"      // Missing zone clearance expansion
};
 
 
BOOST_DATA_TEST_CASE_F( ZONE_FILL_TEST_FIXTURE, RegressionZoneFillTests,
                        boost::unit_test::data::make( RegressionZoneFillTests_tests ), relPath )
{
    KI_TEST::LoadBoard( m_settingsManager, relPath, m_board );
 
    BOARD_DESIGN_SETTINGS& bds = m_board->GetDesignSettings();
 
    KI_TEST::FillZones( m_board.get() );
 
    std::vector<DRC_ITEM> violations;
 
    bds.m_DRCEngine->SetViolationHandler(
            [&]( const std::shared_ptr<DRC_ITEM>& aItem, const VECTOR2I& aPos, int aLayer,
                 const std::function<void( PCB_MARKER* )>& aPathGenerator )
            {
                if( aItem->GetErrorCode() == DRCE_CLEARANCE )
                    violations.push_back( *aItem );
            } );
 
    bds.m_DRCEngine->RunTests( EDA_UNITS::MM, true, false );
 
    if( violations.empty() )
    {
        BOOST_CHECK_EQUAL( 1, 1 );  // quiet "did not check any assertions" warning
        BOOST_TEST_MESSAGE( wxString::Format( "Zone fill regression: %s passed", relPath ) );
    }
    else
    {
        UNITS_PROVIDER unitsProvider( pcbIUScale, EDA_UNITS::INCH );
 
        std::map<KIID, EDA_ITEM*> itemMap;
        m_board->FillItemMap( itemMap );
 
        for( const DRC_ITEM& item : violations )
            BOOST_TEST_MESSAGE( item.ShowReport( &unitsProvider, RPT_SEVERITY_ERROR, itemMap ) );
 
        BOOST_ERROR( wxString::Format( "Zone fill regression: %s failed", relPath ) );
    }
}
 
 
static const std::vector<wxString> RegressionSliverZoneFillTests_tests = {
    "issue16182"    // Slivers
};
 
 
BOOST_DATA_TEST_CASE_F( ZONE_FILL_TEST_FIXTURE, RegressionSliverZoneFillTests,
                        boost::unit_test::data::make( RegressionSliverZoneFillTests_tests ),
                        relPath )
{
    KI_TEST::LoadBoard( m_settingsManager, relPath, m_board );
 
    BOARD_DESIGN_SETTINGS& bds = m_board->GetDesignSettings();
 
    KI_TEST::FillZones( m_board.get() );
 
    std::vector<DRC_ITEM> violations;
 
    bds.m_DRCEngine->SetViolationHandler(
            [&]( const std::shared_ptr<DRC_ITEM>& aItem, const VECTOR2I& aPos, int aLayer,
                 const std::function<void( PCB_MARKER* )>& aPathGenerator )
            {
                if( aItem->GetErrorCode() == DRCE_COPPER_SLIVER )
                    violations.push_back( *aItem );
            } );
 
    bds.m_DRCEngine->RunTests( EDA_UNITS::MM, true, false );
 
    if( violations.empty() )
    {
        BOOST_CHECK_EQUAL( 1, 1 );  // quiet "did not check any assertions" warning
        BOOST_TEST_MESSAGE( wxString::Format( "Zone fill copper sliver regression: %s passed", relPath ) );
    }
    else
    {
        UNITS_PROVIDER unitsProvider( pcbIUScale, EDA_UNITS::INCH );
 
        std::map<KIID, EDA_ITEM*> itemMap;
        m_board->FillItemMap( itemMap );
 
        for( const DRC_ITEM& item : violations )
            BOOST_TEST_MESSAGE( item.ShowReport( &unitsProvider, RPT_SEVERITY_ERROR, itemMap ) );
 
        BOOST_ERROR( wxString::Format( "Zone fill copper sliver regression: %s failed", relPath ) );
    }
}
 
 
static const std::vector<std::pair<wxString,int>> RegressionTeardropFill_tests = {
        { "teardrop_issue_JPC2", 5 },    // Arcs with teardrops connecting to pads
};
 
 
BOOST_DATA_TEST_CASE_F( ZONE_FILL_TEST_FIXTURE, RegressionTeardropFill,
                        boost::unit_test::data::make( RegressionTeardropFill_tests ), test )
{
    const wxString& relPath = test.first;
    const int count = test.second;
 
    KI_TEST::LoadBoard( m_settingsManager, relPath, m_board );
 
    BOARD_DESIGN_SETTINGS& bds = m_board->GetDesignSettings();
 
    KI_TEST::FillZones( m_board.get() );
 
    int zoneCount = 0;
 
    for( ZONE* zone : m_board->Zones() )
    {
        if( zone->IsTeardropArea() )
            zoneCount++;
    }
 
    BOOST_CHECK_MESSAGE( zoneCount == count, "Expected " << count << " teardrop zones in "
                                                            << relPath << ", found "
                                                            << zoneCount );
}
 
 
BOOST_FIXTURE_TEST_CASE( RegressionNetTie, ZONE_FILL_TEST_FIXTURE )
{
 
    std::vector<wxString> tests = { { "issue19956/issue19956" }    // Arcs with teardrops connecting to pads
                                };
 
    for( const wxString& relPath : tests )
    {
        KI_TEST::LoadBoard( m_settingsManager, relPath, m_board );
        BOARD_DESIGN_SETTINGS& bds = m_board->GetDesignSettings();
        KI_TEST::FillZones( m_board.get() );
 
        for( ZONE* zone : m_board->Zones() )
        {
            for( PCB_LAYER_ID layer : zone->GetLayerSet() )
            {
                std::shared_ptr<SHAPE> a_shape( zone->GetEffectiveShape( layer ) );
 
                for( PAD* pad : m_board->GetPads() )
                {
                    std::shared_ptr<SHAPE> pad_shape( pad->GetEffectiveShape( layer ) );
                    int                    clearance = pad_shape->GetClearance( a_shape.get() );
                    BOOST_CHECK_MESSAGE( pad->GetNetCode() == zone->GetNetCode() || clearance != 0,
                                         wxString::Format( "Pad %s from Footprint %s has net code %s and "
                                                           "is connected to zone with net code %s",
                                                           pad->GetNumber(),
                                                           pad->GetParentFootprint()->GetReferenceAsString(),
                                                           pad->GetNetname(),
                                                           zone->GetNetname() ) );
                }
            }
        }
    }
}
 

BOOST_FIXTURE_TEST_CASE( RegressionZonePriorityIsolatedIslands, ZONE_FILL_TEST_FIXTURE )
{
    // Enable iterative refill to fix issue 21746
    ADVANCED_CFG& cfg = const_cast<ADVANCED_CFG&>( ADVANCED_CFG::GetCfg() );
    bool originalIterativeRefill = cfg.m_ZoneFillIterativeRefill;
    cfg.m_ZoneFillIterativeRefill = true;
 
    // Restore config at end of scope to avoid polluting other tests
    struct ScopeGuard { bool& ref; bool orig; ~ScopeGuard() { ref = orig; } } guard{ cfg.m_ZoneFillIterativeRefill, originalIterativeRefill };
 
    KI_TEST::LoadBoard( m_settingsManager, "issue21746/issue21746", m_board );
 
    KI_TEST::FillZones( m_board.get() );
 
    // Find the GND zone
    ZONE* gndZone = nullptr;
 
    for( ZONE* zone : m_board->Zones() )
    {
        if( zone->GetNetname() == "GND" )
        {
            gndZone = zone;
            break;
        }
    }
 
    BOOST_REQUIRE_MESSAGE( gndZone != nullptr, "GND zone not found in test board" );
 
    // Calculate board outline area
    SHAPE_POLY_SET boardOutline;
    bool hasOutline = m_board->GetBoardPolygonOutlines( boardOutline, true );
    BOOST_REQUIRE_MESSAGE( hasOutline, "Board outline not found" );
 
    double boardArea = 0.0;
 
    for( int i = 0; i < boardOutline.OutlineCount(); i++ )
        boardArea += boardOutline.Outline( i ).Area();
 
    // Get GND zone filled area
    gndZone->CalculateFilledArea();
    double gndFilledArea = gndZone->GetFilledArea();
 
    // The GND zone should fill at least 25% of the board area
    // With the bug, it fills almost nothing because VDD knocks it out
    double fillRatio = gndFilledArea / boardArea;
 
    BOOST_TEST_MESSAGE( wxString::Format( "Board area: %.2f sq mm, GND filled area: %.2f sq mm, "
                                          "Fill ratio: %.1f%%",
                                          boardArea / 1e6, gndFilledArea / 1e6,
                                          fillRatio * 100.0 ) );
 
    BOOST_CHECK_MESSAGE( fillRatio >= 0.25,
                         wxString::Format( "GND zone fill ratio %.1f%% is less than expected 25%%. "
                                           "This indicates issue 21746 - lower priority zones not "
                                           "filling areas where higher priority isolated islands "
                                           "were removed.",
                                           fillRatio * 100.0 ) );
}
 

BOOST_FIXTURE_TEST_CASE( RegressionViaFlashingUnreachableZone, ZONE_FILL_TEST_FIXTURE )
{
    KI_TEST::LoadBoard( m_settingsManager, "issue22010/issue22010", m_board );
 
    KI_TEST::FillZones( m_board.get() );
 
    // Find vias with zone_layer_connections set for In1.Cu or In2.Cu
    // After filling, vias that the zone doesn't actually reach should NOT be flashed
    int viasWithUnreachableFlashing = 0;
    int totalConditionalVias = 0;
 
    PCB_LAYER_ID in1Cu = m_board->GetLayerID( wxT( "In1.Cu" ) );
    PCB_LAYER_ID in2Cu = m_board->GetLayerID( wxT( "In2.Cu" ) );
 
    for( PCB_TRACK* track : m_board->Tracks() )
    {
        if( track->Type() != PCB_VIA_T )
            continue;
 
        PCB_VIA* via = static_cast<PCB_VIA*>( track );
 
        if( !via->GetRemoveUnconnected() )
            continue;
 
        totalConditionalVias++;
 
        // Check if via is flashed on In1.Cu or In2.Cu
        bool flashedOnIn1 = via->FlashLayer( in1Cu );
        bool flashedOnIn2 = via->FlashLayer( in2Cu );
 
        if( !flashedOnIn1 && !flashedOnIn2 )
            continue;
 
        VECTOR2I viaCenter = via->GetPosition();
        int      holeRadius = via->GetDrillValue() / 2;
 
        // Check if any zone fill actually reaches this via
        bool zoneReachesVia = false;
 
        for( ZONE* zone : m_board->Zones() )
        {
            if( zone->GetIsRuleArea() )
                continue;
 
            if( zone->GetNetCode() != via->GetNetCode() )
                continue;
 
            for( PCB_LAYER_ID layer : { in1Cu, in2Cu } )
            {
                if( !zone->IsOnLayer( layer ) )
                    continue;
 
                if( !zone->HasFilledPolysForLayer( layer ) )
                    continue;
 
                const std::shared_ptr<SHAPE_POLY_SET>& fill = zone->GetFilledPolysList( layer );
 
                if( fill->Contains( viaCenter, -1, holeRadius ) )
                {
                    zoneReachesVia = true;
                    break;
                }
            }
 
            if( zoneReachesVia )
                break;
        }
 
        // If via is flashed but zone doesn't reach it, that's the bug
        if( !zoneReachesVia && ( flashedOnIn1 || flashedOnIn2 ) )
            viasWithUnreachableFlashing++;
    }
 
    BOOST_TEST_MESSAGE( wxString::Format( "Total conditional vias: %d, Vias with unreachable "
                                          "flashing: %d", totalConditionalVias,
                                          viasWithUnreachableFlashing ) );
 
    BOOST_CHECK_MESSAGE( viasWithUnreachableFlashing == 0,
                         wxString::Format( "Found %d vias flashed on zone layers where the zone "
                                           "fill doesn't actually reach them. This indicates "
                                           "issue 22010 is not fixed.",
                                           viasWithUnreachableFlashing ) );
}
 

BOOST_FIXTURE_TEST_CASE( RegressionViaZoneNetShort, ZONE_FILL_TEST_FIXTURE )
{
    KI_TEST::LoadBoard( m_settingsManager, "issue12964/issue12964", m_board );
 
    KI_TEST::FillZones( m_board.get() );
 
    int viasShortingZones = 0;
    int totalConditionalVias = 0;
 
    for( PCB_TRACK* track : m_board->Tracks() )
    {
        if( track->Type() != PCB_VIA_T )
            continue;
 
        PCB_VIA* via = static_cast<PCB_VIA*>( track );
 
        if( !via->GetRemoveUnconnected() )
            continue;
 
        totalConditionalVias++;
 
        VECTOR2I viaCenter = via->GetPosition();
 
        for( ZONE* zone : m_board->Zones() )
        {
            if( zone->GetIsRuleArea() )
                continue;
 
            if( zone->GetNetCode() == via->GetNetCode() )
                continue;
 
            for( PCB_LAYER_ID layer : zone->GetLayerSet().Seq() )
            {
                if( !via->FlashLayer( layer ) )
                    continue;
 
                if( !zone->HasFilledPolysForLayer( layer ) )
                    continue;
 
                const std::shared_ptr<SHAPE_POLY_SET>& fill = zone->GetFilledPolysList( layer );
                int viaRadius = via->GetWidth( layer ) / 2;
 
                if( fill->Contains( viaCenter, -1, viaRadius ) )
                {
                    BOOST_TEST_MESSAGE( wxString::Format(
                            "Via at (%d, %d) on net %s is flashing on layer %s where zone "
                            "net %s is filled - this creates a short!",
                            viaCenter.x, viaCenter.y, via->GetNetname(),
                            m_board->GetLayerName( layer ), zone->GetNetname() ) );
                    viasShortingZones++;
                }
            }
        }
    }
 
    BOOST_TEST_MESSAGE( wxString::Format( "Total conditional vias: %d, Vias shorting zones: %d",
                                          totalConditionalVias, viasShortingZones ) );
 
    BOOST_CHECK_MESSAGE( viasShortingZones == 0,
                         wxString::Format( "Found %d vias flashed on layers where they short to "
                                           "zones with different nets. This indicates issue 12964 "
                                           "is not fixed.",
                                           viasShortingZones ) );
}