24#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>
52 explicit TEST_TASK( BEHAVIOR aBehavior ) :
53 m_behavior( aBehavior )
63 case BEHAVIOR::COMPLETE:
66 case BEHAVIOR::REPORT_FAILED:
67 m_state = kiapi::common::tasks::TS_FAILED;
68 m_errorMessage =
"reported failure";
71 case BEHAVIOR::REPORT_CANCELLED:
72 m_state = kiapi::common::tasks::TS_CANCELLED;
73 m_errorMessage =
"reported cancellation";
76 case BEHAVIOR::THROW_STD:
77 throw std::runtime_error(
"boom" );
79 case BEHAVIOR::THROW_UNKNOWN:
84 void FillStatus( kiapi::common::tasks::TaskStatusResponse& aStatus )
const override
86 if( m_state != kiapi::common::tasks::TS_UNKNOWN )
87 aStatus.set_state( m_state );
89 if( !m_errorMessage.empty() )
90 aStatus.set_error_message( m_errorMessage );
93 int RunCount()
const {
return m_runCount; }
98 kiapi::common::tasks::TaskState m_state = kiapi::common::tasks::TS_UNKNOWN;
99 std::string m_errorMessage;
103kiapi::common::ApiRequest makeGetTaskStatusRequest(
const std::string& aToken )
105 kiapi::common::tasks::GetTaskStatus command;
106 command.mutable_token()->set_value( aToken );
108 kiapi::common::ApiRequest request;
109 request.mutable_header()->set_client_name(
"kicad.qa" );
110 BOOST_REQUIRE( request.mutable_message()->PackFrom( command ) );
128 auto first = std::make_shared<TEST_TASK>( TEST_TASK::BEHAVIOR::COMPLETE );
129 std::optional<std::string> firstToken = scheduler.
StartTask( first,
"first" );
134 auto second = std::make_shared<TEST_TASK>( TEST_TASK::BEHAVIOR::COMPLETE );
141 auto status = scheduler.
GetStatus( *firstToken );
152 auto throwing = std::make_shared<TEST_TASK>( TEST_TASK::BEHAVIOR::THROW_STD );
153 std::optional<std::string> token = scheduler.
StartTask( throwing,
"throwing" );
158 auto status = scheduler.
GetStatus( *token );
166 auto following = std::make_shared<TEST_TASK>( TEST_TASK::BEHAVIOR::COMPLETE );
167 std::optional<std::string> followingToken = scheduler.
StartTask( following,
"following" );
172 auto followingStatus = scheduler.
GetStatus( *followingToken );
174 BOOST_CHECK_EQUAL( followingStatus->state(), kiapi::common::tasks::TS_COMPLETED );
183 auto throwing = std::make_shared<TEST_TASK>( TEST_TASK::BEHAVIOR::THROW_UNKNOWN );
184 std::optional<std::string> token = scheduler.
StartTask( throwing,
"throwing" );
189 auto status = scheduler.
GetStatus( *token );
201 auto task = std::make_shared<TEST_TASK>( TEST_TASK::BEHAVIOR::REPORT_FAILED );
202 std::optional<std::string> token = scheduler.
StartTask( task,
"reported" );
207 auto status = scheduler.
GetStatus( *token );
219 auto task = std::make_shared<TEST_TASK>( TEST_TASK::BEHAVIOR::REPORT_CANCELLED );
220 std::optional<std::string> token = scheduler.
StartTask( task,
"cancelled" );
225 auto status = scheduler.
GetStatus( *token );
237 std::string firstToken;
238 std::string lastToken;
242 auto task = std::make_shared<TEST_TASK>( TEST_TASK::BEHAVIOR::COMPLETE );
243 std::optional<std::string> token = scheduler.
StartTask( task,
"eviction" );
246 if( firstToken.empty() )
257 auto lastStatus = scheduler.
GetStatus( lastToken );
272 auto task = std::make_shared<TEST_TASK>( TEST_TASK::BEHAVIOR::COMPLETE );
273 std::optional<std::string> token = scheduler.
StartTask( task,
"status" );
276 kiapi::common::ApiRequest runningRequest = makeGetTaskStatusRequest( *token );
280 kiapi::common::tasks::TaskStatusResponse runningStatus;
281 BOOST_REQUIRE( runningResult->message().UnpackTo( &runningStatus ) );
286 kiapi::common::ApiRequest completedRequest = makeGetTaskStatusRequest( *token );
290 kiapi::common::tasks::TaskStatusResponse completedStatus;
291 BOOST_REQUIRE( completedResult->message().UnpackTo( &completedStatus ) );
292 BOOST_CHECK_EQUAL( completedStatus.state(), kiapi::common::tasks::TS_COMPLETED );
300 kiapi::common::ApiRequest request =
301 makeGetTaskStatusRequest(
"deadbeef-0000-0000-0000-000000000000" );
tl::expected< ApiResponse, ApiResponseStatus > API_RESULT
bool CanHandle(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.
For now, a single process-wide task runner, and one task at a time.
std::shared_ptr< API_TASK > GetFinishedTask(const std::string &aToken) const
Look up a task that has finished, for result retrieval.
std::optional< kiapi::common::tasks::TaskStatusResponse > GetStatus(const std::string &aToken) const
Get a snapshot of the task's current status.
bool AnyTaskRunning() const
void Pump()
Run the current task to completion, synchronously.
static API_TASK_SCHEDULER & Instance()
static constexpr size_t MAX_FINISHED_TASKS
std::optional< std::string > StartTask(const std::shared_ptr< API_TASK > &aTask, const wxString &aDescription)
Register a new task and begin running it.
BOOST_AUTO_TEST_CASE(HorizontalAlignment)
BOOST_AUTO_TEST_CASE(StartTaskEnforcesSingleFlight)
BOOST_AUTO_TEST_SUITE(CadstarPartParser)
BOOST_CHECK(res.column_datatype(0)==SQL_NUMERIC||res.column_datatype(0)==SQL_DECIMAL)
BOOST_CHECK_EQUAL(std::any_cast< std::string >(rows[0].at("val")), "12345678901234567.89")
BOOST_REQUIRE(res.columns()==1)
BOOST_AUTO_TEST_SUITE_END()
wxString result
Test unit parsing edge cases and error handling.