aboutsummaryrefslogtreecommitdiff
path: root/backend/README.md
diff options
context:
space:
mode:
authorTerry Truong <terry06890@gmail.com>2022-09-11 14:55:42 +1000
committerTerry Truong <terry06890@gmail.com>2022-09-11 15:04:14 +1000
commit5de5fb93e50fe9006221b30ac4a66f1be0db82e7 (patch)
tree2567c25c902dbb40d44419805cebb38171df47fa /backend/README.md
parentdaccbbd9c73a5292ea9d6746560d7009e5aa666d (diff)
Add backend unit tests
- Add unit testing code in backend/tests/ - Change to snake-case for script/file/directory names - Use os.path.join() instead of '/' - Refactor script code into function defs and a main-guard - Make global vars all-caps Some fixes: - For getting descriptions, some wiki redirects weren't properly resolved - Linked images were sub-optimally propagated - Generation of reduced trees assumed a wiki-id association implied a description - Tilo.py had potential null dereferences by not always using a reduced node set - EOL image downloading didn't properly wait for all threads to end when finishing
Diffstat (limited to 'backend/README.md')
-rw-r--r--backend/README.md12
1 files changed, 9 insertions, 3 deletions
diff --git a/backend/README.md b/backend/README.md
index fc68183..0f3f332 100644
--- a/backend/README.md
+++ b/backend/README.md
@@ -1,5 +1,11 @@
# Files
-- **tolData**: Holds scripts for generating the tree-of-life database
-- **tilo.py**: WSGI script that serves data from the tree-of-life database. <br>
- Note: Using WSGI instead of CGI to avoid starting a new process for each request.
+- **tol_data/**: Holds scripts for generating the tree-of-life database
+- **tilo.py**: WSGI script that serves data from the tree-of-life database. <br>
+ Note: WSGI is used instead of CGI to avoid starting a new process for each request.
- **server.py**: Basic dev server that serves the WSGI script and image files
+- **tests/**: Holds unit testing scripts.<br>
+ Running all tests: `python -m unittest discover -s tests` <br>
+ Running a particular test: `python -m unittest tests/test_script1.py` <br>
+ Getting code coverage info (uses python package 'coverage'): <br>
+ 1. `coverage run -m unittest discover -s tests`
+ 2. `coverage report -m > report.txt`