test_eagle_binary_import.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, see <https://www.gnu.org/licenses/>.
 */

 
#include <pcbnew_utils/board_test_utils.h>
#include <pcbnew_utils/board_file_utils.h>
#include <qa_utils/wx_utils/unit_test_utils.h>
 
#include <pcbnew/pcb_io/eagle/pcb_io_eagle.h>
 
#include <board.h>
#include <footprint.h>
#include <netinfo.h>
#include <pad.h>
#include <pcb_shape.h>
#include <pcb_text.h>
#include <pcb_track.h>
#include <zone.h>
 
#include <algorithm>
#include <map>
#include <set>
#include <vector>
 
#include <wx/filename.h>
 
 
struct EAGLE_BINARY_IMPORT_FIXTURE
{
    EAGLE_BINARY_IMPORT_FIXTURE() {}
 
    BOARD* loadBoard( const std::string& aRelPath )
    {
        std::string dataPath = KI_TEST::GetPcbnewTestDataDir() + aRelPath;
 
        // Every sample these tests name is committed, so a missing one is a broken fixture
        // rather than an optional extra; skipping it silently would assert nothing at all
        BOOST_REQUIRE_MESSAGE( wxFileName::FileExists( dataPath ),
                               "missing binary Eagle sample " + dataPath );
 
        PCB_IO_EAGLE eaglePlugin;
 
        // The binary format is identified by content, never by extension.
        BOOST_CHECK( eaglePlugin.CanReadBoard( dataPath ) );
 
        BOARD* board = nullptr;
 
        try
        {
            board = eaglePlugin.LoadBoard( dataPath, nullptr, nullptr );
        }
        catch( const IO_ERROR& e )
        {
            BOOST_FAIL( "IO_ERROR loading binary Eagle board: " + e.What().ToStdString() );
        }
        catch( const std::exception& e )
        {
            BOOST_FAIL( std::string( "Exception loading binary Eagle board: " ) + e.what() );
        }
 
        return board;
    }
 
    static std::vector<ZONE*> copperPours( BOARD* aBoard )
    {
        std::vector<ZONE*> pours;
 
        for( ZONE* zone : aBoard->Zones() )
        {
            if( !zone->GetIsRuleArea() && IsCopperLayer( zone->GetFirstLayer() ) )
                pours.push_back( zone );
        }
 
        return pours;
    }
};
 
 
BOOST_FIXTURE_TEST_SUITE( EagleBinaryImport, EAGLE_BINARY_IMPORT_FIXTURE )
 
 

BOOST_AUTO_TEST_CASE( LoadBinaryV4V5 )
{
    std::unique_ptr<BOARD> board( loadBoard( "plugins/eagle_binary/blink1_b1a.brd" ) );
    BOOST_REQUIRE( board );
 
    BOOST_CHECK_GT( board->Footprints().size(), 0u );
    BOOST_CHECK_GT( board->Tracks().size(), 0u );
    BOOST_CHECK_GT( board->GetNetInfo().GetNetCount(), 1u );
}
 

BOOST_AUTO_TEST_CASE( LoadBinaryV3 )
{
    std::unique_ptr<BOARD> board( loadBoard( "plugins/eagle_binary/blink1_v1a.brd" ) );
    BOOST_REQUIRE( board );
 
    BOOST_CHECK_GT( board->Footprints().size(), 0u );
    BOOST_CHECK_GT( board->Tracks().size(), 0u );
}
 

BOOST_AUTO_TEST_CASE( LoadV3CustomAttributes )
{
    std::unique_ptr<BOARD> board( loadBoard( "plugins/eagle_binary/rocketgps.brd" ) );
    BOOST_REQUIRE( board );
 
    BOOST_CHECK_GT( board->Footprints().size(), 0u );
    BOOST_CHECK_GT( board->Tracks().size(), 0u );
    BOOST_CHECK_GT( board->GetNetInfo().GetNetCount(), 1u );
}
 

BOOST_AUTO_TEST_CASE( LoadV3UnnamedSignals )
{
    std::unique_ptr<BOARD> board( loadBoard( "plugins/eagle_binary/boomchak.brd" ) );
    BOOST_REQUIRE( board );
 
    BOOST_CHECK_GT( board->Footprints().size(), 0u );
    BOOST_CHECK_GT( board->Tracks().size(), 0u );
    BOOST_CHECK_GT( board->GetNetInfo().GetNetCount(), 1u );
 
    // Every routed item must resolve to a real net; an orphaned net code would
    // have aborted the load before this point.
    for( PCB_TRACK* track : board->Tracks() )
        BOOST_CHECK( track->GetNet() != nullptr );
}
 

BOOST_AUTO_TEST_CASE( LoadV4V5DegeneratePolygons )
{
    std::unique_ptr<BOARD> board( loadBoard( "plugins/eagle_binary/turnemoff.brd" ) );
    BOOST_REQUIRE( board );
 
    BOOST_CHECK_GT( board->Footprints().size(), 0u );
    BOOST_CHECK_GT( board->Tracks().size(), 0u );
}
 

BOOST_AUTO_TEST_CASE( LoadBinaryLongText )
{
    std::unique_ptr<BOARD> board( loadBoard( "plugins/eagle_binary/blink1_b1a.brd" ) );
    BOOST_REQUIRE( board );
 
    std::set<wxString> texts;
 
    for( BOARD_ITEM* item : board->Drawings() )
    {
        if( PCB_TEXT* text = dynamic_cast<PCB_TEXT*>( item ) )
            texts.insert( text->GetText() );
    }
 
    BOOST_CHECK( texts.count( wxS( "blinkm.thingm.com" ) ) );
    BOOST_CHECK( texts.count( wxS( "BlinkM USB" ) ) );
}
 

BOOST_AUTO_TEST_CASE( LoadV3FootprintRotationRing )
{
    std::unique_ptr<BOARD> board( loadBoard( "plugins/eagle_binary/boomchak.brd" ) );
    BOOST_REQUIRE( board );
 
    std::map<int, double> ledRot;
 
    for( FOOTPRINT* fp : board->Footprints() )
    {
        long n = 0;
 
        if( fp->GetReference().StartsWith( wxS( "LED" ) ) && fp->GetReference().Mid( 3 ).ToLong( &n ) )
            ledRot[(int) n] = fp->GetOrientation().AsDegrees();
    }
 
    for( int n = 1; n < 16; n++ )
    {
        BOOST_REQUIRE_MESSAGE( ledRot.count( n ) && ledRot.count( n + 1 ),
                               "expected ring footprints LED" << n << " and LED" << ( n + 1 ) );
 
        double step = ledRot[n + 1] - ledRot[n];
 
        while( step > 180.0 )
            step -= 360.0;
 
        while( step <= -180.0 )
            step += 360.0;
 
        BOOST_CHECK_CLOSE( step, 22.5, 0.5 );
    }
}
 

BOOST_AUTO_TEST_CASE( LoadDropsUnmappedLayers )
{
    auto invalidLayerItems = []( BOARD* board )
    {
        auto bad = []( PCB_LAYER_ID l ) { return (int) l < 0 || (int) l >= PCB_LAYER_ID_COUNT; };
 
        int count = 0;
 
        for( BOARD_ITEM* item : board->Drawings() )
            count += bad( item->GetLayer() );
 
        for( PCB_TRACK* track : board->Tracks() )
            count += bad( track->GetLayer() );
 
        for( FOOTPRINT* fp : board->Footprints() )
        {
            for( BOARD_ITEM* item : fp->GraphicalItems() )
                count += bad( item->GetLayer() );
        }
 
        return count;
    };
 
    auto ruleAreas = []( BOARD* board )
    {
        int count = 0;
 
        for( ZONE* zone : board->Zones() )
            count += zone->GetIsRuleArea();
 
        return count;
    };
 
    for( const char* relPath : { "plugins/eagle_binary/boomchak.brd",
                                 "plugins/eagle_binary/turnemoff.brd" } )
    {
        std::unique_ptr<BOARD> board( loadBoard( relPath ) );
        BOOST_REQUIRE( board );
 
        BOOST_CHECK_EQUAL( invalidLayerItems( board.get() ), 0 );
    }
 
    // turnemoff carries hundreds of via-keepout rectangles on the vRestrict layer; the
    // unmapped-layer handling must keep them as rule areas, not drop them along with the
    // unmappable graphics.
    std::unique_ptr<BOARD> turnemoff( loadBoard( "plugins/eagle_binary/turnemoff.brd" ) );
 
    if( turnemoff )
        BOOST_CHECK_GT( ruleAreas( turnemoff.get() ), 500 );
}
 

BOOST_AUTO_TEST_CASE( LoadRoutesSmashedValueText )
{
    std::unique_ptr<BOARD> board( loadBoard( "plugins/eagle_binary/blink1_b1a.brd" ) );
    BOOST_REQUIRE( board );
 
    auto footprintTexts = [&]()
    {
        std::set<wxString> texts;
 
        for( FOOTPRINT* fp : board->Footprints() )
        {
            texts.insert( fp->Value().GetText() );
 
            for( BOARD_ITEM* item : fp->GraphicalItems() )
            {
                if( PCB_TEXT* text = dynamic_cast<PCB_TEXT*>( item ) )
                    texts.insert( text->GetText() );
            }
        }
 
        return texts;
    }();
 
    BOOST_CHECK( !footprintTexts.count( wxS( "${VALU}" ) ) );
    BOOST_CHECK( !footprintTexts.count( wxS( ">VALU" ) ) );
}
 

BOOST_AUTO_TEST_CASE( LoadV3CopperPourPolygons )
{
    std::unique_ptr<BOARD> board( loadBoard( "plugins/eagle_binary/boomchak.brd" ) );
    BOOST_REQUIRE( board );
 
    std::vector<ZONE*> pours = copperPours( board.get() );
 
    BOOST_REQUIRE_GE( pours.size(), 2u );
 
    // A pour rebuilt from segment start points must yield a single closed outline with at
    // least three corners; a botched conversion would collapse it or leave it empty.
    for( ZONE* zone : pours )
    {
        BOOST_CHECK_EQUAL( zone->Outline()->OutlineCount(), 1 );
        BOOST_CHECK_GE( zone->GetNumCorners(), 3 );
    }
 
    // A pour also keeps the signal it was poured on, so it can still be filled after import
    BOOST_CHECK( std::any_of( pours.begin(), pours.end(),
                              []( ZONE* aZone )
                              {
                                  return aZone->GetNetname() == wxS( "GND" );
                              } ) );
}
 

BOOST_AUTO_TEST_CASE( LoadIssue24827PadNamesAndSignals )
{
    std::unique_ptr<BOARD> board( loadBoard( "plugins/eagle_binary/issue24827_brenner57e.brd" ) );
    BOOST_REQUIRE( board );
 
    BOOST_REQUIRE_GT( board->Footprints().size(), 0u );
 
    int padsWithNumber = 0;
    int padsWithoutNumber = 0;
    int multiPinPartsWithDistinctNets = 0;
 
    for( FOOTPRINT* fp : board->Footprints() )
    {
        std::set<int> nets;
 
        for( PAD* pad : fp->Pads() )
        {
            if( pad->GetNumber().IsEmpty() )
                padsWithoutNumber++;
            else
                padsWithNumber++;
 
            nets.insert( pad->GetNetCode() );
        }
 
        if( fp->Pads().size() > 1 && nets.size() > 1 )
            multiPinPartsWithDistinctNets++;
    }
 
    // The pad-name decode is the whole fix: every through-hole pad in this board
    // carries a numeric name, so an empty-name pad means the short row still won.
    BOOST_CHECK_GT( padsWithNumber, 0 );
    BOOST_CHECK_EQUAL( padsWithoutNumber, 0 );
 
    // With names restored the contactref keys no longer collide, so multi-pin parts
    // spread across several signals instead of collapsing onto one.
    BOOST_CHECK_GT( multiPinPartsWithDistinctNets, 0 );
}
 

BOOST_AUTO_TEST_CASE( LoadIssue24827PadShapes )
{
    std::unique_ptr<BOARD> board( loadBoard( "plugins/eagle_binary/issue24827_brenner57e.brd" ) );
    BOOST_REQUIRE( board );
 
    auto shapeOf = [&]( const wxString& aRef ) -> PAD_SHAPE
    {
        for( FOOTPRINT* fp : board->Footprints() )
        {
            if( fp->GetReference() == aRef && !fp->Pads().empty() )
                return fp->Pads().front()->GetShape( PADSTACK::ALL_LAYERS );
        }
 
        return PAD_SHAPE::CIRCLE;
    };
 
    // R10 is an 0207 resistor (Eagle octagon pads); Q2 is a TO-92 transistor (oblong).
    // Both decoded to circles while the shape ordinal was ignored, and swapping the
    // mapping would trade their shapes.
    BOOST_CHECK_EQUAL( static_cast<int>( shapeOf( wxS( "R10" ) ) ),
                       static_cast<int>( PAD_SHAPE::CHAMFERED_RECT ) );
    BOOST_CHECK_EQUAL( static_cast<int>( shapeOf( wxS( "Q2" ) ) ),
                       static_cast<int>( PAD_SHAPE::OVAL ) );
}

BOOST_AUTO_TEST_CASE( LoadIssue24827CurvedWireArcs )
{
    std::unique_ptr<BOARD> board( loadBoard( "plugins/eagle_binary/issue24827_brenner57e.brd" ) );
    BOOST_REQUIRE( board );
 
    auto bodyArcs = [&]( const wxString& aRef )
    {
        std::vector<PCB_SHAPE*> arcs;
 
        for( FOOTPRINT* fp : board->Footprints() )
        {
            if( fp->GetReference() != aRef )
                continue;
 
            for( BOARD_ITEM* item : fp->GraphicalItems() )
            {
                PCB_SHAPE* shape = dynamic_cast<PCB_SHAPE*>( item );
 
                if( shape && shape->GetShape() == SHAPE_T::ARC && shape->GetLayer() == F_SilkS )
                    arcs.push_back( shape );
            }
        }
 
        return arcs;
    };
 
    // A scattered center is exactly the flattened/indented arc symptom, so require the
    // body arcs of each transistor to stay concentric to a fraction of the body radius.
    for( const wxString& ref : { wxS( "Q2" ), wxS( "IC3" ) } )
    {
        std::vector<PCB_SHAPE*> arcs = bodyArcs( ref );
        BOOST_REQUIRE_GT( arcs.size(), 1u );
 
        VECTOR2I center = arcs.front()->GetCenter();
 
        for( PCB_SHAPE* arc : arcs )
        {
            int dist = ( arc->GetCenter() - center ).EuclideanNorm();
            BOOST_CHECK_MESSAGE( dist < pcbIUScale.mmToIU( 0.5 ),
                                 ref << " silk arc center is " << dist / 1e6 << " mm off the body center" );
        }
    }
}
 
 
BOOST_AUTO_TEST_SUITE_END()