eddb0d2c58
3 new test files that drive the upcoming cli/error_render.py module
and the V2ClientError refactor.
tests/test_cli_error_render.py — 5 cases for `render_error(status, body)`:
recognize cross_project_forbidden BqAccessError shape; recognize
remote_scan_too_large guardrail rejection; recognize
bq_path_not_registered RBAC denial; fall back to truncated form for
unrecognized shape; pass through string `detail`.
tests/test_cli_query_render.py — V2ClientError must use the new renderer:
multi-line output instead of `f"HTTP {code}: {body}"`; no
pre-truncation that would hide the hint field; RemoteQueryError
already carries `details` (smoke).
tests/test_remote_query_error_details.py — audit lock-in for
RemoteQueryError raise sites that already populate details
(blocked_keyword) plus the shape contract for local-validation paths.
Run: 5 errors (cli.error_render module missing — clean ImportError),
2 assertion failures (V2ClientError single-line output, blocked_keyword
detail shape pre-existing). 3 regression-green pass for trivial
reasons; will exercise real code paths once GREEN lands.
66 lines
2.6 KiB
Python
66 lines
2.6 KiB
Python
"""CLI commands route BQ-typed errors through the shared renderer.
|
|
|
|
Three CLI paths surface BQ errors today:
|
|
- `da query --remote` (cli/commands/query.py:_query_remote → /api/query)
|
|
- `da query --register-bq` (cli/commands/query.py:_query_hybrid via
|
|
RemoteQueryError, which wraps server-side BqAccessError)
|
|
- `da fetch` / `da schema` / etc. (cli/v2_client.V2ClientError → v2 endpoints)
|
|
|
|
After the refactor they all call cli.error_render.render_error so analyst
|
|
output is consistent and structured. Closes part of #160 §4.7.3.
|
|
"""
|
|
from __future__ import annotations
|
|
|
|
import pytest
|
|
|
|
|
|
def test_v2_client_error_uses_renderer():
|
|
"""`V2ClientError.__str__` calls render_error so any caller of the v2
|
|
HTTP helpers (api_get_json/api_post_json/api_post_arrow) automatically
|
|
surfaces typed BQ errors as structured output."""
|
|
from cli.v2_client import V2ClientError
|
|
|
|
body = {"detail": {
|
|
"kind": "cross_project_forbidden",
|
|
"message": "USER_PROJECT_DENIED",
|
|
"hint": "Set data_source.bigquery.billing_project",
|
|
}}
|
|
err = V2ClientError(status_code=502, body=body)
|
|
out = str(err)
|
|
# Old form: `HTTP 502: {'detail': {'kind': ...}}` (single line).
|
|
# New form: multi-line structured.
|
|
assert "\n" in out, f"V2ClientError must use multi-line renderer; got {out!r}"
|
|
assert "cross_project_forbidden" in out
|
|
assert "billing_project" in out
|
|
|
|
|
|
def test_v2_client_error_drops_truncation_for_dicts():
|
|
"""The OLD `message=str(body)[:200]` truncation hid the structured
|
|
`hint` field for any reasonably-sized error dict. The new renderer
|
|
must NOT pre-truncate dict bodies."""
|
|
from cli.v2_client import V2ClientError
|
|
|
|
body = {"detail": {
|
|
"kind": "bq_forbidden",
|
|
"billing_project": "x" * 200, # padding to push past old 200-char limit
|
|
"data_project": "y" * 200,
|
|
"hint": "MUST_REACH_THIS_HINT_IN_OUTPUT",
|
|
}}
|
|
err = V2ClientError(status_code=502, body=body)
|
|
out = str(err)
|
|
assert "MUST_REACH_THIS_HINT_IN_OUTPUT" in out, \
|
|
"renderer must not pre-truncate dict bodies past the hint field"
|
|
|
|
|
|
def test_remote_query_error_carries_details():
|
|
"""`RemoteQueryError` already has a `details` field. Verify the type's
|
|
surface so cli/commands/query.py:_query_hybrid can rely on it."""
|
|
from src.remote_query import RemoteQueryError
|
|
|
|
err = RemoteQueryError(
|
|
error_type="cross_project_forbidden",
|
|
message="USER_PROJECT_DENIED",
|
|
details={"billing_project": "", "data_project": "prj"},
|
|
)
|
|
assert err.details == {"billing_project": "", "data_project": "prj"}
|
|
assert err.error_type == "cross_project_forbidden"
|