fherma-runner 0.2.0__tar.gz

fherma_runner-0.2.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 2026 FairMath
+
+   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.

fherma_runner-0.2.0/PKG-INFO

@@ -0,0 +1,124 @@
+Metadata-Version: 2.4
+Name: fherma-runner
+Version: 0.2.0
+Summary: Takes measurement jobs from a FHERMA platform and reports what happened
+Author: FairMath
+License: Apache-2.0
+Project-URL: Homepage, https://fherma.io
+Project-URL: Source, https://github.com/fairmath/fherma-runner
+Keywords: fhe,cryptography,benchmarking,kernels,runner
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Security :: Cryptography
+Classifier: Topic :: Software Development :: Testing
+Classifier: Topic :: System :: Distributed Computing
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# fherma-runner
+
+Takes measurement jobs from a [FHERMA](https://fherma.io) platform and reports
+what happened.
+
+```shell
+uv tool install fherma-runner        # or: pipx install fherma-runner
+fherma-runner --api https://fherma.io --name bench-01 --token fhr_...
+```
+
+A command line tool belongs in an environment of its own, and on macOS it has
+no choice: the system Python has no `pip` on the path at all, and Homebrew's is
+marked externally managed so installing into it is refused. `uv tool` and
+`pipx` both make that environment and leave `fherma-runner` on the path, which
+is the part `pip install --user` does not do.
+
+Neither installed? One line, and nothing else on the machine changes:
+
+```shell
+curl -LsSf https://astral.sh/uv/install.sh | sh
+```
+
+Check what you got:
+
+```console
+$ fherma-runner --version
+fherma-runner 0.2.0 · python 3.13.4
+```
+
+The token comes from the platform, is good for an hour and is spent once: the
+first start exchanges it for this machine's own key and keeps that in
+`~/.fherma-runner`. Every start after the first needs no token.
+
+Every start says what the machine is now, so a server that was re-provisioned is
+matched on what it is rather than on what it was.
+
+## What it needs
+
+An interpreter and `docker`. There are no dependencies: everything here ships
+with Python, and docker is called as a command.
+
+## What it declares
+
+Hardware, and only hardware — cores, memory, architecture, CPU features, an
+accelerator and its driver. It does not declare libraries or images, because
+the environment a job runs in is not a property of a machine: it arrives with
+the job, pinned to a digest.
+
+```
+fherma-runner --describe
+```
+
+prints what it would report, and stops.
+
+## What it does with a job
+
+```
+jobs/<id>/
+├── bundle/     the specification's bundle, unpacked
+├── solution/   the repository at the commit, and its build
+└── points/
+    └── p000/   one point at a time, deleted once reported
+```
+
+Per point: the bundle makes the cases, the solution answers them, the bundle
+judges the answers. Three containers, and the solution is never given the
+directory holding the expected answers.
+
+## Options
+
+```
+--api           where the platform is                  FHERMA_API
+--name          what to call this machine              FHERMA_RUNNER_NAME
+--token         an invitation, spent once for a key
+--interval      seconds between polls                  3
+--once          take one assignment, then stop
+--describe      print what this machine is, and stop
+--version       what is installed, and on what
+--re-register   forget the key and join again
+```
+
+The `--speed`, `--fail-rate`, `--build-seconds` and `--point-seconds` options
+belong to the half that is still pretended, and go away with it.
+
+## Stopping
+
+The platform stops a runner by refusing its heartbeat. It then drops
+everything at once and sends nothing: finishing the work and reporting it would
+be reporting into a result somebody else now owns.
+
+If a runner goes quiet instead, its lease lapses, the run is marked expired and
+the job goes to another machine.
+
+## Licence
+
+Apache-2.0.

fherma_runner-0.2.0/README.md

@@ -0,0 +1,96 @@
+# fherma-runner
+
+Takes measurement jobs from a [FHERMA](https://fherma.io) platform and reports
+what happened.
+
+```shell
+uv tool install fherma-runner        # or: pipx install fherma-runner
+fherma-runner --api https://fherma.io --name bench-01 --token fhr_...
+```
+
+A command line tool belongs in an environment of its own, and on macOS it has
+no choice: the system Python has no `pip` on the path at all, and Homebrew's is
+marked externally managed so installing into it is refused. `uv tool` and
+`pipx` both make that environment and leave `fherma-runner` on the path, which
+is the part `pip install --user` does not do.
+
+Neither installed? One line, and nothing else on the machine changes:
+
+```shell
+curl -LsSf https://astral.sh/uv/install.sh | sh
+```
+
+Check what you got:
+
+```console
+$ fherma-runner --version
+fherma-runner 0.2.0 · python 3.13.4
+```
+
+The token comes from the platform, is good for an hour and is spent once: the
+first start exchanges it for this machine's own key and keeps that in
+`~/.fherma-runner`. Every start after the first needs no token.
+
+Every start says what the machine is now, so a server that was re-provisioned is
+matched on what it is rather than on what it was.
+
+## What it needs
+
+An interpreter and `docker`. There are no dependencies: everything here ships
+with Python, and docker is called as a command.
+
+## What it declares
+
+Hardware, and only hardware — cores, memory, architecture, CPU features, an
+accelerator and its driver. It does not declare libraries or images, because
+the environment a job runs in is not a property of a machine: it arrives with
+the job, pinned to a digest.
+
+```
+fherma-runner --describe
+```
+
+prints what it would report, and stops.
+
+## What it does with a job
+
+```
+jobs/<id>/
+├── bundle/     the specification's bundle, unpacked
+├── solution/   the repository at the commit, and its build
+└── points/
+    └── p000/   one point at a time, deleted once reported
+```
+
+Per point: the bundle makes the cases, the solution answers them, the bundle
+judges the answers. Three containers, and the solution is never given the
+directory holding the expected answers.
+
+## Options
+
+```
+--api           where the platform is                  FHERMA_API
+--name          what to call this machine              FHERMA_RUNNER_NAME
+--token         an invitation, spent once for a key
+--interval      seconds between polls                  3
+--once          take one assignment, then stop
+--describe      print what this machine is, and stop
+--version       what is installed, and on what
+--re-register   forget the key and join again
+```
+
+The `--speed`, `--fail-rate`, `--build-seconds` and `--point-seconds` options
+belong to the half that is still pretended, and go away with it.
+
+## Stopping
+
+The platform stops a runner by refusing its heartbeat. It then drops
+everything at once and sends nothing: finishing the work and reporting it would
+be reporting into a result somebody else now owns.
+
+If a runner goes quiet instead, its lease lapses, the run is marked expired and
+the job goes to another machine.
+
+## Licence
+
+Apache-2.0.

fherma_runner-0.2.0/fherma_runner/__init__.py

@@ -0,0 +1,8 @@
+"""A FHERMA runner: takes measurement jobs and reports what happened.
+
+Nothing here imports anything that does not ship with Python, and docker is
+called as a command rather than through a library. Installing this on a server
+is copying a directory.
+"""
+
+__version__ = "0.2.0"

fherma_runner-0.2.0/fherma_runner/__main__.py

@@ -0,0 +1,129 @@
+"""The command line, and the loop that outlives everything under it.
+
+    fherma-runner --api https://fherma.io --name bench-01
+    fherma-runner --once                one assignment, then stop
+    fherma-runner --re-register         forget the key and join again
+"""
+
+from __future__ import annotations
+
+import argparse
+import os
+import sys
+import time
+from importlib import metadata
+
+from . import job, machine
+from .api import Api, Refused, Unreachable
+from .session import KEYFILE, describe, identify
+
+
+def version() -> str:
+    """What is installed, asked of the installation rather than hardcoded."""
+    try:
+        return metadata.version("fherma-runner")
+    except metadata.PackageNotFoundError:
+        return "unknown (running from a checkout)"
+
+
+def parse(argv: list[str] | None = None) -> argparse.Namespace:
+    parser = argparse.ArgumentParser(
+        prog="fherma-runner",
+        description="Takes measurement jobs from a FHERMA platform and reports what happened.",
+    )
+    parser.add_argument("--api", default=os.environ.get("FHERMA_API", "http://localhost:4000"))
+    parser.add_argument("--name", default=os.environ.get("FHERMA_RUNNER_NAME", "runner"))
+    parser.add_argument("--interval", type=float, default=3.0, help="seconds between polls")
+    parser.add_argument("--once", action="store_true", help="one assignment, then stop")
+    parser.add_argument("--token", help="an invitation, exchanged once for this machine's key")
+    parser.add_argument("--re-register", action="store_true", help="forget the key and join again")
+    parser.add_argument("--describe", action="store_true", help="print what this machine is, and stop")
+    # The first question anybody asks after an install that may not have worked.
+    # One line rather than three, because argparse reflows the text it prints
+    # and a newline here comes out as a space.
+    parser.add_argument(
+        "--version",
+        action="version",
+        version=f"fherma-runner {version()} · python {sys.version.split()[0]}",
+    )
+
+    limits = parser.add_argument_group(
+        "limits",
+        "What a solution's container may take. The platform sets the time limits; "
+        "these are the machine's own.",
+    )
+    limits.add_argument("--memory", default=os.environ.get("FHERMA_MEMORY", "8g"))
+    limits.add_argument("--cpus", default=os.environ.get("FHERMA_CPUS"))
+
+    return parser.parse_args(argv)
+
+
+def main(argv: list[str] | None = None) -> int:
+    options = parse(argv)
+
+    if options.describe:
+        for name, value in machine.describe().items():
+            print(f"{name:12} {value}")
+        print(f"{'can':12} {', '.join(one['name'] for one in machine.capabilities()) or 'nothing'}")
+        return 0
+
+    if options.re_register and KEYFILE.exists():
+        KEYFILE.unlink()
+
+    api = Api(options.api)
+
+    while True:
+        try:
+            api.key = identify(api, options.name, options.token)
+            break
+        except Refused as failure:
+            print(f"could not register: {failure}", file=sys.stderr)
+            return 1
+        except Unreachable as failure:
+            # A runner boots when its machine boots, which may be before the
+            # platform is up. Waiting is the correct answer; exiting would need
+            # somebody to notice and start it again.
+            print(f"waiting for {options.api}: {failure}", file=sys.stderr)
+            time.sleep(options.interval)
+
+    try:
+        describe(api)
+    except Refused as failure:
+        if failure.status in (401, 403):
+            print("the key was refused — try --re-register", file=sys.stderr)
+            return 1
+        raise
+    except Unreachable as failure:
+        print(f"could not describe this machine: {failure}", file=sys.stderr)
+
+    print(f"polling {options.api} every {options.interval}s — ctrl-c to stop")
+
+    while True:
+        try:
+            did = job.take(api, options)
+        except Refused as failure:
+            # A lapsed lease is the ordinary case: stop working on it and ask
+            # again rather than reporting into a result somebody else now owns.
+            print(f"  refused ({failure.status}) — dropping this one", file=sys.stderr)
+            did = False
+        except Unreachable as failure:
+            print(f"  cannot reach {options.api}: {failure}", file=sys.stderr)
+            did = False
+
+        if did and options.once:
+            return 0
+        if not did:
+            print(".", end="", flush=True)
+        time.sleep(options.interval)
+
+
+def run() -> None:
+    """The console entry point. Ctrl-C is an ending, not a crash."""
+    try:
+        raise SystemExit(main())
+    except KeyboardInterrupt:
+        print()
+
+
+if __name__ == "__main__":
+    run()

fherma_runner-0.2.0/fherma_runner/api.py

@@ -0,0 +1,80 @@
+"""Talking to the platform, and the three ways it can go wrong.
+
+The runner is the only one of the three programs on a machine that speaks to
+the platform at all. The bundle is handed a directory; the solution is handed a
+directory; neither has a key and neither has a network.
+
+Nothing here is imported that does not ship with Python. A machine that runs
+this needs nothing installed beyond an interpreter and docker.
+"""
+
+from __future__ import annotations
+
+import json
+import urllib.error
+import urllib.request
+
+
+class Refused(Exception):
+    """The platform answered, and the answer was no."""
+
+    def __init__(self, status: int, detail: str) -> None:
+        super().__init__(f"{status}: {detail}")
+        self.status = status
+        self.detail = detail
+
+
+class Unreachable(Exception):
+    """The platform did not answer. Says nothing about the work."""
+
+
+class Dropped(Exception):
+    """This assignment is no longer ours. Stop, and send nothing."""
+
+
+class Api:
+    """The calls a runner makes, and the one that gets it a key.
+
+    Errors are not swallowed. A runner that carries on after a refusal is a
+    runner reporting into somebody else's result, and the refusals here mean
+    exactly that: the lease lapsed, the assignment went elsewhere.
+    """
+
+    def __init__(self, base: str, key: str | None = None, timeout: float = 30) -> None:
+        self.base = base.rstrip("/")
+        self.key = key
+        self.timeout = timeout
+
+    def call(self, method: str, path: str, body: dict | None = None) -> dict:
+        raw = self._request(method, path, body)
+        return json.loads(raw) if raw else {}
+
+    def download(self, path: str) -> bytes:
+        """A file rather than a document — the bundle archive, and only that."""
+        return self._request("GET", path, None, decode=False)
+
+    def _request(self, method: str, path: str, body: dict | None, decode: bool = True):
+        request = urllib.request.Request(
+            f"{self.base}/api{path}",
+            method=method,
+            data=json.dumps(body).encode() if body is not None else None,
+            headers={
+                "content-type": "application/json",
+                **({"x-fherma-runner": self.key} if self.key else {}),
+            },
+        )
+
+        try:
+            with urllib.request.urlopen(request, timeout=self.timeout) as answer:
+                raw = answer.read()
+                return raw.decode() if decode else raw
+        except urllib.error.HTTPError as failure:
+            detail = failure.read().decode()[:300]
+            raise Refused(failure.code, detail) from None
+        except OSError as failure:
+            # Refused connections arrive as URLError; a read that times out
+            # half-way through arrives as a bare TimeoutError, and a platform
+            # restarting mid-request produces both. They mean one thing to a
+            # runner — nobody answered — and a machine meant to sit in a rack
+            # for weeks must not die of any of them.
+            raise Unreachable(str(getattr(failure, "reason", None) or failure)) from None