qa_common: Cleanup mocks

Use mocks of KIFACE and PGM from Turtle framework
This commit is contained in:
Sylwester Kocjan 2022-02-06 20:39:13 +01:00 committed by Seth Hillbrand
parent a9c2a59049
commit aa7b65c70d
5 changed files with 104 additions and 34 deletions

View File

@ -23,7 +23,7 @@ find_package( wxWidgets 3.0.0 COMPONENTS gl aui adv html core net base xml stc R
set( common_srcs
# This is needed for the global mock objects
common_mocks.cpp
${CMAKE_SOURCE_DIR}/qa/mocks/kicad/common_mocks.cpp
# The main test entry points
test_module.cpp
@ -71,6 +71,8 @@ include_directories(
${CMAKE_SOURCE_DIR}
${CMAKE_SOURCE_DIR}/pcbnew
${CMAKE_SOURCE_DIR}/include
${CMAKE_SOURCE_DIR}/qa/mocks/pcbnew
${CMAKE_SOURCE_DIR}/qa/mocks/include
${INC_AFTER}
)

View File

@ -0,0 +1,37 @@
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2019-2022 KiCad Developers, see CHANGELOG.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
*/
#pragma once
#include <qa_utils/wx_utils/unit_test_utils.h>
#include <kiface_base.h>
MOCK_BASE_CLASS( MOCK_KIFACE_BASE, KIFACE_BASE )
{
MOCK_KIFACE_BASE() : KIFACE_BASE( "common_test", KIWAY::KIWAY_FACE_COUNT ) {};
virtual ~MOCK_KIFACE_BASE() {};
MOCK_METHOD( OnKifaceStart, 2, bool( PGM_BASE*, int ) );
MOCK_METHOD( OnKifaceEnd, 0, void() );
MOCK_METHOD( CreateWindow, 4, wxWindow*( wxWindow*, int, KIWAY*, int ) );
MOCK_METHOD( IfaceOrAddress, 1, void*( int ) );
};

View File

@ -0,0 +1,57 @@
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2019-2022 KiCad Developers, see CHANGELOG.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
*/
#pragma once
#include <qa_utils/wx_utils/unit_test_utils.h>
#include <pgm_base.h>
MOCK_BASE_CLASS( MOCK_PGM_BASE, PGM_BASE )
{
MOCK_PGM_BASE() : PGM_BASE() {};
virtual ~MOCK_PGM_BASE() {};
MOCK_METHOD( MacOpenFile, 1, void( const wxString& ) );
MOCK_METHOD( GetSettingsManager, 0, SETTINGS_MANAGER&() );
MOCK_METHOD( GetCommonSettings, 0, COMMON_SETTINGS*() );
MOCK_METHOD( SetTextEditor, 1, void( const wxString& ) );
MOCK_METHOD( GetTextEditor, 1, wxString&( bool ) );
MOCK_METHOD( AskUserForPreferredEditor, 1, wxString&( wxString& ) );
MOCK_CONST_METHOD( IsKicadEnvVariableDefined, 0, bool() );
MOCK_CONST_METHOD( GetKicadEnvVariable, 0, const wxString&() );
MOCK_CONST_METHOD( GetExecutablePath, 0, const wxString&() );
MOCK_METHOD( GetLocale, 0, wxLocale*() );
MOCK_CONST_METHOD( GetPdfBrowserName, 0, const wxString&() );
MOCK_METHOD( SetPdfBrowserName, 1, void( const wxString& ) );
MOCK_CONST_METHOD( UseSystemPdfBrowser, 0, bool() );
MOCK_METHOD( ForceSystemPdfBrowser, 1, void( bool ) );
MOCK_METHOD( SetLanguage, 2, bool( wxString&, bool ) );
MOCK_METHOD( SetLanguageIdentifier, 1, void( int ) );
MOCK_CONST_METHOD( GetSelectedLanguageIdentifier, 0, int() );
MOCK_METHOD( SetLanguagePath, 0, void() );
MOCK_METHOD( ReadPdfBrowserInfos, 0, void() );
MOCK_METHOD( WritePdfBrowserInfos, 0, void() );
MOCK_METHOD( SetLocalEnvVariable, 2, bool( const wxString&, const wxString& ) );
MOCK_METHOD( SetLocalEnvVariables, 0, void() );
MOCK_CONST_METHOD( GetLocalEnvVariables, 0, ENV_VAR_MAP&() );
MOCK_METHOD( App, 0, wxApp&() );
};

View File

@ -23,49 +23,22 @@
/**
* @file common_mocks.cpp
* @brief Mock objects for libcommon unit tests
* @brief Mock objects for unit tests
*/
#include <pgm_base.h>
#include <kiface_base.h>
#include <mock_kiface_base.h>
#include <mock_pgm_base.h>
struct PGM_TEST_FRAME : public PGM_BASE
{
void MacOpenFile( const wxString& aFileName ) override
{}
};
PGM_BASE& Pgm()
{
static PGM_TEST_FRAME program;
static MOCK_PGM_BASE program;
return program;
}
static struct IFACE : public KIFACE_BASE
{
bool OnKifaceStart( PGM_BASE* aProgram, int aCtlBits ) override
{
return start_common( aCtlBits );
}
wxWindow* CreateWindow( wxWindow* aParent, int aClassId, KIWAY* aKiway, int aCtlBits = 0 ) override
{
return nullptr;
}
void* IfaceOrAddress( int aDataId ) override
{
return nullptr;
}
IFACE( const char* aDSOname, KIWAY::FACE_T aType ) :
KIFACE_BASE( aDSOname, aType )
{}
} kiface( "common_test", KIWAY::KIWAY_FACE_COUNT );
KIFACE_BASE& Kiface()
{
static MOCK_KIFACE_BASE kiface;
return kiface;
}
}

View File

@ -43,6 +43,7 @@ include_directories( BEFORE ${INC_BEFORE} )
target_link_libraries( qa_utils
common
turtle
${Boost_UNIT_TEST_FRAMEWORK_LIBRARY}
${Boost_FILESYSTEM_LIBRARY}
${Boost_SYSTEM_LIBRARY}