pytest-live-pause 0.1.0__tar.gz

pytest_live_pause-0.1.0/.github/workflows/python-publish.yml

@@ -0,0 +1,52 @@
+# This workflow will upload a Python Package to PyPI when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+
+on:
+  push:
+    tags: [ 'v*.*.*' ]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  release-build-and-publish-pypi:
+    runs-on: ubuntu-latest
+
+    environment:
+      name: pypi
+
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+
+      - name: "Set up Python"
+        uses: actions/setup-python@v6
+        with:
+          python-version-file: "pyproject.toml"
+
+      - name: Install the project
+        run: uv sync --all-groups
+
+      - name: Build release distributions
+        run: uv build
+
+      - name: Upload distributions
+        uses: actions/upload-artifact@v7
+        with:
+          name: release-dists
+          path: dist/
+
+      - name: Publish PyPI
+        env:
+          UV_PUBLISH_TOKEN: ${{ secrets.UV_PUBLISH_TOKEN }}
+        run: uv publish

pytest_live_pause-0.1.0/.gitignore

@@ -0,0 +1,218 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer,
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

pytest_live_pause-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Lanbao
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pytest_live_pause-0.1.0/PKG-INFO

@@ -0,0 +1,204 @@
+Metadata-Version: 2.4
+Name: pytest-live-pause
+Version: 0.1.0
+Summary: Pytest plugin and protocol for pausing live test execution and resuming in-process
+License-File: LICENSE
+Requires-Python: >=3.10
+Requires-Dist: pytest>=9.0.3
+Description-Content-Type: text/markdown
+
+## pytest-live-pause
+
+`pytest-live-pause` is intended to be a standalone pytest plugin and runtime protocol for pausing a live test process, inspecting state before teardown, and resuming the same process through a structured control channel.
+
+The repository is currently in bootstrap stage. The design target is:
+
+- a transport-neutral pause runtime
+- a thin pytest plugin adapter
+- structured stdout and JSONL events
+- packaged CLI commands for monitoring and resuming paused runs
+- a compatibility layer for existing QAMule-style workflows
+
+The current design scope lives in `CURRENT_SCOPE.md`.
+
+## Current Status
+
+The first working slice is `--pause-on-failure` using a file-backed control channel.
+
+Checkpoint pauses are also supported through `pytest_live_pause.checkpoint(...)`.
+
+The plugin also auto-registers `live_pause` and `pause_run_id` fixtures for direct injection into test function arguments.
+
+When a test fails in the `call` phase and `--pause-on-failure` is enabled, the plugin:
+
+- writes a pause request JSON file
+- waits for an external resume command file or timeout
+- resumes the same pytest process before teardown starts
+- appends any externally supplied failure reason to the pytest report
+
+Tests can also pause explicitly:
+
+```python
+from pytest_live_pause import checkpoint
+
+
+def test_example():
+	decision = checkpoint(task="Approve the external step", timeout=300)
+	if decision.result is False:
+		raise AssertionError(decision.reason or "checkpoint failed")
+```
+
+	Or through the auto-registered fixture:
+
+	```python
+	def test_example(live_pause, pause_run_id):
+		assert live_pause.run_id == pause_run_id
+		decision = live_pause.checkpoint(task="Approve the external step", timeout=300)
+		assert decision.result is True
+	```
+
+Checkpoint resumes use `--result` and `--reason`:
+
+```bash
+pytest-live-pause resume <pause_id> --result true --reason "approved"
+```
+
+Checkpoint behavior can also be mocked during pytest startup:
+
+```bash
+pytest --pause-checkpoint-mock false
+```
+
+## Usage
+
+Run pytest with pause-on-failure enabled:
+
+```bash
+pytest --pause-on-failure --pause-timeout 300
+```
+
+By default, pause state is written under `/tmp/pytest-live-pause`.
+
+You can still override it explicitly:
+
+```bash
+pytest --pause-on-failure --pause-dir /some/other/path --pause-timeout 300
+```
+
+When a test fails, a pause file appears under the run directory:
+
+```text
+
+/tmp/pytest-live-pause/
+	runs/<run_id>/
+		events.jsonl
+		run.json
+		pauses/<pause_id>.json
+		commands/
+```
+
+Resume the paused failure by pointing the CLI at the pause file:
+
+```bash
+pytest-live-pause resume \
+	/tmp/pytest-live-pause/runs/<run_id>/pauses/<pause_id>.json \
+	--failure-reason "manually confirmed"
+```
+
+You can also resume directly by `pause_id`, which is more convenient when multiple pytest processes share the same pause directory:
+
+```bash
+pytest-live-pause resume <pause_id> --failure-reason "manually confirmed"
+```
+
+If you are using a non-default pause directory, pass it explicitly:
+
+```bash
+pytest-live-pause resume <pause_id> --pause-dir /some/other/path --failure-reason "manually confirmed"
+```
+
+For failure pauses, `--failure-reason` appends an extra explanation to the pytest failure report. Non-failure pauses must not receive `--failure-reason`; the CLI will reject that combination.
+
+For checkpoint pauses, use `--result true|false|none` and optional `--reason`.
+
+For mocked checkpoint pauses, `reason` is fixed to `Mock`.
+
+The CLI writes the matching command file into `commands/`. The pytest process polls for that command and then continues into teardown.
+
+When multiple pytest processes share the same pause directory, each process gets its own `runs/<run_id>/` directory. `run.json` and each pause file also record `pid`, `hostname`, `cwd`, and optional `worker_id` metadata.
+
+You can inspect currently pending pauses across all runs with:
+
+```bash
+pytest-live-pause ls
+```
+
+You can also watch for newly paused tests in real time:
+
+```bash
+pytest-live-pause watch --run-id <run_id>
+```
+
+`watch` requires a specific pytest `run_id`:
+
+```bash
+pytest-live-pause watch --run-id <run_id>
+```
+
+For bounded monitoring, pass a timeout:
+
+```bash
+pytest-live-pause watch --run-id <run_id> --timeout 30
+```
+
+`watch` waits until the latest matching pending pause appears, prints the pause details, and then exits.
+
+By default, `ls` only shows currently resumable `pending` pauses. To include `stale`, `resumed`, and `timed_out` entries, use:
+
+```bash
+pytest-live-pause ls -a
+```
+
+If a pytest process is killed while paused, its pause file remains on disk. The CLI treats that as `stale` when the recorded `pid` is no longer alive on the current host. `ls -a` will show the stale state, and `resume` will refuse to write a command for it.
+
+If no command arrives before `--pause-timeout`, the test resumes automatically without adding an external failure reason.
+
+When pytest starts, it prints the current `run_id`, so you can monitor that specific pytest process with `pytest-live-pause watch --run-id <run_id>`.
+
+## File Protocol
+
+`pauses/<pause_id>.json` currently contains:
+
+```json
+{
+	"pause_id": "...",
+	"run_id": "...",
+	"nodeid": "tests/test_sample.py::test_failure",
+	"timeout": 300.0,
+	"original_failure": "AssertionError: boom",
+	"status": "pending",
+	"created_at": 1710000000.0,
+	"pid": 12345,
+	"hostname": "host.local",
+	"cwd": "/repo"
+}
+```
+
+`commands/<pause_id>.resume.json` currently contains:
+
+```json
+{
+	"failure_reason": "manually confirmed"
+}
+```
+
+Or for a checkpoint pause:
+
+```json
+{
+	"result": true,
+	"reason": "approved"
+}
+```
+
+This file transport is only the first implementation. The runtime can be split from the transport later if you want to add sockets or HTTP.

pytest_live_pause-0.1.0/README.md

@@ -0,0 +1,195 @@
+## pytest-live-pause
+
+`pytest-live-pause` is intended to be a standalone pytest plugin and runtime protocol for pausing a live test process, inspecting state before teardown, and resuming the same process through a structured control channel.
+
+The repository is currently in bootstrap stage. The design target is:
+
+- a transport-neutral pause runtime
+- a thin pytest plugin adapter
+- structured stdout and JSONL events
+- packaged CLI commands for monitoring and resuming paused runs
+- a compatibility layer for existing QAMule-style workflows
+
+The current design scope lives in `CURRENT_SCOPE.md`.
+
+## Current Status
+
+The first working slice is `--pause-on-failure` using a file-backed control channel.
+
+Checkpoint pauses are also supported through `pytest_live_pause.checkpoint(...)`.
+
+The plugin also auto-registers `live_pause` and `pause_run_id` fixtures for direct injection into test function arguments.
+
+When a test fails in the `call` phase and `--pause-on-failure` is enabled, the plugin:
+
+- writes a pause request JSON file
+- waits for an external resume command file or timeout
+- resumes the same pytest process before teardown starts
+- appends any externally supplied failure reason to the pytest report
+
+Tests can also pause explicitly:
+
+```python
+from pytest_live_pause import checkpoint
+
+
+def test_example():
+	decision = checkpoint(task="Approve the external step", timeout=300)
+	if decision.result is False:
+		raise AssertionError(decision.reason or "checkpoint failed")
+```
+
+	Or through the auto-registered fixture:
+
+	```python
+	def test_example(live_pause, pause_run_id):
+		assert live_pause.run_id == pause_run_id
+		decision = live_pause.checkpoint(task="Approve the external step", timeout=300)
+		assert decision.result is True
+	```
+
+Checkpoint resumes use `--result` and `--reason`:
+
+```bash
+pytest-live-pause resume <pause_id> --result true --reason "approved"
+```
+
+Checkpoint behavior can also be mocked during pytest startup:
+
+```bash
+pytest --pause-checkpoint-mock false
+```
+
+## Usage
+
+Run pytest with pause-on-failure enabled:
+
+```bash
+pytest --pause-on-failure --pause-timeout 300
+```
+
+By default, pause state is written under `/tmp/pytest-live-pause`.
+
+You can still override it explicitly:
+
+```bash
+pytest --pause-on-failure --pause-dir /some/other/path --pause-timeout 300
+```
+
+When a test fails, a pause file appears under the run directory:
+
+```text
+
+/tmp/pytest-live-pause/
+	runs/<run_id>/
+		events.jsonl
+		run.json
+		pauses/<pause_id>.json
+		commands/
+```
+
+Resume the paused failure by pointing the CLI at the pause file:
+
+```bash
+pytest-live-pause resume \
+	/tmp/pytest-live-pause/runs/<run_id>/pauses/<pause_id>.json \
+	--failure-reason "manually confirmed"
+```
+
+You can also resume directly by `pause_id`, which is more convenient when multiple pytest processes share the same pause directory:
+
+```bash
+pytest-live-pause resume <pause_id> --failure-reason "manually confirmed"
+```
+
+If you are using a non-default pause directory, pass it explicitly:
+
+```bash
+pytest-live-pause resume <pause_id> --pause-dir /some/other/path --failure-reason "manually confirmed"
+```
+
+For failure pauses, `--failure-reason` appends an extra explanation to the pytest failure report. Non-failure pauses must not receive `--failure-reason`; the CLI will reject that combination.
+
+For checkpoint pauses, use `--result true|false|none` and optional `--reason`.
+
+For mocked checkpoint pauses, `reason` is fixed to `Mock`.
+
+The CLI writes the matching command file into `commands/`. The pytest process polls for that command and then continues into teardown.
+
+When multiple pytest processes share the same pause directory, each process gets its own `runs/<run_id>/` directory. `run.json` and each pause file also record `pid`, `hostname`, `cwd`, and optional `worker_id` metadata.
+
+You can inspect currently pending pauses across all runs with:
+
+```bash
+pytest-live-pause ls
+```
+
+You can also watch for newly paused tests in real time:
+
+```bash
+pytest-live-pause watch --run-id <run_id>
+```
+
+`watch` requires a specific pytest `run_id`:
+
+```bash
+pytest-live-pause watch --run-id <run_id>
+```
+
+For bounded monitoring, pass a timeout:
+
+```bash
+pytest-live-pause watch --run-id <run_id> --timeout 30
+```
+
+`watch` waits until the latest matching pending pause appears, prints the pause details, and then exits.
+
+By default, `ls` only shows currently resumable `pending` pauses. To include `stale`, `resumed`, and `timed_out` entries, use:
+
+```bash
+pytest-live-pause ls -a
+```
+
+If a pytest process is killed while paused, its pause file remains on disk. The CLI treats that as `stale` when the recorded `pid` is no longer alive on the current host. `ls -a` will show the stale state, and `resume` will refuse to write a command for it.
+
+If no command arrives before `--pause-timeout`, the test resumes automatically without adding an external failure reason.
+
+When pytest starts, it prints the current `run_id`, so you can monitor that specific pytest process with `pytest-live-pause watch --run-id <run_id>`.
+
+## File Protocol
+
+`pauses/<pause_id>.json` currently contains:
+
+```json
+{
+	"pause_id": "...",
+	"run_id": "...",
+	"nodeid": "tests/test_sample.py::test_failure",
+	"timeout": 300.0,
+	"original_failure": "AssertionError: boom",
+	"status": "pending",
+	"created_at": 1710000000.0,
+	"pid": 12345,
+	"hostname": "host.local",
+	"cwd": "/repo"
+}
+```
+
+`commands/<pause_id>.resume.json` currently contains:
+
+```json
+{
+	"failure_reason": "manually confirmed"
+}
+```
+
+Or for a checkpoint pause:
+
+```json
+{
+	"result": true,
+	"reason": "approved"
+}
+```
+
+This file transport is only the first implementation. The runtime can be split from the transport later if you want to add sockets or HTTP.

pytest_live_pause-0.1.0/pyproject.toml

@@ -0,0 +1,22 @@
+[build-system]
+requires = ["hatchling>=1.27"]
+build-backend = "hatchling.build"
+
+[project]
+name = "pytest-live-pause"
+version = "0.1.0"
+description = "Pytest plugin and protocol for pausing live test execution and resuming in-process"
+readme = "README.md"
+requires-python = ">=3.10"
+dependencies = [
+    "pytest>=9.0.3",
+]
+
+[project.scripts]
+pytest-live-pause = "pytest_live_pause.cli:main"
+
+[project.entry-points.pytest11]
+pytest_live_pause = "pytest_live_pause.plugin"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/pytest_live_pause"]