x01dc
badbb82ba4
A Ctrl+C during lsamrot/fsamroy/osamroy rotation leaves the cached user_setpoint at the target even though the axis never finished moving (stop() halts the motor mid-move). The next scan then wrongly concluded "no rotation required" from setpoint equality alone, leaving LamNI's air bearings unclamped (confirmed via galil show all) and the beamline unable to scan until the setpoint was nudged manually. lamni_rotation() now also requires lgalil_is_air_off_and_orchestra_enabled() before skipping, since that flag only goes true once the Galil #CENROT sequence (air-clamp plus centering) has fully completed. flomni_rotation()/omny_rotation() use a readback-vs-tolerance check instead, since those axes have no air-bearing clamp step. Along the way, fixed lgalil_is_air_off_and_orchestra_enabled() itself: it did bool(socket_put_and_receive(...)) directly on the raw Galil reply string, which is always truthy, so it could never report anything but True. Confirmed via HW testing in LamNI.
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.