Pseudo-privatize tests (#242)

* Pseudo-privatize tests * Update import paths * Fix paths * Update releasehistory --------- Co-authored-by: Jeffrey Wagner <[email protected]> Co-authored-by: Jeff Wagner <[email protected]>
openforcefield · Dec 22, 2023 · 2b82714 · 2b82714
1 parent 25c9e4c
commit 2b82714
Show file tree

Hide file tree

Showing 22 changed files with 18 additions and 14 deletions.
diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml
@@ -66,7 +66,7 @@ jobs:
 
       - name: Run Tests
         run: |
-          python -m pytest -v --cov=openff --cov-config=setup.cfg --cov-report=xml openff/qcsubmit/tests
+          python -m pytest -v --cov=openff --cov-config=setup.cfg openff/qcsubmit/_tests/ --cov-report=xml
 
       - name: Codecov
         uses: codecov/codecov-action@v3

diff --git a/docs/releasehistory.md b/docs/releasehistory.md
@@ -10,13 +10,17 @@ Releases follow the ``major.minor.micro`` scheme recommended by
 <!--## Version / Date DD-MM-YYYY -->
 ## Current development
 
+### API-breaking changes
+
+* [PR #242:] Make tests private (`openff/qcsubmit/tests` --> `openff/qcsubmit/_tests`) (#242)
+
 ### Bugfixes
 
 * [PR #237:] Correctly use `openff.units` in `TorsionDriveResultCollection.to_records()` and the same method of other classes. (#237) [@chapincavender]
 
 ### Tests updated
 
-* [PR #252:] Update constrained torsiondrive test to use a smaller molecule to avoid CI runs timing out.
+* [PR #252:] Update constrained torsiondrive test to use a smaller molecule to avoid CI runs timing out. (#252)
 
 
 ## 0.4.0 / 11-15-2022

diff --git a/openff/qcsubmit/tests/__init__.py → openff/qcsubmit/_tests/__init__.py b/openff/qcsubmit/tests/__init__.py → openff/qcsubmit/_tests/__init__.py
diff --git a/openff/qcsubmit/tests/conftest.py → openff/qcsubmit/_tests/conftest.py b/openff/qcsubmit/tests/conftest.py → openff/qcsubmit/_tests/conftest.py
diff --git a/openff/qcsubmit/tests/results/__init__.py → openff/qcsubmit/_tests/results/__init__.py b/openff/qcsubmit/tests/results/__init__.py → openff/qcsubmit/_tests/results/__init__.py
diff --git a/openff/qcsubmit/tests/results/conftest.py → openff/qcsubmit/_tests/results/conftest.py b/openff/qcsubmit/tests/results/conftest.py → openff/qcsubmit/_tests/results/conftest.py
@@ -8,16 +8,16 @@
 from qcportal.optimization import OptimizationDatasetEntry as OptEntry
 from qcportal.optimization import OptimizationRecord
 
+from openff.qcsubmit._tests.results import (
+    mock_basic_result_collection,
+    mock_optimization_result_collection,
+    mock_torsion_drive_result_collection,
+)
 from openff.qcsubmit.results import (
     BasicResultCollection,
     OptimizationResultCollection,
     TorsionDriveResultCollection,
 )
-from openff.qcsubmit.tests.results import (
-    mock_basic_result_collection,
-    mock_optimization_result_collection,
-    mock_torsion_drive_result_collection,
-)
 
 
 def _smiles_to_molecule(smiles: str) -> Molecule:

diff --git a/...ff/qcsubmit/tests/results/test_filters.py → ...f/qcsubmit/_tests/results/test_filters.py b/...ff/qcsubmit/tests/results/test_filters.py → ...f/qcsubmit/_tests/results/test_filters.py
@@ -9,6 +9,7 @@
 from qcelemental.models import DriverEnum
 from qcportal.singlepoint import QCSpecification
 
+from openff.qcsubmit._tests.results import mock_optimization_result_collection
 from openff.qcsubmit.results import (
     BasicResult,
     OptimizationResult,
@@ -30,7 +31,6 @@
     SMILESFilter,
     UnperceivableStereoFilter,
 )
-from openff.qcsubmit.tests.results import mock_optimization_result_collection
 
 from . import RecordStatusEnum, SinglepointRecord
 

diff --git a/...ff/qcsubmit/tests/results/test_results.py → ...f/qcsubmit/_tests/results/test_results.py b/...ff/qcsubmit/tests/results/test_results.py → ...f/qcsubmit/_tests/results/test_results.py
@@ -15,6 +15,7 @@
     TorsiondriveSpecification,
 )
 
+from openff.qcsubmit._tests import does_not_raise
 from openff.qcsubmit.common_structures import QCSpec
 from openff.qcsubmit.exceptions import RecordTypeError
 from openff.qcsubmit.results import (
@@ -25,7 +26,6 @@
 )
 from openff.qcsubmit.results.filters import ResultFilter
 from openff.qcsubmit.results.results import TorsionDriveResult, _BaseResultCollection
-from openff.qcsubmit.tests import does_not_raise
 
 from . import (
     OptimizationRecord,

diff --git a/...qcsubmit/tests/specifications/__init__.py → ...csubmit/_tests/specifications/__init__.py b/...qcsubmit/tests/specifications/__init__.py → ...csubmit/_tests/specifications/__init__.py
diff --git a/...qcsubmit/tests/specifications/test_pcm.py → ...csubmit/_tests/specifications/test_pcm.py b/...qcsubmit/tests/specifications/test_pcm.py → ...csubmit/_tests/specifications/test_pcm.py
diff --git a/.../qcsubmit/tests/test_common_structures.py → ...qcsubmit/_tests/test_common_structures.py b/.../qcsubmit/tests/test_common_structures.py → ...qcsubmit/_tests/test_common_structures.py
@@ -1,9 +1,9 @@
 import pytest
 from openff.toolkit.topology import Molecule
 
+from openff.qcsubmit._tests import does_not_raise
 from openff.qcsubmit.common_structures import Metadata, MoleculeAttributes, QCSpec
 from openff.qcsubmit.exceptions import DatasetInputError, QCSpecificationError
-from openff.qcsubmit.tests import does_not_raise
 
 
 def test_attributes_from_openff_molecule():

diff --git a/openff/qcsubmit/tests/test_datasets.py → openff/qcsubmit/_tests/test_datasets.py b/openff/qcsubmit/tests/test_datasets.py → openff/qcsubmit/_tests/test_datasets.py
diff --git a/openff/qcsubmit/tests/test_factories.py → openff/qcsubmit/_tests/test_factories.py b/openff/qcsubmit/tests/test_factories.py → openff/qcsubmit/_tests/test_factories.py
diff --git a/openff/qcsubmit/tests/test_qcsubmit.py → openff/qcsubmit/_tests/test_qcsubmit.py b/openff/qcsubmit/tests/test_qcsubmit.py → openff/qcsubmit/_tests/test_qcsubmit.py
diff --git a/openff/qcsubmit/tests/test_serializers.py → openff/qcsubmit/_tests/test_serializers.py b/openff/qcsubmit/tests/test_serializers.py → openff/qcsubmit/_tests/test_serializers.py
diff --git a/openff/qcsubmit/tests/test_submissions.py → openff/qcsubmit/_tests/test_submissions.py b/openff/qcsubmit/tests/test_submissions.py → openff/qcsubmit/_tests/test_submissions.py
diff --git a/...csubmit/tests/test_workflow_components.py → ...submit/_tests/test_workflow_components.py b/...csubmit/tests/test_workflow_components.py → ...submit/_tests/test_workflow_components.py
diff --git a/openff/qcsubmit/tests/utils/__init__.py → openff/qcsubmit/_tests/utils/__init__.py b/openff/qcsubmit/tests/utils/__init__.py → openff/qcsubmit/_tests/utils/__init__.py
diff --git a/openff/qcsubmit/tests/utils/test_smirnoff.py → ...ff/qcsubmit/_tests/utils/test_smirnoff.py b/openff/qcsubmit/tests/utils/test_smirnoff.py → ...ff/qcsubmit/_tests/utils/test_smirnoff.py
diff --git a/...ff/qcsubmit/tests/utils/test_visualize.py → ...f/qcsubmit/_tests/utils/test_visualize.py b/...ff/qcsubmit/tests/utils/test_visualize.py → ...f/qcsubmit/_tests/utils/test_visualize.py
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.black]
 line-length = 88
-target-version = ['py37']
+target-version = ['py39']
 exclude = '''
 
 (
@@ -16,7 +16,7 @@ exclude = '''
     | build
     | dist
   )/
-  | tests           # also separately exclude a file named foo.py in
+  | _tests           # also separately exclude a file named foo.py in
                      # the root of the project
 )
-'''
+'''
diff --git a/setup.cfg b/setup.cfg
@@ -4,7 +4,7 @@
 # .coveragerc to control coverage.py and pytest-cov
 omit =
     # Omit the tests
-    */*/tests/*
+    */*/_tests/*
     # Omit generated versioneer
     openff/qcsubmit/_version.py