From 86ebd8af80cda93d281de1ba9ad9a60e92d966da Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=96mer=20Faruk=20=C3=96zdemir?= Date: Thu, 14 Apr 2022 00:06:14 +0300 Subject: [PATCH] test-guideline (#990) * test-guideline - add backend test guidelines * Update test/README.md Co-authored-by: Abubakar Abid Co-authored-by: Abubakar Abid --- test/README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 test/README.md diff --git a/test/README.md b/test/README.md new file mode 100644 index 0000000000..d98d54becb --- /dev/null +++ b/test/README.md @@ -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.