Live Smoke Testing Against Real UniFi Hardware
scripts/live_smoke.py is the manifest-driven live hardware test harness. It validates API
contracts that mock-based CI (unit tests, golden fixtures) structurally cannot catch — auth
token expiry, payload normalization, API version mismatches, and hardware-specific field
assumptions. Live smoke runs caught multiple critical bugs before merge. Run live smoke
before every major merge that touches API-facing code.
Prerequisites
Before any live run, ensure:
.envfile at project root (gitignored) with real credentials:UNIFI_HOST=<controller-hostname-or-ip> UNIFI_USERNAME=<admin-username> UNIFI_PASSWORD=<admin-password> UNIFI_SITE=<site-id> # usually "default" # For Access domain: UNIFI_ACCESS_API_KEY=<access-api-key>Per-server
tools_manifest.jsonis up-to-date — the harness auto-discovers tools from each server's manifest. During development, verify your local module's manifest is current:# Check where each server's manifest is located find . -name "tools_manifest.json" -type fNew tools registered in the manifest are automatically included in smoke runs; no manual harness edits are needed just to add read-only or preview coverage for a newly registered tool. If adding a new tool, verify the manifest entry exists and
safety_tier()classification is correct (see Procedure A).Target hardware is reachable — verify connectivity before running:
curl -k https://$UNIFI_HOSTBranch context — the harness lives in
scripts/live_smoke.pyon the main branch. When branching or bisecting, confirm you have the current harness code before running.Git worktree
.envplacement —scripts/live_smoke.pyderives its repo root from its own file location (Path(__file__).resolve().parents[1]) and loads.envfrom that root. In a git worktree the root resolves to the worktree directory, NOT the main checkout. Copy or symlink your credentials file from the main checkout into the worktree root before running:ln -s /path/to/main-checkout/.env /path/to/worktree/.envOmitting this causes silent credential-not-found failures with no warning.
Use
uv run, not system python3 — the repo's dependencies are managed by uv and are not installed in the system Python environment. Always invoke the harness via:uv run python scripts/live_smoke.py --server network --phase safeRunning with bare
python3will fail with import errors foraiounifi,dotenv, and other dependencies not available outside the uv-managed virtual environment.Invoke
uv runfrom the workspace root with--all-packagesin the monorepo. Runninguv run python scripts/live_smoke.pyfrom a package subdirectory (or without--all-packages) can fail withModuleNotFoundError: mcpbecause the workspace's shared dependency isn't resolved into that package's isolated env. Run from the repo root:uv run --all-packages python scripts/live_smoke.py --server network --phase safemcpcan also silently vanish from the root.venvaftermake pre-commit,uv lock, or bareuv sync— any of these run without--all-packagesand re-resolve the root env without the workspace-shared dependency. If a previously-working smoke run suddenly hitsModuleNotFoundError: mcp, re-runuv sync --all-packagesbefore assuming a code regression.
Procedure 0: PRE-MERGE BLOCKING GATE — API Response Parsing Changes
Trigger Criteria — Live Smoke is Mandatory Before Merge:
Code changes in any of these categories require a pre-merge live smoke run that must PASS before the PR can be merged:
- Manager response normalization logic — changes to how API response payloads are converted to domain models (e.g., field mapping, null handling, type coercion in manager classes)
- New API response fields — adding handling for fields that are new to the UniFi API or new to a particular controller firmware version
- Filtering or field selection logic — changes to which fields are extracted from responses, or conditional inclusion/exclusion of fields based on hardware or firmware state
- Payload shape transformation — restructuring nested payloads, flattening, or re-nesting fields for compatibility with domain models
- Version-dependent API contracts — changes that assume an API endpoint behaves differently across firmware versions
Why this is a blocking gate: Mock-based CI uses golden fixtures (static JSON files) that cannot evolve with real hardware firmware updates. Changes to response parsing are invisible to unit tests — they pass against the fixed fixture forever, but fail against real hardware running a different API version. The Access proxy incident exemplifies this: unit tests passed; live hardware returned auth-wrapped-in-200 errors invisible to mocks.
Ship doctrine — verify the changed code path, not an adjacent green path: Smoke evidence only counts if it exercises the specific code modified by the PR. If your PR touches the alarm manager, a passing run that exercises only the client manager is not evidence. Identify the tools that invoke the changed code and name them explicitly in the PR smoke evidence block.
Execution:
# For the affected domain(s) (e.g., network, protect, access):
uv run python scripts/live_smoke.py --server <domain> --phase readonly
uv run python scripts/live_smoke.py --server <domain> --phase safe
# Both must exit status 0 with no failed/exception records in artifacts
Sign-off: Include in the PR description:
**Live Smoke Evidence:**
- ✓ network readonly: 45 tools, 0 failures
- ✓ network safe: 12 lifecycle ops, 0 failures
- Artifacts: [link to live-smoke-results/{server}-{timestamp}.json]
The PR reviewer must confirm both phases passed and inspect the artifact for correct payloads before approving merge. This is equivalent to a code review checkpoint — it verifies API contract assumptions against reality before the code lands on main.
Procedure A: Understand Tool Classification Tiers
The harness classifies tools dynamically from manifest annotations and the RISKY_OPERATION_NAMES
set (line ~90 in scripts/live_smoke.py). safety_tier() on LiveSmokeRunner drives
phase inclusion.
Tier (safety_tier value) |
How it's determined | Run gate |
|---|---|---|
read_only |
readOnlyHint: true annotation in manifest |
Included in readonly and safe phases |
preview_or_safe_lifecycle |
Has confirm param; not in RISKY_OPERATION_NAMES |
Preview (confirm=False) in preview/safe; lifecycle pairs in lifecycle/safe |
requires_approval |
In RISKY_OPERATION_NAMES set OR destructiveHint: true |
Excluded from automated runs; listed in pending_approval; manual only |
defer_heavy_read |
In STREAM_OR_HEAVY_READS set (streaming/export tools) |
Skipped unless --include-heavy-reads passed |
mutating_requires_review |
Has writes but no confirm param and not explicitly risky |
Flagged for manual review |
Classification is driven by manifest annotations — not static tier lists. When in doubt,
set destructiveHint: true on the tool's ToolAnnotations. A tool missing readOnlyHint
that does only reads is silently treated as mutating; fix the annotation.
Procedure B: Run the Harness with --phase Control
The --phase flag bounds blast radius. The --server flag is required for all MCP-direct
phases. Always start at the safest phase and advance only after the prior phase passes cleanly.
# Safest run — readonly + preview + safe lifecycles (default phase is "safe")
uv run python scripts/live_smoke.py --server network --phase safe
# Read-only tools only (narrowest scope)
uv run python scripts/live_smoke.py --server network --phase readonly
# Preview phase — all mutating tools called with confirm=False
uv run python scripts/live_smoke.py --server protect --phase preview
# Approved operations — runs all safe lifecycles plus explicitly approved mutations
uv run python scripts/live_smoke.py --server network --phase approved
# Run all servers at once (requires full .env with Access and Protect creds)
uv run python scripts/live_smoke.py --server all --phase safe
# Inventory — prints safety_tier classification for every tool; no live calls
uv run python scripts/live_smoke.py --server network --phase inventory
Phase progression guidance:
- Start every new tool or hardware target with
--phase readonly. - Advance to
--phase safeonly afterreadonlypasses cleanly. - Advance to
--phase approvedonly aftersafepasses cleanly. - Never skip directly to
approvedon a first run against a new tool or new hardware. - Use
--phase inventoryto audit tier assignments without making any live calls. - Phase scope has expanded over the project lifecycle: earlier phases were intentionally narrow (deployment/auth only, no controller-touching); later phases added full Protect physical actions and Access lock/unlock patterns. Expect further expansion for each new REST endpoint domain.
Expected output: The harness streams per-tool status to stdout. A passing run exits with
a summary count. Any failed or exception status line requires investigation before merge.
Procedure C: Human-in-the-Loop Mutation Gate
Mutation tools require a two-stage human gate. The preview phase (included in safe)
handles Stage 1 automatically; Stage 2 requires human review before running --phase approved.
Stage 1 — Preview phase (harness does this automatically during safe/preview):
The harness calls all preview_or_safe_lifecycle tools with confirm=False. This returns
a preview payload without executing any write. Review the output in the terminal and in the
per-server artifact file in live-smoke-results/.
Stage 2 — Human approval, then approved phase:
# After reviewing Stage 1 preview output, if all looks correct:
uv run python scripts/live_smoke.py --server network --phase approved
The approved phase runs explicitly coded lifecycle methods (e.g.,
lifecycle_network_dns(), lifecycle_network_oon_policy()) that execute idempotent
create+delete pairs with confirm=True.
Rules:
- Never skip Stage 1 — even for tools you've run before, always review the preview against current hardware state. A lifecycle run against stale assumptions can leave orphaned resources on the controller.
- If the preview shows unexpected scope, wrong site, or wrong resource count, stop.
Investigate the tool's argument construction before proceeding to
approved. - Safe-lifecycle runs should leave zero net hardware changes. After an
approvedrun, verify the controller UI shows no orphaned test resources.
Disposable resource rule for destructive operations: When a lifecycle method exercises
destructive operations (archive, bulk-delete, format), always target a disposable resource
created specifically for that run (e.g., a DNS record named smoke-test-<timestamp>). Never
run destructive smoke against a production resource. If a dedicated test resource cannot be
guaranteed (e.g., hardware-bound resources like camera channels), add the tool to
RISKY_OPERATION_NAMES to exclude it from automated phases and require explicit human approval.
Pre-existing infrastructure guard (distinct from the disposable-resource rule above): the
safe phase can mutate settings on pre-existing, non-disposable infrastructure — e.g. a
gateway's broadcast_ping setting — in addition to resources the run itself created. The
disposable-resource rule only covers destructive ops on run-created resources; it does not
cover safe-phase writes to settings on hardware that already existed before the run. Safe-phase
lifecycle methods must reject writes to any resource ID not created by the run itself — verify
the target ID against the run's own created_resources list before mutating.
VLAN reserved-range bug: the disposable-network VLAN picker used for approved-phase lifecycle testing selected a controller-reserved VLAN (>=4010), causing the lifecycle create to fail against real hardware even though the harness logic was correct. Fix: bound the VLAN scan range strictly below 4000 when generating disposable test VLANs — controllers reserve the upper range internally and will reject or silently reassign IDs at/above 4010.
Procedure D: Interpret Artifacts in live-smoke-results/
Each run writes one JSON file per server, stamped with a timestamp:
live-smoke-results/{server}-{timestamp}.json
The file contains a SmokeReport serialized as JSON:
{
"server": "network",
"started_at": "2026-05-01T12:00:00+00:00",
"finished_at": "2026-05-01T12:03:45+00:00",
"connected": true,
"records": [
{
"tool": "unifi_list_clients",
"phase": "readonly",
"status": "ok",
"args": {},
"duration_ms": 342,
"success": true,
"error": null,
"summary": { ... }
}
],
"created_resources": [],
"cleaned_resources": [],
"pending_approval": []
}
Status values per record:
"ok"— tool completed;successistrue; inspectsummaryfor shape correctness."failed"— tool returnedsuccess: false; checkerrorfield."skipped"— tool excluded from current phase or args unavailable; not a failure."exception"— Python exception raised during invocation; checkerrorfor traceback.
API contract mismatches show up in summary content, not always as "failed". For
example, an Access proxy returning HTTP 200 with an auth-failure body: status is "ok"
but success is false or summary contains no usable data. Always inspect summary
content and pending_approval, not just the overall status counts.
live-smoke-results/*.json stores only per-tool summaries, not full response payloads —
a status: "ok" run proves nothing when a PR changes which fields get populated. The
artifact's summary field is a truncated/derived view, not the raw API response, so it
cannot confirm that a specific field was newly populated or correctly filtered. To verify
response-shape changes, run an in-process one-shot probe script that prints the raw payload,
and diff it against the same probe run on git checkout origin/main for a before/after
comparison — the smoke artifact alone is not sufficient evidence for field-level changes.
Confirmed API contract failure patterns (discovered through live testing; mocks did not catch any of these):
| Pattern | Symptom in artifact | Root cause |
|---|---|---|
| Access proxy auth masking | status: ok, empty/error summary |
Token expiry → proxy returns 404 wrapped in 200 |
| OON payload normalization | Create succeeds, object malformed | Manager-side shape translation required; API expects different field structure |
| Alarm archive preview semantics | Preview count ≠ actual archived count | Mismatch between filter used in preview vs. execution |
hardware_platform field assumption |
Field missing or wrong type on some models | Not all hardware versions expose this field |
| Network alerts/IPS API version incompatibility | 404 or schema error on known endpoint | Endpoint path changed between controller firmware versions |
Access CODE_UNAUTHORIZED ambiguity |
Same error code for expired token vs. wrong credentials | Cannot distinguish root cause without inspecting response body detail |
When you see a live smoke failure with no corresponding unit test failure, assume API
contract mismatch first. Inspect the full summary body before looking at tool logic.
Procedure E: Extend the Harness for New Tools
When a new tool is scaffolded and registered in the server's tools_manifest.json, extend
the harness as follows:
Run inventory to see current classification:
uv run python scripts/live_smoke.py --server network --phase inventory | grep unifi_new_thingConfirm
safety_tiermatches your intent. Classification is driven automatically by manifest annotations — check the tool'sToolAnnotationsin the tool module.If the tool should be
read_only: EnsurereadOnlyHint=Trueis set onToolAnnotationsin the tool function. The harness will auto-include it inreadonlyphase. No harness edits needed.If the tool has a
confirmparam (preview/lifecycle): The harness auto-includes it inpreviewphase withconfirm=False. For safe lifecycle testing (create+delete pair), add a new lifecycle method to theLiveSmokeRunnerclass inscripts/live_smoke.pyand call it fromrun_lifecycles()orrun_approved().Building preview args from live values: When constructing
confirm=Falsepreview args for a new capability tool, reuse the device-inventory cache already seeded by prior read-only list tools in the same run (device/client lists fetched earlier) to source live current values (device IDs, MACs) instead of hardcoding hardware identifiers. Hardcoded IDs go stale as soon as lab hardware changes; cached live values stay valid across runs.Lifecycle completeness checklist — required for every new lifecycle method:
- Follows create → update → get → delete order (NOT create → delete only)
- The update step asserts field preservation via a subsequent
getcall - Non-default fields are tested with explicit targeted values (not just defaults)
- The lifecycle method lands in the harness permanently, not a throwaway script
Throwaway vs. permanent: One-off validation scripts (for enum-hint PRs, new optional parameters, or targeted edge-case verification) belong under
scripts/and must be deleted after verification — they are NOT lifecycle methods and must NOT be committed to the harness permanently. Only full create→update→get→delete lifecycle flows should be added as permanent harness methods.The DNS lifecycle (
lifecycle_network_dns) is the canonical reference implementation: create a record, update one field, get it back to assert the update landed, then delete. WLAN and AP-group lifecycles were extended to follow the same pattern.If the tool is risky/destructive: Add it to
RISKY_OPERATION_NAMES(the set at line ~90 inscripts/live_smoke.py) or setdestructiveHint=TrueonToolAnnotations. This moves it topending_approvaland excludes it from automated phases.Run read-only phase first, inspect the artifact:
uv run python scripts/live_smoke.py --server network --phase readonly cat live-smoke-results/network-*.json | python -m json.tool | grep -A5 unifi_new_thingConfirm
status: "ok"andsuccess: trueand thatsummaryhas the expected shape.Advance to safe/approved phase after readonly passes cleanly.
Document the tier classification in the PR description — reviewers need to know the blast-radius classification to sign off on the smoke evidence.
Procedure F: Probe Script Workflow and Image-Level Docker Smoke
Live hardware smoke catches API contract mismatches but requires real hardware access. Two additional regression layers run without hardware and catch regressions in the CI pipeline.
Probe-script layer (scripts/probe_*.py utilities):
Smaller-scope smoke scripts run against development builds without requiring full live hardware setup. These probe scripts verify:
- Tool registration (manifest entries are syntactically valid)
- Schema validation (schemas load and validators register)
- Manager instantiation (DI/bootstrap sequence succeeds)
- Tool function signatures (decorators and parameters match manifest)
Run probe scripts in any PR that touches tool registration or schema changes:
python scripts/probe_tools.py --server network
python scripts/probe_schemas.py
Probe failures are non-fatal for local development but become CI gates to catch early regressions before a full hardware run.
Image-level Docker smoke (release gate requirement):
The release build pipeline runs image-level smoke tests on generated Docker images before they're pushed to GHCR. This tests:
- All three app servers start cleanly inside their respective images
- All tools are discoverable in each image's tools_manifest.json
- Basic connectivity to a mock controller (localhost loopback) succeeds
Image-level smoke does not execute tool logic (no live hardware), but it catches import errors, missing dependencies, manifest corruption, and startup failures that only appear in the final release image.
This layer lives in CI/CD pipeline (GitHub Actions), not in developer workflows. Local equivalents can be tested with:
docker build -t unifi-network:dev -f Dockerfile.network . && \
docker run --rm unifi-network:dev python -c "from unifi_network_mcp import *; print('OK')"
Four-layer regression model:
- Unit/fixture layer — mock data, schema validation, bootstrap (fast, pre-commit)
- Probe-script layer — tool registration, manifest, schema instantiation (minutes, pre-push)
- Live smoke layer — API contract verification on real hardware (manual gate, code review)
- Image-level layer — Docker build, startup, manifest integrity (release gate, CI pipeline)
Each layer adds cost but catches distinct classes of regressions. The first three run in developer workflows; the fourth is automated in the release pipeline.
Cross-Cutting Gotchas
UniFi Network 429 login-lockout — stop on first 429, do not retry through it. A 429 response from the Network controller's login endpoint means the account is rate-limited or locked out. Retrying immediately produces a cascade of misleading "Not-connected" failures across every subsequent tool call in the run, obscuring the real cause. On the first 429, stop the run immediately, wait for the lockout window to clear (do not hot-loop retries), and re-run once — do not interpret the cascading failures as tool bugs.
Write-verification standard — mutations report
WriteVerificationResultseparately frommutation_applied. Lifecycle/mutation tool results classify each written field aspersisted,dropped, orcoercedby comparing the request payload to a follow-upget.mutation_applied(did the API accept the write) is reported as a distinct field from field-level verification (did each value actually stick) — a write can havemutation_applied: truewhile individual fields showdroppedorcoerced. Guest networkpurposechanges are rejected pre-mutation (validated before the write is even attempted). The harness's disabled-VLAN-only lifecycle exercises this verification path; when adding new lifecycle methods for mutating tools, follow the same persisted/dropped/ coerced classification instead of only checkingmutation_applied.Mock + golden fixtures are insufficient by design. Live smoke is the only mechanism that catches auth token expiry, real payload shapes, hardware-specific fields, and API version skew. Treat live smoke as a required quality gate, not optional extra validation.
.envis gitignored — never commit credentials. If you seeUNIFI_HOSTorUNIFI_PASSWORDin a diff, abort the commit immediately and rotate the credentials.--serveris required for all MCP-direct phases. Omitting it causes a parse error.api-actions,api-resources, andapi-streamsphases use a different runner and do not require--server.api-actions and api-resources use curated subsets, not auto-discovery.
API_ACTIONS_SAMPLEinscripts/live_smoke.pyis a hardcoded list of 6 tools (network clients/devices, protect cameras/lights, access doors/users). New tools are NOT automatically included in--phase api-actionscoverage. To add a new tool to the api-actions phase, explicitly append it toAPI_ACTIONS_SAMPLE. Do not assume successful MCP-direct smoke implies api-actions coverage.--phase safeexercises default args only — it is a regression detector, not full coverage. The harness calls every tool with its default argument values. New optional parameters added to existing tools are not exercised by the safe phase. After a PR that adds optional parameters, run a targeted second pass: write a short script underscripts/that calls the tool with each new non-default value and asserts on the response shape. Delete after verification.HA/shadow mode transient failures are environment issues, not code bugs. If live smoke fails with "resource temporarily unavailable," "sync in progress," or similar, verify the HA cluster has stabilized before investigating the tool. Retry after 30–60 seconds. Do not block merge on HA transient failures — note them in the PR with a re-run confirmation.
Credential rotation invalidates prior artifacts. If credentials changed between runs, artifacts from prior runs cannot be used as PR evidence. Re-run from scratch.
api-resourcesparity check can show a falseMISMATCHfrom ID-key preference or the action endpoint's 100-row default._items_id_set()(inscripts/live_smoke.py) walks("id", "_id", "mac", "uuid")in order and uses the first key present on each item; if the resource-endpoint item and the matching action-endpoint item expose different first-matching keys, the comparison can pick non-corresponding values for what is actually the same item. Separately, mostparity_argsentries inAPI_RESOURCES_SAMPLEcall the action tool with default args, and several list tools default tolimit: 100— on a site with more than 100 items,resource_subset_of_actioncan gofalsepurely from action-side truncation, not a real API contract break. Before treatingparity_mismatches > 0as a bug, check the site's item count against 100 and confirm which id key populated on each side.Phase scope expands with each new domain. Each new tool category must be classified and added — do not assume prior phases cover new domains.
tools_manifest.jsonis the source of truth for auto-discovery. Manifest annotation correctness (readOnlyHint,destructiveHint) and harness registration (for lifecycle methods) are both required. Wrong annotations silently misclassify tools.AlarmRulesFacadefallback silently masks SuperAdmin credential failures. If the account lacks SuperAdmin on the Protect console,AlarmManagerPermissionErroris caught byAlarmRulesFacadeand it silently falls back to the legacy automations API. The smoke record showsstatus: ok— but the v2 code path was never exercised. Thecompleteflag in the MCP_metablock distinguishes v2 success (complete: true) from legacy fallback (complete: false). When smoke-testing alarm rules, inspect thesummary._metablock and confirmcomplete: true; a passing run withcomplete: falsemeans v2 was never reached.HTTP 404 from Access API-key endpoints confirms auth is working. When using API-key-authenticated Access endpoints, a 404 on a valid-format resource path means the key was accepted but the resource doesn't exist — this is a green credential signal. A 401/403 means the key was rejected. Use this to validate Access API key configuration: deliberately query a known-missing resource ID and expect 404, not 401.
HTTP 401 on the uiprotect bootstrap/WebSocket path during Protect smoke is expected and benign. The uiprotect library opens a WebSocket channel for real-time events using a cookie-based auth path that the MCP API key does not cover. A 401 on that WebSocket/bootstrap path does not indicate a problem with the REST API key — the REST path used by all MCP tool calls is healthy. When you see a 401 in Protect smoke output, check whether it's on the WebSocket bootstrap path before treating it as a real auth failure.
access_get_activity_summaryCODE_SYSTEM_ERROR -3 on the Access activities histogram endpoint is a pre-existing controller issue, not a code bug. This error reproduces consistently across branches and controller firmware versions on affected controllers. It is a known upstream Access controller issue unrelated to MCP code changes. When this error appears in smoke results, treat it as an environment/controller issue: note it in the PR, re-run on a different controller if available, and do not block merge solely on this error.macOS local-network privacy gate — Homebrew Python/uv gets
[Errno 65] No route to hoston RFC1918 addresses. macOS 15/26.x enforces a per-binary local-network entitlement. Homebrew Python, uv, and other ad-hoc-signed (non-Apple-signed) binaries are denied LAN access by the system firewall even when macOS Privacy & Security shows them as approved — the entitlement check is per binary and resets on Homebrew upgrades. Symptoms:[Errno 65] No route to hostfor any 192.168.x.x / 10.x.x.x connection whilepingsucceeds. Workaround: run the smoke harness inside Docker (docker run --rm ...) where the container inherits the LAN entitlement from Docker Desktop. Per-binary macOS approval is also possible but resets on the nextbrew upgrade.UNIFI_NETWORK_HOSTvsUNIFI_HOST—--server allMCP-direct runs useUNIFI_HOSTfor the Network controller. These are distinct variables operating at different layers. MCP-direct smoke (--server all) bootstraps the Network server usingUNIFI_HOST, notUNIFI_NETWORK_HOST. The API bootstrap path used by REST API phases usesUNIFI_NETWORK_HOSTwhen set. IfUNIFI_NETWORK_HOSTis correct butUNIFI_HOSTis wrong or absent,--server allMCP-direct runs connect to the wrong controller (or fail silently) while--phase api-actionsand--phase api-resourcescontinue working. Always verify both variables when debugging unexpected--server allconnection behavior.Enum-hint PRs require explicit non-default MCP tool calls —
--phase safealone is insufficient evidence. The default--phase saferun exercises every tool with its default argument values only. A PR that modifies enum hints or filter descriptions on tool arguments is never exercised by the harness defaults — the modified annotation paths are simply not invoked. Required evidence: make an explicit targeted call (e.g., via Docker Compose MCP or a short probe script) that passes the newly-documented enum value and confirms the correct filtered response.--phase safeoutput is necessary background but not sufficient smoke evidence for enum-hint changes.Nonzero harness exit from a pre-existing unrelated tool failure — document and proceed. A live smoke run may exit nonzero because a tool unrelated to the PR's changes fails (e.g., a known upstream controller issue or pre-existing API regression). This is NOT a merge blocker for the PR's code path. Required steps: (a) identify the failing tool and confirm it fails identically on
mainindependent of the PR; (b) confirm all tools in the PR's exercised code path showstatus: okin the artifact; (c) document the pre-existing failure with the tool name and error message in the PR description. Never treat every nonzero harness exit as a merge block — only failures in the PR's exercised code path are blocking.Mutation-widening PRs require safe-apply/revert smoke OR documented
confirm=falsepreview. When a PR widens a mutation tool's accepted parameters (e.g., adding updateable fields tounifi_update_traffic_route), unit tests alone are insufficient — mocks cannot catch API-side field rejection or payload normalization failures. Required: either (a) a live smoke run that applies the mutation withconfirm=Trueagainst a disposable resource, asserts the result, and reverts idempotently (net-zero), OR (b) documented deferral: run withconfirm=Falsepreview and embed the returned preview payload showing the would-be request shape in the PR evidence block. Omitting both for mutation-widening PRs is a merge blocker.Bootstrap.doorlocksmay be absent in newer uiprotect versions — access viagetattrfallback only. Thedoorlocksattribute was removed from the uiprotectBootstrapdataclass in a library upgrade. Direct attribute access (bootstrap.doorlocks) raisesAttributeErrorat runtime on affected versions with no deprecation warning. Fix: replace allbootstrap.doorlocksaccesses withgetattr(bootstrap, "doorlocks", []). Live smoke against a controller running an upgraded uiprotect surfaces this as anexceptionstatus in Protect smoke records; mock-based unit tests and golden fixtures cannot catch it.Singleton config resources use an apply → verify → revert lifecycle, not create → delete. Some device/config tools have no create or delete counterpart — they mutate one existing singleton resource. For these, model the lifecycle method as: read current state, apply the new value, verify via a follow-up
get, then revert to the original captured value. Do not force a create/delete pair onto singleton-shaped tools.access_update_device_confighas noconfirm/preview argument — it does not get the Stage 1 preview safety net. Because the harness's preview gate only applies to tools with aconfirmparam, this tool is not automatically protected by Procedure C. Treat it asmutating_requires_review: verify its classification manually and require explicit human review of arguments before any live call, since there is no preview payload to inspect first.Lab hardware strategy: production controllers are discovery/read-only only — mutation testing uses a dedicated Gateway Ultra. Never run
safe/approved-phase mutations against a production controller. Point mutation-phase runs at a dedicated lab Gateway Ultra (or equivalent disposable hardware) reserved for this purpose; reserve production hardware forreadonly/inventorydiscovery passes only.--server allis unsafe as evidence that an installed wheel (not repo source) is under test.--server allinvokesuv run --packageper app, which resolves the repo workspace and can silently substitute the published wheel with local source. To verify a published-package version is actually what's running, invoke--server network/--server protect/--server accessseparately using the isolated env's Python, and assert bothimportlib.metadata.version(...)and the module's__file__path resolve undersite-packages(not the repo checkout). Also runuv pip install --refreshfirst — a freshly published PyPI version can be absent from cached index metadata, so a stale cache silently keeps resolving the prior version.