KiCad PCB EDA Suite
eeschema_test_utils.h
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-2022 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#ifndef QA_EESCHEMA_EESCHEMA_TEST_UTILS__H
25#define QA_EESCHEMA_EESCHEMA_TEST_UTILS__H
26
27
28#include <schematic.h>
30#include <sch_io_mgr.h>
31#include <wx/filename.h>
32
33#include <connection_graph.h>
38#include <project.h>
39#include <sch_io_mgr.h>
40#include <sch_sheet.h>
41#include <schematic.h>
44
45namespace KI_TEST
46{
55wxFileName GetEeschemaTestDataDir();
56
61{
62public:
64 : m_schematic( nullptr ),
65 m_pi( SCH_IO_MGR::FindPlugin( SCH_IO_MGR::SCH_KICAD ) ),
66 m_manager( true )
67 {
68 }
69
71 {
74 }
75
76protected:
77 virtual void LoadSchematic( const wxString& aRelativePath );
78 virtual wxFileName GetSchematicPath( const wxString& aBaseName );
79
82
84
86};
87
88
89} // namespace KI_TEST
90
91
92template <typename Exporter>
94{
95public:
96 virtual wxString GetNetlistPath( bool aTest = false );
97 virtual unsigned GetNetlistOptions() { return 0; }
98
99 void WriteNetlist();
100
101 virtual void CompareNetlists() = 0;
102
103 void Cleanup();
104
105 void TestNetlist( const wxString& aBaseName );
106};
107
108#endif // QA_EESCHEMA_EESCHEMA_TEST_UTILS__H
A generic fixture for loading schematics and associated settings for qa tests.
virtual void LoadSchematic(const wxString &aRelativePath)
SCHEMATIC m_schematic
ā€¨Schematic to load
virtual wxFileName GetSchematicPath(const wxString &aBaseName)
Holds all the data relating to one schematic.
Definition: schematic.h:60
void Reset()
Initialize this schematic to a blank one, unloading anything existing.
Definition: schematic.cpp:51
A factory which returns an instance of a SCH_PLUGIN.
Definition: sch_io_mgr.h:48
static void ReleasePlugin(SCH_PLUGIN *aPlugin)
Release a SCH_PLUGIN back to the system, and may cause it to be unloaded from memory.
Definition: sch_io_mgr.cpp:69
Base class that schematic file and library loading and saving plugins should derive from.
Definition: sch_io_mgr.h:153
void TestNetlist(const wxString &aBaseName)
virtual void CompareNetlists()=0
virtual unsigned GetNetlistOptions()
virtual wxString GetNetlistPath(bool aTest=false)
wxFileName GetEeschemaTestDataDir()
Get the configured location of Eeschema test data.
Definition of file extensions used in Kicad.