sanityops-cli 0.1.6__tar.gz → 0.1.8__tar.gz

{sanityops_cli-0.1.6 → sanityops_cli-0.1.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: sanityops-cli
-Version: 0.1.6
+Version: 0.1.8
 Summary: CLI tool for static defect inspection of AI logical artifacts
 Project-URL: Homepage, https://sanityops.org
 Project-URL: Documentation, https://sanityops.org
@@ -23,7 +23,7 @@ Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
 Classifier: Topic :: Software Development :: Quality Assurance
 Requires-Python: >=3.11
 Requires-Dist: anyio>=4.0
-Requires-Dist: defect-check
+Requires-Dist: defect-check>=0.0.1
 Requires-Dist: httpx>=0.27
 Requires-Dist: pyyaml>=6.0
 Requires-Dist: rich>=13.0

{sanityops_cli-0.1.6 → sanityops_cli-0.1.8}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "sanityops-cli"
-version = "0.1.6"
+version = "0.1.8"
 description = "CLI tool for static defect inspection of AI logical artifacts"
 readme = "README.md"
 requires-python = ">=3.11"
@@ -31,7 +31,7 @@ dependencies = [
     "httpx>=0.27",
     "tomli>=2.0",
     "tomli-w>=1.0",
-    "defect-check",
+    "defect-check>=0.0.1",
     "pyyaml>=6.0",
     "sanityops-agent>=0.0.4",
     "anyio>=4.0",

{sanityops_cli-0.1.6 → sanityops_cli-0.1.8}/src/sanityops_cli/__init__.py

@@ -13,4 +13,4 @@
 # limitations under the License.
 #
 
-__version__ = "0.1.6"
+__version__ = "0.1.8"

{sanityops_cli-0.1.6 → sanityops_cli-0.1.8}/src/sanityops_cli/defect_checker/llm_config.py

@@ -102,10 +102,13 @@ def resolve_llm_config(config_path: str | None = None) -> dict[str, str]:
     if config_values:
         return config_values
 
-    # Fall back to ProviderConfig (env vars)
+    # Fall back to ProviderConfig (env vars). PROVIDER is the field that reads
+    # the documented LLM_PROVIDER variable (env_prefix is "LLM_"); the
+    # LLM_PROVIDER *alias* field listens on LLM_LLM_PROVIDER, so reading it here
+    # left llm_provider None and made the SDK refuse every env-configured run.
     config = ProviderConfig()
     return {
-        "llm_provider": config.LLM_PROVIDER,
+        "llm_provider": config.PROVIDER,
         "llm_api_key": config.API_KEY,
         "llm_model_id": config.MODEL_ID,
         "llm_base_url": config.BASE_URL or "",

{sanityops_cli-0.1.6 → sanityops_cli-0.1.8}/src/sanityops_cli/defect_checker/markdown_reporter.py

@@ -77,6 +77,40 @@ def _aggregate_cross_defects(cross_results: list[dict]) -> list[dict]:
     return defects
 
 
+def _format_permission_table(defects: list[dict]) -> list[str]:
+    """Generate extended markdown table for QD-PM permission defects.
+
+    Columns: ID | Name | Severity | Description | Action | Permission Side | Duty Side | Fix
+
+    Note: Missing fields display as em dash (—) via _esc_md_cell(None).
+    This differs from terminal renderer which silently omits missing fields.
+    """
+    lines = []
+    lines.append("| ID | Name | Severity | Description | Action | Permission Side | Duty Side | Fix |")
+    lines.append("|---|---|---|---|---|---|---|---|")
+
+    for defect in defects:
+        details = defect.get("details", {})
+        if not isinstance(details, dict):
+            details = {}
+
+        defect_id = _esc_md_cell(defect.get("id") or "unknown-permission-defect")
+        name = _esc_md_cell(defect.get("name"))
+        severity = _esc_md_cell(defect.get("severity"))
+        description = _esc_md_cell(defect.get("description"))
+        action = _esc_md_cell(details.get("action"))
+        permission_side = _esc_md_cell(details.get("permission_side"))
+        duty_side = _esc_md_cell(details.get("duty_side"))
+        fix = _esc_md_cell(defect.get("fix_suggestion"))
+
+        lines.append(
+            f"| {defect_id} | {name} | {severity} | {description} | {action} | "
+            f"{permission_side} | {duty_side} | {fix} |"
+        )
+
+    return lines
+
+
 def _calculate_cross_score(
     defects: list[dict],
     check_level: str,
@@ -188,6 +222,14 @@ def _build_report(
             lines.append("")
             continue
 
+        # Use permission-specific table for QD-PM module.
+        # Renderer also detects via module (primary), category, or ID prefix for consistency.
+        if module == "QD-PM":
+            lines.extend(_format_permission_table(defects))
+            lines.append("")
+            continue
+
+        # Standard defect table for other modules
         lines.append("| ID | Name | Severity | Description | Location | Impact | Fix |")
         lines.append("|---|---|---|---|---|---|---|")
         for defect in defects:

{sanityops_cli-0.1.6 → sanityops_cli-0.1.8}/src/sanityops_cli/defect_checker/renderer.py

@@ -33,6 +33,7 @@ _MODULE_LABELS: dict[str, str] = {
     "QDT": "Tools",
     "QDP": "Prompts",
     "CROSS": "Cross",
+    "QD-PM": "Permissions",
 }
 
 #: Map module names to singular type labels for panel titles.
@@ -40,6 +41,7 @@ _MODULE_TYPE_LABELS: dict[str, str] = {
     "QDS": "Skill",
     "QDT": "Tool",
     "QDP": "Prompt",
+    "QD-PM": "Permission",
 }
 
 
@@ -147,20 +149,23 @@ class DefectRenderer:
 
     def _render_artifact_groups(self, results: list[dict[str, Any]]) -> None:
         for result in results:
+            module = result.get("module", "")
             title = resolve_artifact_title(result)
             if title is None:
                 continue
             defects = result.get("defects", [])
             if not defects:
                 continue
-            self._render_group(title, defects)
+            self._render_group(title, defects, module=module)
             self.console.print()
 
-    def _render_group(self, label: str, defects: list[dict[str, Any]]) -> None:
+    def _render_group(
+        self, label: str, defects: list[dict[str, Any]], *, module: str = ""
+    ) -> None:
         lines: list[str] = []
         shown = defects[:MAX_DEFECTS_PER_GROUP]
         for defect in shown:
-            lines.append(self._format_defect(defect))
+            lines.append(self._format_defect(defect, module=module))
 
         hidden = len(defects) - len(shown)
         if hidden > 0:
@@ -169,9 +174,27 @@ class DefectRenderer:
         body = "\n".join(lines)
         self.console.print(Panel(body, title=label, border_style="cyan"))
 
-    def _format_defect(self, defect: dict[str, Any]) -> str:
-        severity = defect.get("severity", "NONE")
-        defect_id = defect.get("id") or "defect"
+    def _format_defect(self, defect: dict[str, Any], *, module: str = "") -> str:
+        """Format a defect for terminal display.
+
+        Dispatches to specialized formatter for permission defects.
+
+        Detection priority: module == "QD-PM" > category == "permission" > ID prefix.
+        This is more permissive than markdown_reporter's module-only detection.
+        Rationale: terminal output is per-defect and can adapt based on defect
+        content, while markdown uses module-level table structure. The primary
+        path (module == "QD-PM") is shared; fallbacks handle edge cases where
+        defect metadata is inconsistent. This is intentional design.
+        """
+        # Detect permission defects via module, category, or ID prefix
+        category = defect.get("category") or ""
+        raw_defect_id = defect.get("id") or ""
+        if module == "QD-PM" or category == "permission" or raw_defect_id.startswith("QD-PM"):
+            return self._format_permission_defect(defect)
+
+        # Default formatting for other defect types
+        severity = defect.get("severity") or "NONE"
+        defect_id = raw_defect_id or "defect"
         lines = [f"[bold red]✗ [{severity}] {defect_id}[/]"]
         if defect.get("location"):
             lines.append(f"  [dim]Location[/] : {defect['location']}")
@@ -181,6 +204,51 @@ class DefectRenderer:
             lines.append(f"  [dim]Fix[/]      : {defect['fix_suggestion']}")
         return "\n".join(lines)
 
+    def _format_permission_defect(self, defect: dict[str, Any]) -> str:
+        """Format a QD-PM permission defect with permission-specific fields.
+
+        Shows: name, description, action, permission_side, duty_side from details dict.
+
+        Note: Missing fields are silently omitted (unlike markdown which uses em dash).
+        This is intentional for terminal output compactness.
+        """
+        severity = defect.get("severity") or "NONE"
+        defect_id = defect.get("id") or "unknown-permission-defect"
+        lines = [f"[bold red]✗ [{severity}] {defect_id}[/]"]
+
+        # Name field (for consistency with markdown table)
+        if defect.get("name"):
+            lines.append(f"  [dim]Name[/]     : {defect['name']}")
+
+        # Description field (standard field)
+        if defect.get("description"):
+            lines.append(f"  [dim]Desc[/]     : {defect['description']}")
+
+        # Standard fields
+        if defect.get("location"):
+            lines.append(f"  [dim]Location[/] : {defect['location']}")
+        if defect.get("impact"):
+            lines.append(f"  [dim]Impact[/]   : {defect['impact']}")
+
+        # Permission-specific fields from details dict
+        details = defect.get("details", {})
+        if isinstance(details, dict):
+            action = details.get("action")
+            if action:
+                lines.append(f"  [dim]Action[/]   : {action}")
+            permission_side = details.get("permission_side")
+            if permission_side:
+                lines.append(f"  [dim]Permission[/]: {permission_side}")
+            duty_side = details.get("duty_side")
+            if duty_side:
+                lines.append(f"  [dim]Duty[/]     : {duty_side}")
+
+        # Fix suggestion
+        if defect.get("fix_suggestion"):
+            lines.append(f"  [dim]Fix[/]      : {defect['fix_suggestion']}")
+
+        return "\n".join(lines)
+
     # ------------------------------------------------------------------
     # Footer
     # ------------------------------------------------------------------

{sanityops_cli-0.1.6 → sanityops_cli-0.1.8}/tests/unit/defect_checker/test_llm_config.py

@@ -1,47 +1,85 @@
 """Unit tests for LLM config resolution."""
 from pathlib import Path
-from unittest import mock
 
 import yaml
 
 from sanityops_cli.defect_checker.llm_config import resolve_llm_config
 
+LLM_ENV_NAMES = (
+    "LLM_PROVIDER",
+    "LLM_LLM_PROVIDER",
+    "LLM_API_KEY",
+    "LLM_MODEL_ID",
+    "LLM_BASE_URL",
+)
 
-class TestResolveLlmConfig:
-    def test_returns_four_expected_keys(self):
+
+def _set_llm_env(monkeypatch, tmp_path: Path, **values: str) -> None:
+    """Point the LLM_* environment variables at `values`, clearing the rest.
+
+    Also chdirs into tmp_path so ProviderConfig's `.env` lookup (env_file)
+    cannot leak values from the repository into the test.
+    """
+    monkeypatch.chdir(tmp_path)
+    for name in LLM_ENV_NAMES:
+        monkeypatch.delenv(name, raising=False)
+    for name, value in values.items():
+        monkeypatch.setenv(name, value)
+
+
+class TestResolveLlmConfigFromEnvironment:
+    """The env fallback must read the documented LLM_* variable names.
+
+    Regression: resolve_llm_config read ``ProviderConfig.LLM_PROVIDER``, the
+    deprecated constructor alias, instead of ``ProviderConfig.PROVIDER``. The
+    settings model sets ``env_prefix="LLM_"``, so that alias listens on
+    ``LLM_LLM_PROVIDER``; the documented ``LLM_PROVIDER`` never reached the
+    defect-check SDK, which refused the run with LLM_CONFIGURATION_MISSING and
+    left the report at zero defects with a PASS gate.
+    """
+
+    def test_returns_four_expected_keys(self, tmp_path: Path, monkeypatch):
+        _set_llm_env(monkeypatch, tmp_path)
         cfg = resolve_llm_config()
         assert set(cfg.keys()) == {"llm_provider", "llm_api_key", "llm_model_id", "llm_base_url"}
 
-    def test_maps_provider_config_fields(self):
-        fake = mock.Mock()
-        fake.LLM_PROVIDER = "anthropic"
-        fake.API_KEY = "sk-test"
-        fake.MODEL_ID = "claude-sonnet-4-20250514"
-        fake.BASE_URL = "https://api.example.com"
-        with mock.patch(
-            "sanityops_cli.defect_checker.llm_config.ProviderConfig",
-            return_value=fake,
-        ):
-            cfg = resolve_llm_config()
-        assert cfg == {
+    def test_reads_documented_env_var_names(self, tmp_path: Path, monkeypatch):
+        """LLM_PROVIDER and friends resolve into the provider the SDK receives."""
+        _set_llm_env(
+            monkeypatch,
+            tmp_path,
+            LLM_PROVIDER="anthropic",
+            LLM_API_KEY="sk-test",
+            LLM_MODEL_ID="claude-sonnet-4-20250514",
+            LLM_BASE_URL="https://api.example.com",
+        )
+        assert resolve_llm_config() == {
             "llm_provider": "anthropic",
             "llm_api_key": "sk-test",
             "llm_model_id": "claude-sonnet-4-20250514",
             "llm_base_url": "https://api.example.com",
         }
 
-    def test_none_base_url_becomes_empty_string(self):
-        fake = mock.Mock()
-        fake.LLM_PROVIDER = "openai"
-        fake.API_KEY = "k"
-        fake.MODEL_ID = "gpt-4o"
-        fake.BASE_URL = None
-        with mock.patch(
-            "sanityops_cli.defect_checker.llm_config.ProviderConfig",
-            return_value=fake,
-        ):
-            cfg = resolve_llm_config()
-        assert cfg["llm_base_url"] == ""
+    def test_deprecated_double_prefixed_provider_name_still_resolves(self, tmp_path: Path, monkeypatch):
+        """LLM_LLM_PROVIDER is the deprecated alias' own env name; keep it working."""
+        _set_llm_env(
+            monkeypatch,
+            tmp_path,
+            LLM_LLM_PROVIDER="openai",
+            LLM_API_KEY="sk-test",
+            LLM_MODEL_ID="gpt-4o",
+        )
+        assert resolve_llm_config()["llm_provider"] == "openai"
+
+    def test_unset_base_url_becomes_empty_string(self, tmp_path: Path, monkeypatch):
+        _set_llm_env(
+            monkeypatch,
+            tmp_path,
+            LLM_PROVIDER="openai",
+            LLM_API_KEY="k",
+            LLM_MODEL_ID="gpt-4o",
+        )
+        assert resolve_llm_config()["llm_base_url"] == ""
 
 
 class TestResolveLlmConfigFromConfigFile:
@@ -103,7 +141,7 @@ class TestResolveLlmConfigFromConfigFile:
 
     def test_model_section_absent_falls_back_to_env_vars(self, tmp_path: Path, monkeypatch):
         """Should fall back to ProviderConfig when model section absent."""
-        monkeypatch.chdir(tmp_path)
+        _set_llm_env(monkeypatch, tmp_path)
         config_dir = tmp_path / ".sanityops"
         config_dir.mkdir()
         config_file = config_dir / "inspect_config.yaml"
@@ -117,17 +155,15 @@ class TestResolveLlmConfigFromConfigFile:
         with open(config_file, "w") as f:
             yaml.dump(config_content, f)
 
-        fake = mock.Mock()
-        fake.LLM_PROVIDER = "env-provider"
-        fake.API_KEY = "env-key"
-        fake.MODEL_ID = "env-model"
-        fake.BASE_URL = "https://env.url"
-        with mock.patch(
-            "sanityops_cli.defect_checker.llm_config.ProviderConfig",
-            return_value=fake,
-        ):
-            cfg = resolve_llm_config(str(config_file))
-        assert cfg == {
+        _set_llm_env(
+            monkeypatch,
+            tmp_path,
+            LLM_PROVIDER="env-provider",
+            LLM_API_KEY="env-key",
+            LLM_MODEL_ID="env-model",
+            LLM_BASE_URL="https://env.url",
+        )
+        assert resolve_llm_config(str(config_file)) == {
             "llm_provider": "env-provider",
             "llm_api_key": "env-key",
             "llm_model_id": "env-model",
@@ -136,19 +172,14 @@ class TestResolveLlmConfigFromConfigFile:
 
     def test_config_file_missing_falls_back_to_env_vars(self, tmp_path: Path, monkeypatch):
         """Should fall back to ProviderConfig when config file doesn't exist."""
-        monkeypatch.chdir(tmp_path)
-
-        fake = mock.Mock()
-        fake.LLM_PROVIDER = "fallback-provider"
-        fake.API_KEY = "fallback-key"
-        fake.MODEL_ID = "fallback-model"
-        fake.BASE_URL = None
-        with mock.patch(
-            "sanityops_cli.defect_checker.llm_config.ProviderConfig",
-            return_value=fake,
-        ):
-            cfg = resolve_llm_config("/nonexistent/config.yaml")
-        assert cfg == {
+        _set_llm_env(
+            monkeypatch,
+            tmp_path,
+            LLM_PROVIDER="fallback-provider",
+            LLM_API_KEY="fallback-key",
+            LLM_MODEL_ID="fallback-model",
+        )
+        assert resolve_llm_config("/nonexistent/config.yaml") == {
             "llm_provider": "fallback-provider",
             "llm_api_key": "fallback-key",
             "llm_model_id": "fallback-model",
@@ -206,20 +237,22 @@ class TestResolveLlmConfigFromConfigFile:
         with open(config_file, "w") as f:
             yaml.dump(config_content, f)
 
-        # Set up env vars that should be ignored
-        fake = mock.Mock()
-        fake.LLM_PROVIDER = "env-provider-should-be-ignored"
-        fake.API_KEY = "env-key-should-be-ignored"
-        fake.MODEL_ID = "env-model-should-be-ignored"
-        fake.BASE_URL = "https://env.url.ignored"
-        with mock.patch(
-            "sanityops_cli.defect_checker.llm_config.ProviderConfig",
-            return_value=fake,
-        ):
-            cfg = resolve_llm_config(str(config_file))
+        # Env vars that must be ignored in favour of the config file's model: section
+        _set_llm_env(
+            monkeypatch,
+            tmp_path,
+            LLM_PROVIDER="env-provider-should-be-ignored",
+            LLM_API_KEY="env-key-should-be-ignored",
+            LLM_MODEL_ID="env-model-should-be-ignored",
+            LLM_BASE_URL="https://env.url.ignored",
+        )
+
+        cfg = resolve_llm_config(str(config_file))
 
         # Config values win
-        assert cfg["llm_provider"] == "config-provider"
-        assert cfg["llm_api_key"] == "config-key"
-        assert cfg["llm_model_id"] == "config-model"
-        assert cfg["llm_base_url"] == ""
+        assert cfg == {
+            "llm_provider": "config-provider",
+            "llm_api_key": "config-key",
+            "llm_model_id": "config-model",
+            "llm_base_url": "",
+        }