KiCad PCB EDA Suite
board_test_utils.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) 2019 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 
24 #include "board_test_utils.h"
25 
27 
28 // For the temp directory logic: can be std::filesystem in C++17
29 #include <boost/filesystem.hpp>
30 #include <boost/test/unit_test.hpp>
31 
32 
33 namespace KI_TEST
34 {
35 
36 BOARD_DUMPER::BOARD_DUMPER() : m_dump_boards( std::getenv( "KICAD_TEST_DUMP_BOARD_FILES" ) )
37 {
38 }
39 
40 
41 void BOARD_DUMPER::DumpBoardToFile( BOARD& aBoard, const std::string& aName ) const
42 {
43  if( !m_dump_boards )
44  return;
45 
46  auto path = boost::filesystem::temp_directory_path() / aName;
47  path += ".kicad_pcb";
48 
49  BOOST_TEST_MESSAGE( "Dumping board file: " << path.string() );
50  ::KI_TEST::DumpBoardToFile( aBoard, path.string() );
51 }
52 
53 } // namespace KI_TEST
Template specialization to enable wxStrings for certain containers (e.g. unordered_map)
Definition: bitmap.cpp:56
void DumpBoardToFile(BOARD &aBoard, const std::string &aName) const
void DumpBoardToFile(BOARD &board, const std::string &aFilename)
Utility function to simply write a Board out to a file.
Information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:176
General utilities for PCB file IO for QA programs.
General utilities for PCB tests.