API_SERVER_E2E_FIXTURE Class Reference

Per-test fixture for API E2E tests. More...

#include <api_e2e_utils.h>

Public Member Functions
	API_SERVER_E2E_FIXTURE ()
	~API_SERVER_E2E_FIXTURE ()
bool	Start (const wxString &aCliPathOverride=wxString())
API_TEST_CLIENT &	Client ()
wxString	CliPath () const
const wxString &	LastError () const

Private Attributes
wxString	m_cliPath
wxString	m_lastError

Detailed Description

Per-test fixture for API E2E tests.

All tests share a single api-server process and NNG client managed by API_SERVER_MANAGER. The server and client are created on the first test's Start() call and remain alive for all subsequent tests in the module.

If the server crashed during a previous test, Start() automatically restarts it.

Definition at line 682 of file api_e2e_utils.h.

Constructor & Destructor Documentation

API_SERVER_E2E_FIXTURE()

API_SERVER_E2E_FIXTURE::API_SERVER_E2E_FIXTURE ( )

inline

Definition at line 685 of file api_e2e_utils.h.

References m_cliPath, and QA_KICAD_CLI_PATH.

~API_SERVER_E2E_FIXTURE()

API_SERVER_E2E_FIXTURE::~API_SERVER_E2E_FIXTURE ( )

inline

Definition at line 690 of file api_e2e_utils.h.

References API_SERVER_MANAGER::Client(), API_TEST_CLIENT::CloseAllDocuments(), and API_SERVER_MANAGER::Instance().

Member Function Documentation

Client()

API_TEST_CLIENT & API_SERVER_E2E_FIXTURE::Client ( )

inline

Definition at line 710 of file api_e2e_utils.h.

References API_SERVER_MANAGER::Client(), and API_SERVER_MANAGER::Instance().

CliPath()

wxString API_SERVER_E2E_FIXTURE::CliPath ( ) const

inline

Definition at line 712 of file api_e2e_utils.h.

References m_cliPath.

LastError()

const wxString & API_SERVER_E2E_FIXTURE::LastError ( ) const

inline

Definition at line 714 of file api_e2e_utils.h.

References m_lastError.

Start()

bool API_SERVER_E2E_FIXTURE::Start ( const wxString & aCliPathOverride = wxString() )

inline

Definition at line 695 of file api_e2e_utils.h.

References API_SERVER_MANAGER::EnsureReady(), API_SERVER_MANAGER::Instance(), m_cliPath, m_lastError, and API_SERVER_MANAGER::Reset().

Member Data Documentation

m_cliPath

wxString API_SERVER_E2E_FIXTURE::m_cliPath

private

Definition at line 717 of file api_e2e_utils.h.

Referenced by API_SERVER_E2E_FIXTURE(), CliPath(), and Start().

m_lastError

wxString API_SERVER_E2E_FIXTURE::m_lastError

private

Definition at line 718 of file api_e2e_utils.h.

Referenced by LastError(), and Start().

---

The documentation for this class was generated from the following file:

• api_e2e_utils.h