board_test_utils.h File Reference

#include <map>
#include <memory>
#include <mutex>
#include <functional>
#include <optional>
#include <string>
#include <wx/string.h>
#include <reporter.h>
#include <core/typeinfo.h>
#include <tool/tool_manager.h>
#include <pcb_io/pcb_io.h>

Go to the source code of this file.

Classes
class	KI_TEST::DUMMY_TOOL
class	KI_TEST::BOARD_DUMPER
	A helper that contains logic to assist in dumping boards to disk depending on some environment variables. More...
class	KI_TEST::CONSOLE_LOG
class	KI_TEST::CONSOLE_MSG_REPORTER
struct	KI_TEST::BOARD_LOAD_TEST_CASE
class	KI_TEST::CAPTURING_REPORTER
	Custom REPORTER that captures all messages for later analysis in the unit test framework. More...
struct	KI_TEST::CAPTURING_REPORTER::MESSAGE
class	KI_TEST::CACHED_BOARD_LOADER
	Manager for caching loaded boards in memory, to avoid repeatedly loading and parsing the same board. More...

Namespaces
namespace	KI_TEST

Functions
void	KI_TEST::LoadBoard (SETTINGS_MANAGER &aSettingsManager, const wxString &aRelPath, std::unique_ptr< BOARD > &aBoard)
BOARD_ITEM &	KI_TEST::RequireBoardItemWithTypeAndId (const BOARD &aBoard, KICAD_T aItemType, const KIID &aID)
	Get an item from the given board with a certain type and UUID.
void	KI_TEST::LoadAndTestBoardFile (const wxString aRelativePath, bool aRoundtrip, std::function< void(BOARD &)> aBoardTestFunction, std::optional< int > aExpectedBoardVersion=std::nullopt)
	Perform "some test" on a board file loaded from the path, then optionally save and reload and run the test again.
void	KI_TEST::LoadAndTestFootprintFile (const wxString &aLibRelativePath, const wxString &aFpName, bool aRoundtrip, std::function< void(FOOTPRINT &)> aFootprintTestFunction, std::optional< int > aExpectedFootprintVersion)
	Same as LoadAndTestBoardFile, but for footprints.
void	KI_TEST::FillZones (BOARD *m_board)
void	KI_TEST::CheckFootprint (const FOOTPRINT *expected, const FOOTPRINT *fp)
	Helper method to check if two footprints are semantically the same.
void	KI_TEST::CheckFpPad (const PAD *expected, const PAD *pad)
void	KI_TEST::CheckFpText (const PCB_TEXT *expected, const PCB_TEXT *text)
void	KI_TEST::CheckFpShape (const PCB_SHAPE *expected, const PCB_SHAPE *shape)
void	KI_TEST::CheckFpZone (const ZONE *expected, const ZONE *zone)
void	KI_TEST::CheckShapePolySet (const SHAPE_POLY_SET *expected, const SHAPE_POLY_SET *polyset)
void	KI_TEST::PrintBoardStats (const BOARD *aBoard, const std::string &aBoardName)
	Print detailed board statistics for debugging using test-framework logging.
std::unique_ptr< BOARD >	KI_TEST::LoadBoardWithCapture (PCB_IO &aIoPlugin, const std::string &aFilePath, REPORTER *aReporter)
	Attempt to load an board with a given IO plugin, capturing all reporter messages.