api-bridgekeeper 0.1.0__tar.gz

api_bridgekeeper-0.1.0/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.

api_bridgekeeper-0.1.0/PKG-INFO

@@ -0,0 +1,96 @@
+Metadata-Version: 2.4
+Name: api-bridgekeeper
+Version: 0.1.0
+Summary: Fail tests if APIs do not have input or output models
+Author-email: Ashish Thomas Cherian <ufoundashish@gmail.com>
+License: MIT
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: flask; extra == "dev"
+Requires-Dist: fastapi; extra == "dev"
+Requires-Dist: pydantic; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Dynamic: license-file
+
+# Bridgekeeper
+Fail tests if API's do not have input or output models  
+
+**Supports:**
+- FastAPI
+- Flask
+
+## Usage
+
+You can use Bridgekeeper to validate your API endpoints and ensure they have explicitly typed input and output models. 
+
+### Basic Example
+
+```python
+from fastapi import FastAPI
+from bridgekeeper import check_models
+
+app = FastAPI()
+
+@app.get("/items/{item_id}")
+def read_item(item_id: int) -> dict:
+    return {"item_id": item_id}
+
+# Run the checker against your initialized app
+results = check_models(app)
+
+# `results` will contain a list of endpoints missing type models
+print(results)
+```
+
+### Options
+
+`check_models(app, allow_list=None, check_only=None)`
+
+- **`allow_list` (list of strings, optional)**: A list of API paths to ignore (e.g., `["/health", "/metrics"]`). If an endpoint matches a path in the list, it is skipped.
+- **`check_only` (literal string, optional)**: If you only want to validate inputs or outputs exclusively, pass `"request"` or `"response"`.
+- **`allow_any` (boolean, optional)**: Defaults to `False`. When `False`, explicitly typing a parameter or return type as `typing.Any` is flagged as missing a strict model. Set to `True` if you want to allow `Any` as a valid type hint.
+
+```python
+results = check_models(
+    app, 
+    allow_list=["/health"], 
+    check_only="response",  # Will strictly look for missing return types
+    allow_any=False         # typing.Any will be rejected
+)
+```
+
+## Handling Complex Apps (Databases/Secrets)
+
+If your FastAPI or Flask app connects to a database (like Postgres) or external service (like Redis) during initialization, trying to run `bridgekeeper` in a GitHub Action might crash when the app imports, before the tests even run.
+
+Bridgekeeper provides generic mocking utilities to safely bypass these side effects. For highly complex apps where you don't want to list out every single dependency, you can use `auto_mock_missing=True` to seamlessly mock any module that isn't installed!
+
+```python
+from bridgekeeper import mock_modules, mock_env
+
+# 1. Mock critical environment variables
+mock_env({
+    "DATABASE_URL": "sqlite:///:memory:",
+    "SECRET_KEY": "dummy_secret_for_ci"
+})
+
+# 2. Automatically mock ANY missing dependency!
+# This is extremely useful if you don't want to install heavy libraries (like SQLAlchemy, boto3, etc.)
+# just to run a quick static analysis check.
+mock_modules(auto_mock_missing=True)
+
+# You can also explicitly mock specific modules with custom fakes:
+# mock_modules({"app.core.db": PostgresTestDb}, auto_mock_missing=True)
+
+# 3. Now it is safe to import the app
+from myapp.main import app
+from bridgekeeper import check_models
+
+results = check_models(app)
+```
+
+## Why the name bridgekeeper?  
+He guards the [Bridge of Death](https://montypython.fandom.com/wiki/Bridge_of_Death) and requires travelers to answer "questions three" before crossing safely.

api_bridgekeeper-0.1.0/README.md

@@ -0,0 +1,79 @@
+# Bridgekeeper
+Fail tests if API's do not have input or output models  
+
+**Supports:**
+- FastAPI
+- Flask
+
+## Usage
+
+You can use Bridgekeeper to validate your API endpoints and ensure they have explicitly typed input and output models. 
+
+### Basic Example
+
+```python
+from fastapi import FastAPI
+from bridgekeeper import check_models
+
+app = FastAPI()
+
+@app.get("/items/{item_id}")
+def read_item(item_id: int) -> dict:
+    return {"item_id": item_id}
+
+# Run the checker against your initialized app
+results = check_models(app)
+
+# `results` will contain a list of endpoints missing type models
+print(results)
+```
+
+### Options
+
+`check_models(app, allow_list=None, check_only=None)`
+
+- **`allow_list` (list of strings, optional)**: A list of API paths to ignore (e.g., `["/health", "/metrics"]`). If an endpoint matches a path in the list, it is skipped.
+- **`check_only` (literal string, optional)**: If you only want to validate inputs or outputs exclusively, pass `"request"` or `"response"`.
+- **`allow_any` (boolean, optional)**: Defaults to `False`. When `False`, explicitly typing a parameter or return type as `typing.Any` is flagged as missing a strict model. Set to `True` if you want to allow `Any` as a valid type hint.
+
+```python
+results = check_models(
+    app, 
+    allow_list=["/health"], 
+    check_only="response",  # Will strictly look for missing return types
+    allow_any=False         # typing.Any will be rejected
+)
+```
+
+## Handling Complex Apps (Databases/Secrets)
+
+If your FastAPI or Flask app connects to a database (like Postgres) or external service (like Redis) during initialization, trying to run `bridgekeeper` in a GitHub Action might crash when the app imports, before the tests even run.
+
+Bridgekeeper provides generic mocking utilities to safely bypass these side effects. For highly complex apps where you don't want to list out every single dependency, you can use `auto_mock_missing=True` to seamlessly mock any module that isn't installed!
+
+```python
+from bridgekeeper import mock_modules, mock_env
+
+# 1. Mock critical environment variables
+mock_env({
+    "DATABASE_URL": "sqlite:///:memory:",
+    "SECRET_KEY": "dummy_secret_for_ci"
+})
+
+# 2. Automatically mock ANY missing dependency!
+# This is extremely useful if you don't want to install heavy libraries (like SQLAlchemy, boto3, etc.)
+# just to run a quick static analysis check.
+mock_modules(auto_mock_missing=True)
+
+# You can also explicitly mock specific modules with custom fakes:
+# mock_modules({"app.core.db": PostgresTestDb}, auto_mock_missing=True)
+
+# 3. Now it is safe to import the app
+from myapp.main import app
+from bridgekeeper import check_models
+
+results = check_models(app)
+```
+
+## Why the name bridgekeeper?  
+He guards the [Bridge of Death](https://montypython.fandom.com/wiki/Bridge_of_Death) and requires travelers to answer "questions three" before crossing safely.

api_bridgekeeper-0.1.0/api_bridgekeeper.egg-info/PKG-INFO

@@ -0,0 +1,96 @@
+Metadata-Version: 2.4
+Name: api-bridgekeeper
+Version: 0.1.0
+Summary: Fail tests if APIs do not have input or output models
+Author-email: Ashish Thomas Cherian <ufoundashish@gmail.com>
+License: MIT
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: flask; extra == "dev"
+Requires-Dist: fastapi; extra == "dev"
+Requires-Dist: pydantic; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Dynamic: license-file
+
+# Bridgekeeper
+Fail tests if API's do not have input or output models  
+
+**Supports:**
+- FastAPI
+- Flask
+
+## Usage
+
+You can use Bridgekeeper to validate your API endpoints and ensure they have explicitly typed input and output models. 
+
+### Basic Example
+
+```python
+from fastapi import FastAPI
+from bridgekeeper import check_models
+
+app = FastAPI()
+
+@app.get("/items/{item_id}")
+def read_item(item_id: int) -> dict:
+    return {"item_id": item_id}
+
+# Run the checker against your initialized app
+results = check_models(app)
+
+# `results` will contain a list of endpoints missing type models
+print(results)
+```
+
+### Options
+
+`check_models(app, allow_list=None, check_only=None)`
+
+- **`allow_list` (list of strings, optional)**: A list of API paths to ignore (e.g., `["/health", "/metrics"]`). If an endpoint matches a path in the list, it is skipped.
+- **`check_only` (literal string, optional)**: If you only want to validate inputs or outputs exclusively, pass `"request"` or `"response"`.
+- **`allow_any` (boolean, optional)**: Defaults to `False`. When `False`, explicitly typing a parameter or return type as `typing.Any` is flagged as missing a strict model. Set to `True` if you want to allow `Any` as a valid type hint.
+
+```python
+results = check_models(
+    app, 
+    allow_list=["/health"], 
+    check_only="response",  # Will strictly look for missing return types
+    allow_any=False         # typing.Any will be rejected
+)
+```
+
+## Handling Complex Apps (Databases/Secrets)
+
+If your FastAPI or Flask app connects to a database (like Postgres) or external service (like Redis) during initialization, trying to run `bridgekeeper` in a GitHub Action might crash when the app imports, before the tests even run.
+
+Bridgekeeper provides generic mocking utilities to safely bypass these side effects. For highly complex apps where you don't want to list out every single dependency, you can use `auto_mock_missing=True` to seamlessly mock any module that isn't installed!
+
+```python
+from bridgekeeper import mock_modules, mock_env
+
+# 1. Mock critical environment variables
+mock_env({
+    "DATABASE_URL": "sqlite:///:memory:",
+    "SECRET_KEY": "dummy_secret_for_ci"
+})
+
+# 2. Automatically mock ANY missing dependency!
+# This is extremely useful if you don't want to install heavy libraries (like SQLAlchemy, boto3, etc.)
+# just to run a quick static analysis check.
+mock_modules(auto_mock_missing=True)
+
+# You can also explicitly mock specific modules with custom fakes:
+# mock_modules({"app.core.db": PostgresTestDb}, auto_mock_missing=True)
+
+# 3. Now it is safe to import the app
+from myapp.main import app
+from bridgekeeper import check_models
+
+results = check_models(app)
+```
+
+## Why the name bridgekeeper?  
+He guards the [Bridge of Death](https://montypython.fandom.com/wiki/Bridge_of_Death) and requires travelers to answer "questions three" before crossing safely.

api_bridgekeeper-0.1.0/api_bridgekeeper.egg-info/SOURCES.txt

@@ -0,0 +1,13 @@
+LICENSE
+README.md
+pyproject.toml
+api_bridgekeeper.egg-info/PKG-INFO
+api_bridgekeeper.egg-info/SOURCES.txt
+api_bridgekeeper.egg-info/dependency_links.txt
+api_bridgekeeper.egg-info/requires.txt
+api_bridgekeeper.egg-info/top_level.txt
+bridgekeeper/__init__.py
+bridgekeeper/checker.py
+bridgekeeper/mocking.py
+tests/test_bridgekeeper.py
+tests/test_mocking.py

api_bridgekeeper-0.1.0/api_bridgekeeper.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

api_bridgekeeper-0.1.0/api_bridgekeeper.egg-info/requires.txt

@@ -0,0 +1,7 @@
+
+[dev]
+pytest
+flask
+fastapi
+pydantic
+mypy

api_bridgekeeper-0.1.0/api_bridgekeeper.egg-info/top_level.txt

@@ -0,0 +1 @@
+bridgekeeper

api_bridgekeeper-0.1.0/bridgekeeper/__init__.py

@@ -0,0 +1,4 @@
+from .checker import check_models
+from .mocking import mock_modules, mock_env
+
+__all__ = ["check_models", "mock_modules", "mock_env"]

api_bridgekeeper-0.1.0/bridgekeeper/checker.py

@@ -0,0 +1,144 @@
+import inspect
+import os
+import typing
+from typing import Any, List, Dict, Optional, Literal, TypedDict, Callable
+
+class MissingResult(TypedDict):
+    api: str
+    file: str
+    missing: List[str]
+
+def _get_relative_path(func: Callable[..., Any]) -> str:
+    try:
+        # Unwrap standard decorators
+        func = inspect.unwrap(func)
+        # Unwrap functools.partial
+        if hasattr(func, 'func'):
+            func = func.func
+        abs_path = inspect.getfile(func)
+        return os.path.relpath(abs_path, os.getcwd())
+    except (TypeError, ValueError):
+        return "unknown"
+
+def _check_missing(func: Callable[..., Any], allow_any: bool) -> List[str]:
+    missing: List[str] = []
+    
+    try:
+        # Unwrap function if it's wrapped (common in Flask decorators)
+        unwrapped_func = inspect.unwrap(func)
+        sig = inspect.signature(unwrapped_func)
+    except (ValueError, TypeError):
+        return []
+        
+    # Check input types
+    missing_request = False
+    for param_name, param in sig.parameters.items():
+        if param_name in ('self', 'cls', 'request', 'response'):
+            continue
+        if param.kind in (inspect.Parameter.VAR_POSITIONAL, inspect.Parameter.VAR_KEYWORD):
+            continue
+        if param.annotation == inspect.Parameter.empty:
+            missing_request = True
+            break
+        if not allow_any and param.annotation is typing.Any:
+            missing_request = True
+            break
+            
+    if missing_request:
+        missing.append("request")
+        
+    # Check return type
+    if sig.return_annotation == inspect.Signature.empty:
+        missing.append("response")
+    elif not allow_any and sig.return_annotation is typing.Any:
+        missing.append("response")
+        
+    return missing
+
+def check_models(
+    app: Any,
+    allow_list: Optional[List[str]] = None,
+    check_only: Optional[Literal["request", "response"]] = None,
+    allow_any: bool = False
+) -> List[MissingResult]:
+    """
+    Checks if API routes have input (request) and output (response) type annotations.
+    
+    :param app: The FastAPI or Flask application instance.
+    :param allow_list: A list of API paths to ignore (e.g., ["/health"]).
+    :param check_only: If specified, restricts the check to either "request" or "response" only.
+    :param allow_any: If False, endpoints using `typing.Any` for models will be flagged as missing.
+    :return: List of dictionaries with missing annotations.
+    """
+    if allow_list is None:
+        allow_list = []
+        
+    results: List[MissingResult] = []
+    
+    def process_missing(api_path: str, func: Callable[..., Any], explicit_has_response: bool = False) -> None:
+        missing = _check_missing(func, allow_any)
+        
+        if explicit_has_response and 'response' in missing:
+            missing.remove('response')
+            
+        if check_only:
+            # Filter the missing list based on check_only
+            missing = [m for m in missing if m == check_only]
+            
+        if missing:
+            results.append({
+                "api": api_path,
+                "file": _get_relative_path(func),
+                "missing": missing
+            })
+
+    if hasattr(app, 'url_map') and hasattr(app, 'view_functions'):
+        for rule in app.url_map.iter_rules():
+            api_path = rule.rule
+            if api_path in allow_list:
+                continue
+                
+            endpoint = rule.endpoint
+            if endpoint == 'static':
+                continue
+                
+            view_func = app.view_functions.get(endpoint)
+            if not view_func:
+                continue
+                
+            process_missing(api_path, view_func)
+                
+    elif hasattr(app, 'routes'):
+        def _process_routes(routes, prefix=''):
+            for route in routes:
+                route_path = prefix + getattr(route, 'path', '')
+                
+                # FastAPI / Starlette Mount or IncludedRouter
+                if hasattr(route, 'routes'):
+                    _process_routes(route.routes, route_path)
+                    continue
+                elif hasattr(route, 'app') and hasattr(route.app, 'routes'):
+                    _process_routes(route.app.routes, route_path)
+                    continue
+                elif hasattr(route, 'include_context') and hasattr(route, 'original_router') and hasattr(route.original_router, 'routes'):
+                    included_prefix = getattr(route.include_context, 'prefix', '')
+                    _process_routes(route.original_router.routes, prefix + included_prefix)
+                    continue
+                elif hasattr(route, 'original_router') and hasattr(route.original_router, 'routes'):
+                    _process_routes(route.original_router.routes, route_path)
+                    continue
+                    
+                if not hasattr(route, 'endpoint'):
+                    continue
+                    
+                if route_path in allow_list:
+                    continue
+                    
+                endpoint = getattr(route, 'endpoint')
+                has_response_model = getattr(route, 'response_model', None) is not None
+                
+                process_missing(route_path, endpoint, explicit_has_response=has_response_model)
+
+        _process_routes(getattr(app, 'routes', []))
+                
+    return results

api_bridgekeeper-0.1.0/bridgekeeper/mocking.py

@@ -0,0 +1,83 @@
+import os
+import sys
+from typing import Dict, List, Union, Any, Optional
+from unittest.mock import MagicMock
+from importlib.abc import MetaPathFinder, Loader
+from importlib.machinery import ModuleSpec
+
+class _MockLoader(Loader):
+    def __init__(self, mock_obj=None):
+        self.mock_obj = mock_obj
+
+    def create_module(self, spec):
+        if self.mock_obj is not None:
+            return self.mock_obj
+        m = MagicMock()
+        m.__path__ = []
+        m.__spec__ = None
+        m.__version__ = "1.0.0"
+        return m
+        
+    def exec_module(self, module):
+        pass
+
+class _MockFinder(MetaPathFinder):
+    def __init__(self, prefixes: List[str], custom_mocks: Dict[str, Any]):
+        self.prefixes = prefixes
+        self.custom_mocks = custom_mocks
+        
+    def find_spec(self, fullname, path, target=None):
+        if fullname in self.custom_mocks:
+            return ModuleSpec(fullname, _MockLoader(self.custom_mocks[fullname]))
+            
+        for prefix in self.prefixes:
+            if fullname == prefix or fullname.startswith(prefix + "."):
+                return ModuleSpec(fullname, _MockLoader())
+                
+        return None
+
+class _FallbackMockFinder(MetaPathFinder):
+    """
+    A fallback finder that returns a mock for any missing module.
+    Because it's appended to the end of sys.meta_path, it only catches
+    modules that genuinely failed to load via standard finders.
+    """
+    def find_spec(self, fullname, path, target=None):
+        return ModuleSpec(fullname, _MockLoader())
+
+def mock_modules(modules: Optional[Union[List[str], Dict[str, Any]]] = None, auto_mock_missing: bool = False) -> None:
+    """
+    Mock heavy modules (like databases, redis, etc.) before importing the app.
+    Automatically intercepts submodules (e.g. mocking 'boto3' also mocks 'boto3.client').
+    
+    :param modules: A list of module strings to mock automatically with MagicMock, 
+                    or a dictionary mapping module strings to custom mock objects.
+    :param auto_mock_missing: If True, appends a fallback finder that automatically
+                              mocks ANY missing module.
+    """
+    prefixes = []
+    custom_mocks = {}
+    
+    if modules:
+        if isinstance(modules, list):
+            prefixes = modules
+        elif isinstance(modules, dict):
+            for k, v in modules.items():
+                if v is None:
+                    prefixes.append(k)
+                else:
+                    custom_mocks[k] = v
+                    
+        sys.meta_path.insert(0, _MockFinder(prefixes, custom_mocks))
+        
+    if auto_mock_missing:
+        sys.meta_path.append(_FallbackMockFinder())
+
+def mock_env(env_vars: Dict[str, str]) -> None:
+    """
+    Mock environment variables before importing the app.
+    
+    :param env_vars: A dictionary of environment variable keys and values.
+    """
+    for key, value in env_vars.items():
+        os.environ[key] = value

api_bridgekeeper-0.1.0/pyproject.toml

@@ -0,0 +1,27 @@
+[build-system]
+requires = ["setuptools>=61.0.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "api-bridgekeeper"
+version = "0.1.0"
+description = "Fail tests if APIs do not have input or output models"
+readme = "README.md"
+requires-python = ">=3.8"
+license = { text = "MIT" }
+authors = [
+    { name = "Ashish Thomas Cherian", email = "ufoundashish@gmail.com" }
+]
+dependencies = []
+
+[project.optional-dependencies]
+dev = [
+    "pytest",
+    "flask",
+    "fastapi",
+    "pydantic",
+    "mypy"
+]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

api_bridgekeeper-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

api_bridgekeeper-0.1.0/tests/test_bridgekeeper.py

@@ -0,0 +1,179 @@
+import pytest
+import typing
+from typing import Any, List, Dict
+from bridgekeeper import check_models
+from bridgekeeper.checker import MissingResult
+
+# Mock FastAPI to avoid hard dependency in tests if missing
+class MockAPIRoute:
+    def __init__(self, path: str, endpoint: typing.Callable[..., Any], response_model: typing.Optional[str] = None):
+        self.path = path
+        self.endpoint = endpoint
+        self.response_model = response_model
+
+class MockFastAPI:
+    def __init__(self, routes: List[MockAPIRoute]):
+        self.routes = routes
+
+# Mock Flask
+class MockRule:
+    def __init__(self, rule: str, endpoint: str):
+        self.rule = rule
+        self.endpoint = endpoint
+
+class MockUrlMap:
+    def __init__(self, rules: List[MockRule]):
+        self.rules = rules
+    def iter_rules(self) -> List[MockRule]:
+        return self.rules
+
+class MockFlask:
+    def __init__(self, rules: List[MockRule], view_functions: Dict[str, typing.Callable[..., Any]]):
+        self.url_map = MockUrlMap(rules)
+        self.view_functions = view_functions
+
+# Test functions
+def perfect_func(item: str) -> str:
+    return item
+
+def missing_return(item: str) -> Any:
+    return item
+
+def missing_input(item: Any) -> str:
+    return str(item)
+
+def missing_both(item: Any) -> Any:
+    return item
+
+# We need to remove the return annotations for missing tests to trigger the logic.
+# Python signatures are dynamic, let's redefine without hints.
+def missing_return_real(item: str):
+    return item
+
+def missing_input_real(item) -> str:
+    return item
+
+def missing_both_real(item):
+    return item
+
+def test_fastapi_checker() -> None:
+    routes = [
+        MockAPIRoute("/perfect", perfect_func),
+        MockAPIRoute("/missing_return", missing_return_real),
+        MockAPIRoute("/missing_input", missing_input_real),
+        MockAPIRoute("/missing_both", missing_both_real),
+        MockAPIRoute("/with_response_model", missing_return_real, response_model="SomeModel"),
+    ]
+    app = MockFastAPI(routes)
+    
+    results = check_models(app)
+    
+    assert len(results) == 3
+    
+    assert results[0]['api'] == "/missing_return"
+    assert results[0]['missing'] == ["response"]
+    
+    assert results[1]['api'] == "/missing_input"
+    assert results[1]['missing'] == ["request"]
+    
+    assert results[2]['api'] == "/missing_both"
+    assert set(results[2]['missing']) == {"request", "response"}
+
+def test_fastapi_allow_list() -> None:
+    routes = [
+        MockAPIRoute("/missing_both", missing_both_real),
+        MockAPIRoute("/ignored", missing_both_real),
+    ]
+    app = MockFastAPI(routes)
+    
+    results = check_models(app, allow_list=["/ignored"])
+    assert len(results) == 1
+    assert results[0]['api'] == "/missing_both"
+
+def test_fastapi_check_only_request() -> None:
+    routes = [
+        MockAPIRoute("/perfect", perfect_func),
+        MockAPIRoute("/missing_return", missing_return_real),
+        MockAPIRoute("/missing_input", missing_input_real),
+        MockAPIRoute("/missing_both", missing_both_real),
+    ]
+    app = MockFastAPI(routes)
+    
+    results = check_models(app, check_only="request")
+    
+    # Missing return should be ignored now
+    assert len(results) == 2
+    
+    assert results[0]['api'] == "/missing_input"
+    assert results[0]['missing'] == ["request"]
+    
+    assert results[1]['api'] == "/missing_both"
+    assert results[1]['missing'] == ["request"]
+
+def test_fastapi_check_only_response() -> None:
+    routes = [
+        MockAPIRoute("/perfect", perfect_func),
+        MockAPIRoute("/missing_return", missing_return_real),
+        MockAPIRoute("/missing_input", missing_input_real),
+        MockAPIRoute("/missing_both", missing_both_real),
+    ]
+    app = MockFastAPI(routes)
+    
+    results = check_models(app, check_only="response")
+    
+    # Missing input should be ignored now
+    assert len(results) == 2
+    
+    assert results[0]['api'] == "/missing_return"
+    assert results[0]['missing'] == ["response"]
+    
+    assert results[1]['api'] == "/missing_both"
+    assert results[1]['missing'] == ["response"]
+
+def test_flask_checker() -> None:
+    rules = [
+        MockRule("/perfect", "perfect_func"),
+        MockRule("/missing_return", "missing_return_real"),
+        MockRule("/static", "static"),
+    ]
+    view_functions: Dict[str, typing.Callable[..., Any]] = {
+        "perfect_func": perfect_func,
+        "missing_return_real": missing_return_real,
+        "static": lambda: "static"
+    }
+    app = MockFlask(rules, view_functions)
+    
+    results = check_models(app)
+    
+    assert len(results) == 1
+    assert results[0]['api'] == "/missing_return"
+    assert results[0]['missing'] == ["response"]
+
+def test_allow_any_false_by_default() -> None:
+    routes = [
+        MockAPIRoute("/missing_any_return", missing_return),
+        MockAPIRoute("/missing_any_input", missing_input),
+        MockAPIRoute("/missing_any_both", missing_both),
+    ]
+    app = MockFastAPI(routes)
+    
+    # allow_any defaults to False, so typing.Any should be flagged as missing
+    results = check_models(app)
+    
+    assert len(results) == 3
+    assert results[0]['missing'] == ["response"]
+    assert results[1]['missing'] == ["request"]
+    assert set(results[2]['missing']) == {"request", "response"}
+
+def test_allow_any_true() -> None:
+    routes = [
+        MockAPIRoute("/missing_any_return", missing_return),
+        MockAPIRoute("/missing_any_input", missing_input),
+        MockAPIRoute("/missing_any_both", missing_both),
+    ]
+    app = MockFastAPI(routes)
+    
+    # allow_any=True means typing.Any is accepted as a valid model
+    results = check_models(app, allow_any=True)
+    
+    assert len(results) == 0

api_bridgekeeper-0.1.0/tests/test_mocking.py

@@ -0,0 +1,68 @@
+import os
+import sys
+from unittest.mock import MagicMock
+from bridgekeeper.mocking import mock_modules, mock_env
+
+def test_mock_modules_list() -> None:
+    # Ensure module isn't loaded
+    if "dummy_module_1" in sys.modules:
+        del sys.modules["dummy_module_1"]
+        
+    mock_modules(["dummy_module_1"])
+    
+    import dummy_module_1  # type: ignore
+    assert "dummy_module_1" in sys.modules
+    assert isinstance(sys.modules["dummy_module_1"], MagicMock)
+
+def test_mock_modules_dict() -> None:
+    if "dummy_module_2" in sys.modules:
+        del sys.modules["dummy_module_2"]
+    if "dummy_module_3" in sys.modules:
+        del sys.modules["dummy_module_3"]
+        
+    custom_mock = object()
+    
+    mock_modules({
+        "dummy_module_2": None,          # Should be MagicMock
+        "dummy_module_3": custom_mock    # Should be custom_mock
+    })
+    
+    import dummy_module_2  # type: ignore
+    import dummy_module_3  # type: ignore
+    assert "dummy_module_2" in sys.modules
+    assert isinstance(sys.modules["dummy_module_2"], MagicMock)
+    
+    assert "dummy_module_3" in sys.modules
+    assert sys.modules["dummy_module_3"] is custom_mock
+
+def test_mock_env() -> None:
+    if "DUMMY_ENV_VAR" in os.environ:
+        del os.environ["DUMMY_ENV_VAR"]
+        
+    mock_env({"DUMMY_ENV_VAR": "secret_value"})
+    
+    assert os.environ.get("DUMMY_ENV_VAR") == "secret_value"
+    
+def test_auto_mock_missing() -> None:
+    # Ensure a truly non-existent module is not there
+    non_existent = "some_crazy_non_existent_module_name"
+    if non_existent in sys.modules:
+        del sys.modules[non_existent]
+        
+    # Clear out the fallback mock finder if previous tests added it
+    sys.meta_path = [m for m in sys.meta_path if type(m).__name__ != '_FallbackMockFinder']
+        
+    # Standard import should fail
+    try:
+        import some_crazy_non_existent_module_name  # type: ignore
+        assert False, "Should have raised ImportError"
+    except ImportError:
+        pass
+        
+    # Now enable auto_mock_missing
+    mock_modules(auto_mock_missing=True)
+    
+    # Standard import should now succeed and return a MagicMock!
+    import some_crazy_non_existent_module_name  # type: ignore
+    assert "some_crazy_non_existent_module_name" in sys.modules
+    assert isinstance(sys.modules["some_crazy_non_existent_module_name"], MagicMock)