board_test_utils.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright The 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, see <https://www.gnu.org/licenses/>.
 */
 
 
#pragma once
 
#include <filesystem>
#include <map>
#include <memory>
#include <mutex>
#include <functional>
#include <optional>
#include <set>
#include <string>
#include <system_error>
 
#include <wx/string.h>
 
#include <boost/test/unit_test.hpp>
 
#include <reporter.h>
#include <core/typeinfo.h>
#include <tool/tool_manager.h>
#include <pcb_io/pcb_io.h>
#include <pcb_track_types.h>
 
#include <pcbnew_utils/board_file_utils.h>
 
class BOARD;
class BOARD_ITEM;
class FOOTPRINT;
class KIID;
class PCB_TEXT;
class PCB_SHAPE;
class ZONE;
class PAD;
class SHAPE_POLY_SET;
class SETTINGS_MANAGER;
 
 
/*
 * Boost test printers
 */
std::ostream& boost_test_print_type( std::ostream& os, const VIATYPE& aViaType );
 
 
namespace KI_TEST
{
class DUMMY_TOOL : public TOOL_BASE
{
public:
    DUMMY_TOOL() :
        TOOL_BASE( BATCH, TOOL_MANAGER::MakeToolId( "" ), "testframework.dummytool" )
    {};
 
    void Reset( RESET_REASON aReason ) override {}
};
 

class TEMPORARY_DIRECTORY
{
public:
    TEMPORARY_DIRECTORY( const std::string& aNamePrefix, const std::string aSuffix )
    {
        int i = 0;
 
        // Find a unique directory name
        while( true )
        {
            m_path = std::filesystem::temp_directory_path()
                     / ( aNamePrefix + std::to_string( i ) + aSuffix );
 
            if( !std::filesystem::exists( m_path ) )
                break;
 
            i++;
        }
 
        wxASSERT( !std::filesystem::exists( m_path ) );
        std::filesystem::create_directories( m_path );
    }
 
    ~TEMPORARY_DIRECTORY() { std::filesystem::remove_all( m_path ); }
 
    const std::filesystem::path& GetPath() const { return m_path; }
 
private:
    std::filesystem::path m_path;
};
 

class STALE_DRU_SIDECAR_FIXTURE
{
public:
    STALE_DRU_SIDECAR_FIXTURE() : m_preexisting( scan() ) {}
 
    ~STALE_DRU_SIDECAR_FIXTURE()
    {
        std::error_code ec;
 
        for( const std::string& path : scan() )
        {
            if( m_preexisting.count( path ) == 0 )
                std::filesystem::remove( path, ec );
        }
    }
 
private:
    static std::set<std::string> scan()
    {
        std::set<std::string> found;
        std::error_code       ec;
 
        for( auto it = std::filesystem::recursive_directory_iterator( GetPcbnewTestDataDir(), ec );
             !ec && it != std::filesystem::recursive_directory_iterator(); it.increment( ec ) )
        {
            if( it->path().extension() == ".kicad_dru" )
                found.insert( it->path().string() );
        }
 
        return found;
    }
 
    std::set<std::string> m_preexisting;
};
 

class BOARD_DUMPER
{
public:
    BOARD_DUMPER();
 
    void DumpBoardToFile( BOARD& aBoard, const std::string& aName ) const;
 
    const bool m_dump_boards;
};
 
 
class CONSOLE_LOG
{
public:
    enum COLOR
    {
        RED = 0,
        GREEN,
        DEFAULT
    };
 
    CONSOLE_LOG(){};
 
    const wxString& GetLogContents() const 
    {
        return m_logContents;
    }
 
    void PrintProgress( const wxString& aMessage )
    {
        if ( m_silenceConsoleOutput )
            return;
 
        if( m_lastLineIsProgressBar )
            eraseLastLine();
 
        printf( "%s", (const char*) aMessage.c_str() );
        fflush( stdout );
 
        m_lastLineIsProgressBar = true;
    }
 
 
    void Print( const wxString& aMessage )
    {
        if( m_lastLineIsProgressBar )
            eraseLastLine();
 
        if( !m_silenceConsoleOutput )
        {
        printf( "%s", (const char*) aMessage.c_str() );
        fflush( stdout );
        }
 
        m_logContents.append( aMessage );
        m_lastLineIsProgressBar = false;
    }
 
 
    void SetColor( COLOR color )
    {
        if ( m_silenceConsoleOutput )
            return;
 
        std::map<COLOR, wxString> colorMap =
        {
            { RED, "\033[0;31m" },
                                               { GREEN, "\033[0;32m" },
            { DEFAULT, "\033[0;37m" }
        };
 
        printf( "%s", (const char*) colorMap[color].c_str() );
        fflush( stdout );
    }
 
 
private:
    void eraseLastLine()
    {
        if ( m_silenceConsoleOutput )
            return;
 
        printf( "\r\033[K" );
        fflush( stdout );
    }
 
    bool m_silenceConsoleOutput = true;
    bool       m_lastLineIsProgressBar = false;
    std::mutex m_lock;
    wxString m_logContents;
};
 
 
class CONSOLE_MSG_REPORTER : public REPORTER
{
public:
    CONSOLE_MSG_REPORTER( CONSOLE_LOG* log ) : m_log( log ){};
    ~CONSOLE_MSG_REPORTER(){};
 
 
    virtual REPORTER& Report( const wxString& aText,
                              SEVERITY        aSeverity = RPT_SEVERITY_UNDEFINED ) override
    {
        switch( aSeverity )
        {
        case RPT_SEVERITY_ERROR:
            m_log->SetColor( CONSOLE_LOG::RED );
            m_log->Print( "ERROR | " );
            break;
 
        default: m_log->SetColor( CONSOLE_LOG::DEFAULT ); m_log->Print( "      | " );
        }
 
        m_log->SetColor( CONSOLE_LOG::DEFAULT );
        m_log->Print( aText + "\n" );
        return *this;
    }
 
    virtual bool HasMessage() const override { return true; }
 
private:
    CONSOLE_LOG* m_log;
};
 
 
struct BOARD_LOAD_TEST_CASE
{
    wxString m_BoardFileRelativePath;
 
    // These tests may well test specific versions of the board file format,
    // so don't let it change accidentally in the files (e.g. by resaving in newer KiCad)!
    std::optional<int> m_ExpectedBoardVersion;
 
    // Be default, printing the board file is sufficent to identify the test case
    friend std::ostream& operator<<( std::ostream& os, const BOARD_LOAD_TEST_CASE& aTestCase )
    {
        os << aTestCase.m_BoardFileRelativePath;
        return os;
    }
};
 
 
void LoadBoard( SETTINGS_MANAGER& aSettingsManager, const wxString& aRelPath,
                std::unique_ptr<BOARD>& aBoard );

BOARD_ITEM& RequireBoardItemWithTypeAndId( const BOARD& aBoard, KICAD_T aItemType,
                                           const KIID& aID );

void LoadAndTestBoardFile( const wxString aRelativePath, bool aRoundtrip,
                           std::function<void( BOARD& )> aBoardTestFunction,
                           std::optional<int> aExpectedBoardVersion = std::nullopt );

void LoadAndTestFootprintFile( const wxString& aLibRelativePath, const wxString& aFpName,
                               bool                              aRoundtrip,
                               std::function<void( FOOTPRINT& )> aFootprintTestFunction,
                               std::optional<int>                aExpectedFootprintVersion );
 
 
void FillZones( BOARD* m_board );
 

void CheckFootprint( const FOOTPRINT* expected, const FOOTPRINT* fp );
 
void CheckFpPad( const PAD* expected, const PAD* pad );
 
void CheckFpText( const PCB_TEXT* expected, const PCB_TEXT* text );
 
void CheckFpShape( const PCB_SHAPE* expected, const PCB_SHAPE* shape );
 
void CheckFpZone( const ZONE* expected, const ZONE* zone );
 
void CheckShapePolySet( const SHAPE_POLY_SET* expected, const SHAPE_POLY_SET* polyset );

void PrintBoardStats( const BOARD* aBoard, const std::string& aBoardName );
 

class CAPTURING_REPORTER : public REPORTER
{
public:
    struct MESSAGE
    {
        wxString text;
        SEVERITY severity = RPT_SEVERITY_UNDEFINED;
    };
 
    CAPTURING_REPORTER() :
            m_errorCount( 0 ),
            m_warningCount( 0 ),
            m_infoCount( 0 )
    {
    }
 
    REPORTER& Report( const wxString& aText, SEVERITY aSeverity = RPT_SEVERITY_UNDEFINED ) override;
 
    bool HasMessage() const override { return !m_messages.empty(); }
 
    EDA_UNITS GetUnits() const override { return EDA_UNITS::MM; }
 
    void Clear() override
    {
        m_messages.clear();
        m_errorCount = 0;
        m_warningCount = 0;
        m_infoCount = 0;
    }
 
    void PrintAllMessages( const std::string& aContext ) const;
 
    int                         GetErrorCount() const { return m_errorCount; }
    int                         GetWarningCount() const { return m_warningCount; }
    const std::vector<MESSAGE>& GetMessages() const { return m_messages; }
 
private:
    std::vector<MESSAGE> m_messages;
    int                  m_errorCount;
    int                  m_warningCount;
    int                  m_infoCount;
};
 

std::unique_ptr<BOARD> LoadBoardWithCapture( PCB_IO& aIoPlugin, const std::string& aFilePath, REPORTER* aReporter );
 

class CACHED_BOARD_LOADER
{
public:
    BOARD* LoadAndCache( const std::string& aFilePath, REPORTER* aReporter );

    BOARD* GetCachedBoard( const std::string& aFilePath );
 
protected:
    BOARD* getCachedBoard( PCB_IO& aIoPlugin, const std::string& aFilePath, bool aForceReload, REPORTER* aReporter );

    virtual BOARD* getCachedBoard( const std::string& aFilePath, bool aForceReload, REPORTER* aReporter ) = 0;
 
private:
    std::map<std::string, std::unique_ptr<BOARD>> m_boardCache;
};
 
} // namespace KI_TEST