pytest-api-cov 0.1.0__py3-none-any.whl

pytest_api_cov-0.1.0.dist-info/METADATA

@@ -0,0 +1,330 @@
+Metadata-Version: 2.4
+Name: pytest-api-cov
+Version: 0.1.0
+Summary: Api Coverage Report Pytest Plugin
+Author-email: Barnaby Gill <barnabasgill@gmail.com>
+License: Apache-2.0
+License-File: LICENSE
+Requires-Python: >=3.10
+Requires-Dist: fastapi>=0.116.1
+Requires-Dist: flask>=3.1.1
+Requires-Dist: httpx>=0.28.1
+Requires-Dist: pydantic>=2.11.7
+Requires-Dist: rich>=14.0.0
+Requires-Dist: starlette>=0.47.1
+Requires-Dist: tomli>=2.2.1
+Description-Content-Type: text/markdown
+
+# pytest-api-cov
+
+A **pytest plugin** that measures **API endpoint coverage** for FastAPI and Flask applications. Know which endpoints are tested and which are missing coverage.
+
+## Features
+
+- **Zero Configuration**: Plug-and-play with Flask/FastAPI apps - just install and run
+- **Terminal Reports**: Rich terminal output with detailed coverage information
+- **JSON Reports**: Export coverage data for CI/CD integration
+- **Setup Wizard**: Interactive setup wizard for complex projects
+
+## Quick Start
+
+### Installation
+
+```bash
+pip install pytest-api-cov
+```
+
+### Basic Usage
+
+For most projects, no configuration is needed:
+
+```bash
+# Just add the flag to your pytest command
+pytest --api-cov-report
+```
+
+The plugin will automatically discover your Flask/FastAPI app if it's in common locations:
+- `app.py` (with variable `app`, `application`, or `main`)
+- `main.py` (with variable `app`, `application`, or `main`) 
+- `server.py` (with variable `app`, `application`, or `server`)
+
+### Example
+
+Given this FastAPI app in `app.py`:
+
+```python
+from fastapi import FastAPI
+
+app = FastAPI()
+
+@app.get("/")
+def read_root():
+    return {"message": "Hello World"}
+
+@app.get("/users/{user_id}")
+def get_user(user_id: int):
+    return {"user_id": user_id}
+
+@app.get("/health")
+def health_check():
+    return {"status": "ok"}
+```
+
+And this test file:
+
+```python
+def test_root_endpoint(client):
+    response = client.get("/")
+    assert response.status_code == 200
+
+def test_get_user(client):
+    response = client.get("/users/123")
+    assert response.status_code == 200
+```
+
+Running `pytest --api-cov-report` produces:
+
+```
+API Coverage Report
+Uncovered Endpoints:
+  [X] /health
+
+Total API Coverage: 66.67%
+```
+
+## Advanced Configuration
+
+### Setup Wizard
+
+If auto-discovery doesn't work for your project, use the interactive setup wizard:
+
+```bash
+pytest-api-cov init
+```
+
+This will:
+- Detect your framework and app location
+- Create a `conftest.py` fixture if needed
+- Generate suggested `pyproject.toml` configuration
+
+### Manual Configuration
+
+Create a `conftest.py` file:
+
+```python
+import pytest
+from your_app import app
+
+@pytest.fixture
+def app():
+    return app
+```
+
+### Configuration Options
+
+Add configuration to your `pyproject.toml`:
+
+```toml
+[tool.pytest_api_cov]
+# Fail if coverage is below this percentage
+fail_under = 80.0
+
+# Control what's shown in reports
+show_uncovered_endpoints = true
+show_covered_endpoints = false
+show_excluded_endpoints = false
+
+# Exclude endpoints from coverage using simple wildcard patterns
+# Use * for wildcard matching, all other characters are matched literally
+exclusion_patterns = [
+    "/health",        # Exact match
+    "/metrics",       # Exact match
+    "/docs/*",        # Wildcard: matches /docs/swagger, /docs/openapi, etc.
+    "/admin/*",       # Wildcard: matches all admin endpoints
+    "/api/v1.0/*"     # Exact version match (won't match /api/v1x0/*)
+]
+
+# Save detailed JSON report
+report_path = "api_coverage.json"
+
+# Force Unicode symbols in output
+force_sugar = true
+
+# Force no Unicode symbols in output
+force_sugar_disabled = true
+```
+
+### Command Line Options
+
+```bash
+# Basic coverage report
+pytest --api-cov-report
+
+# Set coverage threshold to fail test session
+pytest --api-cov-report --api-cov-fail-under=80
+
+# Show covered endpoints
+pytest --api-cov-report --api-cov-show-covered-endpoints
+
+# Show excluded endpoints
+pytest --api-cov-report --api-cov-show-excluded-endpoints
+
+# Hide uncovered endpoints
+pytest --api-cov-report --api-cov-show-uncovered-endpoints=false
+
+# Save JSON report
+pytest --api-cov-report --api-cov-report-path=api_coverage.json
+
+# Exclude specific endpoints (supports wildcards)
+pytest --api-cov-report --api-cov-exclusion-patterns="/health" --api-cov-exclusion-patterns="/docs/*"
+
+# Verbose logging (shows discovery process)
+pytest --api-cov-report -v
+
+# Debug logging (very detailed)
+pytest --api-cov-report -vv
+```
+
+## Framework Support
+
+Works automatically with FastAPI and Flask applications.
+
+### FastAPI
+
+```python
+from fastapi import FastAPI
+from fastapi.testclient import TestClient
+
+app = FastAPI()
+
+@app.get("/items/{item_id}")
+def read_item(item_id: int):
+    return {"item_id": item_id}
+
+# Tests automatically get a 'client' fixture
+def test_read_item(client):
+    response = client.get("/items/42")
+    assert response.status_code == 200
+```
+
+### Flask
+
+```python
+from flask import Flask
+
+app = Flask(__name__)
+
+@app.route("/users/<int:user_id>")
+def get_user(user_id):
+    return {"user_id": user_id}
+
+# Tests automatically get a 'client' fixture  
+def test_get_user(client):
+    response = client.get("/users/123")
+    assert response.status_code == 200
+```
+
+## Parallel Testing
+
+pytest-api-cov fully supports pytest-xdist for parallel test execution:
+
+```bash
+# Run tests in parallel with coverage
+pytest --api-cov-report -n auto
+```
+
+Coverage data is automatically collected from all worker processes and merged in the final report.
+
+## JSON Report Format
+
+When using `--api-cov-report-path`, the plugin generates a detailed JSON report:
+
+```json
+{
+  "status": 0,
+  "coverage": 66.67,
+  "required_coverage": 80.0,
+  "total_endpoints": 3,
+  "covered_count": 2,
+  "uncovered_count": 1,
+  "excluded_count": 0,
+  "detail": [
+    {
+      "endpoint": "/",
+      "callers": ["test_root_endpoint"]
+    },
+    {
+      "endpoint": "/users/{user_id}",
+      "callers": ["test_get_user"]
+    },
+    {
+      "endpoint": "/health",
+      "callers": []
+    }
+  ]
+}
+```
+
+## CI/CD Integration
+
+### Fail on Low Coverage
+
+```bash
+# Fail the build if coverage is below 80%
+pytest --api-cov-report --api-cov-fail-under=80
+```
+
+### GitHub Actions Example
+
+```yaml
+name: API Coverage
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v4
+      with:
+        python-version: '3.12'
+    - run: pip install pytest pytest-api-cov
+    - run: pytest --api-cov-report --api-cov-fail-under=80 --api-cov-report-path=coverage.json
+    - uses: actions/upload-artifact@v4
+      with:
+        name: api-coverage-report
+        path: coverage.json
+```
+
+## Troubleshooting
+
+### No App Found
+
+If you see "No API app found", ensure:
+
+1. Your app is in a standard location (`app.py`, `main.py`, etc.)
+2. Your app variable has a standard name (`app`, `application`, `main`)
+3. Your app imports are correct (`from fastapi import FastAPI` or `from flask import Flask`)
+
+Or use the setup wizard: `pytest-api-cov init`
+
+### No Endpoints Discovered
+
+If you see "No endpoints discovered":
+
+1. Check that your app is properly instantiated
+2. Verify your routes/endpoints are defined
+3. Ensure the `client` fixture is working in your tests
+4. Use `-v` or `-vv` for debug information
+
+### Framework Not Detected
+
+The plugin supports:
+- **FastAPI**: Detected by `from fastapi import` or `import fastapi`
+- **Flask**: Detected by `from flask import` or `import flask`
+
+Other frameworks are not currently supported.
+
+## License
+
+This project is licensed under the Apache License 2.0.

pytest_api_cov-0.1.0.dist-info/RECORD

@@ -0,0 +1,13 @@
+pytest_api_cov/__init__.py,sha256=J7hqjMaNcnMdBP0OB012hPK7ZjhRVDIyd9NBr8gewsc,65
+pytest_api_cov/cli.py,sha256=aCfq6EWKixdGhbY9t6xmiWnlqCPbIBd__sf1EyNrUT8,5775
+pytest_api_cov/config.py,sha256=cB8N9bpkGmYhXLW3QL08atJy3ukC1vJcSD2qc8tRol0,3166
+pytest_api_cov/frameworks.py,sha256=5d6wnEsb2BykPtpnpkv98GMPuyoG4elXRJ7vtGHF06A,3228
+pytest_api_cov/models.py,sha256=YiXLiEEyNREiodzn1pGqSNIHrm3zV6kFn0XgyN8_8Rs,4893
+pytest_api_cov/plugin.py,sha256=Sa4tWSXmwcXDmxRSAwlM6n4RjU-HqY3S9G8Esicy2nw,11078
+pytest_api_cov/pytest_flags.py,sha256=aH-MpUQCX7JdPA7f_Qulf0HzOtFpyTqDbHFDy48epOg,1949
+pytest_api_cov/report.py,sha256=VxfWag20V8o9ArbxOkR_gWQ2TE-sthrS0PCJvn4YCSU,6642
+pytest_api_cov-0.1.0.dist-info/METADATA,sha256=OuZlDB2M4CnuvHZTd3YMyzqnfhUsX7I88sZuiSUOJps,7499
+pytest_api_cov-0.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+pytest_api_cov-0.1.0.dist-info/entry_points.txt,sha256=hWqEhsBKzbwSwcxCzKgSA8NElQxk0K4PKERrYsi3csk,110
+pytest_api_cov-0.1.0.dist-info/licenses/LICENSE,sha256=HrhfyXIkWY2tGFK11kg7vPCqhgh5DcxleloqdhrpyMY,11558
+pytest_api_cov-0.1.0.dist-info/RECORD,,

pytest_api_cov-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

pytest_api_cov-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,5 @@
+[console_scripts]
+pytest-api-cov = pytest_api_cov.cli:main
+
+[pytest11]
+pytest_api_cov = pytest_api_cov.plugin

pytest_api_cov-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.