The following signatures cover common CI and local integration failures.
Simulator startup failures
- Signature:
GitHubSimProcessError: Bun executable not found: ...Cause: Bun is not installed or not visible onPATH. Fix: install Bun and, if needed, set theBUNenvironment variable to the executable path. - Signature:
GitHubSimProcessError: Simulator exited before emitting listening eventCause: Simulacrum dependencies were not installed where simulacat resolvespackage.json. Fix: run Installing Simulacrum dependencies before starting tests.
Configuration serialization errors
- Signature:
TypeError: github_sim_config must be a mappingCause: fixture returned a non-mapping value (for example, a string). Fix: return a dict-like value orScenarioConfig. - Signature:
TypeError: Object of type PosixPath is not JSON serializableCause: non-JSON values were included ingithub_sim_config. Fix: convert values to JSON-compatible primitives before returning fixture data.
`github3.py` and simulator coverage mismatches
- Signature:
github3.exceptions.IncompleteResponseCause: selected endpoint response is missing fields expected bygithub3.py. Fix: use supported calls (for example,repository,repositories_by,issue,pull_request, andrate_limit) or use raw session requests. - Signature: HTTP
404/501from simulator-backed calls Cause: endpoint is not implemented by the simulator version in use. Fix: constrain tests to implemented endpoints or model behaviour at the configuration layer.