plesty-bench 0.3.1__tar.gz

plesty_bench-0.3.1/.gitignore

@@ -0,0 +1,86 @@
+# Custom
+.deprecated/
+logs/
+runs/
+
+# Field test and check reports. The JSON documents are the published
+# artifacts — hub.plesty.net and manager.plesty.net read them, so they are
+# committed. The markdown and JSONL forms are for whoever ran the test: they
+# carry the host name, the instrument address, its serial and the lab's file
+# paths, and a hub repository is world-readable.
+# An interrupted `plesty init field-test` leaves its answers here.
+.plesty-field-test.partial.json
+
+reports/**/*.md
+reports/**/*.jsonl
+reports/*.md
+reports/*.jsonl
+
+# Auto-generated device reference pages (regenerated by `plesty docs`)
+docs/_generated/
+
+# Python bytecode and caches
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions and shared libraries
+*.so
+*.pyd
+*.dll
+
+# Packaging and build artifacts. The dist-* directories are the ones the
+# packaging scripts write: dist-server (server_dist.py), dist-test and dist-exp
+# (the installers' test modes). They must be listed HERE and not only be
+# self-ignored by the .gitignore uv drops inside its own output directories:
+# the build backend honours this file and does not descend into nested ones, so
+# a directory git hides but this file does not name still lands in the sdist.
+build/
+dist/
+dist-*/
+*.egg-info/
+.eggs/
+
+# uv's cache, which `[tool.uv] cache-dir` puts inside the project. Same reason:
+# uv hides it from git with a file of its own, which the build backend does not
+# read — and a source distribution built from a synced tree carried 485 MB of
+# it before this line existed.
+.uv-cache/
+.uv_cache/
+
+# Local credentials — keep `.env.example` tracked, never the real `.env`
+.env
+
+# Virtual environments
+.venv/
+venv/
+env/
+ENV/
+
+# Test and coverage outputs
+.pytest_cache/
+.coverage
+.coverage.*
+htmlcov/
+.mypy_cache/
+.ruff_cache/
+
+# Jupyter
+.ipynb_checkpoints/
+
+# Logs and runtime files
+*.log
+*.pid
+
+# IDE/editor
+.vscode/
+.idea/
+*.swp
+*.swo
+
+# OS files
+.DS_Store
+Thumbs.db
+
+# Generated from packaging/plesty-mark.png at build time (installer:windows).
+packaging/plesty-mark.ico

plesty_bench-0.3.1/.gitlab-ci.yml

@@ -0,0 +1,238 @@
+stages:
+  - check
+  - security
+  - deploy
+  - release
+
+variables:
+  # Required for versioningit: the runner must fetch full Git history and tags.
+  GIT_DEPTH: "0"
+
+include:
+  - component: $CI_SERVER_FQDN/plesty/plesty-ci/plesty-standard-ci@main
+    inputs:
+      standard: quantum
+      extra_branch: exp
+      access_token: $CI_BOT_TOKEN
+
+# The template's hub-release publishes plesty-bench. Both PyPI publishers use
+# the same namespace/project/pipeline file, so they are told apart by the
+# GitLab environment the publishing job runs in (PyPI refuses two pending
+# publishers that differ only in the project name): pypi-bench here,
+# pypi-server below.
+hub-release:
+  environment:
+    name: pypi-bench
+    url: https://pypi.org/project/plesty-bench/
+
+# ---------------------------------------------------------------------------
+# The suite, on Windows.
+#
+# Every gate the template runs, runs on Linux — and nearly every bug this
+# component has had is Windows-only: process groups and console control
+# events, path handling, whether a tool exists at all. The
+# `# pragma: no cover — exercised on the Windows CI job` markers in
+# plesty/server/host.py mean this job; without it they claim a coverage that
+# never happened, and a green pipeline says nothing about the platform the
+# benches run on.
+#
+# Runs where hub-check runs (merge requests, the default branch, exp) and on
+# tags. Coverage is measured on Linux, where the gate is; here the outcome is
+# the point, so pytest runs plain.
+# ---------------------------------------------------------------------------
+tests:windows:
+  stage: check
+  tags:
+    - saas-windows-medium-amd64
+  rules:
+    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
+    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
+    - if: $CI_COMMIT_BRANCH == "exp"
+    - if: $CI_COMMIT_TAG
+  timeout: 30 minutes
+  variables:
+    UV_LINK_MODE: copy
+    # No cache, deliberately. Measured on this runner: restoring it took 4m03s
+    # and saving it several minutes more, to speed a `uv sync` that takes 1m35s
+    # even when the cache is warm. It cost about ten minutes of a twenty-two
+    # minute job to save one and a half. Downloading the wheels afresh is the
+    # cheaper half of that trade.
+    UV_CACHE_DIR: .uv_cache
+    # tests/test_view.py drives the Qt console and the runner has no desktop
+    QT_QPA_PLATFORM: offscreen
+  before_script:
+    - powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
+    - $env:Path = "$env:USERPROFILE\.local\bin;$env:Path"
+    - uv --version
+  script:
+    # --all-extras: the Qt console is part of what a bench runs on Windows
+    - uv sync --frozen --all-extras
+    # -v so the log names the test that is running when something wedges, and a
+    # per-test timeout so a wedge is a traceback rather than the job's 30
+    # minutes: `-q` reports failures only in a summary a hang never reaches,
+    # which is exactly how the first run of this job came back unreadable.
+    - uv run pytest -v -rf --timeout=120 --timeout-method=thread
+
+# ---------------------------------------------------------------------------
+# The second distribution and the light installers — on tags.
+#
+# The standard template's hub-release publishes the wheel of this project
+# (plesty-bench, the client). The bench application is a second distribution,
+# plesty-server, assembled from the same tree by packaging/server_dist.py and
+# published here through the same trusted publisher (OIDC, no stored token).
+# The installers carry no application code: they install uv and run
+# `uv tool install "plesty-server[gui]==<version>"` on the bench.
+# ---------------------------------------------------------------------------
+.release-rules:
+  rules:
+    - if: $CI_COMMIT_TAG
+
+release:server-wheel:
+  stage: release
+  extends: .release-rules
+  # the PLESTY runner image (git + uv), as the template's hub-release uses
+  image: registry.gitlab.com/plesty/core/plesty-ci/runner:quantum
+  environment:
+    name: pypi-server
+    url: https://pypi.org/project/plesty-server/
+  id_tokens:
+    PYPI_ID_TOKEN:
+      aud: pypi
+  variables:
+    UV_LINK_MODE: copy
+    UV_CACHE_DIR: /tmp/uv-cache
+  before_script:
+    - git fetch --tags --force
+  script:
+    - uv sync --frozen
+    - VERSION="$(uv run python -c 'from importlib.metadata import version; print(version("plesty-bench"))')"
+    # This is the version the installers pin, so it has to be the tag itself --
+    # a .dev/+local version here means the tag or the fetch went wrong.
+    - |
+      test "$VERSION" = "${CI_COMMIT_TAG#v}" || {
+        echo "wheel version $VERSION does not match tag ${CI_COMMIT_TAG#v}"; exit 1; }
+    - echo "plesty-server $VERSION"
+    - uv run python packaging/server_dist.py --out dist-server --version "$VERSION"
+    - ls -la dist-server
+    - |
+      # Trusted publishing: mint an upload token from the job's ID token, as the
+      # standard template does for plesty-bench (a PYPI_TOKEN variable wins if set).
+      if [ -n "${PYPI_TOKEN:-}" ]; then
+        uv publish --token "$PYPI_TOKEN" dist-server/*
+      else
+        test -n "$PYPI_ID_TOKEN" || { echo "no OIDC ID token"; exit 1; }
+        API_TOKEN="$(python3 - <<'PY'
+      import json, os, urllib.request
+      req = urllib.request.Request("https://pypi.org/_/oidc/mint-token",
+          data=json.dumps({"token": os.environ["PYPI_ID_TOKEN"]}).encode(),
+          headers={"Content-Type": "application/json"})
+      with urllib.request.urlopen(req, timeout=30) as r:
+          print(json.load(r)["token"])
+      PY
+      )"
+        uv publish --token "$API_TOKEN" dist-server/*
+      fi
+  artifacts:
+    paths:
+      - dist-server/*.whl
+    expire_in: 1 year
+
+installer:windows:
+  stage: release
+  # on tags, and on demand from an installer/<name> branch to prove a change
+  # to the Inno Setup script before it is tagged
+  rules:
+    - if: $CI_COMMIT_TAG
+    - if: $CI_COMMIT_BRANCH =~ /^installer\//
+  tags:
+    - saas-windows-medium-amd64
+  before_script:
+    - powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
+    - $env:Path = "$env:USERPROFILE\.local\bin;$env:Path"
+    - choco install innosetup -y --no-progress | Out-Null
+    - git fetch --tags --force
+  script:
+    # The version baked in is the PyPI pin the wizard installs, so it must be a
+    # released version -- never what versioningit derives from the working tree
+    # (0.2.3.dev7+abc1234 and 0.2.2+modified are not on PyPI, and an installer
+    # built with one fails on every machine). On a tag it is the tag; an
+    # installer/<name> branch proves a script change against the last release,
+    # or against INSTALLER_VERSION when set.
+    - |
+      if ($env:CI_COMMIT_TAG) { $VERSION = $env:CI_COMMIT_TAG -replace '^v', '' }
+      elseif ($env:INSTALLER_VERSION) { $VERSION = $env:INSTALLER_VERSION -replace '^v', '' }
+      else { $VERSION = (git describe --tags --abbrev=0) -replace '^v', '' }
+      if ($VERSION -notmatch '^[0-9]+\.[0-9]+\.[0-9]+$') {
+        throw "not a released version: '$VERSION' -- set INSTALLER_VERSION to the release to pin"
+      }
+      "installer pins plesty-server[gui]==$VERSION"
+    - uv sync --frozen --group build
+    - uv run --group build python -c "from PIL import Image; Image.open('packaging/plesty-mark.png').save('packaging/plesty-mark.ico', sizes=[(256,256),(128,128),(64,64),(48,48),(32,32),(16,16)])"
+    # WINDOWS_SIGN_COMMAND (a protected CI variable) is the signtool command
+    # line with Inno's $f placeholder for the file. Without it the build is
+    # unsigned and SmartScreen warns on download -- see docs/design/packaging.md.
+    - |
+      $isccArgs = @("/DAppVersion=$VERSION")
+      if ($env:WINDOWS_SIGN_COMMAND) {
+        $isccArgs += @("/DSignTool=plesty", "/Splesty=$env:WINDOWS_SIGN_COMMAND")
+      } else {
+        Write-Warning "WINDOWS_SIGN_COMMAND is not set -- building an unsigned installer"
+      }
+      & "C:\Program Files (x86)\Inno Setup 6\ISCC.exe" @isccArgs packaging\windows\plesty-server.iss
+      if ($LASTEXITCODE -ne 0) { throw "ISCC failed with exit code $LASTEXITCODE" }
+    - Get-ChildItem dist
+  artifacts:
+    paths:
+      - dist/plesty-server-*-windows-setup.exe
+    expire_in: 1 year
+
+# The GitLab release for a tag: the Windows installer and the install script
+# for macOS/Linux from the package registry (permanent), plus the two PyPI
+# distributions — the Releases page is the download list.
+release:assets:
+  stage: release
+  extends: .release-rules
+  image: registry.gitlab.com/gitlab-org/release-cli:latest
+  needs:
+    - job: installer:windows
+      artifacts: true
+    - job: release:server-wheel
+      artifacts: false
+  variables:
+    REGISTRY: "$CI_API_V4_URL/projects/$CI_PROJECT_ID/packages/generic/plesty-server/$CI_COMMIT_TAG"
+  script:
+    - apk add --no-cache curl >/dev/null
+    - ls -la dist
+    - |
+      setup="$(ls dist/plesty-server-*-windows-setup.exe | head -1)"
+      [ -n "$setup" ] || { echo "no Windows installer"; exit 1; }
+      curl --fail --silent --show-error --header "JOB-TOKEN: $CI_JOB_TOKEN" \
+        --upload-file "$setup" "$REGISTRY/plesty-server-$CI_COMMIT_TAG-windows-setup.exe"
+      # Stamp the release into the script so it pins, like the Windows installer.
+      version="${CI_COMMIT_TAG#v}"
+      sed "s/@PLESTY_VERSION@/$version/" packaging/install.sh > install.sh
+      grep -q "release_version=\"$version\"" install.sh || { echo "install.sh not stamped"; exit 1; }
+      curl --fail --silent --show-error --header "JOB-TOKEN: $CI_JOB_TOKEN" \
+        --upload-file install.sh "$REGISTRY/install.sh"
+  release:
+    tag_name: $CI_COMMIT_TAG
+    name: "plesty-server $CI_COMMIT_TAG"
+    description: >-
+      Windows: run the installer (it installs uv and the application from PyPI;
+      Start-menu entry, optional desktop shortcut). macOS and Linux: download
+      install.sh and run it with sh. Developer machines: uv tool install plesty-bench.
+      Update a bench with uv tool upgrade plesty-server. See CHANGELOG.md.
+    assets:
+      links:
+        - name: "plesty-server-$CI_COMMIT_TAG-windows-setup.exe (Windows installer)"
+          url: "$REGISTRY/plesty-server-$CI_COMMIT_TAG-windows-setup.exe"
+          link_type: package
+        - name: "install.sh (macOS and Linux: run with sh)"
+          url: "$REGISTRY/install.sh"
+          link_type: other
+        - name: "plesty-server on PyPI (the bench application)"
+          url: "https://pypi.org/project/plesty-server/"
+          link_type: other
+        - name: "plesty-bench on PyPI (the client)"
+          url: "https://pypi.org/project/plesty-bench/"
+          link_type: other