/* * This program source code file is part of KiCad, a free EDA CAD application. * * Copyright (C) 2023 Roberto Fernandez Bautista * Copyright (C) 2023 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 . */ #include #include #include #include #include BOOST_AUTO_TEST_SUITE( IOMGR ) struct PCB_IO_PLUGIN_CASE { std::string m_case_name; std::string m_file_rel_path; PCB_IO_MGR::PCB_FILE_T m_expected_type; }; // clang-format off static const std::vector BoardPluginCases = { // // FAKE Boards (should return FILE_TYPE_NONE): // { "Fake Board file (KiCad *Legacy* / EAGLE file ext)", "plugins/fakeboard.brd", PCB_IO_MGR::FILE_TYPE_NONE }, { "Fake Board file (KiCad file ext)", "plugins/fakeboard.kicad_pcb", PCB_IO_MGR::FILE_TYPE_NONE }, { "Fake Board file (PCAD file ext)", "plugins/fakeboard.pcb", PCB_IO_MGR::FILE_TYPE_NONE }, { "Fake Board file (CADSTAR file ext)", "plugins/fakeboard.cpa", PCB_IO_MGR::FILE_TYPE_NONE }, { "Fake Board file (Altium Circuit Studio file ext)", "plugins/fakeboard.CSPcbDoc", PCB_IO_MGR::FILE_TYPE_NONE }, { "Fake Board file (Altium Circuit Maker file ext)", "plugins/fakeboard.CMPcbDoc", PCB_IO_MGR::FILE_TYPE_NONE }, { "Fake Board file (Altium Designer file ext)", "plugins/fakeboard.PcbDoc", PCB_IO_MGR::FILE_TYPE_NONE }, { "Fake Board file (Solid Works PCB file ext)", "plugins/fakeboard.SWPcbDoc", PCB_IO_MGR::FILE_TYPE_NONE }, // // REAL Boards: // { "Basic KiCad *Legacy* board file", "plugins/legacy_demos/flat_hierarchy/flat_hierarchy.brd", PCB_IO_MGR::LEGACY }, { "Basic KiCad board file", "complex_hierarchy.kicad_pcb", PCB_IO_MGR::KICAD_SEXP }, { "Basic Eagle board file", "plugins/eagle/Adafruit-AHT20-PCB/Adafruit AHT20 Temperature & Humidity.brd", PCB_IO_MGR::EAGLE }, { "Basic PCAD board file", "plugins/pcad/pcad_4layer_glyph_test_ascii.PCB", PCB_IO_MGR::PCAD }, { "Basic CADSTAR board file", "plugins/cadstar/route_offset/minimal_route_offset_curved_track.cpa", PCB_IO_MGR::CADSTAR_PCB_ARCHIVE }, { "Basic EasyEDA Std board json file", "plugins/easyeda/PCB_USBMETER-PD QC修改版_2023-09-02.json", PCB_IO_MGR::EASYEDA }, { "Basic EasyEDA Std backup file", "plugins/easyeda/BackupProjects_ESP32-PICO-D4_smart_watch.zip", PCB_IO_MGR::EASYEDA }, { "Basic EasyEDA Pro zip board project", "plugins/easyedapro/Scanning Tunneling Microscope OpenSTM ControlBoard.zip", PCB_IO_MGR::EASYEDAPRO }, { "Basic EasyEDA Pro epro project", "plugins/easyedapro/ProProject_Yuzuki Chameleon_2023-09-02.epro", PCB_IO_MGR::EASYEDAPRO }, { "Basic Altium Designer board file", "plugins/altium/eDP_adapter_dvt1_source/eDP_adapter_dvt1.PcbDoc", PCB_IO_MGR::ALTIUM_DESIGNER } // Todo: Add Altium derivatives and Fabmaster tests }; static const std::vector LibraryPluginCases = { // // NOT libraries (should return FILE_TYPE_NONE): // { "Non-Library file (KiCad *Legacy* / EAGLE file ext)", "plugins/fakeboard.brd", PCB_IO_MGR::FILE_TYPE_NONE }, { "Non-Library file (KiCad file ext)", "plugins/fakeboard.kicad_pcb", PCB_IO_MGR::FILE_TYPE_NONE }, { "Non-Library file (PCAD file ext)", "plugins/fakeboard.pcb", PCB_IO_MGR::FILE_TYPE_NONE }, { "Non-Library file (CADSTAR file ext)", "plugins/fakeboard.cpa", PCB_IO_MGR::FILE_TYPE_NONE }, { "Non-Library file (Altium Circuit Studio file ext)", "plugins/fakeboard.CSPcbDoc", PCB_IO_MGR::FILE_TYPE_NONE }, { "Non-Library file (Altium Circuit Maker file ext)", "plugins/fakeboard.CMPcbDoc", PCB_IO_MGR::FILE_TYPE_NONE }, { "Non-Library file (Altium Designer file ext)", "plugins/fakeboard.PcbDoc", PCB_IO_MGR::FILE_TYPE_NONE }, { "Non-Library file (Solid Works PCB file ext)", "plugins/fakeboard.SWPcbDoc", PCB_IO_MGR::FILE_TYPE_NONE }, // // REAL Libraries: // { "Basic KiCad footprint .pretty library", "plugins/eagle/lbr/SparkFun-GPS.pretty", PCB_IO_MGR::KICAD_SEXP }, { "Basic Eagle library file", "plugins/eagle/lbr/SparkFun-GPS.lbr", PCB_IO_MGR::EAGLE }, { "Basic CADSTAR PCB Archive library file", "plugins/cadstar/lib/footprint-with-thermal-pad.cpa", PCB_IO_MGR::CADSTAR_PCB_ARCHIVE }, { "Basic EasyEDA Std board json file", "plugins/easyeda/PCB_USBMETER-PD QC修改版_2023-09-02.json", PCB_IO_MGR::EASYEDA }, { "Basic EasyEDA Std backup file", "plugins/easyeda/BackupProjects_ESP32-PICO-D4_smart_watch.zip", PCB_IO_MGR::EASYEDA }, { "Basic EasyEDA Pro zip board project", "plugins/easyedapro/Scanning Tunneling Microscope OpenSTM ControlBoard.zip", PCB_IO_MGR::EASYEDAPRO }, { "Basic EasyEDA Pro epro project", "plugins/easyedapro/ProProject_Yuzuki Chameleon_2023-09-02.epro", PCB_IO_MGR::EASYEDAPRO }, { "Altium Designer 'Espressif ESP32-WROOM-32.PcbLib' library file", "plugins/altium/pcblib/Espressif ESP32-WROOM-32.PcbLib", PCB_IO_MGR::ALTIUM_DESIGNER }, { "Altium Designer 'Tracks.v6.PcbLib' library file", "plugins/altium/pcblib/Tracks.v6.PcbLib", PCB_IO_MGR::ALTIUM_DESIGNER } // Todo: Add Altium derivatives and Fabmaster tests }; // clang-format on BOOST_AUTO_TEST_CASE( FindBoardPluginType ) { for( auto& c : BoardPluginCases ) { BOOST_TEST_CONTEXT( c.m_case_name ) { wxString dataPath = wxString::FromUTF8( KI_TEST::GetPcbnewTestDataDir() + c.m_file_rel_path ); BOOST_CHECK_EQUAL( PCB_IO_MGR::FindPluginTypeFromBoardPath( dataPath ), c.m_expected_type ); // Todo add tests to check if it still works with upper/lower case ext. // ( FindPluginTypeFromBoardPath should be case insensitive) } } } BOOST_AUTO_TEST_CASE( GuessLibraryPluginType ) { for( auto& c : LibraryPluginCases ) { BOOST_TEST_CONTEXT( c.m_case_name ) { wxString dataPath = wxString::FromUTF8( KI_TEST::GetPcbnewTestDataDir() + c.m_file_rel_path ); BOOST_CHECK_EQUAL( PCB_IO_MGR::GuessPluginTypeFromLibPath( dataPath ), c.m_expected_type ); // Todo add tests to check if it still works with upper/lower case ext. // ( GuessPluginTypeFromLibPath should be case insensitive) } } } BOOST_AUTO_TEST_CASE( CheckCanReadBoard ) { for( auto& c : BoardPluginCases ) { BOOST_TEST_CONTEXT( c.m_case_name ) { wxString dataPath = wxString::FromUTF8( KI_TEST::GetPcbnewTestDataDir() + c.m_file_rel_path ); auto& pluginEntries = PCB_IO_MGR::PLUGIN_REGISTRY::Instance()->AllPlugins(); for( auto& entry : pluginEntries ) { BOOST_TEST_CONTEXT( entry.m_name ) { auto plugin = IO_RELEASER( PCB_IO_MGR::PluginFind( entry.m_type ) ); bool expectValidHeader = c.m_expected_type == entry.m_type; BOOST_CHECK_EQUAL( plugin->CanReadBoard( dataPath ), expectValidHeader ); } } } } } BOOST_AUTO_TEST_SUITE_END()