test-guideline (#990)

* test-guideline
- add backend test guidelines

* Update test/README.md

Co-authored-by: Abubakar Abid <abubakar@huggingface.co>

Co-authored-by: Abubakar Abid <abubakar@huggingface.co>
This commit is contained in:
Ömer Faruk Özdemir 2022-04-14 00:06:14 +03:00 committed by GitHub
parent 9cb40dc99a
commit 86ebd8af80
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

10
test/README.md Normal file
View File

@ -0,0 +1,10 @@
# Backend Testing Guidelines
- All the tests should test Backend functionalities. Frontend functionalities and e2e tests are done in Frontend.
- Make use of pytest fixtures whenever it is possible. With fixtures, objects with high initialize durations are reused within tests, ex. a client session.
- All test_data resides within _gradio/test_data_ and all test_files resides within test/test_files.
- When doing network operations do not forget to make use of async to make tests faster.
- Have clear class and function naming within the tests.
- Short descriptions within test functions are great.
- Library function docstrings is expected to contain an example, please add missing docstrings to the library while you are writing tests the related function.
- Library docstring examples and descriptions are expected to align with tests, please fix divergent tests and library docstrings.