pytest-cov-container 0.0.1__tar.gz

pytest_cov_container-0.0.1/.github/workflows/release.yaml

@@ -0,0 +1,132 @@
+name: release
+
+on:
+  push:
+    tags:
+      - "[0-9]+.[0-9]+.[0-9]+"
+
+env:
+  PACKAGE_NAME: pytest-cov-container
+  OWNER: tomaDev
+
+jobs:
+  check_pypi:
+    runs-on: ubuntu-latest
+    outputs:
+      PYPI_VERSION: ${{ steps.get.outputs.PYPI_VERSION }}
+    steps:
+      - name: Fetch information from PyPI
+        id: get
+        run: |
+          response=$(curl -s https://pypi.org/pypi/${{ env.PACKAGE_NAME }}/json || echo "{}")
+          version=$(echo $response | grep -oP '"releases":\{"\K[^"]+' | sort -rV | head -n 1)
+          if [ -z "$version" ]; then
+            echo "Package not found on PyPI."
+            version="0.0.0"
+          fi
+          echo "Latest version on PyPI: $version"
+          echo "PYPI_VERSION=$version" >> $GITHUB_OUTPUT
+
+  setup_and_build:
+    needs: [check_pypi]
+    name: project setup and build
+    runs-on: ubuntu-latest
+    outputs:
+      NEW_VERSION: ${{ steps.get.outputs.NEW_VERSION }}
+    steps:
+      - name: Get the new project version
+        id: get
+        run: echo "NEW_VERSION=${GITHUB_REF#refs/tags/}" >> "$GITHUB_OUTPUT"
+
+      - name: Compare versions and exit if not newer
+        run: |
+          PYPI_VERSION=${{ needs.check_pypi.outputs.PYPI_VERSION }}
+          NEW_VERSION=${{ steps.get.outputs.NEW_VERSION }}
+          echo "New release version - $NEW_VERSION"
+          echo "latest PyPI version - $PYPI_VERSION"
+          if [ "$NEW_VERSION" == "$PYPI_VERSION" ]; then
+            echo "same version. No need to release"
+            exit 1
+          elif [ "$(printf '%s\n' "$PYPI_VERSION" "$NEW_VERSION" | sort -rbV | head -n 1)" != "$NEW_VERSION" ]; then
+            echo "The new version $NEW_VERSION is not greater than the latest version $PYPI_VERSION on PyPI"
+            exit 1
+          else
+            echo "The new version $NEW_VERSION is greater than the latest version $PYPI_VERSION on PyPI"
+          fi
+
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version-file: "pyproject.toml"
+
+      - name: Validate package version matches tag version
+        run: |
+          PACKAGE_VERSION="$(python -c 'from src.pytest_cov_container.__about__ import __version__;print(__version__)')"
+          TAG_VERSION="${{ steps.get.outputs.NEW_VERSION }}"
+          if [ "$PACKAGE_VERSION" != "$TAG_VERSION" ]; then
+              echo "Version mismatch: (package internal) $PACKAGE_VERSION != $TAG_VERSION (tag)"
+              exit 1
+          fi
+
+      - name: Install the project
+        run: uv sync --all-extras --frozen --no-editable
+
+      - name: Build the project
+        run: uv build
+
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  github_release:
+    name: Create GitHub Release
+    needs: [setup_and_build]
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Create GitHub Release
+        id: create_release
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          VERSION=v${{ needs.setup_and_build.outputs.NEW_VERSION }}
+          gh release create $VERSION dist/* --title $VERSION --generate-notes
+
+  pypi_publish:
+    name: Upload release to PyPI
+    needs: [setup_and_build]
+    runs-on: ubuntu-latest
+    environment:
+      name: release
+    permissions:
+      id-token: write
+    steps:
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish distribution to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

pytest_cov_container-0.0.1/.gitignore

@@ -0,0 +1 @@
+__pycache__/

pytest_cov_container-0.0.1/LICENSE.txt

@@ -0,0 +1,18 @@
+MIT License
+
+Copyright (c) 2026-present tomaDev <genins21@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
+associated documentation files (the "Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the
+following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial
+portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
+LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
+EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
+USE OR OTHER DEALINGS IN THE SOFTWARE.

pytest_cov_container-0.0.1/PKG-INFO

@@ -0,0 +1,153 @@
+Metadata-Version: 2.4
+Name: pytest-cov-container
+Version: 0.0.1
+Summary: Pytest plugin to collect code coverage from applications running inside Docker containers
+Project-URL: Documentation, https://github.com/tomaDev/pytest-cov-container#readme
+Project-URL: Issues, https://github.com/tomaDev/pytest-cov-container/issues
+Project-URL: Source, https://github.com/tomaDev/pytest-cov-container
+Author-email: tomaDev <genins21@gmail.com>
+License-Expression: MIT
+License-File: LICENSE.txt
+Keywords: containers,coverage,docker,pytest,testing
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: Pytest
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Requires-Python: >=3.11
+Requires-Dist: coverage>=7.2
+Requires-Dist: docker>=6.0
+Requires-Dist: pytest-cov>=4.0
+Requires-Dist: pytest>=7.0
+Description-Content-Type: text/markdown
+
+# pytest-cov-container
+
+[![PyPI - Version](https://img.shields.io/pypi/v/pytest-cov-container.svg)](https://pypi.org/project/pytest-cov-container)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pytest-cov-container.svg)](https://pypi.org/project/pytest-cov-container)
+[![security: bandit](https://img.shields.io/badge/security-bandit-yellow.svg)](https://github.com/PyCQA/bandit)
+
+Collect code coverage from Python applications running inside Docker containers during integration tests. Works alongside [pytest-cov](https://github.com/pytest-dev/pytest-cov) to combine container coverage with your local test coverage.
+
+Built for projects using [AWS SAM](https://docs.aws.amazon.com/serverless-application-model/) local testing, but works with any Docker-based test workflow.
+
+## How It Works
+
+1. **Before tests** — injects a coverage wrapper, `.coveragerc`, and `run.sh` into your SAM build directory
+2. **During tests** — your containerized app runs under `coverage` via the injected wrapper
+3. **After tests** — extracts `.coverage.*` files from containers and runs `coverage combine` to merge them with local results
+
+## Installation
+
+```console
+pip install pytest-cov-container
+```
+
+Requires Python 3.11+.
+
+## Configuration
+
+Add to your `pyproject.toml`:
+
+```toml
+[tool.pytest-cov-container]
+image_pattern = "samcli/lambda*"
+label = "pytest-cov-container"
+
+[tool.pytest-cov-container.path_mapping]
+"src/api" = "/var/task"
+
+[tool.pytest-cov-container.python]
+build_dir = ".aws-sam/build/ApiFunction"
+entrypoint = "uvicorn app:app --host 0.0.0.0 --port 8080"
+```
+
+| Key | Description |
+|-----|-------------|
+| `image_pattern` | Glob pattern to match container image tags |
+| `label` | Docker label to filter containers |
+| `path_mapping` | Maps host source paths to container paths (used by `coverage combine`) |
+| `build_dir` | SAM build output directory where coverage files are injected |
+| `entrypoint` | The command your app runs inside the container |
+| `language` | Language driver to use (default: `"python"`) |
+| `enabled` | Set to `false` to disable (default: `true`) |
+
+## Usage
+
+Run your tests with `--cov` as usual:
+
+```console
+pytest --cov=src/api tests/
+```
+
+The plugin activates automatically when:
+- pytest-cov is active (`--cov` flag present)
+- `[tool.pytest-cov-container]` is configured in `pyproject.toml`
+
+Disable it for a run with:
+
+```console
+pytest --cov=src/api --no-cov-container tests/
+```
+
+### Mid-Session Collection
+
+If you need to collect coverage before containers stop (e.g., in a session-scoped fixture teardown), use the public API:
+
+```python
+from pytest_cov_container import collect_container_coverage
+
+@pytest.fixture(scope="session")
+def sam_api():
+    proc = start_sam(...)
+    yield SAM_URL
+    collect_container_coverage()
+    proc.terminate()
+```
+
+This sends `SIGUSR1` to running containers to flush coverage data, then extracts the files.
+
+## Pluggable Drivers
+
+Language support is pluggable via entry points. The built-in Python driver handles:
+
+- Writing `.coveragerc` with `parallel = true` and `sigterm = true`
+- Writing `_cov_wrapper.py` that starts coverage, handles `SIGTERM`/`SIGUSR1`, and runs your entrypoint
+- Writing `run.sh` to bootstrap the wrapper
+- Extracting `.coverage.*` files from `/tmp` in containers
+
+To add a driver for another language, register an entry point:
+
+```toml
+[project.entry-points."pytest_cov_container.drivers"]
+node = "my_package.drivers.node:NodeDriver"
+```
+
+Drivers must implement the `LanguageDriver` protocol from `pytest_cov_container.models`.
+
+## Development
+
+```console
+# Run tests
+hatch test
+
+# Run across all Python versions
+hatch test --all
+
+# Format and lint
+hatch fmt
+
+# Type check
+hatch run types:check
+
+# Security scan
+hatch run security:scan
+```
+
+## License
+
+`pytest-cov-container` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

pytest_cov_container-0.0.1/README.md

@@ -0,0 +1,126 @@
+# pytest-cov-container
+
+[![PyPI - Version](https://img.shields.io/pypi/v/pytest-cov-container.svg)](https://pypi.org/project/pytest-cov-container)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pytest-cov-container.svg)](https://pypi.org/project/pytest-cov-container)
+[![security: bandit](https://img.shields.io/badge/security-bandit-yellow.svg)](https://github.com/PyCQA/bandit)
+
+Collect code coverage from Python applications running inside Docker containers during integration tests. Works alongside [pytest-cov](https://github.com/pytest-dev/pytest-cov) to combine container coverage with your local test coverage.
+
+Built for projects using [AWS SAM](https://docs.aws.amazon.com/serverless-application-model/) local testing, but works with any Docker-based test workflow.
+
+## How It Works
+
+1. **Before tests** — injects a coverage wrapper, `.coveragerc`, and `run.sh` into your SAM build directory
+2. **During tests** — your containerized app runs under `coverage` via the injected wrapper
+3. **After tests** — extracts `.coverage.*` files from containers and runs `coverage combine` to merge them with local results
+
+## Installation
+
+```console
+pip install pytest-cov-container
+```
+
+Requires Python 3.11+.
+
+## Configuration
+
+Add to your `pyproject.toml`:
+
+```toml
+[tool.pytest-cov-container]
+image_pattern = "samcli/lambda*"
+label = "pytest-cov-container"
+
+[tool.pytest-cov-container.path_mapping]
+"src/api" = "/var/task"
+
+[tool.pytest-cov-container.python]
+build_dir = ".aws-sam/build/ApiFunction"
+entrypoint = "uvicorn app:app --host 0.0.0.0 --port 8080"
+```
+
+| Key | Description |
+|-----|-------------|
+| `image_pattern` | Glob pattern to match container image tags |
+| `label` | Docker label to filter containers |
+| `path_mapping` | Maps host source paths to container paths (used by `coverage combine`) |
+| `build_dir` | SAM build output directory where coverage files are injected |
+| `entrypoint` | The command your app runs inside the container |
+| `language` | Language driver to use (default: `"python"`) |
+| `enabled` | Set to `false` to disable (default: `true`) |
+
+## Usage
+
+Run your tests with `--cov` as usual:
+
+```console
+pytest --cov=src/api tests/
+```
+
+The plugin activates automatically when:
+- pytest-cov is active (`--cov` flag present)
+- `[tool.pytest-cov-container]` is configured in `pyproject.toml`
+
+Disable it for a run with:
+
+```console
+pytest --cov=src/api --no-cov-container tests/
+```
+
+### Mid-Session Collection
+
+If you need to collect coverage before containers stop (e.g., in a session-scoped fixture teardown), use the public API:
+
+```python
+from pytest_cov_container import collect_container_coverage
+
+@pytest.fixture(scope="session")
+def sam_api():
+    proc = start_sam(...)
+    yield SAM_URL
+    collect_container_coverage()
+    proc.terminate()
+```
+
+This sends `SIGUSR1` to running containers to flush coverage data, then extracts the files.
+
+## Pluggable Drivers
+
+Language support is pluggable via entry points. The built-in Python driver handles:
+
+- Writing `.coveragerc` with `parallel = true` and `sigterm = true`
+- Writing `_cov_wrapper.py` that starts coverage, handles `SIGTERM`/`SIGUSR1`, and runs your entrypoint
+- Writing `run.sh` to bootstrap the wrapper
+- Extracting `.coverage.*` files from `/tmp` in containers
+
+To add a driver for another language, register an entry point:
+
+```toml
+[project.entry-points."pytest_cov_container.drivers"]
+node = "my_package.drivers.node:NodeDriver"
+```
+
+Drivers must implement the `LanguageDriver` protocol from `pytest_cov_container.models`.
+
+## Development
+
+```console
+# Run tests
+hatch test
+
+# Run across all Python versions
+hatch test --all
+
+# Format and lint
+hatch fmt
+
+# Type check
+hatch run types:check
+
+# Security scan
+hatch run security:scan
+```
+
+## License
+
+`pytest-cov-container` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.