snapdelta 0.1.0__tar.gz

snapdelta-0.1.0/.gitignore

@@ -0,0 +1,5 @@
+.venv/
+__pycache__/
+.pytest_cache/
+.ruff_cache/
+*.tmp

snapdelta-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.

snapdelta-0.1.0/PKG-INFO

@@ -0,0 +1,72 @@
+Metadata-Version: 2.5
+Name: snapdelta
+Version: 0.1.0
+Summary: Snapshot your devices and services, then see exactly what changed: CLI and Python API, built on diffsync
+Project-URL: Homepage, https://github.com/antoinekh/snapdelta
+Project-URL: Documentation, https://github.com/antoinekh/snapdelta/tree/main/docs
+Project-URL: Issues, https://github.com/antoinekh/snapdelta/issues
+Project-URL: Changelog, https://github.com/antoinekh/snapdelta/blob/main/CHANGELOG.md
+Author-email: Antoine Keranflec'h <antoine.keranflech@gmail.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: diff,diffsync,netdevops,network-automation,nornir,snapshot
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: System Administrators
+Classifier: Intended Audience :: Telecommunications Industry
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: System :: Networking
+Classifier: Topic :: System :: Networking :: Monitoring
+Classifier: Typing :: Typed
+Requires-Python: >=3.13
+Requires-Dist: diffsync<3,>=2.2
+Requires-Dist: pydantic>=2.7
+Requires-Dist: pyyaml>=6
+Requires-Dist: tomlkit>=0.15
+Requires-Dist: typer>=0.12
+Description-Content-Type: text/markdown
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/antoinekh/snapdelta/main/docs/images/logo-wordmark-light.svg" width="400" alt="snapdelta" />
+</p>
+
+**Snapshot your devices and services, then see exactly what changed.**
+
+Take a snapshot of anything, then compare two snapshots. A plugin brings the [diffsync](https://github.com/networktocode/diffsync) models and a source: the way to get the data of one target, from input files, an API, NETCONF or SSH. snapdelta saves each load as a snapshot, compares two snapshots on their models, not on text, and shows what changed.
+
+This package is the core and the `snapdelta` CLI. The web UI, the JSON API and the MCP server are in [snapdelta-web](https://pypi.org/project/snapdelta-web/).
+
+## Install
+
+snapdelta needs Python 3.13 or later. In your plugin project:
+
+```bash
+uv add snapdelta snapdelta-web
+```
+
+## Use it
+
+With a plugin source installed (here `my-source`):
+
+```bash
+snapdelta snapshot --source my-source --all-targets --label before
+snapdelta snapshot --source my-source --all-targets --label after
+snapdelta diff R1@before R1@after
+```
+
+## Documentation
+
+- [Getting started](https://github.com/antoinekh/snapdelta/blob/main/docs/getting-started.md): your own project, step by step
+- [Architecture](https://github.com/antoinekh/snapdelta/blob/main/docs/architecture.md): the parts and the extension points
+- [Profiles](https://github.com/antoinekh/snapdelta/blob/main/docs/profiles.md): ignore, tolerance, counts, pairs
+- [Inventory](https://github.com/antoinekh/snapdelta/blob/main/docs/inventory.md): the optional Nornir inventory
+- [Settings](https://github.com/antoinekh/snapdelta/blob/main/docs/settings.md): every key of `snapdelta.toml`
+- [Changelog](https://github.com/antoinekh/snapdelta/blob/main/CHANGELOG.md)
+
+## License
+
+Apache License 2.0.

snapdelta-0.1.0/README.md

@@ -0,0 +1,40 @@
+<p align="center">
+  <img src="https://raw.githubusercontent.com/antoinekh/snapdelta/main/docs/images/logo-wordmark-light.svg" width="400" alt="snapdelta" />
+</p>
+
+**Snapshot your devices and services, then see exactly what changed.**
+
+Take a snapshot of anything, then compare two snapshots. A plugin brings the [diffsync](https://github.com/networktocode/diffsync) models and a source: the way to get the data of one target, from input files, an API, NETCONF or SSH. snapdelta saves each load as a snapshot, compares two snapshots on their models, not on text, and shows what changed.
+
+This package is the core and the `snapdelta` CLI. The web UI, the JSON API and the MCP server are in [snapdelta-web](https://pypi.org/project/snapdelta-web/).
+
+## Install
+
+snapdelta needs Python 3.13 or later. In your plugin project:
+
+```bash
+uv add snapdelta snapdelta-web
+```
+
+## Use it
+
+With a plugin source installed (here `my-source`):
+
+```bash
+snapdelta snapshot --source my-source --all-targets --label before
+snapdelta snapshot --source my-source --all-targets --label after
+snapdelta diff R1@before R1@after
+```
+
+## Documentation
+
+- [Getting started](https://github.com/antoinekh/snapdelta/blob/main/docs/getting-started.md): your own project, step by step
+- [Architecture](https://github.com/antoinekh/snapdelta/blob/main/docs/architecture.md): the parts and the extension points
+- [Profiles](https://github.com/antoinekh/snapdelta/blob/main/docs/profiles.md): ignore, tolerance, counts, pairs
+- [Inventory](https://github.com/antoinekh/snapdelta/blob/main/docs/inventory.md): the optional Nornir inventory
+- [Settings](https://github.com/antoinekh/snapdelta/blob/main/docs/settings.md): every key of `snapdelta.toml`
+- [Changelog](https://github.com/antoinekh/snapdelta/blob/main/CHANGELOG.md)
+
+## License
+
+Apache License 2.0.

snapdelta-0.1.0/pyproject.toml

@@ -0,0 +1,40 @@
+[project]
+name = "snapdelta"
+version = "0.1.0"
+description = "Snapshot your devices and services, then see exactly what changed: CLI and Python API, built on diffsync"
+readme = "README.md"
+requires-python = ">=3.13"
+license = "Apache-2.0"
+authors = [{ name = "Antoine Keranflec'h", email = "antoine.keranflech@gmail.com" }]
+keywords = ["network-automation", "netdevops", "snapshot", "diff", "diffsync", "nornir"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Environment :: Console",
+    "Intended Audience :: System Administrators",
+    "Intended Audience :: Telecommunications Industry",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: System :: Networking",
+    "Topic :: System :: Networking :: Monitoring",
+    "Typing :: Typed",
+]
+dependencies = ["diffsync>=2.2,<3", "pydantic>=2.7", "pyyaml>=6", "typer>=0.12", "tomlkit>=0.15"]
+
+[project.urls]
+Homepage = "https://github.com/antoinekh/snapdelta"
+Documentation = "https://github.com/antoinekh/snapdelta/tree/main/docs"
+Issues = "https://github.com/antoinekh/snapdelta/issues"
+Changelog = "https://github.com/antoinekh/snapdelta/blob/main/CHANGELOG.md"
+
+[project.scripts]
+snapdelta = "snapdelta.cli:app"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/snapdelta"]

snapdelta-0.1.0/src/snapdelta/__init__.py

@@ -0,0 +1,5 @@
+"""snapdelta: snapshot anything with diffsync models, then compare two snapshots."""
+
+from importlib.metadata import version
+
+__version__ = version("snapdelta")

snapdelta-0.1.0/src/snapdelta/about.py

@@ -0,0 +1,50 @@
+"""What a user or a support request needs to know: the versions, the plugins and the project links."""
+
+from __future__ import annotations
+
+import platform
+from collections.abc import Iterable
+from dataclasses import dataclass, field
+from importlib.metadata import PackageNotFoundError, version
+
+from .source import broken_sources, source_classes
+
+PROJECT_URL = "https://github.com/antoinekh/snapdelta"
+DOCS_URL = f"{PROJECT_URL}/tree/main/docs"
+CHANGELOG_URL = f"{PROJECT_URL}/blob/main/CHANGELOG.md"
+ISSUES_URL = f"{PROJECT_URL}/issues"
+
+
+@dataclass(frozen=True)
+class Component:
+    name: str
+    version: str
+    sources: list[str] = field(default_factory=list)
+
+
+def package_version(distribution: str) -> str:
+    try:
+        return version(distribution)
+    except PackageNotFoundError:
+        return "unknown"
+
+
+def components(extra: Iterable[str] = ()) -> list[Component]:
+    """snapdelta, the other given packages (the web UI), diffsync and Python."""
+    names = ["snapdelta", *extra, "diffsync"]
+    return [*(Component(name, package_version(name)) for name in names), Component("Python", platform.python_version())]
+
+
+def plugins() -> list[Component]:
+    """The installed plugins with their sources; a source with no distribution is listed under its own name."""
+    by_plugin: dict[str, list[str]] = {}
+    for name, cls in sorted(source_classes().items()):
+        by_plugin.setdefault(cls.distribution or name, []).append(name)
+    for name in sorted(broken_sources()):
+        by_plugin.setdefault(f"{name} (cannot load)", []).append(name)
+    return [Component(plugin, package_version(plugin), names) for plugin, names in sorted(by_plugin.items())]
+
+
+def version_line() -> str:
+    core, diffsync = package_version("snapdelta"), package_version("diffsync")
+    return f"snapdelta {core} (diffsync {diffsync}, Python {platform.python_version()})"

snapdelta-0.1.0/src/snapdelta/activity.py

@@ -0,0 +1,182 @@
+"""What snapdelta did: one run per command (snapshots, a diff), with its result and the log messages of its loads.
+
+A source plugin logs with the standard `logging` module. While a load runs, `LogCollector` adds each message to
+the log of that load, even from the threads of `run_parallel()`, which copy the context of their caller.
+"""
+
+from __future__ import annotations
+
+import getpass
+import logging
+import secrets
+from collections.abc import Iterator
+from contextlib import contextmanager
+from contextvars import ContextVar
+from datetime import UTC, datetime
+from enum import StrEnum
+from typing import TYPE_CHECKING
+
+from pydantic import BaseModel, Field
+
+from .errors import SnapdeltaError
+
+if TYPE_CHECKING:
+    from .store import Store
+
+_log = logging.getLogger(__name__)
+# The log that receives the messages of the current context, and the target that they are about.
+_lines: ContextVar[list[LogLine] | None] = ContextVar("snapdelta_log_lines", default=None)
+_target: ContextVar[str | None] = ContextVar("snapdelta_log_target", default=None)
+# Only a load collects: the compare of a run logs too (diffsync), and that says nothing about the targets.
+_loading: ContextVar[bool] = ContextVar("snapdelta_loading", default=False)
+
+
+class LogLine(BaseModel):
+    at: datetime
+    level: str
+    logger: str
+    target: str | None = None
+    message: str
+
+
+class RunStatus(StrEnum):
+    OK = "ok"
+    PARTIAL = "partial"
+    FAILED = "failed"
+
+
+class Run(BaseModel):
+    """One command: what it took or compared, how it ended, and the log of its loads."""
+
+    id: str
+    kind: str = Field(description="snapshot or diff")
+    origin: str = Field(description="cli, web, api, mcp, or python for a direct call")
+    user: str | None = None
+    started_at: datetime
+    ended_at: datetime
+    status: RunStatus
+    targets: list[str] = []
+    saved: list[str] = Field(default=[], description="The references of the saved snapshots.")
+    output: str | None = Field(default=None, description="The name of the saved diff.")
+    errors: dict[str, str] = Field(default={}, description="The error of each failed target, or of the run under `*`.")
+    log: list[LogLine] = []
+
+    @property
+    def duration_s(self) -> float:
+        return (self.ended_at - self.started_at).total_seconds()
+
+
+class LogCollector(logging.Handler):
+    """Adds each message of a load to the log of the current context; any other message goes nowhere."""
+
+    def emit(self, record: logging.LogRecord) -> None:
+        lines = _lines.get()
+        if lines is None or not _loading.get():
+            return
+        try:
+            message = record.getMessage()
+        except (TypeError, ValueError):
+            message = str(record.msg)
+        lines.append(
+            LogLine(
+                at=datetime.fromtimestamp(record.created, UTC),
+                level=record.levelname.lower(),
+                logger=record.name,
+                target=_target.get(),
+                message=message,
+            )
+        )
+
+
+def configure_logging(level: str = "info") -> None:
+    """Collect the messages at `level` and above, and keep the console at warning; once per process."""
+    root = logging.getLogger()
+    wanted = logging.getLevelNamesMapping()[level.upper()]
+    for handler in root.handlers:
+        # The console handler of logging.basicConfig() shows warnings only, as before the collector.
+        if type(handler) is logging.StreamHandler and handler.level == logging.NOTSET:
+            handler.setLevel(logging.WARNING)
+    if not any(isinstance(handler, LogCollector) for handler in root.handlers):
+        root.addHandler(LogCollector(wanted))
+    else:
+        for handler in root.handlers:
+            if isinstance(handler, LogCollector):
+                handler.setLevel(wanted)
+    root.setLevel(min(root.level or logging.WARNING, wanted))
+
+
+@contextmanager
+def collecting(target: str | None = None, loading: bool = True) -> Iterator[list[LogLine]]:
+    """The log of the load in the block, about `target`; the lines also go to the log around it."""
+    outer = _lines.get()
+    lines: list[LogLine] = []
+    tokens = (_lines.set(lines), _target.set(target), _loading.set(loading))
+    try:
+        yield lines
+    finally:
+        _lines.reset(tokens[0])
+        _target.reset(tokens[1])
+        _loading.reset(tokens[2])
+        if outer is not None:
+            outer.extend(lines)
+
+
+class RunRecord:
+    """A run while it goes on; the caller fills `saved`, `output` and `errors`."""
+
+    def __init__(self, kind: str, origin: str, targets: list[str]) -> None:
+        self.kind = kind
+        self.origin = origin
+        self.targets = targets
+        self.started_at = datetime.now(UTC)
+        self.saved: list[str] = []
+        self.output: str | None = None
+        self.errors: dict[str, str] = {}
+        self.log: list[LogLine] = []
+
+    def finished(self) -> Run:
+        done = len(self.saved) + (1 if self.output else 0)
+        status = RunStatus.OK if not self.errors else RunStatus.PARTIAL if done else RunStatus.FAILED
+        # Microseconds, so that the ids of two runs of the same second sort in their order.
+        stamp = self.started_at.strftime("%Y%m%dT%H%M%S%fZ")
+        return Run(
+            id=f"{stamp}-{self.kind}-{secrets.token_hex(2)}",
+            kind=self.kind,
+            origin=self.origin,
+            user=_user() if self.origin == "cli" else None,
+            started_at=self.started_at,
+            ended_at=datetime.now(UTC),
+            status=status,
+            targets=self.targets,
+            saved=self.saved,
+            output=self.output,
+            errors=self.errors,
+            # The loads add their lines when they end: the time gives back the order of the events.
+            log=sorted(self.log, key=lambda line: line.at),
+        )
+
+
+@contextmanager
+def recorded(store: Store, kind: str, origin: str, targets: list[str]) -> Iterator[RunRecord]:
+    """Record the block as a run of the store; an error fails the run and goes on to the caller."""
+    record = RunRecord(kind, origin, targets)
+    try:
+        with collecting(loading=False) as lines:
+            record.log = lines
+            yield record
+    except Exception as error:
+        record.errors["*"] = str(error) if isinstance(error, SnapdeltaError) else f"{type(error).__name__}: {error}"
+        raise
+    finally:
+        try:
+            store.save_run(record.finished())
+        except (OSError, SnapdeltaError) as error:
+            # The command itself went well: a run that cannot be saved must not turn it into an error.
+            _log.warning("the run was not saved: %s", error)
+
+
+def _user() -> str | None:
+    try:
+        return getpass.getuser()
+    except (KeyError, OSError):
+        return None