Use pytest as default test runner, add test coverage (#24)

* Add more build artifacts to the gitignore

* Update tests to use pytest as default runner, add coverage

Also update the README and test dependencies

* Produce HTML coverage report with terminal report

Author: AetherUnbound

.gitignore

@@ -2,7 +2,11 @@
 *.py[cod]
 build/
 dist/
+\.coverage
+labkey\.egg-info/
+\.eggs/
 
 # Project Artifacts
 .idea/
-*.iml
+*.iml
+*.swp

README.md

@@ -106,16 +106,21 @@ LabKey Server v15.1 and later.
 This package is maintained by [LabKey](http://www.labkey.com/). If you have any questions or need support, please use the [LabKey Server developer support forum](https://www.labkey.org/home/developer/forum/project-start.view).
 
 ### Testing
-If you are looking to contribute please run the tests before issuing a PR. For now you need to manually get the dependencies:
+If you are looking to contribute please run the tests before issuing a PR. The tests can be initiated by running
 
 ```bash
-$ pip install mock
+$ python setup.py test
 ```
 
-Then, to run the tests:
+This runs the tests using [pytest](https://docs.pytest.org/en/latest/contents.html). If you'd like to run pytest directly you can install the testing dependencies in your virtual environment with:
 
 ```bash
-$ python test/test_labkey.py
+$ pip install -e .[test]
+```
+
+Then, the tests can be run with
+```bash
+$ pytest .
 ```
 
 ### Maintainers

setup.cfg

@@ -1,2 +1,12 @@
 [metadata]
-description-file = README.md
+description-file = README.md
+
+[aliases]
+test=pytest
+
+[tool:pytest]
+addopts = -v --cov=labkey --cov-config=setup.cfg --cov-report=html --cov-report=term
+
+[coverage:html]
+directory = build/coverage_html
+title = Test coverage report for labkey

setup.py

@@ -36,6 +36,8 @@
 
 long_desc = "Python client API for LabKey Server. Supports query and experiment APIs."
 
+tests_require = ['pytest', 'requests', 'mock', 'pytest-cov']
+
 setup(
     name='labkey',
     version=version,
@@ -50,7 +52,11 @@
     packages=packages,
     package_data={},
     install_requires=['requests'],
-    tests_require=['requests', 'mock'],
+    tests_require=tests_require,
+    setup_requires=['pytest-runner'],
+    extras_require={
+        'test': tests_require
+    },
     keywords="labkey api client",
     classifiers=[
         'Development Status :: 4 - Beta',

test/conftest.py

@@ -0,0 +1,6 @@
+from labkey import utils
+
+# The mocks in the tests expect a request only to be made to the appropriate action.
+# This flag disables the CSRF check built into ServerContext.make_request() so the tests
+# get consistent results.
+utils.DISABLE_CSRF_CHECK = True

test/test_domain.py

@@ -28,7 +28,7 @@
 from labkey.domain import create, Domain, drop, get, infer_fields, save
 from labkey.exceptions import RequestAuthorizationError
 
-from utilities import MockLabKey, mock_server_context, success_test, success_test_get, throws_error_test, throws_error_test_get
+from .utilities import MockLabKey, mock_server_context, success_test, success_test_get, throws_error_test, throws_error_test_get
 
 
 domain_controller = 'property'

test/test_experiment_api.py

@@ -25,7 +25,7 @@
 from labkey.experiment import load_batch, save_batch, Batch, Run
 from labkey.exceptions import RequestError, QueryNotFoundError, ServerNotFoundError, RequestAuthorizationError
 
-from utilities import MockLabKey, mock_server_context, success_test, throws_error_test
+from .utilities import MockLabKey, mock_server_context, success_test, throws_error_test
 
 
 class MockLoadBatch(MockLabKey):

test/test_labkey.py

@@ -25,7 +25,7 @@
 from labkey.query import delete_rows, update_rows, insert_rows, select_rows, execute_sql, QueryFilter
 from labkey.exceptions import RequestError, QueryNotFoundError, ServerNotFoundError, RequestAuthorizationError
 
-from utilities import MockLabKey, mock_server_context, success_test, throws_error_test
+from .utilities import MockLabKey, mock_server_context, success_test, throws_error_test
 
 
 class MockSelectRows(MockLabKey):

test/test_query_api.py

@@ -27,7 +27,7 @@
     remove_from_group, remove_from_role, add_to_role, get_roles, list_groups
 from labkey.exceptions import RequestError, QueryNotFoundError, ServerNotFoundError, RequestAuthorizationError
 
-from utilities import MockLabKey, mock_server_context, success_test, throws_error_test
+from .utilities import MockLabKey, mock_server_context, success_test, throws_error_test
 
 
 class MockSecurityController(MockLabKey):