alembic-runner 0.1.0__tar.gz

alembic_runner-0.1.0/.gitignore

@@ -0,0 +1,16 @@
+__pycache__/
+*.py[cod]
+.venv/
+venv/
+build/
+dist/
+*.egg-info/
+.ruff_cache/
+.mypy_cache/
+.pytest_cache/
+.coverage
+.coverage.*
+coverage.xml
+htmlcov/
+site/
+.DS_Store

alembic_runner-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 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 2026 cyberwitchery labs
+
+   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.

alembic_runner-0.1.0/PKG-INFO

@@ -0,0 +1,35 @@
+Metadata-Version: 2.5
+Name: alembic-runner
+Version: 0.1.0
+Summary: run alembic plan, review and apply from a host application
+Project-URL: Homepage, https://github.com/cyberwitchery/alembic-sot-plugins
+Project-URL: Repository, https://github.com/cyberwitchery/alembic-sot-plugins
+Project-URL: alembic (core), https://github.com/cyberwitchery/alembic
+Author-email: cyberwitchery lab <contact@cyberwitchery.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: alembic,nautobot,netbox,network-automation
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: System Administrators
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: System :: Networking
+Requires-Python: >=3.10
+Provides-Extra: dev
+Requires-Dist: coverage[toml]; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# alembic-runner
+
+the host-independent core of the alembic netbox and nautobot plugins. it runs
+the `alembic` cli for a flow's plan, stale check, apply and drift report, parses
+what the cli writes, and owns the run state machine. no django in here.
+
+each run gets an environment built from scratch: the worker's own secrets never
+reach alembic, and credentials go through environment variables, never a file.
+
+it is installed as a dependency of
+[netbox-alembic](https://pypi.org/project/netbox-alembic/) and
+[nautobot-alembic](https://pypi.org/project/nautobot-alembic/); on its own it
+needs only python 3.10+ and the `alembic` binary.

alembic_runner-0.1.0/README.md

@@ -0,0 +1,13 @@
+# alembic-runner
+
+the host-independent core of the alembic netbox and nautobot plugins. it runs
+the `alembic` cli for a flow's plan, stale check, apply and drift report, parses
+what the cli writes, and owns the run state machine. no django in here.
+
+each run gets an environment built from scratch: the worker's own secrets never
+reach alembic, and credentials go through environment variables, never a file.
+
+it is installed as a dependency of
+[netbox-alembic](https://pypi.org/project/netbox-alembic/) and
+[nautobot-alembic](https://pypi.org/project/nautobot-alembic/); on its own it
+needs only python 3.10+ and the `alembic` binary.

alembic_runner-0.1.0/pyproject.toml

@@ -0,0 +1,47 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "alembic-runner"
+version = "0.1.0"
+description = "run alembic plan, review and apply from a host application"
+readme = "README.md"
+requires-python = ">=3.10"
+license = "Apache-2.0"
+authors = [{ name = "cyberwitchery lab", email = "contact@cyberwitchery.com" }]
+keywords = ["alembic", "netbox", "nautobot", "network-automation"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: System Administrators",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Topic :: System :: Networking",
+]
+dependencies = []
+
+[project.urls]
+Homepage = "https://github.com/cyberwitchery/alembic-sot-plugins"
+Repository = "https://github.com/cyberwitchery/alembic-sot-plugins"
+"alembic (core)" = "https://github.com/cyberwitchery/alembic"
+
+[project.optional-dependencies]
+dev = ["coverage[toml]", "ruff"]
+
+[tool.hatch.build.targets.wheel]
+exclude = ["tests"]
+packages = ["src/alembic_runner"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py310"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "B", "UP"]
+
+[tool.coverage.run]
+source = ["alembic_runner"]
+branch = true
+
+[tool.coverage.report]
+show_missing = true

alembic_runner-0.1.0/src/alembic_runner/__init__.py

@@ -0,0 +1,61 @@
+"""run alembic plan, review and apply from a host application."""
+
+from .backend import CONFIG_KEYS, KINDS, TOKEN_ENV, Backend, BackendError, StateStore, token_env
+from .plan import ApplyReport, DocumentError, DriftReport, Plan
+from .runner import (
+    SUPPORTED,
+    ApplyOutcome,
+    Completed,
+    DriftOutcome,
+    Flow,
+    InventoryOutcome,
+    PlanOutcome,
+    Runner,
+    RunnerError,
+    StaleCheck,
+)
+from .status import (
+    ACTIVE,
+    TERMINAL,
+    TRANSITIONS,
+    RunStatus,
+    TransitionError,
+    check_transition,
+    failure_status,
+)
+from .workspace import Workspace, WorkspaceError
+
+__version__ = "0.1.0"
+
+__all__ = [
+    "ACTIVE",
+    "CONFIG_KEYS",
+    "KINDS",
+    "SUPPORTED",
+    "TERMINAL",
+    "TOKEN_ENV",
+    "TRANSITIONS",
+    "ApplyOutcome",
+    "ApplyReport",
+    "Backend",
+    "BackendError",
+    "Completed",
+    "DocumentError",
+    "DriftOutcome",
+    "DriftReport",
+    "Flow",
+    "InventoryOutcome",
+    "Plan",
+    "PlanOutcome",
+    "RunStatus",
+    "Runner",
+    "RunnerError",
+    "StaleCheck",
+    "StateStore",
+    "TransitionError",
+    "Workspace",
+    "WorkspaceError",
+    "check_transition",
+    "failure_status",
+    "token_env",
+]

alembic_runner-0.1.0/src/alembic_runner/backend.py

@@ -0,0 +1,111 @@
+"""backends and state stores, as the environment and files a run hands to alembic."""
+
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+from typing import Any
+
+KINDS = ("netbox", "nautobot", "infrahub", "peeringdb", "external")
+
+# the config keys a stored backend may set. anything that names a command, a
+# working directory or an environment for a process stays in host settings:
+# whoever can edit a backend must not be able to run something on the worker.
+CONFIG_KEYS = {
+    "netbox": frozenset({"url", "instance"}),
+    "nautobot": frozenset({"url", "instance"}),
+    "infrahub": frozenset({"url", "instance"}),
+    "peeringdb": frozenset({"url", "instance"}),
+    "external": frozenset({"args", "setup", "timeout_seconds", "instance"}),
+}
+
+# the environment variable each built-in adapter reads its credential from.
+TOKEN_ENV = {
+    "netbox": "NETBOX_TOKEN",
+    "nautobot": "NAUTOBOT_TOKEN",
+    "infrahub": "INFRAHUB_TOKEN",
+    "peeringdb": "PEERINGDB_API_KEY",
+}
+
+
+class BackendError(ValueError):
+    pass
+
+
+@dataclass(frozen=True)
+class Backend:
+    """one backend as a run sees it.
+
+    `config` is the non-secret part of an alembic backend config, without the
+    `backend:` key. `env` holds the credentials, by variable name. an external
+    backend's `command` comes from host settings, never from stored config.
+    """
+
+    kind: str
+    config: dict[str, Any] = field(default_factory=dict)
+    env: dict[str, str] = field(default_factory=dict)
+    command: str | None = None
+
+    def __post_init__(self) -> None:
+        if self.kind not in KINDS:
+            raise BackendError(f"unknown backend kind {self.kind!r}")
+        unknown = self.config.keys() - CONFIG_KEYS[self.kind]
+        if unknown:
+            raise BackendError(
+                f"a {self.kind} backend config cannot set {', '.join(sorted(unknown))}; "
+                f"it takes {', '.join(sorted(CONFIG_KEYS[self.kind]))}"
+            )
+        if self.kind == "external":
+            if not self.command:
+                raise BackendError("an external backend needs a command from host settings")
+        elif self.command:
+            raise BackendError(f"a {self.kind} backend takes no command")
+
+    def config_document(self) -> dict[str, Any]:
+        doc = {"backend": self.kind, **self.config}
+        if self.command:
+            doc["command"] = self.command
+        return doc
+
+
+def token_env(kind: str, token: str) -> dict[str, str]:
+    """the environment that hands `token` to a built-in adapter of `kind`."""
+    try:
+        return {TOKEN_ENV[kind]: token}
+    except KeyError:
+        raise BackendError(f"a {kind} backend reads no token variable") from None
+
+
+@dataclass(frozen=True)
+class StateStore:
+    """where identity state lives. `local` keeps it in the flow directory."""
+
+    backend: str = "local"
+    postgres_url: str | None = None
+    postgres_tls: str | None = None
+
+    def __post_init__(self) -> None:
+        if self.backend not in ("local", "postgres"):
+            raise BackendError(f"unknown state backend {self.backend!r}")
+        if self.backend == "postgres" and not self.postgres_url:
+            raise BackendError("postgres state needs a postgres_url")
+
+    @classmethod
+    def from_settings(cls, settings: dict[str, Any] | None) -> StateStore:
+        settings = settings or {}
+        return cls(
+            backend=settings.get("backend", "local"),
+            postgres_url=settings.get("postgres_url"),
+            postgres_tls=settings.get("postgres_tls"),
+        )
+
+    def env(self, key: str) -> dict[str, str]:
+        if self.backend == "local":
+            return {"ALEMBIC_STATE_BACKEND": "local"}
+        env = {
+            "ALEMBIC_STATE_BACKEND": "postgres",
+            "ALEMBIC_STATE_POSTGRES_URL": self.postgres_url or "",
+            "ALEMBIC_STATE_KEY": key,
+        }
+        if self.postgres_tls:
+            env["ALEMBIC_STATE_POSTGRES_TLS"] = self.postgres_tls
+        return env

alembic_runner-0.1.0/src/alembic_runner/hosting.py

@@ -0,0 +1,197 @@
+"""run bookkeeping the host apps share: moves, locks, approval checks and the job
+wrapper. it needs django, so only the host apps import it; the rest of the core
+stays stdlib-only.
+
+a host's run model carries the fields both apps define: `flow`, `kind`,
+`status`, `requested_by`, `decided_by`, `decided_at`, `planned_at`,
+`apply_started_at`, `finished_at`, `plan`, `plan_sha256`, `approved_sha256`,
+`error`, `output`."""
+
+from __future__ import annotations
+
+from collections.abc import Callable, Iterable
+from datetime import timedelta
+from typing import Any
+
+from django.core.exceptions import PermissionDenied, ValidationError
+from django.db import IntegrityError, transaction
+from django.utils import timezone
+
+from .pipeline import Outcome, RunFailed, approved_plan
+from .plan import Plan
+from .status import RunStatus, TransitionError, check_transition, failure_status
+
+S = RunStatus
+
+# a new plan of a flow takes these runs' place.
+SUPERSEDABLE = (S.AWAITING_APPROVAL.value, S.APPLY_FAILED.value)
+
+
+class ActionError(ValidationError):
+    """a run cannot do what was asked of it in its current state."""
+
+
+def _save(run) -> None:
+    # nautobot validates on save through `validated_save`; netbox has only `save`.
+    getattr(run, "validated_save", run.save)()
+
+
+def move(run, new: RunStatus | str, **fields: Any):
+    """move a locked run to `new`, setting `fields`, or raise ActionError."""
+    try:
+        check_transition(run.status, new)
+    except TransitionError as e:
+        raise ActionError(str(e)) from e
+    run.status = RunStatus(new).value
+    for name, value in fields.items():
+        setattr(run, name, value)
+    _save(run)
+    return run
+
+
+def locked(run):
+    return type(run).objects.select_for_update().get(pk=run.pk)
+
+
+def expired(run, ttl_hours: int | None) -> bool:
+    return bool(
+        ttl_hours
+        and run.planned_at
+        and timezone.now() > run.planned_at + timedelta(hours=ttl_hours)
+    )
+
+
+def create_run(model, flow, user, kind: str, supersede: bool, retire: Callable = lambda run: None):
+    """create a pending run of `flow`. a plan (`supersede`) takes the place of the
+    flow's waiting runs, each passed to `retire` first. call inside a transaction."""
+    if supersede:
+        for run in model.objects.select_for_update().filter(flow=flow, status__in=SUPERSEDABLE):
+            retire(run)
+            move(run, S.SUPERSEDED, finished_at=timezone.now())
+    try:
+        with transaction.atomic():
+            return model.objects.create(flow=flow, kind=kind, requested_by=user)
+    except IntegrityError:
+        raise ActionError("This flow already has a run in progress.") from None
+
+
+def _approve_perm(run) -> str:
+    return f"{run._meta.app_label}.approve_run"
+
+
+def refusal(run, user, distinct: bool, ttl_hours: int | None = None) -> str | None:
+    """why `user` may not approve or reject `run`, or None if they may."""
+    if not user.has_perm(_approve_perm(run), run):
+        return "You may not approve or reject this run."
+    if distinct and run.requested_by_id == user.pk:
+        return "Someone other than the requester approves this run."
+    if expired(run, ttl_hours):
+        return "This plan is too old to approve. Plan again."
+    return None
+
+
+def check_approver(run, user, distinct: bool) -> None:
+    reason = refusal(run, user, distinct)
+    if reason:
+        raise PermissionDenied(reason)
+
+
+def approve(run, user, ttl_hours: int | None) -> bool:
+    """move a locked, waiting run to approved, or to expired when its plan is too
+    old. returns whether it was approved; the caller queues the apply."""
+    if expired(run, ttl_hours):
+        move(run, S.EXPIRED, finished_at=timezone.now())
+        return False
+    move(
+        run,
+        S.APPROVED,
+        decided_by=user,
+        decided_at=timezone.now(),
+        approved_sha256=run.plan_sha256,
+    )
+    return True
+
+
+def reject(run, user):
+    now = timezone.now()
+    return move(run, S.REJECTED, decided_by=user, decided_at=now, finished_at=now)
+
+
+def check_resumable(run, user) -> None:
+    if not user.has_perm(_approve_perm(run), run):
+        raise PermissionDenied("You may not resume this run.")
+    if run.status != S.APPLY_FAILED.value:
+        raise ActionError("Only a failed apply can be resumed.")
+
+
+# jobs
+
+
+def transition(run, new: RunStatus | str, **fields: Any) -> None:
+    with transaction.atomic():
+        move(locked(run), new, **fields)
+    run.refresh_from_db()
+
+
+def settle(run, outcome: Outcome, **fields: Any) -> None:
+    """store what a pipeline step decided on the run."""
+    if outcome.finished:
+        fields["finished_at"] = timezone.now()
+    transition(run, outcome.status, **outcome.fields, **fields)
+
+
+def fail(run, message: str, output: str = "") -> None:
+    """record a failure on the run, in the status its phase fails into."""
+    fields: dict[str, Any] = {"error": message}
+    if output:
+        fields["output"] = output
+    with transaction.atomic():
+        run = locked(run)
+        new = failure_status(run.status)
+        if new is S.FAILED:
+            fields["finished_at"] = timezone.now()
+        if new is not None:
+            move(run, new, **fields)
+
+
+def run_guarded(run, execute: Callable, logger, known: Iterable[type[Exception]] = ()) -> None:
+    """run a job's body. a failure it expects becomes the run's status; anything
+    else does too, and is raised again so the host marks its job as errored."""
+    try:
+        execute(run)
+    except RunFailed as e:
+        logger.error(str(e))
+        fail(run, str(e), e.output)
+    except ActionError as e:
+        # the run is not in a state this job can act on; leave it as it is.
+        logger.error(" ".join(e.messages))
+    except tuple(known) as e:
+        logger.error(str(e))
+        fail(run, str(e))
+    except Exception as e:
+        fail(run, f"{type(e).__name__}: {e}")
+        raise
+
+
+def start_apply(run) -> tuple[Plan, bool]:
+    """take the run into applying: one apply per target at a time, from an
+    approved run or a failed apply, and only with the plan that was approved.
+    returns the plan and whether this resumes a failed apply."""
+    model = type(run)
+    with transaction.atomic():
+        current = locked(run)
+        busy = (
+            model.objects.filter(flow__target=run.flow.target, status=S.APPLYING.value)
+            .exclude(pk=run.pk)
+            .select_for_update()
+        )
+        if busy.exists():
+            raise RunFailed(f"Another run is applying to {run.flow.target}; try again later.")
+        if current.status not in (S.APPROVED.value, S.APPLY_FAILED.value):
+            raise ActionError(f"a {current.status} run is not applied")
+        resuming = current.status == S.APPLY_FAILED.value
+        # checked before the move, so a plan that fails it never becomes resumable.
+        plan = approved_plan(current.plan, current.approved_sha256)
+        move(current, S.APPLYING, apply_started_at=current.apply_started_at or timezone.now())
+    run.refresh_from_db()
+    return plan, resuming