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 <pcb_text.h>
#include <pcb_track.h>
#include <zone.h>
 
#include <map>
#include <set>
 
#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;
 
        if( !wxFileName::FileExists( dataPath ) )
        {
            BOOST_TEST_MESSAGE( "no real binary Eagle sample available at " + dataPath + "; load test skipped" );
            return nullptr;
        }
 
        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;
    }
};
 
 
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" ) );
 
    if( !board )
        return;
 
    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" ) );
 
    if( !board )
        return;
 
    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" ) );
 
    if( !board )
        return;
 
    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" ) );
 
    if( !board )
        return;
 
    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" ) );
 
    if( !board )
        return;
 
    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/issue24612_nova_usbbox.brd" ) );
 
    if( !board )
        return;
 
    BOOST_CHECK_GT( board->Footprints().size(), 0u );
    BOOST_CHECK_GT( board->Tracks().size(), 0u );
 
    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( "ASTROELEKTRONIK" ) ) );
    BOOST_CHECK( texts.count( wxS( "Nova+ USB-Box" ) ) );
}
 

BOOST_AUTO_TEST_CASE( LoadV3RecursiveCountOverrun )
{
    std::unique_ptr<BOARD> board( loadBoard( "plugins/eagle_binary/Sigma2_e.brd" ) );
 
    if( !board )
        return;
 
    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( LoadV3FootprintRotationRing )
{
    std::unique_ptr<BOARD> board( loadBoard( "plugins/eagle_binary/boomchak.brd" ) );
 
    if( !board )
        return;
 
    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 ) );
 
        if( !board )
            continue;
 
        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_SUITE_END()