build: update pyproject.toml to support hatch test command

Author: zaufi

.github/workflows/linters.yaml

@@ -89,9 +89,6 @@ jobs:
       - name: Run type check
         run: hatch run type-check
 
-      - name: Run spell check
-        run: hatch run spell-check
-
       - name: Run license check
         run: hatch run license-check
 

.github/workflows/release.yaml

@@ -35,7 +35,9 @@ jobs:
         shell: bash
         run: |
           echo "CACHE_KEY=$( \
-              .github/workflows/get-key.py --hash tool.hatch.envs.default.dependencies \
+              yq eval -r .tool.hatch.envs.default.dependencies -oy pyproject.toml \
+            | sha1sum \
+            | cut -f 1 -d ' ' \
             )" | tee -a "${GITHUB_ENV}"
 
       - name: Prepare Cache

.github/workflows/run-tests.yaml

@@ -40,9 +40,10 @@ jobs:
 
       - name: Get Cache Key
         run: |
-          [[ '${{ matrix.python-version }}' == '3.10' ]] && pip install tomli
           echo "CACHE_KEY=$( \
-              .github/workflows/get-key.py --json --hash tool.hatch.envs.test.overrides.matrix.pytest.dependencies \
+              yq eval -r .tool.hatch.envs.hatch-test.overrides.matrix.pytest.dependencies -oy pyproject.toml \
+            | sha1sum \
+            | cut -f 1 -d ' ' \
             )" | tee -a "${GITHUB_ENV}"
         shell: bash
 
@@ -58,8 +59,5 @@ jobs:
         uses: pypa/hatch@install
 
       - name: Run tests
-        # NOTE Run tests per environment to avoid `default` environment activation
-        # when `hatch run test` running.
         run: |
-          hatch run test.pytest.7x:test
-          hatch run test.pytest.8x:test
+          hatch test -i pytest=pytest.7x,pytest.8x

ChangeLog.rst

@@ -26,10 +26,13 @@ to `Semantic Versioning`_.
 Unreleased_
 ===========
 
-Added
------
+Changed
+-------
 
+- Set the :option:`pm-patterns-base-dir` default to :file:`tests/data/expected` to align with
+  the common :file:`tests/` directory layout.
 - Improve documentation.
+- Update the :file:`pyproject.toml` to suit the :program:`hatch test` command.
 
 
 2.0.2_ -- 2024-08-01

REUSE.toml

@@ -25,7 +25,7 @@ SPDX-FileCopyrightText = "2024 Alex Turbov <zaufi@pm.me>"
 SPDX-License-Identifier = "CC0-1.0"
 
 [[annotations]]
-path = "test/data/**"
+path = "tests/data/**"
 precedence = "aggregate"
 SPDX-FileCopyrightText = "2024 Alex Turbov <zaufi@pm.me>"
 SPDX-License-Identifier = "CC0-1.0"

doc/api.rst

@@ -69,7 +69,7 @@ Marker
         def system_specific_test(capfd, expected_out):
             ...
             stdout, _ = capfd.readouterr()
-            # Get content from `<base-dir>/.../system_specific-Linux.out`
+            # Get content from `<base-dir>/.../system_specific_test-Linux.out`
             assert expected_out == stdout
 
         @pytest.mark.expect_suffix(

doc/configuration.rst

@@ -40,7 +40,7 @@ The following options can be set in the `Pytest configuration file`_.
 
 .. option:: pm-patterns-base-dir
 
-    :Default: :file:`test/data/expected`
+    :Default: :file:`tests/data/expected`
 
     Base directory used for storing pattern files.
     The directory must be relative to the project's root.

doc/getting-started.rst

@@ -21,7 +21,7 @@ or with ``diff`` mode highlighted via ``Pygments``:
 The plugin provides the fixtures :py:data:`expected_out` and :py:data:`expected_err`.
 Usage is straightforward as shown below:
 
-.. literalinclude:: ../test/test_foo.py
+.. literalinclude:: ../tests/test_foo.py
     :language: python
     :pyobject: test_foo
 
@@ -30,33 +30,34 @@ If you run :command:`pytest` now, the test will be skipped because the expectati
 .. code-block:: console
     :emphasize-lines: 5,6
 
-    $ pytest --no-header --no-summary test/test_foo.py::test_foo
+    $ pytest --no-header --no-summary tests/test_foo.py::test_foo
     ============================= test session starts ==============================
     collected 1 item
 
-    test/test_foo.py::test_foo SKIPPED (Base directory for pattern-matcher
-    does not exist: `…/pytest-matcher/master/test/data/expected`)               [100%]
+    tests/test_foo.py::test_foo SKIPPED (Base directory for pattern-matcher
+    does not exist: `…/pytest-matcher/master/tests/data/expected`)            [100%]
 
     ============================== 1 skipped in 0.01s ==============================
 
 
 Add the :option:`pm-patterns-base-dir` option to the `Pytest configuration file`_
-pointing, for example, to :file:`test/data/expected`. Run :command:`pytest` with
+pointing, for example, to :file:`tests/data/expected`. Run :command:`pytest` with
 the :option:`--pm-save-patterns` option to write the initial expectation file:
 
 .. code-block:: console
     :emphasize-lines: 5,6
 
-    $ pytest --pm-save-patterns --no-header --no-summary test/test_foo.py::test_foo
+    $ pytest --pm-save-patterns --no-header --no-summary tests/test_foo.py::test_foo
     ============================= test session starts ==============================
     collecting ... collected 1 item
 
-    test/test_foo.py::test_foo SKIPPED (Pattern file saved to
-    `…/pytest-matcher/master/test/data/expected/test_foo/test_foo.out`)       [100%]
+    tests/test_foo.py::test_foo SKIPPED (Pattern file saved to
+    `…/pytest-matcher/master/tests/data/expected/test_foo/test_foo.out`)      [100%]
 
     ============================== 1 skipped in 0.02s ==============================
 
-Review the stored pattern file :file:`test/data/expected/test_foo/test_foo.out` and add it to your VCS.
+Review the stored pattern file :file:`tests/data/expected/test_foo/test_foo.out` and add it to
+your VCS.
 
 .. note::
 
@@ -71,11 +72,11 @@ output matches expectations:
 .. code-block:: console
     :emphasize-lines: 5
 
-    $ pytest --no-header --no-summary test/test_foo.py::test_foo
+    $ pytest --no-header --no-summary tests/test_foo.py::test_foo
     ============================= test session starts ==============================
     collected 1 item
 
-    test/test_foo.py::test_foo PASSED                                        [100%]
+    tests/test_foo.py::test_foo PASSED                                        [100%]
 
     ============================== 1 passed in 0.01s ===============================
 
@@ -85,20 +86,20 @@ output matches expectations:
 If the captured output contains values that change from run to run, for example timestamps
 or filesystem paths, you can match the output using regular expressions:
 
-.. literalinclude:: ../test/test_foo.py
+.. literalinclude:: ../tests/test_foo.py
     :language: python
     :pyobject: test_regex
 
 Store the pattern file for this test and rerun :command:`pytest` with the ``-vv`` option:
 
 .. code-block:: console
-    :emphasize-lines: 24,28
+    :emphasize-lines: 24,25,28,29
 
-    $ pytest -vv --no-header test/test_foo.py::test_regex
+    $ pytest -vv --no-header tests/test_foo.py::test_regex
     ============================= test session starts ==============================
     collecting ... collected 1 item
 
-    test/test_foo.py::test_regex FAILED                                      [100%]
+    tests/test_foo.py::test_regex FAILED                                      [100%]
 
     =================================== FAILURES ===================================
     __________________________________ test_regex __________________________________
@@ -112,43 +113,43 @@ Store the pattern file for this test and rerun :command:`pytest` with the ``-vv`
 
             stdout, _ = capfd.readouterr()
 
-    >       assert expected_out.match(stdout) ==True
+    >       assert expected_out.match(stdout) == True
     E       AssertionError: assert
     E         The test output doesn't match the expected regex.
-    E         (from `…/pytest-matcher/master/test/data/expected/test_foo/test_regex.out`):
+    E         (from `…/pytest-matcher/master/tests/data/expected/test_foo/test_regex.out`):
     E         ---[BEGIN actual output]---
     E         Current date: 2024-03-02 21:59:03.792447
-    E         Current module: …/pytest-matcher/master/test/test_foo.py
+    E         Current module: …/pytest-matcher/master/tests/test_foo.py
     E         ---[END actual output]---
     E         ---[BEGIN expected regex]---
     E         Current date: 2024-03-02 21:58:32.289679
-    E         Current module: …/pytest-matcher/master/test/test_foo.py
+    E         Current module: …/pytest-matcher/master/tests/test_foo.py
     E         ---[END expected regex]---
 
-    test/test_foo.py:26: AssertionError
+    tests/test_foo.py:26: AssertionError
     =========================== short test summary info ============================
-    FAILED test/test_foo.py::test_regex - AssertionError: assert
+    FAILED tests/test_foo.py::test_regex - AssertionError: assert
     ============================== 1 failed in 0.03s ===============================
 
 To make it match, edit the expectation file and replace the changing parts with regular
 expressions:
 
 .. code-block::
-    :caption: ``test/data/expect/test_foo/test_regex.out``
+    :caption: ``tests/data/expect/test_foo/test_regex.out``
 
     Current date: [0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}(\.[0-9]+)?
-    Current module: .*/test/test_foo.py
+    Current module: .*/tests/test_foo.py
 
 The test will now pass:
 
 .. code-block:: console
     :emphasize-lines: 5
 
-    $ pytest --no-header --no-summary test/test_foo.py::test_regex
+    $ pytest --no-header --no-summary tests/test_foo.py::test_regex
     ============================= test session starts ==============================
     collected 1 item
 
-    test/test_foo.py::test_regex PASSED                                        [100%]
+    tests/test_foo.py::test_regex PASSED                                      [100%]
 
     ============================== 1 passed in 0.01s ===============================
 

pyproject.toml

@@ -87,8 +87,7 @@ packages = ["src/pytest_matcher"]
 [tool.hatch.envs.default]
 description = "Development environment"
 dependencies = [
-    "codespell >= 2.4.1"
-  , "isort"
+    "isort"
   , "mypy"
   , "reuse ~= 5.0"
   , "ruff ~= 0.12.3"
@@ -102,30 +101,28 @@ installer = "uv"
 [tool.hatch.envs.default.scripts]
 # Some shortcut commands
 all = [
-    "dead-check", "dist-check", "license-check", "lint-check", "pyproject-check", "spell-check", "type-check"
+    "dead-check", "dist-check", "license-check", "lint-check", "pyproject-check", "type-check"
   ]
 # Various linter commands
 dead-check = "vulture src/pytest_matcher"
 dist-check = "twine check dist/*"
 license-check = "reuse lint"
-lint-check = "ruff check doc src/pytest_matcher test"
+lint-check = "ruff check doc src/pytest_matcher tests"
 pyproject-check = "validate-pyproject {root:real}/pyproject.toml"
-spell-check = "codespell"
-type-check = "mypy src/pytest_matcher test"
-# Testing commands
-cov = "hatch env run -e test cov"
-test = "hatch env run -e test test"
+type-check = "mypy src/pytest_matcher"
+# Testing shortcut commands
+cov = "hatch test --cov"
+test = "hatch test -i pytest=pytest.7x,pytest.8x"
 # Misc commands
 annotate-code = "reuse annotate -c \"$(git config --get user.name) <$(git config --get user.email)>\" -t code -l GPL-3.0-or-later {args}"
 annotate-misc = "reuse annotate -c \"$(git config --get user.name) <$(git config --get user.email)>\" -t misc -l CC0-1.0 {args}"
 dist = "hatch build -t wheel"
-fix-spelling = "codespell -i 3 -w"
 
 [tool.hatch.envs.doc]
 description = "Environment to build documentation"
 dependencies = [
-    "sphinx < 8.0.0"
-  , "sphinx_rtd_theme >= 2.0.0"
+    "sphinx"
+  , "sphinx_rtd_theme"
   ]
 installer = "uv"
 template = "doc"
@@ -135,26 +132,31 @@ build = "sphinx-build --color -j auto doc/ build/sphinx/html/"
 link-check = "sphinx-build --color -b linkcheck doc/ build/sphinx/link-check/"
 show = "xdg-open build/sphinx/html/index.html"
 
-[tool.hatch.envs.test]
+[tool.hatch.envs.hatch-test]
 description = "Unit tests environment"
-template = "test"
+dependencies = [
+  "coverage-enable-subprocess == 1.0",
+  "coverage[toml] ~= 7.4",
+  "pytest-randomly ~= 3.15",
+  "pytest-rerunfailures ~= 14.0",
+  "pytest-xdist[psutil] ~= 3.5",
+]
 installer = "uv"
 
-[[tool.hatch.envs.test.matrix]]
+[[tool.hatch.envs.hatch-test.matrix]]
 pytest = ["pytest.8x", "pytest.7x"]
 
-[tool.hatch.envs.test.overrides]
+[tool.hatch.envs.hatch-test.overrides]
 matrix.pytest.dependencies = [
     "coverage[toml]"
   , "pytest-cov"
   , { value = "pytest ~= 8.0", if = ["pytest.8x"] }
   , { value = "pytest ~= 7.0", if = ["pytest.7x"] }
   ]
 
-[tool.hatch.envs.test.scripts]
+[tool.hatch.envs.hatch-test.scripts]
+run = "pytest{env:HATCH_TEST_ARGS:} -o cache_dir=build/.{matrix:pytest}_cache {verbosity:flag} {args}"
 cov = "pytest --cov-report term --cov-report html:build/coverage-{matrix:pytest} --cov=pytest_matcher"
-show-cov = "xdg-open build/coverage-{matrix:pytest}/index.html"
-test = "pytest -o cache_dir=build/.{matrix:pytest}_cache {verbosity:flag} {args}"
 
 [tool.hatch.version]
 source = "vcs"
@@ -229,7 +231,7 @@ minversion = "7.0"
 python_files = ["test_*.py"]
 python_classes = ["*Tester"]
 python_functions = ["*_test", "*_test_?", "*_test_??", "test_*"]
-testpaths = ["test"]
+testpaths = ["tests"]
 xfail_strict = true
 
 # https://docs.astral.sh/ruff/configuration/
@@ -256,12 +258,12 @@ select = ["ALL"]
   , "D100"      # Missing docstring in public module
   , "A001"      # Variable `copyright` is shadowing a Python builtin
   ]
-"test/test_*.py" = [
+"tests/test_*.py" = [
     "ANN001"    # Missing type annotation for function argument
   , "D"         # Documentation issues
   , "PLR2004"   # Magic value used in comparison
   ]
-"test/test_foo.py" = [
+"tests/test_foo.py" = [
     "T201"      # `print` found
   , "E712"      # Comparison to `True`
   , "DTZ005"    # The use of `datetime.datetime.now()` without `tz` argument is not allowed

src/pytest_matcher/plugin.py

@@ -469,7 +469,7 @@ def pytest_addoption(parser: pytest.Parser) -> None:
     parser.addini(
         'pm-patterns-base-dir'
       , help='Base directory used for storing pattern files.'
-      , default=pathlib.Path('test/data/expected')
+      , default=pathlib.Path('tests/data/expected')
       )
     parser.addini(
         'pm-pattern-file-fmt'