eeschema_test_utils.cpp

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2019-2022 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, you may find one here:
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * or you may search the http://www.gnu.org website for the version 2 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
 */
 
#include "eeschema_test_utils.h"
#include <qa_utils/wx_utils/unit_test_utils.h>
#include <wildcards_and_files_ext.h>
 
#include <cstdlib>
#include <memory>
 
#include <eeschema/sch_io_mgr.h>
#include <eeschema/sch_screen.h>
#include <eeschema/schematic.h>
#include <eeschema/connection_graph.h>
 
 
#ifndef QA_EESCHEMA_DATA_LOCATION
 #define QA_EESCHEMA_DATA_LOCATION "???"
#endif
 
wxFileName KI_TEST::GetEeschemaTestDataDir()
{
 const char* env = std::getenv( "KICAD_TEST_EESCHEMA_DATA_DIR" );
 wxString fn;
 
 if( !env )
 {
 // Use the compiled-in location of the data dir
 // (i.e. where the files were at build time)
 fn << QA_EESCHEMA_DATA_LOCATION;
 }
 else
 {
 // Use whatever was given in the env var
 fn << env;
 }
 
 // Ensure the string ends in / to force a directory interpretation
 fn << "/";
 
 return wxFileName{ fn };
}
 
 
void KI_TEST::SCHEMATIC_TEST_FIXTURE::LoadSchematic( const wxString& aBaseName )
{
 wxFileName fn = GetSchematicPath( aBaseName );
 
 BOOST_TEST_MESSAGE( fn.GetFullPath() );
 
 wxFileName pro( fn );
 pro.SetExt( ProjectFileExtension );
 
 // Schematic must be reset before a project is reloaded
 m_schematic.Reset();
 m_manager.LoadProject( pro.GetFullPath() );
 
 m_manager.Prj().SetElem( PROJECT::ELEM_SCH_SYMBOL_LIBS, nullptr );
 
 m_schematic.SetProject( &m_manager.Prj() );
 m_schematic.SetRoot( m_pi->Load( fn.GetFullPath(), &m_schematic ) );
 
 BOOST_REQUIRE_EQUAL( m_pi->GetError().IsEmpty(), true );
 
 m_schematic.CurrentSheet().push_back( &m_schematic.Root() );
 
 SCH_SCREENS screens( m_schematic.Root() );
 
 for( SCH_SCREEN* screen = screens.GetFirst(); screen; screen = screens.GetNext() )
 screen->UpdateLocalLibSymbolLinks();
 
 SCH_SHEET_LIST sheets = m_schematic.GetSheets();
 
 // Restore all of the loaded symbol instances from the root sheet screen.
 if( m_schematic.RootScreen()->GetFileFormatVersionAtLoad() < 20221002 )
 sheets.UpdateSymbolInstances( m_schematic.RootScreen()->GetSymbolInstances() );
 
 if( m_schematic.RootScreen()->GetFileFormatVersionAtLoad() < 20221110 )
 sheets.UpdateSheetInstances( m_schematic.RootScreen()->GetSheetInstances() );
 
 sheets.AnnotatePowerSymbols();
 
 // NOTE: This is required for multi-unit symbols to be correct
 // Normally called from SCH_EDIT_FRAME::FixupJunctions() but could be refactored
 for( SCH_SHEET_PATH& sheet : sheets )
 sheet.UpdateAllScreenReferences();
 
 // NOTE: SchematicCleanUp is not called; QA schematics must already be clean or else
 // SchematicCleanUp must be freed from its UI dependencies.
 
 m_schematic.ConnectionGraph()->Recalculate( sheets, true );
}
 
 
wxFileName KI_TEST::SCHEMATIC_TEST_FIXTURE::GetSchematicPath( const wxString& aBaseName )
{
 wxFileName fn = KI_TEST::GetEeschemaTestDataDir();
 fn.AppendDir( "netlists" );
 fn.AppendDir( aBaseName );
 fn.SetName( aBaseName );
 fn.SetExt( KiCadSchematicFileExtension );
 
 return fn;
}
 
 
template <typename Exporter>
wxString TEST_NETLIST_EXPORTER_FIXTURE<Exporter>::GetNetlistPath( bool aTest )
{
 wxFileName netFile = m_schematic.Prj().GetProjectFullName();
 
 if( aTest )
 netFile.SetName( netFile.GetName() + "_test" );
 
 netFile.SetExt( NetlistFileExtension );
 
 return netFile.GetFullPath();
}
 
 
template <typename Exporter>
void TEST_NETLIST_EXPORTER_FIXTURE<Exporter>::WriteNetlist()
{
 // In case of a crash the file may not have been deleted.
 if( wxFileExists( GetNetlistPath( true ) ) )
 wxRemoveFile( GetNetlistPath( true ) );
 
 wxString errors;
 WX_STRING_REPORTER reporter( &errors );
 std::unique_ptr<Exporter> exporter = std::make_unique<Exporter>( &m_schematic );
 
 bool success = exporter->WriteNetlist( GetNetlistPath( true ), GetNetlistOptions(), reporter );
 
 BOOST_REQUIRE( success && errors.IsEmpty() );
}
 
 
template <typename Exporter>
void TEST_NETLIST_EXPORTER_FIXTURE<Exporter>::Cleanup()
{
 wxRemoveFile( GetNetlistPath( true ) );
 m_schematic.Reset();
}
 
 
template <typename Exporter>
void TEST_NETLIST_EXPORTER_FIXTURE<Exporter>::TestNetlist( const wxString& aBaseName )
{
 LoadSchematic( aBaseName );
 WriteNetlist();
 CompareNetlists();
 Cleanup();
}
 
 
template class TEST_NETLIST_EXPORTER_FIXTURE<NETLIST_EXPORTER_KICAD>;
template class TEST_NETLIST_EXPORTER_FIXTURE<NETLIST_EXPORTER_SPICE>;