KiCad PCB EDA Suite
test_custom_rule_severities.cpp
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2021 KiCad Developers, see AUTHORS.txt for contributors.
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version 2
9 * of the License, or (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, you may find one here:
18 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
19 * or you may search the http://www.gnu.org website for the version 2 license,
20 * or you may write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
22 */
23
26#include <board.h>
28#include <pcb_marker.h>
29#include <drc/drc_item.h>
31
32
34{
36 m_settingsManager( true /* headless */ )
37 { }
38
40 std::unique_ptr<BOARD> m_board;
41};
42
43
45{
46 // This board has two edge-connectors. There is a custom DRC rule which conditionally
47 // applies to one of them and sets the edge-clearance severity to "ignore". It should
48 // therefore only generate edge-clearance violations for the other edge connector.
49
50 KI_TEST::LoadBoard( m_settingsManager, "severities", m_board );
51 KI_TEST::FillZones( m_board.get() );
52
53 std::vector<DRC_ITEM> violations;
54 BOARD_DESIGN_SETTINGS& bds = m_board->GetDesignSettings();
55
56 // Disable DRC tests not handled in this testcase
57 // These DRC tests are not useful and do not work because they need a footprint library
58 // associated to the board
61
62 // Also disable a couple of footprint checks which throw up errors on this board
64
65 bds.m_DRCEngine->SetViolationHandler(
66 [&]( const std::shared_ptr<DRC_ITEM>& aItem, VECTOR2I aPos, int aLayer )
67 {
68 PCB_MARKER temp( aItem, aPos );
69
70 if( bds.m_DrcExclusions.find( temp.Serialize() ) == bds.m_DrcExclusions.end() )
71 violations.push_back( *aItem );
72 } );
73
74 bds.m_DRCEngine->RunTests( EDA_UNITS::MILLIMETRES, true, false );
75
76 if( violations.size() == 8 )
77 {
78 BOOST_CHECK_EQUAL( 1, 1 ); // quiet "did not check any assertions" warning
79 BOOST_TEST_MESSAGE( "Custom rule severity test passed" );
80 }
81 else
82 {
83 BOOST_CHECK_EQUAL( violations.size(), 8 );
84
86
87 std::map<KIID, EDA_ITEM*> itemMap;
88 m_board->FillItemMap( itemMap );
89
90 for( const DRC_ITEM& item : violations )
91 BOOST_TEST_MESSAGE( item.ShowReport( &unitsProvider, RPT_SEVERITY_ERROR, itemMap ) );
92
93 BOOST_ERROR( "Custom rule severity test failed" );
94 }
95}
constexpr EDA_IU_SCALE pcbIUScale
Definition: base_units.h:109
Container for design settings for a BOARD object.
std::map< int, SEVERITY > m_DRCSeverities
std::shared_ptr< DRC_ENGINE > m_DRCEngine
std::set< wxString > m_DrcExclusions
wxString Serialize() const
Definition: pcb_marker.cpp:95
@ DRCE_LIB_FOOTPRINT_ISSUES
Definition: drc_item.h:76
@ DRCE_FOOTPRINT_TYPE_MISMATCH
Definition: drc_item.h:75
@ DRCE_LIB_FOOTPRINT_MISMATCH
Definition: drc_item.h:77
void LoadBoard(SETTINGS_MANAGER &aSettingsManager, const wxString &aRelPath, std::unique_ptr< BOARD > &aBoard)
void FillZones(BOARD *m_board)
@ RPT_SEVERITY_ERROR
@ RPT_SEVERITY_IGNORE
BOOST_FIXTURE_TEST_CASE(DRCCustomRuleSeverityTest, DRC_REGRESSION_TEST_FIXTURE)