diff --git a/docs/developer/testing.rst b/docs/developer/testing.rst index 8e1f08dc..97ba7d1c 100644 --- a/docs/developer/testing.rst +++ b/docs/developer/testing.rst @@ -21,9 +21,9 @@ In addition, the fakes are relatively complex and may diverge from the real impl To mitigate these problems, the fake client is tested alongside a real client. But to (mostly) avoid the downsides stated in the beginning, the real client is connected to a local SciCat server. -See ``src/testing/backend.py`` and ``tests/conftest.py`` for the concrete setup. +See the `src/scitacean/backend `_ folder and `tests/conftest.py `_ file for the concrete setup. The backend is launched in a docker container with the image of the latest release of the SciCat backend. -Tests in ``tests/client`` are then run with both the fake and the real client to ensure that both produce the same results. +Tests in `tests/client `_ are then run with both the fake and the real client to ensure that both produce the same results. Use ``--backend-tests`` with ``pytest`` to run these tests. @@ -31,9 +31,9 @@ SFTP file transfer ------------------ Testing :class:`scitacean.transfer.sftp.SFTPFileTransfer` requires an SFTP server. -``tests/common/sftp_server.py`` contains helpers for managing one via Docker. +:mod:`scitacean.testing.sftp` contains helpers for managing one via Docker. Tests can use it by depending on the ``sftp_fileserver`` fixture. -See the documentation in ``tests/common/sftp_server.py`` for how it works. +See the `documentation `_ for how it works. Note that those tests may leave a small directory behind. This is an issue with file ownership and permissions caused by making the Docker volumes writable.