22#include <boost/test/unit_test.hpp>
28#include <api/common/commands/editor_commands.pb.h>
29#include <api/common/envelope.pb.h>
30#include <api/common/tasks.pb.h>
32#include <api/schematic/schematic_tasks.pb.h>
33#include <api/schematic/schematic_types.pb.h>
51struct API_HANDLER_SCH_FIXTURE
53 SETTINGS_MANAGER m_settingsManager;
54 std::unique_ptr<SCHEMATIC> m_schematic;
56 std::shared_ptr<HEADLESS_SCH_CONTEXT> m_context;
58 SCHEMATIC* loadSchematic(
const wxString& aRelPath )
61 m_schematicSlot = m_schematic.get();
62 m_context = std::make_shared<HEADLESS_SCH_CONTEXT>( &m_schematicSlot,
63 &m_settingsManager.Prj() );
64 return m_schematic.get();
69kiapi::common::types::DocumentSpecifier makeDocument(
const SCHEMATIC& aSchematic )
71 kiapi::common::types::DocumentSpecifier document;
72 document.set_type( kiapi::common::types::DocumentType::DOCTYPE_SCHEMATIC );
79kiapi::common::ApiRequest makeBeginCommitRequest(
const SCHEMATIC& aSchematic )
81 kiapi::common::commands::BeginCommit command;
82 *command.mutable_header()->mutable_document() = makeDocument( aSchematic );
84 kiapi::common::ApiRequest request;
85 request.mutable_header()->set_client_name(
"kicad.qa" );
86 BOOST_REQUIRE( request.mutable_message()->PackFrom( command ) );
92kiapi::common::ApiRequest makeRevertRequest(
const SCHEMATIC& aSchematic )
94 kiapi::common::commands::RevertDocument command;
95 *command.mutable_document() = makeDocument( aSchematic );
97 kiapi::common::ApiRequest request;
98 request.mutable_header()->set_client_name(
"kicad.qa" );
99 BOOST_REQUIRE( request.mutable_message()->PackFrom( command ) );
105kiapi::common::ApiRequest makeStartErcTaskRequest(
const SCHEMATIC& aSchematic )
107 kiapi::schematic::tasks::StartErcTask command;
108 *command.mutable_document() = makeDocument( aSchematic );
110 kiapi::common::ApiRequest request;
111 request.mutable_header()->set_client_name(
"kicad.qa" );
112 BOOST_REQUIRE( request.mutable_message()->PackFrom( command ) );
118kiapi::common::ApiRequest makeGetErcTaskResultRequest(
const std::string& aToken )
120 kiapi::schematic::tasks::GetErcTaskResult command;
121 command.mutable_token()->set_value( aToken );
123 kiapi::common::ApiRequest request;
124 request.mutable_header()->set_client_name(
"kicad.qa" );
125 BOOST_REQUIRE( request.mutable_message()->PackFrom( command ) );
134BOOST_FIXTURE_TEST_SUITE( ApiHandlerSch, API_HANDLER_SCH_FIXTURE )
143 kiapi::common::ApiRequest beginRequest = makeBeginCommitRequest( *
schematic );
146 kiapi::common::ApiRequest request = makeRevertRequest( *
schematic );
151 BOOST_CHECK(
result.error().error_message().find(
"commit" ) != std::string::npos );
160 schematic::types::SheetSymbol sheet;
162 sheet.mutable_id()->set_value(
id.AsStdString() );
163 sheet.mutable_name_field()->mutable_text()->set_text(
"RejectedSheet" );
164 sheet.mutable_filename_field()->mutable_text()->set_text(
"rejected.kicad_sch" );
165 sheet.set_page_number(
"999" );
166 auto* field = sheet.add_user_fields();
167 field->set_name(
"Reference Suffix" );
168 field->mutable_text()->set_text(
"_M1" );
169 auto* variant = sheet.mutable_variants()->add_variants();
170 variant->set_name(
"rejected-variant" );
171 ( *variant->mutable_fields() )[
"Reference Suffix"] =
"_M2";
172 variant->set_dnp(
true );
174 commands::CreateItems command;
175 *command.mutable_header()->mutable_document() = makeDocument( *
model );
178 request.mutable_header()->set_client_name(
"kicad.qa" );
179 BOOST_REQUIRE( request.mutable_message()->PackFrom( command ) );
183 commands::CreateItemsResponse response;
186 BOOST_CHECK_EQUAL( response.created_items( 0 ).status().code(), commands::ISC_INVALID_DATA );
196 BOOST_REQUIRE_GE(
model->Hierarchy().size(), 2 );
201 const wxString originalName = original->
GetName();
204 schematic::types::SheetSymbol sheet;
206 sheet.mutable_name_field()->mutable_text()->set_text(
"RejectedName" );
207 sheet.set_page_number(
"999" );
208 auto* field = sheet.add_user_fields();
209 field->set_name(
"Reference Suffix" );
210 field->mutable_text()->set_text(
"_M1" );
211 auto* variant = sheet.mutable_variants()->add_variants();
212 variant->set_name(
"rejected-variant" );
213 ( *variant->mutable_fields() )[
"Reference Suffix"] =
"_M2";
215 commands::UpdateItems command;
216 *command.mutable_header()->mutable_document() = makeDocument( *
model );
219 request.mutable_header()->set_client_name(
"kicad.qa" );
220 BOOST_REQUIRE( request.mutable_message()->PackFrom( command ) );
224 commands::UpdateItemsResponse response;
227 BOOST_CHECK_EQUAL( response.updated_items( 0 ).status().code(), commands::ISC_INVALID_DATA );
238 commands::CreateItems command;
239 *command.mutable_header()->mutable_document() = makeDocument( *
model );
240 std::vector<KIID> ids( 3 );
242 for(
int i = 0; i < 3; ++i )
244 schematic::types::SheetSymbol sheet;
245 sheet.mutable_id()->set_value( ids[i].AsStdString() );
246 sheet.mutable_name_field()->mutable_text()->set_text(
"Sheet" + std::to_string( i ) );
247 sheet.mutable_filename_field()->mutable_text()->set_text(
"batch" + std::to_string( i ) +
".kicad_sch" );
248 sheet.set_page_number( std::to_string( 20 + i ) );
249 auto* suffix = sheet.add_user_fields();
250 suffix->set_name(
"Reference Suffix" );
251 suffix->mutable_text()->set_text(
"_M1" );
252 auto* field = sheet.add_user_fields();
253 field->set_name(
"Channel" );
254 field->mutable_text()->set_text(
"base" );
255 auto* variant = sheet.mutable_variants()->add_variants();
256 variant->set_name(
"batch-variant-" + std::to_string( i ) );
257 variant->set_dnp(
true );
258 ( *variant->mutable_fields() )[
"Channel"] =
"override";
261 ( *variant->mutable_fields() )[
"Reference Suffix"] =
"_M2";
267 request.mutable_header()->set_client_name(
"kicad.qa" );
268 BOOST_REQUIRE( request.mutable_message()->PackFrom( command ) );
271 commands::CreateItemsResponse response;
278 for(
int i = 0; i < 3; ++i )
280 const wxString variantName = wxString::Format( wxS(
"batch-variant-%d" ), i );
281 auto* sheet =
dynamic_cast<SCH_SHEET*
>(
model->Hierarchy().ResolveItem( ids[i],
nullptr,
true ) );
283 i == 1 ? commands::ISC_INVALID_DATA : commands::ISC_OK );
293 BOOST_CHECK( sheet->GetDNP( &parent, variantName ) );
294 BOOST_CHECK( sheet->GetFieldText( wxS(
"Channel" ), &parent, variantName ) == wxS(
"override" ) );
295 schematic::types::SheetSymbol stored;
307 ApiRequest beginRequest = makeBeginCommitRequest( *
schematic );
310 commands::CreateItems command;
311 command.mutable_header()->mutable_document()->CopyFrom( makeDocument( *
schematic ) );
313 schematic::types::SchematicLine line;
314 line.mutable_id()->set_value(
"83618809-06d6-4cbe-ba0e-ec60fe58921c" );
315 line.set_type( schematic::types::SchematicLineType::SLT_WIRE );
316 line.add_custom_properties()->set_key(
"linE Width" );
317 line.add_custom_properties()->set_key(
"start X" );
322 request.mutable_header()->set_client_name(
"kicad.qa" );
323 BOOST_REQUIRE( request.mutable_message()->PackFrom( command ) );
328 commands::CreateItemsResponse response;
332 const commands::ItemStatus& status = response.created_items( 0 ).status();
335 BOOST_CHECK_EQUAL( status.code(), kiapi::common::commands::ItemStatusCode::ISC_INVALID_DATA );
336 BOOST_CHECK_NE( status.error_message().find(
"Invalid custom properties" ), std::string::npos );
345 ApiRequest beginRequest = makeBeginCommitRequest( *
schematic );
348 commands::CreateItems command;
349 command.mutable_header()->mutable_document()->CopyFrom( makeDocument( *
schematic ) );
351 schematic::types::SchematicSymbolInstance symbol;
352 symbol.mutable_id()->set_value(
"f8688bac-2fcb-4184-ab0e-0cf46a139c43" );
353 symbol.mutable_transform()->set_orientation( schematic::types::SchematicSymbolOrientation::SSO_0 );
355 symbol.mutable_definition()->mutable_id()->set_entry_name(
"R" );
357 schematic::types::SchematicField* field = symbol.add_user_fields();
358 field->set_name(
"MPN" );
359 field->mutable_text()->set_text(
"123" );
361 types::CustomProperty* prop = symbol.add_custom_properties();
362 prop->set_key(
"MPN" );
363 prop->set_value(
"456" );
368 request.mutable_header()->set_client_name(
"kicad.qa" );
369 BOOST_REQUIRE( request.mutable_message()->PackFrom( command ) );
374 commands::CreateItemsResponse response;
378 const commands::ItemStatus& status = response.created_items( 0 ).status();
381 BOOST_CHECK_EQUAL( status.code(), kiapi::common::commands::ItemStatusCode::ISC_INVALID_DATA );
382 BOOST_CHECK_NE( status.error_message().find(
"MPN" ), std::string::npos );
389 SCHEMATIC*
model = loadSchematic( wxS(
"net_chains_four_nets_labeled" ) );
390 const auto path =
model->Hierarchy().front();
395 if(
static_cast<SCH_LABEL*
>( item )->GetText() == wxS(
"SIG" ) )
402 for(
bool published : {
false,
true } )
407 const wxString
name = published ? wxS(
"PUBLISHED_API" ) : wxS(
"LEGACY_API" );
412 model->ConnectionGraph()->Reset();
414 model->RebuildConnectivity();
416 for(
bool filtered : {
false,
true } )
418 kiapi::schematic::commands::GetSchematicNetlist command;
419 *command.mutable_document() = makeDocument( *
model );
422 command.add_types( kiapi::common::types::KOT_SCH_LABEL );
425 request.mutable_header()->set_client_name(
"kicad.qa" );
426 BOOST_REQUIRE( request.mutable_message()->PackFrom( command ) );
429 kiapi::schematic::commands::SchematicNetlistResponse response;
431 std::set<std::string> items;
433 for(
const auto& net : response.nets() )
438 for(
const auto& sheet : net.sheets() )
440 for(
const auto& item : sheet.items() )
441 items.insert( item.value() );
450 BOOST_CHECK_GT( items.size(), 1 );
460 SCHEMATIC*
model = loadSchematic( wxS(
"netlists/hierarchy_aliases/hierarchy_aliases" ) );
461 auto* root =
model->Hierarchy().front().LastScreen();
464 auto* unusedBus =
static_cast<SCH_LABEL*
>( ( *labels.begin() )->Clone() );
465 const_cast<KIID&
>( unusedBus->m_Uuid ) =
KIID();
466 unusedBus->SetText( wxS(
"API_UNUSED[0..1]" ) );
467 unusedBus->SetPosition(
VECTOR2I( 0, 0 ) );
468 root->Append( unusedBus );
473 auto* line =
static_cast<SCH_LINE*
>( item );
477 undriven =
static_cast<SCH_LINE*
>( line->Clone() );
485 root->Append( undriven );
487 using CONTENTS = std::map<std::string, std::map<std::vector<std::string>, std::set<std::string>>>;
489 for(
bool filtered : {
false,
true } )
493 for(
bool published : {
false,
true } )
501 model->ConnectionGraph()->Reset();
503 model->RebuildConnectivity();
505 kiapi::schematic::commands::GetSchematicNetlist command;
506 *command.mutable_document() = makeDocument( *
model );
509 command.add_types( kiapi::common::types::KOT_SCH_PIN );
512 request.mutable_header()->set_client_name(
"kicad.qa" );
513 BOOST_REQUIRE( request.mutable_message()->PackFrom( command ) );
516 kiapi::schematic::commands::SchematicNetlistResponse response;
519 size_t nestedItems = 0;
521 for(
const auto& net : response.nets() )
523 BOOST_CHECK_GT( net.sheets_size(), 0 );
524 BOOST_CHECK( net.name().find(
'{' ) == std::string::npos );
525 BOOST_CHECK( net.name().find(
"API_UNUSED" ) == std::string::npos );
527 for(
const auto& sheet : net.sheets() )
529 std::vector<std::string>
path;
531 for(
const auto&
id : sheet.path().path() )
532 path.push_back(
id.value() );
536 for(
const auto& item : sheet.items() )
539 items.insert( item.value() );
542 if(
path.size() > 2 )
543 nestedItems += items.size();
549 BOOST_CHECK_GT( nestedItems, 0 );
573 throw std::runtime_error(
"Native label extraction failed" );
583 SCHEMATIC*
model = loadSchematic( wxS(
"net_chains_four_nets_labeled" ) );
584 auto* screen =
model->Hierarchy().front().LastScreen();
585 auto labels = screen->Items().OfType(
SCH_LABEL_T );
587 auto* original =
static_cast<SCH_LABEL*
>( *labels.begin() );
588 auto* replacement =
new FAILING_LABEL( *original );
589 screen->Remove( original );
591 screen->Append( replacement );
592 model->ConnectionGraph()->Reset();
593 replacement->fail =
true;
596 kiapi::schematic::commands::GetSchematicNetlist command;
597 *command.mutable_document() = makeDocument( *
model );
599 request.mutable_header()->set_client_name(
"kicad.qa" );
600 BOOST_REQUIRE( request.mutable_message()->PackFrom( command ) );
605 replacement->fail =
false;
608 kiapi::schematic::commands::SchematicNetlistResponse response;
610 BOOST_CHECK_GT( response.nets_size(), 0 );
620 kiapi::common::ApiRequest startRequest = makeStartErcTaskRequest( *
schematic );
624 kiapi::common::tasks::StartTaskResponse startResponse;
625 BOOST_REQUIRE( start->message().UnpackTo( &startResponse ) );
634 kiapi::common::ApiRequest resultRequest = makeGetErcTaskResultRequest( startResponse.token().value() );
638 kiapi::schematic::tasks::ErcTaskResult ercResult;
641 BOOST_CHECK_GT( ercResult.violations_size(), 0 );
644 BOOST_CHECK_GT( ercResult.ignored_count(), 0 );
651 for(
SCH_ITEM* item : screen->Items() )
660 for(
const kiapi::schematic::ErcMarker& violation : ercResult.violations() )
663 BOOST_CHECK( violation.error_type() != kiapi::schematic::ErcErrorType::ERCET_UNKNOWN );
674 kiapi::common::ApiRequest startRequest = makeStartErcTaskRequest( *
schematic );
678 kiapi::common::tasks::StartTaskResponse startResponse;
679 BOOST_REQUIRE( start->message().UnpackTo( &startResponse ) );
683 kiapi::common::ApiRequest secondRequest = makeStartErcTaskRequest( *
schematic );
686 BOOST_CHECK_EQUAL( second.error().status(), kiapi::common::ApiStatusCode::AS_BUSY );
688 kiapi::common::ApiRequest runningRequest = makeGetErcTaskResultRequest( startResponse.token().value() );
691 BOOST_CHECK_EQUAL( runningResult.error().status(), kiapi::common::ApiStatusCode::AS_BUSY );
695 kiapi::common::ApiRequest finishedRequest =
696 makeGetErcTaskResultRequest( startResponse.token().value() );
704 loadSchematic( wxS(
"NoConnectOnPin" ) );
708 kiapi::common::ApiRequest request = makeGetErcTaskResultRequest(
"deadbeef-0000-0000-0000-000000000000" );
tl::expected< ApiResponse, ApiResponseStatus > API_RESULT
bool PackSheet(kiapi::schematic::types::SheetSymbol *aOutput, const SCH_SHEET *aInput, const SCH_SHEET_PATH &aPath)
static const ADVANCED_CFG & GetCfg()
Get the singleton instance's config, which is shared by all consumers.
API_RESULT Handle(ApiRequest &aMsg)
Attempt to handle the given API request, if a handler exists in this class for the message.
std::optional< kiapi::common::tasks::TaskStatusResponse > GetStatus(const std::string &aToken) const
Get a snapshot of the task's current status.
void Pump()
Run the current task to completion, synchronously.
static API_TASK_SCHEDULER & Instance()
virtual void SetText(const wxString &aText)
std::string AsStdString() const
Holds all the data relating to one schematic.
PROJECT & Project() const
Return a reference to the project this schematic is part of.
Base class for any item which can be embedded within the SCHEMATIC container class,...
wxString GetShownText(const SCH_SHEET_PATH *aPath, RESOLUTION_CONTEXT aContext, int aDepth=0) const override
SCH_LABEL(const VECTOR2I &aPos=VECTOR2I(0, 0), const wxString &aText=wxEmptyString)
Segment description base class to describe items which have 2 end points (track, wire,...
VECTOR2I GetStartPoint() const
void Move(const VECTOR2I &aMoveVector) override
Move the item by aMoveVector to a new position.
Container class that holds multiple SCH_SCREEN objects in a hierarchy.
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
wxString GetPageNumber() const
SCH_SHEET * Last() const
Return a pointer to the last SCH_SHEET of the list.
void pop_back()
Forwarded method from std::vector.
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
RAII class that sets an value at construction and resets it to the original value at destruction.
static std::string ToStdString(const wxString &aStr)
void LoadSchematic(SETTINGS_MANAGER &aSettingsManager, const wxString &aRelPath, std::unique_ptr< SCHEMATIC > &aSchematic)
KICOMMON_API void PackProject(types::ProjectSpecifier &aOutput, const PROJECT &aInput)
BOOST_AUTO_TEST_CASE(HorizontalAlignment)
BOOST_CHECK(res.column_datatype(0)==SQL_NUMERIC||res.column_datatype(0)==SQL_DECIMAL)
BOOST_REQUIRE_EQUAL(rows.size(), 1)
BOOST_CHECK_EQUAL(std::any_cast< std::string >(rows[0].at("val")), "12345678901234567.89")
BOOST_REQUIRE(res.columns()==1)
BOOST_AUTO_TEST_SUITE_END()
VECTOR3I expected(15, 30, 45)
BOOST_AUTO_TEST_CASE(RevertDocumentRejectedWithOpenCommit)
BOOST_TEST_CONTEXT("Test Clearance")
wxString result
Test unit parsing edge cases and error handling.
VECTOR2< int32_t > VECTOR2I