Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Simplify setup of local tests & update contributor docs #1353

Closed
tholor opened this issue Aug 18, 2021 · 2 comments
Closed

Simplify setup of local tests & update contributor docs #1353

tholor opened this issue Aug 18, 2021 · 2 comments
Labels
topic:tests type:feature New feature or request

Comments

@tholor
Copy link
Member

tholor commented Aug 18, 2021

Is your feature request related to a problem? Please describe.
Our CI works nicely, but it's currently quite cumbersome to run all tests locally. Especially, as they require running some document stores in the background.

Describe the solution you'd like

  • Cleaner option to launch required document stores locally
  • Remove unused fixtures
  • Review if we can make better use of the --document_store param to run all tests with the docstore of ones choice (e.g. document_store=memory should cover all major functionalities and only leave out the tests that are highly specific for elastic, faiss & co)
  • Update contributor guidelines to explain the local test setup
@mathislucka
Copy link
Member

Just to add a bit of information to this discussion:

I think what's still missing from the documentation added in #1355 is a hint that a dev should first install the requirements.txt and the requirements-dev.txt (pytest is only included in the dev requirements).

Furthermore, your Dockerfile does not install the requirements-dev.txt which would mean that the container would at least be missing pytest and sentence-transformers.

Also if using the docker container shouldn't the tests be run inside the container? Otherwise I'd still have to install all the dependencies locally. So the docs should probably contain a section on SSH'ing into the container and running tests from a shell inside the container.

Hope I'm not completely off with my observations.

@tholor
Copy link
Member Author

tholor commented Sep 28, 2021

Fixed by #1487

@tholor tholor closed this as completed Sep 28, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic:tests type:feature New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants