test_odb_soldermask_shape_export.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 <filesystem>
#include <fstream>
#include <memory>
 
#include <algorithm>
#include <footprint.h>
 
#include <qa_utils/wx_utils/unit_test_utils.h>
#include <qa_utils/file_utils.h>
#include <pcbnew_utils/board_file_utils.h>
#include <boost/test/unit_test.hpp>
 
#include <base_units.h>
#include <board.h>
#include <footprint.h>
#include <pcb_shape.h>
#include <pcbnew/pcb_io/odbpp/pcb_io_odbpp.h>
#include <settings/settings_manager.h>
#include <core/utf8.h>
 
namespace fs = std::filesystem;

static int countOdbSurfaceRecords( const fs::path& aFeaturesFile )
{
    int           surfaceCount = 0;
    std::ifstream stream( aFeaturesFile );
    std::string   line;
 
    while( std::getline( stream, line ) )
    {
        if( line.rfind( "S ", 0 ) == 0 )
            surfaceCount++;
    }
 
    return surfaceCount;
}
 

static int countMaskSurfaceRecords( const fs::path& aRoot, bool& aFoundFile )
{
    int total = 0;
    aFoundFile = false;
 
    for( const fs::directory_entry& entry : fs::recursive_directory_iterator( aRoot ) )
    {
        if( !entry.is_regular_file() || entry.path().filename() != "features" )
            continue;
 
        const std::string layerDir = entry.path().parent_path().filename().string();
 
        if( layerDir.find( "mask" ) == std::string::npos )
            continue;
 
        aFoundFile = true;
        total += countOdbSurfaceRecords( entry.path() );
    }
 
    return total;
}
 

BOOST_AUTO_TEST_CASE( OdbSolderMaskShapeExport )
{
    SETTINGS_MANAGER       settingsManager;
    std::unique_ptr<BOARD> board = KI_TEST::RequireBoardFromPcbnewQAData( "issue24690/soldermask_shape.kicad_pcb" );
 
    // The export can only drop the mask opening if the mask-flagged shape is on
    // the board to begin with, so confirm the fixture still carries it.
    BOOST_REQUIRE_EQUAL( board->Footprints().size(), 1u );
 
    const FOOTPRINT* fp = board->Footprints().front();
 
    const auto onMask =
            []( const BOARD_ITEM* aItem )
            {
                return aItem->Type() == PCB_SHAPE_T && aItem->IsOnLayer( F_Mask );
            };
 
    BOOST_REQUIRE( std::any_of( fp->GraphicalItems().begin(), fp->GraphicalItems().end(),
                                onMask ) );
 
    KI_TEST::SCOPED_TEMP_DIR outDir( wxT( "kicad_qa_odb_soldermask_24690" ) );
 
    PCB_IO_ODBPP                odbExporter;
    std::map<std::string, UTF8> props;
    props["units"] = "mm";
    props["sigfig"] = "6";
 
    BOOST_REQUIRE_NO_THROW( odbExporter.SaveBoard( outDir.Path().string(), *board, &props ) );
 
    BOOST_REQUIRE_MESSAGE( fs::exists( outDir.Path() ), "ODB++ export produced no output tree" );
 
    bool foundMask = false;
    int  surfaceCount = countMaskSurfaceRecords( outDir.Path(), foundMask );
 
    BOOST_REQUIRE_MESSAGE( foundMask, "ODB++ export produced no solder-mask features file" );
 
    BOOST_CHECK_MESSAGE( surfaceCount > 0, "Mask-flagged shape was dropped from the ODB++ export "
                                           "(no surface features on the solder-mask layer)" );
}