FlexMeasures / flexmeasures-client / 33997113812

97%

Build Type

push

github

Committed by web-flow

Commit Message

Feat/integrate reporting endpoints & use in HEMS script (#224)

* feat(client): add job failure and timeout exceptions

Background jobs polled via the generic jobs API can end in a failed
terminal state or never reach one at all. Give both cases a dedicated
exception so callers can tell them apart from transport errors.

Signed-off-by: Mohamed Belhsan Hmida <mohamedbelhsanhmida@gmail.com>

* feat(client): poll background jobs via the generic jobs API

Add get_job_status() for a single lookup of GET /api/v3_0/jobs/<uuid>,
and wait_for_job() to poll one until it reaches a terminal state, with
exponential backoff capped at max_polling_interval and a total timeout
budget.

Failed jobs raise JobFailedError carrying the server's message and
traceback, so callers get something actionable instead of a bare status.

Signed-off-by: Mohamed Belhsan Hmida <mohamedbelhsanhmida@gmail.com>

* feat(client): trigger one-off reports over the asset API

Add trigger_report(), posting to POST /assets/<id>/reports/trigger and
returning the queued job UUID, plus trigger_and_await_report() which
chains it with wait_for_job().

The endpoint lands in FlexMeasures v1.1.0, so a 404 from an older server
is reported as a version problem pointing at the CLI fallback.

Signed-off-by: Mohamed Belhsan Hmida <mohamedbelhsanhmida@gmail.com>

* test(client): cover report triggering and job polling

Assert the exact request bodies sent to the trigger endpoint, that
polling walks through QUEUED/DEFERRED/STARTED before returning a
finished job, and that failed, stopped, canceled and never-finishing
jobs each raise the right error.

Signed-off-by: Mohamed Belhsan Hmida <mohamedbelhsanhmida@gmail.com>

* refactor(hems): drive reports over the API instead of the CLI

Replace run_report_cmd() and its subprocess call with an async
run_report() that triggers the report on the asset owning its output
sensors and waits for the job.

Parameters are now built in memory rather than written to
configs/... (continued)

Coverage Stats

118 of 121 new or added lines in 4 files covered. (97.52%)

1 existing line in 1 file now uncovered.

823 of 850 relevant lines covered (96.82%)

9.68 hits per line