proxmox-api-simulator

Stateful asynchronous Proxmox VE API simulator for testing API clients and infrastructure tooling without a real hypervisor cluster.

The project is in its foundation stage. Only liveness and PostgreSQL-backed readiness endpoints exist. No Proxmox endpoint is claimed as compatible yet; the official contract importer and stateful vertical slice are tracked in the implementation plan.

Development

Python 3.13 is required.

make install
make ci

Local services use plain HTTP at this stage:

cp .env.example .env
make docker-up
curl http://localhost:8006/health/live
curl http://localhost:8006/health/ready

Contract artifacts can be validated and imported into immutable local revisions:

.venv/bin/proxmox-api-contract validate tests/fixtures/api-viewer/pve-9.2.3-version.json
.venv/bin/proxmox-api-contract --store contracts import \
  --file tests/fixtures/api-viewer/pve-9.2.3-version.json --version 9.2.3
.venv/bin/proxmox-api-contract --store contracts list

Remote imports accept HTTPS URLs on the explicit official-domain allowlist and reject private address resolution, unsafe redirects, oversized responses, and unbounded retries. Imported revisions are addressed by their normalized snapshot checksum and are never overwritten.

Normalized snapshots can be compared in text, JSON, Markdown, or HTML. The diff command exits with status 1 when it finds a breaking change, making it suitable for CI policy checks:

.venv/bin/proxmox-api-contract diff old-snapshot.json new-snapshot.json \
  --format markdown

See the architecture for component boundaries and durability decisions. Commands for not-yet-implemented milestones intentionally return a non-zero status instead of pretending to succeed.