x01dc
57903579fc
Real hardware already applies this correctly: controller1.dmc's #NEWPAR handler subtracts 25 deg from the target when setting osamroy's position (contrID=3, axis=2), symmetric with the +25 the ophyd read side (OMNYGalilReadbackSignal._socket_get) already adds back. The simulated Galil controller (SimGalilState.start_move_from_newpar) didn't replicate this, so a simulated osamroy.move(x) landed 25 deg away from where real hardware would -- a simulator-fidelity bug, not a hardware or ophyd bug. Also adds osamroy to the offline sim_lamni_omny_harness so this class of bug is caught there going forward, and a focused unit test for the round-trip and its scoping to port 8083 / axis 2 only.
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.