csrd-utils 0.3.44__tar.gz → 0.3.45__tar.gz

{csrd_utils-0.3.44 → csrd_utils-0.3.45}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: csrd-utils
-Version: 0.3.44
+Version: 0.3.45
 Summary: CLI utilities for csrd service generation and feature augmentation
 Project-URL: Repository, https://github.com/csrd-api/fastapi-common
 Project-URL: Documentation, https://github.com/csrd-api/fastapi-common/tree/main/packages/utils

{csrd_utils-0.3.44 → csrd_utils-0.3.45}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "csrd-utils"
-version = "0.3.44"
+version = "0.3.45"
 description = "CLI utilities for csrd service generation and feature augmentation"
 license = { text = "MIT" }
 requires-python = ">=3.12"

{csrd_utils-0.3.44 → csrd_utils-0.3.45}/src/csrd_utils/generator.py

@@ -9,6 +9,61 @@ from cookiecutter.main import cookiecutter
 
 from .resources import templates_path
 
+_WORKSPACE_PYTEST_TOML = """\
+# Workspace-level tool configuration.
+# Add [project] and [build-system] sections if you need to publish this workspace as a package.
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+testpaths = ["tests"]
+pythonpath = ["src"]
+"""
+
+_WORKSPACE_README = """\
+# Workspace
+
+Generated workspace with one or more microservices.
+
+## Run tests
+
+From the workspace root, run all tests:
+
+```bash
+pytest
+```
+
+Run tests for a specific service:
+
+```bash
+pytest tests/unit/{service_name}
+pytest tests/acceptance/{service_name}
+```
+
+Run tests in watch mode (requires `pytest-watch`):
+
+```bash
+ptw
+```
+
+## Run services
+
+See individual service README files under `src/{service_name}/README.md` for instructions on running each service.
+
+## Docker Compose
+
+Run all services and infrastructure:
+
+```bash
+docker compose up --build
+```
+
+Check service health:
+
+```bash
+./smoke.sh
+```
+"""
+
 
 def _build_context(
     *,
@@ -123,6 +178,12 @@ def generate_service(
     _move_docker_files_to_workspace_root(generated_path, output_root, name)
     _move_tests_to_workspace_root(generated_path, output_root, name)
 
+    # Ensure workspace root has a pyproject.toml with pytest config.
+    _write_workspace_pyproject(output_root)
+
+    # Ensure workspace root has a README with test running instructions.
+    _write_workspace_readme(output_root)
+
     return generated_path
 
 
@@ -193,3 +254,36 @@ def _move_tests_to_workspace_root(
             shutil.copy2(src_file, acceptance_dst / filename)
 
     shutil.rmtree(tests_src, ignore_errors=True)
+
+
+def _write_workspace_pyproject(workspace_root: Path) -> None:
+    """Write or update workspace-level pyproject.toml with pytest configuration.
+
+    If the file does not exist it is created from scratch.  If it already exists
+    and already contains a ``[tool.pytest.ini_options]`` section it is left
+    untouched (the user may have customised it).  Otherwise the pytest block is
+    appended so that a second ``generate_service`` call on the same workspace
+    gains the config without clobbering prior edits.
+    """
+    dst = workspace_root / "pyproject.toml"
+    if dst.exists():
+        existing = dst.read_text(encoding="utf-8")
+        if "[tool.pytest.ini_options]" in existing:
+            return
+        dst.write_text(
+            existing.rstrip() + "\n\n" + _WORKSPACE_PYTEST_TOML,
+            encoding="utf-8",
+        )
+    else:
+        dst.write_text(_WORKSPACE_PYTEST_TOML, encoding="utf-8")
+
+
+def _write_workspace_readme(workspace_root: Path) -> None:
+    """Write workspace-level README.md with test running and setup instructions.
+
+    If the file does not exist it is created from scratch.  If it already exists
+    it is left untouched (the user may have customised it).
+    """
+    dst = workspace_root / "README.md"
+    if not dst.exists():
+        dst.write_text(_WORKSPACE_README, encoding="utf-8")

{csrd_utils-0.3.44 → csrd_utils-0.3.45}/src/csrd_utils/templates/cookiecutter-service/{{cookiecutter.__service_name_snake}}/pyproject.toml

@@ -38,9 +38,6 @@ dev = [
 [tool.hatch.build.targets.wheel]
 packages = ["{{cookiecutter.__service_name_snake}}"]
 
-[tool.pytest.ini_options]
-asyncio_mode = "auto"
-testpaths = ["tests"]
 
 [tool.mypy]
 python_version = "3.12"

{csrd_utils-0.3.44 → csrd_utils-0.3.45}/src/csrd_utils/templates/cookiecutter-service/{{cookiecutter.__service_name_snake}}/tests/conftest.py

@@ -1,15 +1,11 @@
 """Shared test fixtures for {{ cookiecutter.service_name }}."""
 
 import os
-import sys
-from pathlib import Path
 
 import pytest
 from fastapi.testclient import TestClient
 
-sys.path.insert(0, str(Path(__file__).parent.parent / "src"))
-
-from app import build_app
+from {{cookiecutter.__service_name_snake}} import build_app
 
 HAS_DATABASE = {{"True" if cookiecutter.has_database else "False"}}
 DB_KIND = "{{ cookiecutter.database }}"

{csrd_utils-0.3.44 → csrd_utils-0.3.45}/src/csrd_utils/templates/cookiecutter-service/{{cookiecutter.__service_name_snake}}/tests/test_items.py

@@ -111,7 +111,7 @@ def test_delegate_create_and_list(monkeypatch, client):
             return {"id": "d1", "name": payload["name"], "created_at": "2026-01-01T00:00:00Z"}
         return {"{{ cookiecutter.model_name_plural | lower | replace(' ', '_') }}": [{"id": "d1", "name": "X", "created_at": "t"}]}
 
-    monkeypatch.setattr("app.views.unversioned.items_view._delegate_request", fake_delegate_request)
+    monkeypatch.setattr("{{cookiecutter.__service_name_snake}}.views.unversioned.items_view._delegate_request", fake_delegate_request)
 
     created = client.post(
         "/api/{{ cookiecutter.model_name_plural | lower | replace(' ', '_') }}", json={"name": "X"}
@@ -130,7 +130,7 @@ def test_delegate_error_mapping(monkeypatch, client):
     async def fake_delegate_request(_method: str, _path: str, payload=None):
         raise HTTPException(status_code=404, detail="not found")
 
-    monkeypatch.setattr("app.views.unversioned.items_view._delegate_request", fake_delegate_request)
+    monkeypatch.setattr("{{cookiecutter.__service_name_snake}}.views.unversioned.items_view._delegate_request", fake_delegate_request)
     response = client.get("/api/{{ cookiecutter.model_name_plural | lower | replace(' ', '_') }}/missing")
     assert response.status_code == 404
 
@@ -147,7 +147,7 @@ def test_delegate_get_update_upsert_delete(monkeypatch, client):
             return {"id": "d2", "deleted": True}
         return {}
 
-    monkeypatch.setattr("app.views.unversioned.items_view._delegate_request", fake_delegate_request)
+    monkeypatch.setattr("{{cookiecutter.__service_name_snake}}.views.unversioned.items_view._delegate_request", fake_delegate_request)
 
     fetched = client.get("/api/{{ cookiecutter.model_name_plural | lower | replace(' ', '_') }}/d2")
     assert fetched.status_code == 200
@@ -176,7 +176,7 @@ def test_delegate_list_invalid_payload_returns_502(monkeypatch, client):
     async def fake_delegate_request(_method: str, _path: str, payload=None):
         return {"{{ cookiecutter.model_name_plural | lower | replace(' ', '_') }}": "bad"}
 
-    monkeypatch.setattr("app.views.unversioned.items_view._delegate_request", fake_delegate_request)
+    monkeypatch.setattr("{{cookiecutter.__service_name_snake}}.views.unversioned.items_view._delegate_request", fake_delegate_request)
     response = client.get("/api/{{ cookiecutter.model_name_plural | lower | replace(' ', '_') }}")
     assert response.status_code == 502
 {%- endif %}

{csrd_utils-0.3.44 → csrd_utils-0.3.45}/src/csrd_utils/templates/cookiecutter-service/{{cookiecutter.__service_name_snake}}/tests/unit/test_cache.py

@@ -17,7 +17,7 @@ def test_cache_client_uses_decode_responses() -> None:
 
 
 def test_cache_client_uses_runtime_cache_url() -> None:
-    settings_mod = importlib.import_module("app.settings")
+    settings_mod = importlib.import_module("{{cookiecutter.__service_name_snake}}.settings")
     original = settings_mod.settings.cache_url
     try:
         settings_mod.settings.cache_url = "redis://cache-host:6381/2"

{csrd_utils-0.3.44 → csrd_utils-0.3.45}/src/csrd_utils/templates/cookiecutter-service/{{cookiecutter.__service_name_snake}}/tests/unit/test_settings_contracts.py

@@ -73,11 +73,11 @@ def test_validate_db_credentials_rejects_weak_defaults(
 
 def test_app_package_init_modules_expose_tuple_all() -> None:
     for module_name in [
-        "app.delegates",
-        "app.dependencies",
-        "app.middleware",
-        "app.repositories",
-        "app.workers",
+        "{{cookiecutter.__service_name_snake}}.delegates",
+        "{{cookiecutter.__service_name_snake}}.dependencies",
+        "{{cookiecutter.__service_name_snake}}.middleware",
+        "{{cookiecutter.__service_name_snake}}.repositories",
+        "{{cookiecutter.__service_name_snake}}.workers",
     ]:
         module = importlib.import_module(module_name)
         exports = getattr(module, "__all__", ())

{csrd_utils-0.3.44 → csrd_utils-0.3.45}/src/csrd_utils/templates/cookiecutter-service/{{cookiecutter.__service_name_snake}}/tests/unit/test_worker_broker.py

@@ -16,7 +16,7 @@ def test_ping_task_returns_pong() -> None:
 
 
 def test_worker_broker_url_reflects_runtime_settings() -> None:
-    settings_mod = importlib.import_module("app.settings")
+    settings_mod = importlib.import_module("{{cookiecutter.__service_name_snake}}.settings")
     original = settings_mod.settings.worker_broker_url
     try:
         settings_mod.settings.worker_broker_url = "amqp://runtime-test"