Merge pull request #228 from DerwenAI/pytest-basics

Implement pytest for current tests

Author: ceteri

.bandit

@@ -1,4 +1,5 @@
 [bandit]
 exclude_dirs:
   - examples
-exclude: setup.py,test.py
+  - tests
+exclude: setup.py

.pre-commit-config.yaml

@@ -17,17 +17,17 @@ repos:
     rev: 1.7.0
     hooks:
     -   id: bandit # security vulnerabilities
-        args: [ "--exclude", "setup.py,bin,test.py" ]
+        args: [ "--exclude", "setup.py,bin,tests" ]
 -   repo: https://github.com/pre-commit/mirrors-mypy
     rev: v0.812
     hooks:
     -   id: mypy # type annotations
-        exclude: ^examples/,^wip/,^test.py
+        exclude: ^examples/,^wip/,^tests/
 -   repo: https://github.com/PyCQA/pylint
     rev: pylint-2.7.2
     hooks:
     -   id: pylint
-        exclude: ^wip/,^test.py
+        exclude: ^wip/,^tests/
         files: ^kglab/
 -   repo: https://github.com/codespell-project/codespell
     rev: v2.0.0

docker/Dockerfile

@@ -37,7 +37,6 @@ COPY ./kglab /opt/kglab/kglab
 COPY ./dat /opt/kglab/dat
 COPY ./examples /opt/kglab/examples
 COPY ./requirements*.txt /opt/kglab/
-COPY ./test.py /opt/kglab/
 COPY ./sample.py /opt/kglab/
 
 ## create a known user ID

docker/Dockerfile.common

@@ -37,7 +37,6 @@ COPY ./kglab /opt/kglab/kglab
 COPY ./dat /opt/kglab/dat
 COPY ./examples /opt/kglab/examples
 COPY ./requirements*.txt /opt/kglab/
-COPY ./test.py /opt/kglab/
 COPY ./sample.py /opt/kglab/
 
 ## create a known user ID

docker/Dockerfile.testsuite

@@ -6,8 +6,10 @@ FROM kglab as testsuite
 WORKDIR /opt/kglab
 USER appuser
 
+COPY ./tests/* /opt/kglab/tests/
+
 RUN set -eux; \
 	source /opt/kglab/venv/bin/activate ; \
 	/opt/kglab/venv/bin/python3.8 -m pip install -r /opt/kglab/requirements-dev.txt
 
-CMD /opt/kglab/venv/bin/python3.8 /opt/kglab/test.py
+CMD /opt/kglab/venv/bin/python3.8 -m pytest tests/

docker/testsuite.Dockerfile

@@ -37,7 +37,7 @@ COPY ./kglab /opt/kglab/kglab
 COPY ./dat /opt/kglab/dat
 COPY ./examples /opt/kglab/examples
 COPY ./requirements*.txt /opt/kglab/
-COPY ./test.py /opt/kglab/
+COPY ./tests/ /opt/kglab/tests/
 COPY ./sample.py /opt/kglab/
 
 ## create a known user ID
@@ -70,4 +70,4 @@ RUN set -eux; \
 	source /opt/kglab/venv/bin/activate ; \
 	/opt/kglab/venv/bin/python3.8 -m pip install -r /opt/kglab/requirements-dev.txt
 
-CMD /opt/kglab/venv/bin/python3.8 /opt/kglab/test.py
+CMD /opt/kglab/venv/bin/python3.8 -m pytest tests/

docs/build.md

@@ -79,7 +79,7 @@ This project uses `unittest` and
 [`coverage`](https://coverage.readthedocs.io/)
 for *unit test* coverage. 
 Source for unit tests is in the 
-[`test.py`](https://github.com/DerwenAI/kglab/blob/main/test.py)
+[`tests/`](https://github.com/DerwenAI/kglab/blob/main/tests/)
 module.
 
 To run unit tests:
@@ -100,7 +100,7 @@ Test coverage reports can be viewed at
 The CI pipeline will test automatically for each pull request,
 although to run these tests manually:
 ```
-python3 ./test.py
+python3 -m pytest tests/
 python3 -m pytest --nbmake examples/
 ```
 
@@ -153,7 +153,7 @@ release process:
 
 ```
 python3 -m pip install -e .
-python3 ./test.py
+python3 -m pytest tests/
 python3 -m pip uninstall kglab
 ```
 

requirements-dev.txt

@@ -17,6 +17,7 @@ pre-commit
 pygments >= 2.7.4
 pylint >= 2.7.0
 pymdown-extensions
+pytest
 scikit-learn >= 0.20.2
 selenium
 twine