DiamondLightSource / DiamondLightSource/dodal

Fix build and test docs to mention system tests

Open
#1,698 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
5
Forks
13
Avg merge
3d 2h
Merged PRs (30d)
10

Description

https://diamondlightsource.github.io/dodal/main/how-to/dev-install.html#build-and-test instructs developers to run `tox -p` to confirm a working environment. However, this fails the system tests with an error like:
```
read_pv: NotConnectedError: ca://BL01T-DI-CAM-01:HDF5:QueueSize_RBV
write_pv: NotConnectedError: ca://BL01T-DI-CAM-01:HDF5:QueueSize
position_mode: NotConnectedError:
read_pv: NotConnectedError: ca://BL01T-DI-CAM-01:HDF5:PositionMode_RBV
write_pv: NotConnectedError: ca://BL01T-DI-CAM-01:HDF5:PositionMode
compression: NotConnectedError:
read_pv: NotConnectedError: ca://BL01T-DI-CAM-01:HDF5:Compression_RBV
write_pv: NotConnectedError: ca://BL01T-DI-CAM-01:HDF5:Compression
num_extra_dims: NotConnectedError:
read_pv: NotConnectedError: ca://BL01T-DI-CAM-01:HDF5:NumExtraDims_RBV
write_pv: NotConnectedError: ca://BL01T-DI-CAM-01:HDF5:NumExtraDims
swmr_mode: NotConnectedError:
read_pv: NotConnectedError: ca://BL01T-DI-CAM-01:HDF5:SWMRMode_RBV
write_pv: NotConnectedError: ca://BL01T-DI-CAM-01:HDF5:SWMRMode
flush_now: NotConnectedError: ca://BL01T-DI-CAM-01:HDF5:FlushNow
xml_file_name: NotConnectedError:
read_pv: NotConnectedError: ca://BL01T-DI-CAM-01:HDF5:XMLFileName_RBV
write_pv: NotConnectedError: ca://BL01T-DI-CAM-01:HDF5:XMLFileName
num_frames_chunks: NotConnectedError:
read_pv: NotConnectedError: ca://BL01T-DI-CAM-01:HDF5:NumFramesChunks_RBV
write_pv: NotConnectedError: ca://BL01T-DI-CAM-01:HDF5:NumFramesChunks
chunk_size_auto: NotConnectedError:
read_pv: NotConnectedError: ca://BL01T-DI-CAM-01:HDF5:ChunkSizeAuto_RBV
write_pv: NotConnectedError: ca://BL01T-DI-CAM-01:HDF5:ChunkSizeAuto
lazy_open: NotConnectedError:
read_pv: NotConnectedError: ca://BL01T-DI-CAM-01:HDF5:LazyOpen_RBV
write_pv: NotConnectedError: ca://BL01T-DI-CAM-01:HDF5:LazyOpen
====== 6 passed, 1 skipped, 1 deselected, 11 errors in 132.43s (0:02:12) =======
ERROR: InvocationError for command /scratch/ffv81422/bluesky_work/mx-bluesky/.venv/bin/pytest -m 'not requires(instrument="i04")' --cov-report xml:system_cov.xml --json-report --json-report-file=system-report.json system_tests (exited with code 1)

========================================================================================== log end ==========================================================================================
✖ FAIL system-report in 2 minutes, 26.583 seconds
__________________________________________________________________________________________ summary __________________________________________________________________________________________
pre-commit: commands succeeded
type-checking: commands succeeded
tests: commands succeeded
ERROR: docs: parallel child exit code 1
unit-report: commands succeeded
ERROR: system-report: parallel child exit code 1
```
This is because the system test dependencies have not been started as specified in https://diamondlightsource.github.io/dodal/main/how-to/run-tests.html#system-tests-locally.

## Acceptance Criteria
Documentation either:
* Instructs you on running all tests except the system tests (then points you to how you can add the system tests in there too)
* Tells you to set up everything for the system tests first
* Ideally - make running `tox -p` also start the required system test dependencies if they haven't already been

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.