Add CLI commands to inspect/restart the environment

[joeshannon]

No description provided.

[stan-dot]

what are the features of environment we want to inspect here? is it about pip environment? or beamline-specific config?

[joeshannon]

This to add cli support for the environment end points. This allows the bluesky context to be reloaded without restarting the whole service which is useful if blueapi is loading plans from a "scratch" area to allow rapid development/testing.

[stan-dot]

connected to #363 (?)

looking into the environment now

[stan-dot]

`
@app.get("/environment", response_model=EnvironmentResponse)
def get_environment(
handler: BlueskyHandler = Depends(get_handler),
) -> EnvironmentResponse:
return EnvironmentResponse(initialized=handler.initialized)

@app.delete("/environment")
async def delete_environment(
background_tasks: BackgroundTasks,
handler: BlueskyHandler = Depends(get_handler),
):
def restart_handler(handler: BlueskyHandler):
handler.stop()
handler.start()

if handler.initialized:
    background_tasks.add_task(restart_handler, handler)

`

I see only two endpoints right now - get and delete, no 'reload'. Reading into the calls from delete it looks like that it is how the reload should be performed.

would the minimal implementation user experience be of this kind: blueapi env and blueapi env reload? with some alternatives names possible ('env r') for faster reload?

[callumforrester]

You're correct, "reload" is a verb, so shouldn't be in the rest api. But the CLI can combine nouns into a verb. So your suggested UX looks good.

[stan-dot]

ok will implement that, it should be a pretty minimal addition

[stan-dot]

not sure if 'environment' is the best name here

one confusing thing is the similarity between 'infrastructure environment', 'environment variables' and what we have here is 'devices ensemble' or 'devices config'. [just brainstorming]

[stan-dot]

currently {'initialized': True} is as much of an inspection main.py allows:

@app.get("/environment", response_model=EnvironmentResponse) def get_environment( handler: BlueskyHandler = Depends(get_handler), ) -> EnvironmentResponse: return EnvironmentResponse(initialized=handler.initialized)

[stan-dot]

using blueapi controller env as that click command group has already the rest client in the context, hence as this env command also uses the rest client it only makes sense that it is under command not main

[stan-dot]

none is not an allowed value (type=type_error.none.not_allowed) Pydantic complains. @callumforrester could you check cli.py:114?

[stan-dot]

thinking how to fix the test which fails now that there's the 'sleep(5) line there

[stan-dot]

testing sleep does not seem to be well-supported
pytest-dev/pytest#11196

most use cases are to use 'sleep' in the test body itself