x01dc
62b4b8d8fa
oosa_in(), oosa_out(), ofzp_in(), ofzp_out() used to unconditionally re-move every axis (and, for FZP, unconditionally disable rt feedback) even when already at the target -- visible as repeated no-op progress bars on back-to-back calls. Ported the same "skip if already there" optimization flomni's fosa_in()/ffzp_in() already have (and that lamni already got too, see test_lamni_optics_skip_if_in_position.py). For oosa_in()/oosa_out() the "already there" check has to run *before* _oosa_check_y(), since that call unconditionally parks oosay at 0.9 -- never the real in/out position for either near- or far-field mode -- so checking afterward would always miss the match. oosa_out()'s "out" targets are hardcoded literals in the existing code (no user_parameter for out, unlike oosa_in's far_field_in/near_field_in), so the skip check compares against those same literals. New tests/tests_bec_ipython_client/test_omny_optics_skip_if_in_position.py (9 tests, mirroring the lamni test's structure): skip-vs-move for both near/far field on oosa_in/oosa_out, and skip-vs-move-and-disable-feedback for ofzp_in/ofzp_out.
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.