80 kiapi::board::commands::BoardDesignRulesResponse* aOut, wxString* aError =
nullptr )
82 kiapi::board::commands::GetBoardDesignRules request;
83 *request.mutable_board() = aDocument;
85 kiapi::common::ApiResponse response;
95 if( response.status().status() != kiapi::common::AS_OK )
98 *aError = response.status().error_message();
103 if( !response.message().UnpackTo( aOut ) )
106 *aError = wxS(
"Failed to unpack BoardDesignRulesResponse" );
116 kiapi::board::commands::CustomRulesResponse* aOut, wxString* aError =
nullptr )
118 kiapi::board::commands::GetCustomDesignRules request;
119 *request.mutable_board() = aDocument;
121 kiapi::common::ApiResponse response;
131 if( response.status().status() != kiapi::common::AS_OK )
134 *aError = response.status().error_message();
139 if( !response.message().UnpackTo( aOut ) )
142 *aError = wxS(
"Failed to unpack CustomRulesResponse" );
166 kiapi::common::types::DocumentSpecifier document;
168 wxFileName boardPath( testDataDir, wxS(
"api_kitchen_sink.kicad_pcb" ) );
171 "OpenDocument failed: " + Client().LastError() );
173 BOOST_REQUIRE( document.type() == kiapi::common::types::DOCTYPE_PCB );
174 BOOST_REQUIRE( boardPath.GetFullName().Matches( document.board_filename() ) );
176 int footprintCount = 0;
178 BOOST_REQUIRE_MESSAGE( Client().GetItemsCount( document, kiapi::common::types::KOT_PCB_FOOTPRINT, &footprintCount ),
179 "GetItems failed: " + Client().LastError() );
181 BOOST_CHECK_GT( footprintCount, 0 );
190 kiapi::common::types::DocumentSpecifier document;
194 "OpenDocument failed: " + Client().LastError() );
196 kiapi::common::commands::SetPageSettings request;
197 request.mutable_document()->CopyFrom( document );
198 request.mutable_page_settings()->set_orientation( kiapi::common::types::PO_PORTRAIT );
200 kiapi::common::ApiResponse response;
202 "SetPageSettings failed to send: " + Client().LastError() );
203 BOOST_CHECK( response.status().status() == kiapi::common::AS_BAD_REQUEST );
204 BOOST_CHECK_EQUAL( response.status().error_message(),
"SetPageSettings requires page_size" );
214 kiapi::common::types::DocumentSpecifier document;
218 "OpenDocument failed: " + Client().LastError() );
223 "GetFirstFootprint failed: " + Client().LastError() );
228 kiapi::common::commands::DeleteItems request;
229 *request.mutable_header()->mutable_document() = document;
232 kiapi::common::ApiResponse response;
235 "DeleteItems failed: " + Client().LastError() );
238 kiapi::common::commands::DeleteItemsResponse deleteResponse;
240 BOOST_REQUIRE( response.message().UnpackTo( &deleteResponse ) );
243 kiapi::common::commands::ItemDeletionStatus::IDS_IMMUTABLE );
248 "GetFirstFootprint after delete failed: " + Client().LastError() );
262 wxFileName boardPathA( testDataDir, wxS(
"api_kitchen_sink.kicad_pcb" ) );
263 wxFileName boardPathB( testDataDir, wxS(
"padstacks.kicad_pcb" ) );
265 kiapi::common::types::DocumentSpecifier documentA;
268 "OpenDocument for first board failed: " + Client().LastError() );
273 "GetFirstFootprint for first board failed: " + Client().LastError() );
276 kiapi::common::ApiStatusCode closeStatusA = kiapi::common::AS_UNKNOWN;
279 "CloseDocument for first board failed: " + Client().LastError() );
282 kiapi::common::types::DocumentSpecifier documentB;
285 "OpenDocument for second board failed: " + Client().LastError() );
290 "GetFirstFootprint for second board failed: " + Client().LastError() );
292 BOOST_CHECK_NE( footprintA.
Similarity( footprintB ), 1.0 );
294 kiapi::common::ApiStatusCode closeStatus = kiapi::common::AS_UNKNOWN;
297 "CloseDocument failed: " + Client().LastError() );
301 "CloseDocument after already closed failed: " + Client().LastError() );
310 kiapi::common::types::DocumentSpecifier document;
314 "OpenDocument failed: " + Client().LastError() );
316 kiapi::board::commands::BoardDesignRulesResponse rulesResponse;
320 "GetBoardDesignRules failed: " + error );
322 BOOST_CHECK_GE( rulesResponse.rules().constraints().min_clearance().value_nm(), 0 );
323 BOOST_CHECK_GE( rulesResponse.rules().constraints().min_track_width().value_nm(), 0 );
324 BOOST_CHECK( rulesResponse.custom_rules_status() == kiapi::board::commands::CRS_VALID );
337 kiapi::common::types::DocumentSpecifier document;
340 "OpenDocument failed: " + Client().LastError() );
342 kiapi::board::commands::BoardDesignRulesResponse getResponse;
345 "Initial GetBoardDesignRules failed: " + copyError );
347 int newWidth = getResponse.rules().constraints().min_track_width().value_nm() + 1000;
349 kiapi::board::commands::SetBoardDesignRules setRequest;
350 *setRequest.mutable_board() = document;
351 *setRequest.mutable_rules()->mutable_constraints() = getResponse.rules().constraints();
352 setRequest.mutable_rules()->mutable_constraints()->mutable_min_track_width()->set_value_nm( newWidth );
354 kiapi::common::ApiResponse setApiResponse;
357 "SetBoardDesignRules failed to send: " + Client().LastError() );
358 BOOST_REQUIRE( setApiResponse.status().status() == kiapi::common::AS_OK );
360 kiapi::board::commands::BoardDesignRulesResponse setResponse;
361 BOOST_REQUIRE( setApiResponse.message().UnpackTo( &setResponse ) );
363 BOOST_CHECK_EQUAL( setResponse.rules().constraints().min_track_width().value_nm(), newWidth );
365 kiapi::board::commands::BoardDesignRulesResponse verifyResponse;
368 "Verification GetBoardDesignRules failed: " + copyError );
370 BOOST_CHECK_EQUAL( verifyResponse.rules().constraints().min_track_width().value_nm(), newWidth );
383 kiapi::common::types::DocumentSpecifier document;
386 "OpenDocument failed: " + Client().LastError() );
388 kiapi::board::commands::BoardDesignRulesResponse getResponse;
391 "Initial GetBoardDesignRules failed: " + copyError );
393 kiapi::board::commands::SetBoardDesignRules setRequest;
394 *setRequest.mutable_board() = document;
395 *setRequest.mutable_rules()->mutable_constraints() = getResponse.rules().constraints();
396 setRequest.mutable_rules()->mutable_constraints()->mutable_min_track_width()->set_value_nm( 1000000000 );
398 kiapi::common::ApiResponse response;
401 "SetBoardDesignRules failed to send: " + Client().LastError() );
403 BOOST_CHECK( response.status().status() == kiapi::common::AS_BAD_REQUEST );
404 BOOST_CHECK( !response.status().error_message().empty() );
417 kiapi::common::types::DocumentSpecifier document;
420 "OpenDocument failed: " + Client().LastError() );
422 kiapi::board::commands::BoardDesignRulesResponse getResponse;
424 "Initial GetBoardDesignRules failed: " + copyError );
426 auto applySeverityAndVerify = [&]( kiapi::common::types::RuleSeverity aSeverity )
428 kiapi::board::commands::SetBoardDesignRules setRequest;
429 *setRequest.mutable_board() = document;
431 kiapi::board::DrcSeveritySetting* setting = setRequest.mutable_rules()->add_severities();
432 setting->set_rule_type( kiapi::board::DrcErrorType::DRCET_UNCONNECTED_ITEMS );
433 setting->set_severity( aSeverity );
435 kiapi::common::ApiResponse setApiResponse;
437 "SetBoardDesignRules failed to send: " + Client().LastError() );
438 BOOST_REQUIRE( setApiResponse.status().status() == kiapi::common::AS_OK );
440 kiapi::board::commands::BoardDesignRulesResponse verifyResponse;
442 "Verification GetBoardDesignRules failed: " + copyError );
446 for(
const kiapi::board::DrcSeveritySetting& severity : verifyResponse.rules().severities() )
448 if( severity.rule_type() == kiapi::board::DrcErrorType::DRCET_UNCONNECTED_ITEMS )
459 applySeverityAndVerify( kiapi::common::types::RS_IGNORE );
460 applySeverityAndVerify( kiapi::common::types::RS_ERROR );
468 kiapi::common::types::DocumentSpecifier document;
472 "OpenDocument failed: " + Client().LastError() );
474 kiapi::board::commands::CustomRulesResponse response;
478 "GetCustomDesignRules failed: " + error );
480 BOOST_CHECK( response.status() == kiapi::board::commands::CRS_VALID );
481 BOOST_CHECK_GT( response.rules_size(), 0 );
483 bool foundFixtureRule =
false;
485 for(
const kiapi::board::CustomRule& rule : response.rules() )
487 if( rule.name() ==
"myrule" )
489 foundFixtureRule =
true;
510 kiapi::common::types::DocumentSpecifier document;
513 "OpenDocument failed: " + Client().LastError() );
515 kiapi::board::commands::CustomRulesResponse response;
519 "GetCustomDesignRules failed: " + error );
521 BOOST_CHECK( response.status() == kiapi::board::commands::CRS_VALID );
522 BOOST_CHECK_GT( response.rules_size(), 0 );
524 kiapi::board::commands::SetCustomDesignRules setRequest;
525 *setRequest.mutable_board() = document;
527 setRequest.mutable_rules()->CopyFrom( response.rules() );
529 kiapi::board::CustomRule* rule = setRequest.add_rules();
530 rule->set_name(
"api_roundtrip_rule" );
531 rule->set_condition(
"A.NetClass == 'HV'" );
532 rule->set_layer_mode( kiapi::board::CRLM_OUTER );
533 rule->set_severity( kiapi::common::types::RS_WARNING );
535 kiapi::board::CustomRuleConstraint* annular = rule->add_constraints();
536 annular->set_type( kiapi::board::CRCT_TRACK_WIDTH );
537 annular->mutable_numeric()->set_min( 3000000 );
538 annular->mutable_numeric()->set_opt( 4000000 );
539 annular->mutable_numeric()->set_max( 5000000 );
541 kiapi::board::CustomRuleConstraint* disallow = rule->add_constraints();
542 disallow->set_type( kiapi::board::CRCT_DISALLOW );
543 disallow->mutable_disallow()->add_types( kiapi::board::CRDT_BLIND_VIAS );
545 kiapi::common::ApiResponse setApiResponse;
548 "SetCustomDesignRules failed to send: " + Client().LastError() );
549 BOOST_REQUIRE( setApiResponse.status().status() == kiapi::common::AS_OK );
551 kiapi::board::commands::CustomRulesResponse setResponse;
552 BOOST_REQUIRE( setApiResponse.message().UnpackTo( &setResponse ) );
554 int num_rules = setResponse.rules_size();
555 BOOST_CHECK( setResponse.status() == kiapi::board::commands::CRS_VALID );
557 BOOST_CHECK_EQUAL( setResponse.rules( num_rules - 1 ).name(),
"api_roundtrip_rule" );
571 kiapi::common::types::DocumentSpecifier document;
574 "OpenDocument failed: " + Client().LastError() );
576 kiapi::board::commands::CustomRulesResponse getResponse;
580 "GetCustomDesignRules failed: " + error );
581 BOOST_REQUIRE( getResponse.status() == kiapi::board::commands::CRS_VALID );
582 BOOST_REQUIRE_GT( getResponse.rules_size(), 0 );
584 bool sawReturnPath =
false;
586 for(
const kiapi::board::CustomRule& rule : getResponse.rules() )
588 for(
const kiapi::board::CustomRuleConstraint& constraint : rule.constraints() )
590 if( constraint.type() != kiapi::board::CRCT_NET_CHAIN_RETURN_PATH )
593 sawReturnPath =
true;
601 kiapi::board::commands::SetCustomDesignRules setRequest;
602 *setRequest.mutable_board() = document;
603 setRequest.mutable_rules()->CopyFrom( getResponse.rules() );
605 kiapi::common::ApiResponse setApiResponse;
608 "SetCustomDesignRules failed to send: " + Client().LastError() );
610 setApiResponse.status().error_message() );
612 kiapi::board::commands::CustomRulesResponse setResponse;
613 BOOST_REQUIRE( setApiResponse.message().UnpackTo( &setResponse ) );
614 BOOST_REQUIRE( setResponse.status() == kiapi::board::commands::CRS_VALID );
617 for(
int ii = 0; ii < getResponse.rules_size(); ++ii )
619 BOOST_CHECK_MESSAGE( setResponse.rules( ii ).SerializeAsString() == getResponse.rules( ii ).SerializeAsString(),
620 getResponse.rules( ii ).name() <<
" changed in the round trip" );
631 kiapi::common::types::DocumentSpecifier projectDoc;
634 kiapi::common::types::DOCTYPE_PROJECT, &projectDoc ),
635 "OpenDocument for project failed: " + Client().LastError() );
637 BOOST_REQUIRE( projectDoc.type() == kiapi::common::types::DOCTYPE_PROJECT );
639 kiapi::common::types::DocumentSpecifier boardDoc;
642 kiapi::common::types::DOCTYPE_PCB, &boardDoc ),
643 "OpenDocument for board failed: " + Client().LastError() );
645 BOOST_REQUIRE( boardDoc.type() == kiapi::common::types::DOCTYPE_PCB );
648 int footprintCount = 0;
649 BOOST_REQUIRE_MESSAGE( Client().GetItemsCount( boardDoc, kiapi::common::types::KOT_PCB_FOOTPRINT, &footprintCount ),
650 "GetItems for board failed: " + Client().LastError() );
651 BOOST_CHECK_GT( footprintCount, 0 );
653 kiapi::common::types::DocumentSpecifier schDoc;
656 kiapi::common::types::DOCTYPE_SCHEMATIC, &schDoc ),
657 "OpenDocument for schematic failed: " + Client().LastError() );
659 BOOST_REQUIRE( schDoc.type() == kiapi::common::types::DOCTYPE_SCHEMATIC );
663 BOOST_REQUIRE_MESSAGE( Client().GetItemsCount( boardDoc, kiapi::common::types::KOT_PCB_FOOTPRINT, &footprintCount ),
664 "GetItems for board after opening schematic failed: " + Client().LastError() );
665 BOOST_CHECK_GT( footprintCount, 0 );
670 kiapi::common::types::DocumentSpecifier otherBoardDoc;
673 !Client().OpenDocument( otherDataDir + wxS(
"api_kitchen_sink.kicad_pcb" ),
674 kiapi::common::types::DOCTYPE_PCB, &otherBoardDoc ),
675 "OpenDocument for a different-project board should have failed" );
677 BOOST_CHECK( Client().LastError().Contains( wxS(
"already open" ) ) );
686 [&]( kiapi::common::types::DocumentType aType,
const wxString& aExpectedExt )
691 wxFileName fileWithExt( tempDir.
ChildPathStr(
"new_doc" + aExpectedExt ) );
692 wxFileName projectWithExt( tempDir.
ChildPathStr(
"new_doc.kicad_pro" ) );
694 kiapi::common::types::DocumentSpecifier document;
697 "CreateDocument failed: " + Client().LastError() );
700 BOOST_CHECK( document.project().name() == projectWithExt.GetName() );
701 BOOST_CHECK( document.project().path() == projectWithExt.GetPath( wxPATH_GET_SEPARATOR | wxPATH_GET_VOLUME ) );
703 kiapi::common::ApiResponse response;
704 kiapi::common::commands::GetDocumentModifiedState state;
705 state.mutable_document()->CopyFrom( document );
706 BOOST_CHECK( Client().SendCommand( state, &response ) );
709 BOOST_CHECK( !wxFileName( fileWithExt ).FileExists() );
710 BOOST_CHECK( !wxFileName( projectWithExt ).FileExists() );
712 kiapi::common::commands::SaveDocument
save;
713 save.mutable_document()->CopyFrom( document );
716 BOOST_CHECK( wxFileName( fileWithExt ).FileExists() );
717 BOOST_CHECK( wxFileName( projectWithExt ).FileExists() );
720 std::map<kiapi::common::types::DocumentType, wxString> cases = {
721 { kiapi::common::types::DOCTYPE_PCB, wxS(
".kicad_pcb" )},
722 { kiapi::common::types::DOCTYPE_SCHEMATIC, wxS(
".kicad_sch" ) }
725 for(
const auto& [docType, ext] : cases )
729 test( docType, ext );
737 using namespace kiapi::common::commands;
742 [&]( kiapi::common::types::DocumentType aType,
const wxString& aExistingPath )
745 wxString docFileName = tempDir.
ChildPathStr(
"new_doc" );
747 kiapi::common::types::DocumentSpecifier existingDoc;
750 "OpenDocument failed: " + Client().LastError() );
752 SetPageSettings modify;
753 modify.mutable_document()->CopyFrom( existingDoc );
754 modify.mutable_page_settings()->set_page_size( kiapi::common::types::PS_A4 );
755 modify.mutable_page_settings()->set_orientation( kiapi::common::types::PO_PORTRAIT );
756 kiapi::common::ApiResponse response;
757 BOOST_CHECK( Client().SendCommand( modify, &response ) );
759 GetDocumentModifiedState stateQuery;
760 stateQuery.mutable_document()->CopyFrom( existingDoc );
761 BOOST_CHECK( Client().SendCommand( stateQuery, &response ) );
762 GetDocumentModifiedStateResponse state;
763 BOOST_CHECK( response.message().UnpackTo( &state ) );
764 BOOST_CHECK( state.state() == DocumentModifiedState::DMS_MODIFIED );
766 kiapi::common::types::DocumentSpecifier newDoc;
768 BOOST_REQUIRE( !Client().CreateDocument( docFileName, aType, &newDoc ) );
770 BOOST_CHECK( Client().LastError().Contains( wxS(
"save or revert" ) ) );
772 kiapi::common::commands::RevertDocument revert;
773 revert.mutable_document()->CopyFrom( existingDoc );
774 BOOST_CHECK( Client().SendCommand( revert, &response ) );
776 BOOST_REQUIRE( Client().CreateDocument( docFileName, aType, &newDoc ) );
781 std::map<kiapi::common::types::DocumentType, wxString> cases = {
782 { kiapi::common::types::DOCTYPE_PCB,
784 { kiapi::common::types::DOCTYPE_SCHEMATIC,
788 for(
const auto& [docType,
path] : cases )
803 [&]( kiapi::common::types::DocumentType aType,
const wxString& aSourcePath,
804 const wxString& aSourceName,
const wxString& aDocumentExt )
808 wxString sourceCopy = tempDir.
ChildPathStr( aSourceName );
809 BOOST_REQUIRE( wxCopyFile( aSourcePath, sourceCopy,
true ) );
811 kiapi::common::types::DocumentSpecifier document;
814 "OpenDocument failed: " + Client().LastError() );
816 wxFileName newDocFile( tempDir.
ChildPathStr(
"renamed" + aDocumentExt ) );
817 wxFileName newProjectFile( tempDir.
ChildPathStr(
"renamed.kicad_pro" ) );
819 kiapi::common::commands::SaveDocumentAs saveAs;
820 saveAs.mutable_document()->CopyFrom( document );
821 saveAs.set_path( tempDir.
ChildPathStr(
"renamed" ).ToStdString() );
823 kiapi::common::ApiResponse response;
825 "SaveDocumentAs failed to send: " + Client().LastError() );
826 BOOST_REQUIRE( response.status().status() == kiapi::common::AS_OK );
831 kiapi::common::commands::GetOpenDocuments openDocs;
832 openDocs.set_type( aType );
833 BOOST_REQUIRE( Client().SendCommand( openDocs, &response ) );
835 kiapi::common::commands::GetOpenDocumentsResponse docsResponse;
836 BOOST_REQUIRE( response.message().UnpackTo( &docsResponse ) );
839 kiapi::common::types::DocumentSpecifier renamedDoc = docsResponse.documents( 0 );
844 wxString expectedProjectPath = ( aType == kiapi::common::types::DOCTYPE_PCB )
845 ? newProjectFile.GetPath()
846 : newProjectFile.GetPath( wxPATH_GET_SEPARATOR | wxPATH_GET_VOLUME );
848 BOOST_CHECK_EQUAL( renamedDoc.project().path(), expectedProjectPath.ToStdString() );
849 BOOST_CHECK_EQUAL( renamedDoc.project().name(), newProjectFile.GetName().ToStdString() );
851 if( aType == kiapi::common::types::DOCTYPE_PCB )
852 BOOST_CHECK_EQUAL( renamedDoc.board_filename(), newDocFile.GetFullName().ToStdString() );
855 kiapi::common::commands::GetDocumentModifiedState stateQuery;
856 stateQuery.mutable_document()->CopyFrom( document );
857 BOOST_CHECK( Client().SendCommand( stateQuery, &response ) );
858 BOOST_CHECK( response.status().status() != kiapi::common::AS_OK );
861 stateQuery.mutable_document()->CopyFrom( renamedDoc );
862 BOOST_CHECK( Client().SendCommand( stateQuery, &response ) );
863 BOOST_REQUIRE( response.status().status() == kiapi::common::AS_OK );
865 kiapi::common::commands::GetDocumentModifiedStateResponse state;
867 BOOST_CHECK( state.state() == kiapi::common::commands::DocumentModifiedState::DMS_UNMODIFIED );
869 kiapi::common::commands::SaveDocument
save;
870 save.mutable_document()->CopyFrom( renamedDoc );
872 BOOST_CHECK( response.status().status() == kiapi::common::AS_OK );
875 kiapi::common::ApiStatusCode closeStatus = kiapi::common::AS_UNKNOWN;
877 "CloseDocument after SaveAs failed: " + Client().LastError() );
885 wxString documentExt;
888 std::map<kiapi::common::types::DocumentType, SaveAsCase> cases = {
889 { kiapi::common::types::DOCTYPE_PCB,
891 wxS(
"api_kitchen_sink.kicad_pcb" ), wxS(
".kicad_pcb" ) } },
892 { kiapi::common::types::DOCTYPE_SCHEMATIC,
894 wxS(
"api_kitchen_sink.kicad_sch" ), wxS(
".kicad_sch" ) } }
897 for(
const auto& [docType,
source] : cases )
915 kiapi::common::types::DocumentSpecifier document;
918 "OpenDocument failed: " + Client().LastError() );
920 kiapi::common::ApiResponse response;
923 kiapi::common::commands::SaveDocumentAs emptyPath;
924 emptyPath.mutable_document()->CopyFrom( document );
925 BOOST_CHECK( Client().SendCommand( emptyPath, &response ) );
926 BOOST_CHECK( response.status().status() == kiapi::common::AS_BAD_REQUEST );
927 BOOST_CHECK( wxString( response.status().error_message() ).Contains( wxS(
"path is required" ) ) );
930 kiapi::common::commands::SaveDocumentAs staleDoc;
931 staleDoc.mutable_document()->CopyFrom( document );
932 staleDoc.mutable_document()->set_board_filename(
"no_such_board.kicad_pcb" );
933 staleDoc.set_path( tempDir.
ChildPathStr(
"never_written" ).ToStdString() );
934 BOOST_CHECK( Client().SendCommand( staleDoc, &response ) );
935 BOOST_CHECK( response.status().status() == kiapi::common::AS_BAD_REQUEST );
939 Client().CloseAllDocuments();
951 kiapi::common::types::DocumentSpecifier document;
954 "OpenDocument failed: " + Client().LastError() );
959 kiapi::common::commands::SaveDocumentAs saveAs;
960 saveAs.mutable_document()->CopyFrom( document );
961 saveAs.set_path( ( subdir + wxS(
"/moved" ) ).
ToStdString() );
963 kiapi::common::ApiResponse response;
965 "SaveDocumentAs failed to send: " + Client().LastError() );
966 BOOST_REQUIRE( response.status().status() == kiapi::common::AS_OK );
968 BOOST_CHECK( wxFileName( subdir + wxS(
"/moved.kicad_pcb" ) ).FileExists() );
969 BOOST_CHECK( wxFileName( subdir + wxS(
"/moved.kicad_pro" ) ).FileExists() );
972 kiapi::common::types::DocumentSpecifier otherBoard;
974 "Opening a board from the old project directory should have failed" );
975 BOOST_CHECK( Client().LastError().Contains( wxS(
"already open" ) ) );
977 Client().CloseAllDocuments();