Add pull request validation workflow (#1)

* Add workflow and replace pytest-cov with coverage package

* Fix wrong group name in poetry install step

* Update code coverage

* Fix formatting issues, add badges and add trigger for main branch

* Remove limitations on installed dependencies to fix type analysis

* Fix template files matching test file pattern

* Fix inconsistency in test runs when using tox vs. IDE

Problem was caused by pytester reusing the terminal width of the pytest process resulting in inconsistent result for the summary block of the pytest output

* Fix coverage calls and add development documentation

* Add unit tests for get_parametrized_value

* Add unit tests for get_parameter_from_type_hints

* Formatting

Author: skeletorXVI

.github/workflows/run-checks.yml

@@ -0,0 +1,70 @@
+name: Run pull request validation
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  run-checks:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        include:
+          - python-version: "3.10"
+          - python-version: "3.11"
+          - python-version: "3.12"
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        id: setup-python
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install poetry
+        run: |
+          python -m pip install poetry==1.8.2
+
+      - name: Configure poetry
+        run: |
+          python -m poetry config virtualenvs.in-project true
+
+      - name: Cache the virtualenv
+        id: poetry-dependencies-cache
+        uses: actions/cache@v3
+        with:
+          path: ./.venv
+          key: ${{ runner.os }}-venv-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('**/poetry.lock') }}
+
+      - name: Install dev dependencies
+        if: steps.poetry-dependencies-cache.outputs.cache-hit != 'true'
+        run: |
+          python -m poetry install
+
+      - name: Check for formatting issues
+        run:  python -m poetry run black --check --diff .
+
+      - name: Check for linting issues
+        run: python -m poetry run ruff check .
+
+      - name: Run static type analysis
+        run: python -m poetry run mypy .
+
+      - name: Test with tox
+        run: |
+          source .venv/bin/activate
+          coverage erase
+          tox run-parallel -f py${{ matrix.python-version }} --parallel-no-spinner --parallel-live
+          coverage xml
+
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v4
+        with:
+          fail_ci_if_error: true
+          token: ${{ secrets.CODECOV_TOKEN }}
+          verbose: true

.gitignore

@@ -77,4 +77,9 @@ coverage.xml
 
 # OS
 .DS_Store
-Thumbs.db
+Thumbs.db
+
+# Coverage
+.coverage
+.coverage.*
+.cache

README.md

@@ -1,5 +1,8 @@
 # Package to use type annotations for parametrization in pytest
 
+[![codecov](https://codecov.io/gh/skeletorXVI/pytest-parametrization-annotation/graph/badge.svg?token=22CXIHTW1Q)](https://codecov.io/gh/skeletorXVI/pytest-parametrization-annotation)
+<a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
+
 This package allows the declaration of parametrization using type annotations and definition of test cases using a
 decorator.
 
@@ -108,3 +111,30 @@ from pytest_parametrization_annotation import Parametrized
 def test(a: Annotated[int, Parametrized]) -> None:
     ...
 ```
+
+## Develop
+
+### Install dependencies
+
+```shell
+poetry install
+```
+
+### Format code
+
+```shell
+poetry run ruff format
+poetry run black .
+```
+
+### Run static type checker
+
+```shell
+poetry run mypy .
+```
+
+### Run tests
+
+```shell
+poetry run tox run-parallel
+```

examples/test_indirect.py

@@ -11,7 +11,8 @@
 
 @pytest.fixture
 def doubled(request: FixtureRequest) -> int:
-    return request.param * 2
+    value: int = request.param
+    return value * 2
 
 
 @pytest.mark.case(

poetry.lock

@@ -44,9 +44,9 @@ black = "v24.3"
 mypy = "^1.9.0"
 
 [tool.poetry.group.testing.dependencies]
-pytest-cov = "*"
 jinja2 = ">=3"
 tox = "^4.14.2"
+coverage = {extras = ["toml"], version = ">=6.5.0"}
 
 [build-system]
 requires = ["poetry-core"]
@@ -71,4 +71,9 @@ target-version = ["py310", "py311", "py312"]
 python_version = "3.10"
 warn_return_any = true
 warn_unused_configs = true
-files = ["src", "tests"]
+files = ["src", "tests"]
+
+[tool.coverage.report]
+exclude_lines = [
+    "if TYPE_CHECKING:"
+]

pyproject.toml

@@ -9,4 +9,4 @@
 class Parametrized:
     indirect: bool = False
     default: Any = _Default
-    default_factory: Callable[[], Any] = _DefaultCallable
+    default_factory: Callable[[], Any] = _DefaultCallable

src/pytest_parametrization_annotation/annotation.py

@@ -1,6 +1,14 @@
 from __future__ import annotations
 
-from typing import Annotated, Any, Callable, Mapping, get_origin, get_type_hints, TYPE_CHECKING
+from typing import (
+    Annotated,
+    Any,
+    Callable,
+    Mapping,
+    get_origin,
+    get_type_hints,
+    TYPE_CHECKING,
+)
 
 from _pytest.outcomes import fail
 
@@ -37,7 +45,7 @@ def get_parameters_from_type_hints(func: Callable) -> dict[str, Parametrized]:
 
 
 def get_parametrized_value(
-        kwargs: Mapping[str, Any], parameter: str, meta: Parametrized
+    kwargs: Mapping[str, Any], parameter: str, meta: Parametrized
 ) -> Any:
     if parameter in kwargs:
         return kwargs[parameter]

src/pytest_parametrization_annotation/functionality.py

@@ -9,7 +9,9 @@
 
 
 def pytest_configure(config: Config) -> None:
-    config.addinivalue_line("markers", "case: Parametrize the test with the provided values.")
+    config.addinivalue_line(
+        "markers", "case: Parametrize the test with the provided values."
+    )
 
 
 def pytest_generate_tests(metafunc: Metafunc) -> None:

src/pytest_parametrization_annotation/plugin.py

@@ -1 +1 @@
-pytest_plugins = ["pytester"]
+pytest_plugins = ["pytester"]