Make backend and conftest into links in dev docs #149
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jl-wynen
reviewed
Sep 29, 2023
docs/developer/testing.rst
Outdated
| @@ -21,12 +21,18 @@ 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 |backend folder|_ folder and |conftest file|_ for the concrete setup. | |||
There was a problem hiding this comment.
Why is this needed? Can't you use
`src/scitacean/backend <https://github.com/SciCatProject/scitacean/tree/main/src/scitacean/testing/backend>`_
?
nvaytet
commented
Apr 17, 2024
| 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 <https://github.com/SciCatProject/scitacean/tree/main/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. | ||
|
|
There was a problem hiding this comment.
It seems the paths to the files below are out of date. There is no tests/common/sftp_server.py in the repo I think?
There was a problem hiding this comment.
True. Those files are now packaged with Scitacean and are now in
:mod:`scitacean.testing.sftp`
Can you update the paths to this? I don't think we need to refer to any concrete files in this case but to the user guide in https://scicatproject.github.io/scitacean/user-guide/testing.html#Local-SFTP-fileserver
There was a problem hiding this comment.
Is this statement still true?
Tests can use it by depending on the
sftp_fileserverfixture.
There was a problem hiding this comment.
jl-wynen
force-pushed
the
links-testing-docs
branch
from
1ede3c8
to
768ad38
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.