simloom 0.1.0__tar.gz

simloom-0.1.0/.gitignore

@@ -0,0 +1,22 @@
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+dist/
+build/
+
+# Tooling
+.venv/
+.mypy_cache/
+.ruff_cache/
+.pytest_cache/
+.hypothesis/
+
+# simloom artifacts
+.sim/
+
+# internal documents, never tracked
+BRIEF.md
+
+# OS
+.DS_Store

simloom-0.1.0/CHANGELOG.md

@@ -0,0 +1,57 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2026-06-13
+
+First public release. The deterministic core, simulated world, fault matrix,
+explorer, shrinker, and pytest plugin are all present and exercised by a
+10,000-seed determinism torture in CI.
+
+### Added
+- Project scaffold: `src/` layout, strict mypy, ruff, pytest + hypothesis, CI.
+- Phase 0 feasibility spikes under `spikes/`.
+- **Phase A core**: the choice tape (`Tape`, labeled bounded draws, strict/fallback
+  replay, versioned JSON serialization), the deterministic event loop (`SimLoop`)
+  with virtual time, loop-owned task naming, escape detection
+  (`EscapedSimulationError`), deadlock reporting (`SimDeadlockError`), controlled
+  GC, and deterministic teardown; `run()`/`replay()` entry points returning
+  `RunResult` with a sha256 universe digest; event log format v1
+  (`docs/event-log.md`); honesty doc (`docs/determinism.md`); 10,000-seed
+  determinism-torture CI job.
+- **Phase B world**: simulated network behind the loop primitives (in-memory
+  transports with FIFO stream guarantees, `SimServer`, strict `SimDNS`, tape-driven
+  latency and loss-as-retransmission-delay), `World`/`Host` with power-cut crash
+  semantics and entry-factory restart, `SimDisk` with honest fsync. Gate: unmodified
+  aiohttp + httpx exchanging requests over the lossy simulated network, replayable
+  byte-for-byte (`tests/test_world_http.py`).
+- **Phase C faults + buggify**: partition/heal (hold-and-release, streams never
+  corrupt), asymmetric block, connection-reset injection, partition-aware connects,
+  torn/lost/flushed unsynced writes on crash; `simloom.sometimes`/`draw`/`reached`
+  with `RunResult.coverage`. Gate: the toy Raft torture suite
+  (`tests/test_raft_demo.py`) catches a planted double-vote bug via exploration and
+  replays it exactly; the correct implementation survives.
+- **Phase D explorer + shrinker**: `simloom.explore` (random walk or PCT scheduling,
+  serial or multiprocess, failure corpus + coverage union), `simloom.shrink`
+  (deviations-first greedy minimization with re-recorded candidates and zero-refill
+  fallback; human-readable `describe()`), `PCT`/`RandomWalk` strategies with
+  replay-matched recording. Gate: the benchmark bug zoo measures find rates — PCT
+  finds the starvation-class bug a random walk never does (0 vs 151 of 400 seeds),
+  and random dominates shallow races; both results asserted in CI.
+- **Phase E pytest plugin**: `@simloom.test(runs=N)` turns an async test into a
+  seed-exploring simulation test — failures are shrunk, written to `.sim/failures/`
+  as replayable artifacts, and reported with seed + re-run command + minimal
+  schedule. Options: `--simloom-seed`, `--simloom-runs`, `--simloom-tape`,
+  `--simloom-no-shrink`; `require_coverage` for per-test sometimes-assertions.
+- **Examples + demo #4**: `examples/toy_raft.py` (runnable) and
+  `examples/bpo42130.py` — the historical `asyncio.wait_for` cancellation-swallowing
+  race (bpo-42130) reproduced deterministically from a seed; the modern stdlib
+  survives the identical torture. Launch-post draft in `docs/launch-post.md`.
+
+[Unreleased]: https://github.com/mandipadk/simloom/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/mandipadk/simloom/releases/tag/v0.1.0

simloom-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

simloom-0.1.0/PKG-INFO

@@ -0,0 +1,220 @@
+Metadata-Version: 2.4
+Name: simloom
+Version: 0.1.0
+Summary: Deterministic simulation testing for asyncio: seeded schedules, fault injection, perfect replay.
+Project-URL: Homepage, https://github.com/mandipadk/simloom
+Project-URL: Repository, https://github.com/mandipadk/simloom
+Project-URL: Documentation, https://github.com/mandipadk/simloom/tree/main/docs
+Project-URL: Changelog, https://github.com/mandipadk/simloom/blob/main/CHANGELOG.md
+Project-URL: Issues, https://github.com/mandipadk/simloom/issues
+Author: Mandip Adhikari
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: asyncio,concurrency,deterministic,fault-injection,simulation,testing
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Framework :: AsyncIO
+Classifier: Framework :: Pytest
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Testing
+Classifier: Topic :: Software Development :: Testing :: Mocking
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Provides-Extra: dev
+Requires-Dist: hypothesis>=6.115; extra == 'dev'
+Requires-Dist: mypy>=1.14; extra == 'dev'
+Requires-Dist: pytest>=8.3; extra == 'dev'
+Requires-Dist: ruff>=0.9; extra == 'dev'
+Provides-Extra: spikes
+Requires-Dist: aiohttp>=3.11; extra == 'spikes'
+Requires-Dist: httpx>=0.28; extra == 'spikes'
+Description-Content-Type: text/markdown
+
+<h1 align="center">simloom</h1>
+
+<p align="center">
+  <strong>Deterministic simulation testing for Python's asyncio.</strong><br>
+  Find the race before it ships. Replay it forever from a seed.
+</p>
+
+<p align="center">
+  <a href="https://pypi.org/project/simloom/"><img src="https://img.shields.io/pypi/v/simloom.svg" alt="PyPI"></a>
+  <a href="https://pypi.org/project/simloom/"><img src="https://img.shields.io/pypi/pyversions/simloom.svg" alt="Python versions"></a>
+  <a href="https://github.com/mandipadk/simloom/actions/workflows/ci.yml"><img src="https://github.com/mandipadk/simloom/actions/workflows/ci.yml/badge.svg" alt="CI"></a>
+  <a href="LICENSE"><img src="https://img.shields.io/badge/license-Apache%202.0-blue.svg" alt="License: Apache 2.0"></a>
+  <img src="https://img.shields.io/badge/types-strict-blue.svg" alt="Typed: strict">
+</p>
+
+---
+
+Your async code is tested one interleaving at a time — the polite one your laptop
+happened to schedule. Races ship. Flakes get retried. "Works on my machine" is the
+state of the art.
+
+**simloom runs your unmodified asyncio program inside a fully simulated world** — a
+seeded scheduler that owns every interleaving, a virtual clock, an in-memory network
+with injectable latency, loss, partitions, and crashes — and explores thousands of
+hostile schedules looking for the one that breaks your invariants. When it finds one,
+it hands you a **seed** that replays the failure byte-for-byte, forever, and **shrinks**
+it to the minimal schedule that still triggers the bug.
+
+```text
+FAILED test_lease_exclusivity — simloom found a failing universe
+  seed: 17   (re-run: pytest -k lease --simloom-seed=17)
+  error: AssertionError: two holders of an exclusive lease
+  shrunk: 31 draws → 29, schedule deviations 25 → 1 (106 candidate runs)
+  minimal schedule: FIFO everywhere except:
+    draw #0: sched.pick = 1 (of 4)
+  artifacts: .sim/failures/test_lease_exclusivity-seed17.tape.json, …
+```
+
+The entire bug, above, is *"one callback ran out of order, once."* No more staring at a
+flake that reproduces every thousandth CI run.
+
+## Install
+
+```sh
+pip install simloom        # or: uv add simloom
+```
+
+Python 3.12+. Zero runtime dependencies. The pytest plugin loads automatically.
+
+## Quickstart
+
+Write an ordinary async test, decorate it, and let simloom explore the schedule space:
+
+```python
+import asyncio
+import simloom
+
+@simloom.test(runs=2000)          # explores 2000 schedules; pytest collects this
+async def test_counter_is_atomic():
+    state = {"value": 0}
+
+    async def worker():
+        for _ in range(3):
+            current = state["value"]
+            await asyncio.sleep(0)          # a scheduling point — the race lives here
+            state["value"] = current + 1
+
+    await asyncio.gather(*(worker() for _ in range(3)))
+    assert state["value"] == 9             # a plain assert: it fires under exploration
+```
+
+```sh
+pytest                                  # finds the lost-update race, shrinks it, prints the seed
+pytest --simloom-seed=42                # replay one exact universe
+```
+
+Need a distributed system? Ask for a `world` and you get hosts, a network, and faults:
+
+```python
+@simloom.test(runs=5000)
+async def test_leader_election(world):
+    nodes = [world.host(f"n{i}") for i in range(5)]
+    for h in nodes:
+        h.spawn(lambda h=h: run_node(h, peers=nodes))   # your real, unmodified asyncio code
+
+    world.net.partition(nodes[:2], nodes[2:])           # faults are first-class
+    await world.sleep(30)                               # virtual seconds — wall time ≈ 0
+    world.net.heal()
+    nodes[0].crash()                                    # a real power cut: no finally blocks
+    nodes[0].restart()                                  # comes back against fsynced disk only
+
+    await world.until(lambda: exactly_one_leader(nodes), timeout=120)
+```
+
+## Why this didn't exist before
+
+Rust has [`loom`](https://github.com/tokio-rs/loom),
+[`turmoil`](https://github.com/tokio-rs/turmoil),
+[`madsim`](https://github.com/madsim-rs/madsim), and
+[`shuttle`](https://github.com/awslabs/shuttle). .NET had
+[Coyote](https://github.com/microsoft/coyote). FoundationDB built a company-defining
+simulator; [Antithesis](https://antithesis.com) sells the methodology at the hypervisor
+level. Python — where a huge share of backend glue and agent orchestration is written —
+had **nothing**.
+
+And asyncio is *structurally perfect* for it: every interleaving decision happens at an
+`await`, under a **replaceable event loop**. simloom swaps in a deterministic one — no
+forked interpreter, no hypervisor, no recompilation. Because the ecosystem (aiohttp,
+httpx, the streams API) bottoms out in loop primitives, **real, unmodified libraries run
+inside the simulation**. Our CI runs a genuine aiohttp server against a genuine httpx
+client over the simulated network, with 20% packet loss injected, replayable from a seed.
+
+## What you get
+
+- **🎲 Seeded, exhaustive-ish scheduling** — a single *choice tape* (the Hypothesis
+  trick, applied to schedules) drives every decision. One seed → one exact universe.
+- **⏱ Virtual time** — an hour of simulated `asyncio.sleep` traffic runs in
+  milliseconds. Timeouts and retries are tested at full speed.
+- **🌐 A simulated network** — in-memory transports with tape-driven latency, loss
+  (modeled as TCP retransmit delay — streams never corrupt), partitions, asymmetric
+  blocks, and connection resets.
+- **💥 Honest crashes** — `host.crash()` is a power cut: tasks stop with no `finally`
+  blocks, unsynced disk writes are lost or *torn*, peers see resets. `restart()` brings
+  the host back against its surviving fsynced state.
+- **🔬 Fault injection in your code** — `simloom.sometimes("drop_cache")` is tape-driven
+  inside the sim and a constant `False` in production. Annotate rare branches; explore
+  them.
+- **🪓 Automatic shrinking** — failures reduce to the minimal schedule deviation, with a
+  human-readable explanation and a replayable artifact on disk.
+- **🧭 Pluggable search** — a uniform random walk *and* PCT
+  ([Probabilistic Concurrency Testing](https://www.microsoft.com/en-us/research/publication/a-randomized-scheduler-with-probabilistic-guarantees-of-finding-bugs/)),
+  which finds deep ordering and starvation bugs a random walk essentially never hits.
+- **🚨 Escape detection** — touch a real socket, signal, subprocess, or the wall clock
+  from inside the sim and you get an `EscapedSimulationError` at the exact call site
+  instead of silent nondeterminism.
+
+## It finds real bugs
+
+**A multi-year CPython race.** Pre-3.12 `asyncio.wait_for` could *swallow a delivered
+cancellation* when the inner future completed in the same window as the cancel
+([bpo-42130](https://github.com/python/cpython/issues/86296)). In production it took an
+exact wall-clock collision; under simloom the timeout boundary is just another
+scheduling choice, so exploration finds the interleaving **from a seed** and replays it
+exactly. The modern implementation survives the identical torture. → `examples/bpo42130.py`
+
+**The canonical demo.** A toy Raft over the simulated network — persisted term/votedFor,
+JSON-RPC, the works — tortured with partitions, crashes, and restarts. Plant the classic
+double-vote bug and exploration elects two leaders in one term in ~1 seed of 5; the fixed
+version survives, with coverage counters proving the faults actually fired.
+→ `examples/toy_raft.py`
+
+## Honesty first
+
+A determinism claim is only as good as its disclosed limits. simloom raises a loud error
+when your code reaches outside the simulation, and [`docs/determinism.md`](docs/determinism.md)
+states **exactly** what is and isn't deterministic. Known boundaries: blocking
+C-extension I/O (`psycopg2`, `requests`, grpc's C core) can't run in-sim; direct
+`time.time()` reads bypass the virtual clock; real subprocesses and external servers
+need Python stand-ins. None of these fail silently.
+
+## Status
+
+**Pre-alpha, and built in the open.** The deterministic core, simulated world, fault
+matrix, explorer, shrinker, and pytest plugin all exist and are exercised by a
+10,000-seed determinism torture on every CI run (the harness holds itself to the same
+hostility it applies to your code). The API may still shift before 1.0. If you try it,
+[open an issue](https://github.com/mandipadk/simloom/issues) — early feedback shapes it.
+
+## Learn more
+
+- [`docs/determinism.md`](docs/determinism.md) — the honest boundary of the simulation
+- [`docs/event-log.md`](docs/event-log.md) — the versioned event-log and tape formats
+- [`examples/`](examples/) — the toy Raft and the bpo-42130 reproduction, both runnable
+- [`docs/plan.md`](docs/plan.md) — the architecture and the road to 1.0
+
+## Development
+
+```sh
+uv run --all-extras pytest          # tests (incl. the determinism torture)
+uv run --all-extras mypy src        # strict typing
+uv run --all-extras ruff check .    # lint
+```
+
+## License
+
+Apache-2.0. See [LICENSE](LICENSE).