23#include <boost/test/unit_test.hpp>
25#include <wx/filename.h>
43#include <api/board/board_commands.pb.h>
44#include <api/board/board_rules.pb.h>
45#include <api/board/board_tasks.pb.h>
46#include <api/common/commands/editor_commands.pb.h>
47#include <api/common/envelope.pb.h>
48#include <api/common/tasks.pb.h>
49#include <api/common/types/base_types.pb.h>
57const wxString F_CU_ZONE = wxS(
"00000000-0000-0000-0000-00005c07d704" );
58const wxString B_CU_ZONE = wxS(
"00000000-0000-0000-0000-00005c07d701" );
59const wxString IN1_CU_ZONE = wxS(
"00000000-0000-0000-0000-00005c07d707" );
60const wxString IN2_CU_ZONE = wxS(
"00000000-0000-0000-0000-00005c07d70a" );
63struct API_HANDLER_PCB_FIXTURE
65 SETTINGS_MANAGER m_settingsManager;
66 std::unique_ptr<BOARD> m_board;
67 std::shared_ptr<HEADLESS_PCB_CONTEXT> m_context;
71 BOARD* loadBoard(
const wxString& aRelPath )
75 BOARD* board = m_board.get();
76 m_context = std::make_shared<HEADLESS_PCB_CONTEXT>( std::move( m_board ),
77 &m_settingsManager.Prj(),
nullptr );
81 kiapi::common::ApiRequest makeRefillRequest(
BOARD* aBoard,
const std::vector<wxString>& aZoneIds )
const
83 kiapi::board::commands::RefillZones command;
84 command.mutable_board()->set_type( kiapi::common::types::DocumentType::DOCTYPE_PCB );
85 command.mutable_board()->set_board_filename(
86 wxFileName( aBoard->
GetFileName() ).GetFullName().ToStdString() );
88 for(
const wxString&
id : aZoneIds )
91 kiapi::common::ApiRequest request;
92 request.mutable_header()->set_client_name(
"kicad.qa" );
93 BOOST_REQUIRE( request.mutable_message()->PackFrom( command ) );
98 ZONE* zoneByUuid(
BOARD* aBoard,
const wxString& aUuid )
const
100 for( ZONE* zone : aBoard->
Zones() )
102 if( zone->m_Uuid.AsString() == aUuid )
109 void unfillAll(
BOARD* aBoard )
const
112 for( ZONE* zone : aBoard->
Zones() )
121kiapi::common::ApiRequest makeBeginCommitRequest()
124 kiapi::common::commands::BeginCommit command;
126 kiapi::common::ApiRequest request;
127 request.mutable_header()->set_client_name(
"kicad.qa" );
128 BOOST_REQUIRE( request.mutable_message()->PackFrom( command ) );
134kiapi::common::ApiRequest makeRevertRequest(
BOARD* aBoard )
136 kiapi::common::commands::RevertDocument command;
137 command.mutable_document()->set_type( kiapi::common::types::DocumentType::DOCTYPE_PCB );
138 command.mutable_document()->set_board_filename( wxFileName( aBoard->
GetFileName() ).GetFullName().ToStdString() );
140 kiapi::common::ApiRequest request;
141 request.mutable_header()->set_client_name(
"kicad.qa" );
142 BOOST_REQUIRE( request.mutable_message()->PackFrom( command ) );
148kiapi::common::types::DocumentSpecifier makeBoardDocument(
const BOARD& aBoard )
150 kiapi::common::types::DocumentSpecifier document;
151 document.set_type( kiapi::common::types::DocumentType::DOCTYPE_PCB );
152 document.set_board_filename( wxFileName( aBoard.
GetFileName() ).GetFullName().ToStdString() );
158kiapi::common::ApiRequest makeStartRefillZonesTaskRequest(
159 const BOARD& aBoard,
const std::vector<wxString>& aZoneIds = {} )
161 kiapi::board::tasks::StartRefillZonesTask command;
162 *command.mutable_board() = makeBoardDocument( aBoard );
164 for(
const wxString&
id : aZoneIds )
165 command.add_zones()->set_value(
id.
ToStdString() );
167 kiapi::common::ApiRequest request;
168 request.mutable_header()->set_client_name(
"kicad.qa" );
169 BOOST_REQUIRE( request.mutable_message()->PackFrom( command ) );
175kiapi::common::ApiRequest makeStartDrcTaskRequest(
const BOARD& aBoard,
bool aTestSchematicParity =
false,
176 bool aRequireZonesFilled =
false )
178 kiapi::board::tasks::StartDrcTask command;
179 *command.mutable_board() = makeBoardDocument( aBoard );
180 command.set_test_schematic_parity( aTestSchematicParity );
181 command.set_require_zones_filled( aRequireZonesFilled );
183 kiapi::common::ApiRequest request;
184 request.mutable_header()->set_client_name(
"kicad.qa" );
185 BOOST_REQUIRE( request.mutable_message()->PackFrom( command ) );
191kiapi::common::ApiRequest makeGetDrcTaskResultRequest(
const std::string& aToken )
193 kiapi::board::tasks::GetDrcTaskResult command;
194 command.mutable_token()->set_value( aToken );
196 kiapi::common::ApiRequest request;
197 request.mutable_header()->set_client_name(
"kicad.qa" );
198 BOOST_REQUIRE( request.mutable_message()->PackFrom( command ) );
206BOOST_FIXTURE_TEST_SUITE( ApiHandlerPcb, API_HANDLER_PCB_FIXTURE )
212 kiapi::board::jobs::RunBoardJobExportODB request;
213 request.add_variant_names(
"var1" );
214 request.add_variant_names(
"var2" );
215 request.set_variant(
"legacy" );
216 request.set_variant_packaging( kiapi::board::jobs::ODBVP_COMBINED );
217 request.set_manufacturer_part_number_column(
"MPN" );
226 kiapi::board::jobs::RunBoardJobExportODB legacyRequest;
227 legacyRequest.set_variant(
"legacy" );
238 kiapi::board::jobs::RunBoardJobExportODB request;
239 request.set_origin( kiapi::board::jobs::ODBO_GRID );
240 request.set_product_name(
"board product" );
241 request.mutable_content()->set_data_set( kiapi::board::jobs::FDS_ASSEMBLY );
242 request.mutable_content()->set_sections(
"KP" );
243 request.mutable_content()->set_net_names( kiapi::board::jobs::FNNP_ANONYMIZE );
254 kiapi::board::jobs::RunBoardJobExportODB legacy;
265 BOARD*
board = loadBoard( wxS(
"issue5830" ) );
270 kiapi::common::ApiRequest request = makeRefillRequest(
board, { F_CU_ZONE, IN1_CU_ZONE } );
275 BOOST_FAIL(
"RefillZones returned status " <<
result.error().status() <<
": "
276 <<
result.error().error_message() );
281 ZONE* fCu = zoneByUuid(
board, F_CU_ZONE );
282 ZONE* bCu = zoneByUuid(
board, B_CU_ZONE );
283 ZONE* in1Cu = zoneByUuid(
board, IN1_CU_ZONE );
284 ZONE* in2Cu = zoneByUuid(
board, IN2_CU_ZONE );
298 BOARD*
board = loadBoard( wxS(
"issue5830" ) );
304 board->BuildConnectivity();
305 const unsigned baseline =
board->GetConnectivity()->GetUnconnectedCount(
false );
309 kiapi::common::ApiRequest request = makeRefillRequest(
board, { F_CU_ZONE, IN1_CU_ZONE } );
314 BOOST_FAIL(
"RefillZones returned status " <<
result.error().status() <<
": "
315 <<
result.error().error_message() );
318 const unsigned afterFill =
board->GetConnectivity()->GetUnconnectedCount(
false );
323 BOOST_CHECK_MESSAGE( afterFill > 0,
"connectivity was cleared, not rebuilt, after the fill" );
324 BOOST_CHECK_MESSAGE( afterFill < baseline,
325 "filling the GND planes should reduce the unconnected count ("
326 << afterFill <<
" vs baseline " << baseline <<
")" );
332 BOARD*
board = loadBoard( wxS(
"issue5830" ) );
337 kiapi::common::ApiRequest request = makeRefillRequest(
board, {} );
342 BOOST_FAIL(
"RefillZones returned status " <<
result.error().status() <<
": "
343 <<
result.error().error_message() );
350 BOOST_CHECK_MESSAGE( zone->IsFilled(),
"zone " << zone->m_Uuid.AsStdString() <<
" not filled" );
356 BOARD*
board = loadBoard( wxS(
"issue5830" ) );
359 kiapi::common::ApiRequest request =
360 makeRefillRequest(
board, { wxS(
"deadbeef-0000-0000-0000-000000000000" ) } );
373 BOARD*
board = loadBoard( wxS(
"issue5830" ) );
378 kiapi::common::ApiRequest beginRequest = makeBeginCommitRequest();
381 kiapi::common::ApiRequest request = makeRevertRequest(
board );
386 BOOST_CHECK(
result.error().error_message().find(
"commit" ) != std::string::npos );
394 BOARD*
board = loadBoard( wxS(
"issue5830" ) );
397 kiapi::common::ApiRequest request = makeRevertRequest(
board );
413 BOARD*
board = loadBoard( wxS(
"issue5830" ) );
419 kiapi::board::tasks::StartRefillZonesTask command;
420 command.mutable_board()->set_type( kiapi::common::types::DocumentType::DOCTYPE_PCB );
421 command.mutable_board()->set_board_filename(
422 wxFileName(
board->GetFileName() ).GetFullName().ToStdString() );
423 command.add_zones()->set_value( F_CU_ZONE.ToStdString() );
424 command.add_zones()->set_value( IN1_CU_ZONE.ToStdString() );
426 kiapi::common::ApiRequest request;
427 request.mutable_header()->set_client_name(
"kicad.qa" );
428 BOOST_REQUIRE( request.mutable_message()->PackFrom( command ) );
434 kiapi::common::tasks::StartTaskResponse response;
445 ZONE* fCu = zoneByUuid(
board, F_CU_ZONE );
446 ZONE* in1Cu = zoneByUuid(
board, IN1_CU_ZONE );
447 ZONE* bCu = zoneByUuid(
board, B_CU_ZONE );
458 BOARD*
board = loadBoard( wxS(
"issue5830" ) );
462 kiapi::board::tasks::StartRefillZonesTask command;
463 command.mutable_board()->set_type( kiapi::common::types::DocumentType::DOCTYPE_PCB );
464 command.mutable_board()->set_board_filename(
465 wxFileName(
board->GetFileName() ).GetFullName().ToStdString() );
466 command.add_zones()->set_value(
"deadbeef-0000-0000-0000-000000000000" );
468 kiapi::common::ApiRequest request;
469 request.mutable_header()->set_client_name(
"kicad.qa" );
470 BOOST_REQUIRE( request.mutable_message()->PackFrom( command ) );
482 BOARD*
board = loadBoard( wxS(
"issue5830" ) );
489 kiapi::common::ApiRequest request = makeStartRefillZonesTaskRequest( *
board );
493 kiapi::common::tasks::StartTaskResponse response;
505 if( !zone->GetIsRuleArea() )
506 BOOST_CHECK_MESSAGE( zone->IsFilled(),
"zone " << zone->GetZoneName() <<
" was not filled" );
511 kiapi::common::commands::GetDocumentModifiedState stateCommand;
512 *stateCommand.mutable_document() = makeBoardDocument( *
board );
514 kiapi::common::ApiRequest stateRequest;
515 stateRequest.mutable_header()->set_client_name(
"kicad.qa" );
516 BOOST_REQUIRE( stateRequest.mutable_message()->PackFrom( stateCommand ) );
521 kiapi::common::commands::GetDocumentModifiedStateResponse state;
529 BOARD*
board = loadBoard( wxS(
"issue5830" ) );
533 kiapi::board::tasks::StartDrcTask command;
534 command.mutable_board()->set_type( kiapi::common::types::DocumentType::DOCTYPE_PCB );
535 command.mutable_board()->set_board_filename(
536 wxFileName(
board->GetFileName() ).GetFullName().ToStdString() );
538 kiapi::common::ApiRequest request;
539 request.mutable_header()->set_client_name(
"kicad.qa" );
540 BOOST_REQUIRE( request.mutable_message()->PackFrom( command ) );
545 kiapi::common::tasks::StartTaskResponse response;
556 kiapi::board::tasks::GetDrcTaskResult resultRequest;
557 resultRequest.mutable_token()->set_value( response.token().value() );
559 kiapi::common::ApiRequest resultApiRequest;
560 resultApiRequest.mutable_header()->set_client_name(
"kicad.qa" );
561 BOOST_REQUIRE( resultApiRequest.mutable_message()->PackFrom( resultRequest ) );
566 kiapi::board::tasks::DrcTaskResult drcResult;
567 BOOST_REQUIRE( resultResponse->message().UnpackTo( &drcResult ) );
571 BOOST_CHECK_GT( drcResult.violations_size(), 0 );
575 for(
const kiapi::board::DrcMarker& violation : drcResult.violations() )
578 BOOST_CHECK( violation.error_type() != kiapi::board::DrcErrorType::DRCET_UNKNOWN );
585 loadBoard( wxS(
"issue5830" ) );
589 kiapi::board::tasks::GetDrcTaskResult resultRequest;
590 resultRequest.mutable_token()->set_value(
"deadbeef-0000-0000-0000-000000000000" );
592 kiapi::common::ApiRequest request;
593 request.mutable_header()->set_client_name(
"kicad.qa" );
594 BOOST_REQUIRE( request.mutable_message()->PackFrom( resultRequest ) );
605 BOARD*
board = loadBoard( wxS(
"issue5830" ) );
609 auto makeStartRequest = [&]() -> kiapi::common::ApiRequest
611 kiapi::board::tasks::StartDrcTask command;
612 command.mutable_board()->set_type( kiapi::common::types::DocumentType::DOCTYPE_PCB );
613 command.mutable_board()->set_board_filename(
614 wxFileName(
board->GetFileName() ).GetFullName().ToStdString() );
615 command.set_require_zones_filled(
true );
617 kiapi::common::ApiRequest request;
618 request.mutable_header()->set_client_name(
"kicad.qa" );
619 BOOST_REQUIRE( request.mutable_message()->PackFrom( command ) );
626 kiapi::common::ApiRequest request = makeStartRequest();
630 kiapi::common::tasks::StartTaskResponse response;
638 BOOST_CHECK( status->error_message().find(
"zone" ) != std::string::npos );
643 if( !zone->GetIsRuleArea() )
646 std::vector<ZONE*> toFill = { zone };
651 kiapi::common::ApiRequest request2 = makeStartRequest();
655 kiapi::common::tasks::StartTaskResponse response2;
668 BOARD*
board = loadBoard( wxS(
"issue5830" ) );
674 kiapi::common::ApiRequest startRequest =
675 makeStartDrcTaskRequest( *
board,
false,
true );
679 kiapi::common::tasks::StartTaskResponse response;
688 kiapi::common::ApiRequest resultRequest =
689 makeGetDrcTaskResultRequest( response.token().value() );
693 BOOST_CHECK(
result.error().error_message().find(
"zone" ) != std::string::npos );
699 BOARD*
board = loadBoard( wxS(
"via_off_center" ) );
705 + wxS(
"via_off_center.kicad_pcb" ) );
709 kiapi::common::ApiRequest startRequest =
710 makeStartDrcTaskRequest( *
board,
true ,
false );
714 kiapi::common::tasks::StartTaskResponse response;
722 BOOST_CHECK_MESSAGE( status->error_message().find(
"parity tests" ) != std::string::npos,
723 "unexpected error: " << status->error_message() );
729 BOARD*
board = loadBoard( wxS(
"issue5830" ) );
733 kiapi::common::ApiRequest startRequest = makeStartDrcTaskRequest( *
board );
737 kiapi::common::tasks::StartTaskResponse response;
742 kiapi::common::ApiRequest secondRequest =
743 makeStartRefillZonesTaskRequest( *
board, { F_CU_ZONE } );
746 BOOST_CHECK_EQUAL( second.error().status(), kiapi::common::ApiStatusCode::AS_BUSY );
749 kiapi::common::ApiRequest runningRequest =
750 makeGetDrcTaskResultRequest( response.token().value() );
753 BOOST_CHECK_EQUAL( runningResult.error().status(), kiapi::common::ApiStatusCode::AS_BUSY );
757 kiapi::common::ApiRequest finishedRequest =
758 makeGetDrcTaskResultRequest( response.token().value() );
766 loadBoard( wxS(
"issue5830" ) );
782 BOARD*
board = loadBoard( wxS(
"issue5830" ) );
785 drcItem->SetItems(
KIID(
"12345678-1234-1234-1234-123456789abc" ),
786 KIID(
"87654321-4321-4321-4321-cba987654321" ) );
788 DRC_RULE rule( wxS(
"custom clearance" ) );
789 drcItem->SetViolatingRule( &rule );
792 board->Add( marker );
793 marker->
SetExcluded(
true,
"Test exclusion comment" );
795 kiapi::board::DrcMarker msg;
802 const kiapi::board::DrcMarker& canonical = exclusion.
ToProto().marker();
806 BOOST_CHECK_EQUAL( canonical.severity(), kiapi::common::types::RuleSeverity::RS_UNKNOWN );
813 const kiapi::board::DrcMarker& roundTrippedMsg = roundTripped.
ToProto().marker();
814 BOOST_CHECK( roundTrippedMsg.violating_rule().empty() );
815 BOOST_CHECK( roundTrippedMsg.description().empty() );
tl::expected< ApiResponse, ApiResponseStatus > API_RESULT
void ApplyOdbJobRequest(const RunBoardJobExportODB &aRequest, JOB_EXPORT_PCB_ODB &aJob)
bool AllowsDuringTask(const std::string &aTypeName) const
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()
Information pertinent to a Pcbnew printed circuit board.
const ZONES & Zones() const
const wxString & GetFileName() const
Container for an DRC exclusion, which is a PCB_MARKER plus an optional comment.
static DRC_EXCLUSION FromProto(const kiapi::board::DrcExclusion &aMessage)
static DRC_EXCLUSION FromMarker(const PCB_MARKER &aMarker)
const kiapi::board::DrcExclusion & ToProto() const
static std::shared_ptr< DRC_ITEM > Create(int aErrorCode)
Constructs a DRC_ITEM for the given error code.
std::optional< wxString > m_sections
Section key that replaces the optional sections of the data set Unset lets the data set select them a...
std::vector< wxString > m_variantNames
VARIANT_PACKAGING m_variantPackaging
void SetExcluded(bool aExcluded, const wxString &aComment=wxEmptyString)
static void ToProto(kiapi::board::DrcMarker &aMsg, const PCB_MARKER &aMarker)
bool Fill(const std::vector< ZONE * > &aZones, bool aCheck=false, wxWindow *aParent=nullptr)
Fills the given list of zones.
Handle a list of polygons defining a copper zone.
static std::string ToStdString(const wxString &aStr)
std::string GetPcbnewTestDataDir()
Utility which returns a path to the data directory where the test board files are stored.
void LoadBoard(SETTINGS_MANAGER &aSettingsManager, const wxString &aRelPath, std::unique_ptr< BOARD > &aBoard)
BOOST_AUTO_TEST_CASE(HorizontalAlignment)
BOOST_AUTO_TEST_CASE(OdbJobRequestMapsVariants)
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_MESSAGE(dc.CacheTableInfo(table, { "part_id", "val" }), dc.GetLastError())
BOOST_REQUIRE(res.columns()==1)
BOOST_AUTO_TEST_SUITE_END()
wxString result
Test unit parsing edge cases and error handling.
VECTOR2< int32_t > VECTOR2I