The previous fix only covered on_complete. At the beamline the scan with packet loss then completed (S00998), but the next one failed in on_stage (S00999): on_stage calls wait_for_idle() with raise_on_timeout=True, and /wait_till_done keeps answering HTTP 500 "Missing packets in data collection; reduce frame rate" until the next collection starts, although the broker is Idle. wait_for_idle() now checks the broker state when /wait_till_done raises a ServiceException and returns True if it is Idle. This covers every caller (on_stage, on_complete, initialise). The broker message stays available through jfj_status, so on_complete still applies the missing-packet policy and the image-count check. on_complete no longer needs its own state check; it keeps the 0.2 s pause between failed attempts. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Getting Started with Testing using pytest
BEC is using the pytest framework. It can be installed via
pip install pytest
in your python environment.
We note that pytest is part of the optional-dependencies [dev] of the plugin package.
Introduction
Tests in this package should be stored in the tests directory.
We suggest to sort tests of different submodules, i.e. scans or devices in the respective folder structure, and to folow a naming convention of <test_module_name.py>.
It is mandatory for test files to begin with test_ for pytest to discover them.
To run all tests, navigate to the directory of the plugin from the command line, and run the command
pytest -v --random-order ./tests
Note, the python environment needs to be active.
The additional arg -v allows pytest to run in verbose mode which provides more detailed information about the tests being run.
The argument --random-order instructs pytest to run the tests in random order, which is the default in the CI pipelines.
Test examples
Writing tests can be quite specific for the given function. We recommend writing tests as isolated as possible, i.e. try to test single functions instead of full classes. A very useful class to enable isolated testing is MagicMock. In addition, we also recommend to take a look at the How-to guides from pytest.