Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Enhance documentation of tests #851

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

Enhance documentation of tests #851

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
20 changes: 19 additions & 1 deletion tests/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,19 @@
"""Tests module for the SimPhoNy OSP."""
"""Tests for the SimPhoNy OSP.

Brief summary of the contents of the module:

- `benchmark.py`: Defines an abstract class to base individual benchmarks on.
- `benchmark_api.py`: Benchmarks methods from SimPhoNy's public API. Currently
exclusively focused on methods associated to ontology individuals.
- `pytest.ini`: pytest configuration (to run benchmarks only). Tests are run
with unittest.
- `test_api.py`: Tests public API methods involving sessions, terminological
knowledge, assertional knowledge, `pico`, and the `simphony_osp.tools`
module. Check the docstring of each test case for more details.
- `test_api_importexport_*`: Files used by `test_apy.py` to test importing
and exporting RDF files.
- `test_simphony_osp_session.py`: Tests functionality in the
`simphony_osp.session` module that is not part of the public API.
- `test_wrapper.py`: End-to-end tests involving the wrappers included with
SimPhoNy.
"""