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

Create simple test for examples/client_example #1717

Open
kairoaraujo opened this issue Dec 8, 2021 · 2 comments
Open

Create simple test for examples/client_example #1717

kairoaraujo opened this issue Dec 8, 2021 · 2 comments
Labels

Comments

@kairoaraujo
Copy link
Collaborator

Description of issue or feature request:
Adding a tests folder in examples/client_example and writing a simple test would be a great demonstration of best practices to who will be using the code to start a client implementation. Also, it avoids us making changes and breaking the example.

Current behavior:
No tests to the client example

Expected behavior:
Unit tests to the client example

@kairoaraujo
Copy link
Collaborator Author

IMO it could be tagged as "good first issue"

@jku
Copy link
Member

jku commented Dec 9, 2021

Adding a tests folder in examples/client_example

Let's keep all tests in the top-level tests/ dir: Lukas already added a tests/test_examples.py: this test can be added there

I think a simple "does the tool run successfully?, Did it download the file we wanted?" test is enough. The only tricky part here is that the test needs a server to be running: doing that reliably and quickly in CI is a problem -- maybe we can use the infrastructure we already have for simple_server.py. @MVrachev will be able to advice here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants