cli changes etc

Author: BarnabasG

Makefile

@@ -46,13 +46,18 @@ clean:
 
 build:
 	@echo "Building plugin..."
+	@uv sync
 	@uv build
 
 publish:
 	@echo "Publishing plugin..."
-	# @uv publish --token $(PYPI_TOKEN)
+	@uv publish --token $(PYPI_TOKEN)
 
 publish-test:
 	@echo "Publishing plugin to test PyPI..."
-	@echo $(TEST_PYPI_TOKEN)
-	@uv publish --token $(TEST_PYPI_TOKEN)
+	@echo //$(TEST_PYPI_TOKEN)//
+	@uv publish --token $(TEST_PYPI_TOKEN) --index testpypi
+
+verify-publish:
+	@echo "Verifying plugin was published to PyPI..."
+	@uv run --with pytest-api-cov --no-project -- python -c "import pytest_api_cov; print(f'Plugin verified successfully. Version: {pytest_api_cov.__version__}')"

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pytest-api-cov"
-version = "1.0.0"
+version = "0.1.2"
 description = "Api Coverage Report Pytest Plugin"
 readme = "README.md"
 authors = [
@@ -17,12 +17,12 @@ dependencies = [
     "rich>=14.0.0",
     "starlette>=0.47.1",
     "tomli>=2.2.1",
+    "pytest>=8.4.1",
 ]
 
 [dependency-groups]
 dev = [
     "mypy>=1.17.0",
-    "pytest>=8.4.1",
     "pytest-cov>=6.2.1",
     "pytest-sugar>=1.0.0",
     "pytest-xdist>=3.8.0",
@@ -69,6 +69,12 @@ include = [
     "pyproject.toml",
 ]
 
+# [[tool.uv.index]]
+# name = "testpypi"
+# url = "https://test.pypi.org/simple/"
+# publish-url = "https://test.pypi.org/legacy/"
+# explicit = true
+
 [project.entry-points."pytest11"]
 pytest_api_cov = "pytest_api_cov.plugin"
 

src/pytest_api_cov/__init__.py

@@ -1 +1,7 @@
-# This file makes the pytest_api_cov directory a Python package
+"""init pytest_api_cov."""
+
+try:
+    from importlib.metadata import version
+    __version__ = version("pytest-api-cov")
+except ImportError:
+    __version__ = "unknown"

src/pytest_api_cov/cli.py

@@ -11,52 +11,66 @@ def detect_framework_and_app() -> Optional[tuple[str, str, str]]:
     Detect framework and app location.
     Returns (framework, file_path, app_variable) or None.
     """
-    common_patterns = [
-        ("app.py", ["app", "application", "main"]),
-        ("main.py", ["app", "application", "main"]),
-        ("server.py", ["app", "application", "server"]),
-        ("wsgi.py", ["app", "application"]),
-        ("asgi.py", ["app", "application"]),
-    ]
-
-    for filename, attr_names in common_patterns:
-        if os.path.exists(filename):
-            try:
-                with open(filename, "r") as f:
-                    content = f.read()
-
-                if "from fastapi import" in content or "import fastapi" in content:
-                    framework = "FastAPI"
-                elif "from flask import" in content or "import flask" in content:
-                    framework = "Flask"
-                else:
-                    continue
-
-                for attr_name in attr_names:
-                    if f"{attr_name} = " in content:
-                        return framework, filename, attr_name
-
-            except Exception:
+    import glob
+
+    # Search for app files at any depth in current directory
+    app_patterns = ["app.py", "main.py", "server.py", "wsgi.py", "asgi.py"]
+    common_vars = ["app", "application", "main", "server"]
+
+    # Find all matching files recursively
+    found_files = []
+    for pattern in app_patterns:
+        found_files.extend(glob.glob(f"**/{pattern}", recursive=True))
+
+    # Sort by depth (shallowest first) and then by filename priority
+    found_files.sort(key=lambda x: (x.count(os.sep), app_patterns.index(os.path.basename(x))))
+
+    for file_path in found_files:
+        try:
+            with open(file_path, "r") as f:
+                content = f.read()
+
+            if "from fastapi import" in content or "import fastapi" in content:
+                framework = "FastAPI"
+            elif "from flask import" in content or "import flask" in content:
+                framework = "Flask"
+            else:
                 continue
 
+            for var_name in common_vars:
+                if f"{var_name} = " in content:
+                    return framework, file_path, var_name
+
+        except Exception:
+            continue
+
     return None
 
 
 def generate_conftest_content(framework: str, file_path: str, app_variable: str) -> str:
     """Generate conftest.py content based on detected framework."""
-    module_name = file_path[:-3]  # Remove .py
+    # Convert file path to import path (e.g., "src/main.py" -> "src.main")
+    module_path = file_path.replace("/", ".").replace("\\", ".").replace(".py", "")
 
     return f'''"""conftest.py - Auto-generated by pytest-api-cov init"""
 
 import pytest
 
 # Import your {framework} app
-from {module_name} import {app_variable}
+from {module_path} import {app_variable}
 
 
 @pytest.fixture
-def app():
-    """Provide the {framework} app for API coverage testing."""
+def client():
+    """Provide the {framework} client for API coverage testing.
+    
+    In your test:
+    ```
+    def test_root_endpoint(client):
+        response = client.get("/")
+        assert response.status_code == 200
+    ```
+    """
     return {app_variable}
 '''
 
@@ -152,9 +166,9 @@ def test_root_endpoint(client):
         print("❌ No FastAPI or Flask app detected in common locations")
         print()
         print("Please ensure you have one of these files with a Flask/FastAPI app:")
-        print("• app.py")
-        print("• main.py")
-        print("• server.py")
+        print("• app.py, main.py, server.py, wsgi.py, or asgi.py")
+        print("• Files can be in the current directory or any subdirectory")
+        print("• The file must contain a variable named 'app', 'application', 'main', or 'server'")
         print()
         print("Example app.py:")
         print("""

tests/integration/__init__.py

@@ -1 +1 @@
-# This file makes the integration directory a Python package
+"""init integration tests."""

tests/unit/__init__.py

@@ -1 +1 @@
-# This file makes the unit directory a Python package
+"""init unit tests."""

tests/unit/test_cli.py

@@ -18,7 +18,7 @@ class TestDetectFrameworkAndApp:
 
     def test_no_files_exist(self):
         """Test detection when no app files exist."""
-        with patch("os.path.exists", return_value=False):
+        with patch("glob.glob", return_value=[]):
             result = detect_framework_and_app()
             assert result is None
 
@@ -28,6 +28,8 @@ def test_no_files_exist(self):
             ("FastAPI", "from fastapi import FastAPI", "app", "app.py", "app"),
             ("Flask", "from flask import Flask", "application", "app.py", "application"),
             ("FastAPI", "import fastapi\nfrom fastapi import FastAPI", "main", "main.py", "main"),
+            ("FastAPI", "from fastapi import FastAPI", "app", "src/main.py", "app"),
+            ("Flask", "from flask import Flask", "app", "example/src/main.py", "app"),
         ],
     )
     def test_framework_app_detection(self, framework, import_stmt, var_name, expected_file, expected_var):
@@ -53,10 +55,7 @@ def root():
     return "hello"
 """
 
-        def mock_exists(path):
-            return path == expected_file
-
-        with patch("os.path.exists", side_effect=mock_exists), patch("builtins.open", mock_open(read_data=app_content)):
+        with patch("glob.glob", return_value=[expected_file]), patch("builtins.open", mock_open(read_data=app_content)):
             result = detect_framework_and_app()
             assert result == (framework, expected_file, expected_var)
 
@@ -68,7 +67,7 @@ def test_no_framework_detected(self):
 def hello():
     return "hello"
 """
-        with patch("os.path.exists", return_value=True), patch("builtins.open", mock_open(read_data=app_content)):
+        with patch("glob.glob", return_value=["app.py"]), patch("builtins.open", mock_open(read_data=app_content)):
             result = detect_framework_and_app()
             assert result is None
 
@@ -79,14 +78,14 @@ def test_framework_but_no_app_variable(self):
 
 # No app variable defined
 """
-        with patch("os.path.exists", return_value=True), patch("builtins.open", mock_open(read_data=app_content)):
+        with patch("glob.glob", return_value=["app.py"]), patch("builtins.open", mock_open(read_data=app_content)):
             result = detect_framework_and_app()
             assert result is None
 
     def test_file_read_exception(self):
         """Test handling of file read exceptions."""
         with (
-            patch("os.path.exists", return_value=True),
+            patch("glob.glob", return_value=["app.py"]),
             patch("builtins.open", side_effect=IOError("Cannot read file")),
         ):
             result = detect_framework_and_app()
@@ -99,18 +98,19 @@ def test_multiple_files_checked(self):
 server = Flask(__name__)
 """
 
-        def mock_exists(path):
-            return path in ["app.py", "server.py"]
+        with patch("glob.glob", return_value=["app.py", "server.py"]):
 
-        def mock_open_handler(path, mode="r"):
-            if path == "app.py":
-                return mock_open(read_data="# just a comment")()
-            elif path == "server.py":
-                return mock_open(read_data=flask_content)()
+            def mock_open_handler(path, mode="r"):
+                if path == "app.py":
+                    return mock_open(read_data="# foobar")()
+                elif path == "server.py":
+                    return mock_open(read_data=flask_content)()
+                else:
+                    return mock_open(read_data="")()
 
-        with patch("os.path.exists", side_effect=mock_exists), patch("builtins.open", side_effect=mock_open_handler):
-            result = detect_framework_and_app()
-            assert result == ("Flask", "server.py", "server")
+            with patch("builtins.open", side_effect=mock_open_handler):
+                result = detect_framework_and_app()
+                assert result == ("Flask", "server.py", "server")
 
 
 class TestGenerateConftestContent:
@@ -136,6 +136,26 @@ def test_flask_conftest(self):
         assert "Provide the Flask app" in content
         assert "return application" in content
 
+    def test_subdirectory_conftest(self):
+        """Test generating conftest for app in subdirectory."""
+        content = generate_conftest_content("FastAPI", "src/main.py", "app")
+
+        assert "import pytest" in content
+        assert "from src.main import app" in content
+        assert "def app():" in content
+        assert "Provide the FastAPI app" in content
+        assert "return app" in content
+
+    def test_nested_subdirectory_conftest(self):
+        """Test generating conftest for app in nested subdirectory."""
+        content = generate_conftest_content("Flask", "example/src/main.py", "app")
+
+        assert "import pytest" in content
+        assert "from example.src.main import app" in content
+        assert "def app():" in content
+        assert "Provide the Flask app" in content
+        assert "return app" in content
+
 
 class TestGeneratePyprojectConfig:
     """Tests for generate_pyproject_config function."""

tests/unit/test_plugin.py

@@ -21,6 +21,13 @@
 class TestSupportedFramework:
     """Tests for framework detection utility functions."""
 
+    def test_package_version(self):
+        """Test that package version is accessible."""
+        import pytest_api_cov
+        assert hasattr(pytest_api_cov, "__version__")
+        assert isinstance(pytest_api_cov.__version__, str)
+        assert pytest_api_cov.__version__ == "0.1.1"
+
     def test_is_supported_framework_none(self):
         """Test framework detection with None."""
         assert is_supported_framework(None) is False