784964c907
Ports the corporate-GitHub wilm branch onto main, keeping the two branches
separate. Thirteen upstream commits arrive with their authorship intact; the
review fixes and the portability work below are on top.
What arrives:
endpoints plugin - a ShopDB agent reporting endpoint state, telemetry,
services and interfaces, with a command channel the agent
long-polls. Ingest stays on the generic collector route
(ADR-006); the agent key is a UI-managed single-scope
token whose revocation is an instant kill switch.
computers policies - Configuration and Business Policies (RMM-style), scope
trees validated at write time, actions checked against
the endpoints command allowlist. Feature-gated: every
route 404s while the setting is off, so enabling it can
never half-expose the surface.
asset CSV import - templates, a collector script carrying the site path, and
a validate-then-commit import. A plugin can own a virtual
column plus a post-write row hook, which is how a PC's
machine number becomes a controls link without a
hand-built relationships sheet.
agent/ - the Windows agent and its installer.
Contract 0.21.0 -> 0.24.0, additive throughout: register_import_hook (0.22),
mint/list/revoke_service_token (0.23), collector_authorized (0.24). The stability
table had no rows for any of them and now does.
MySQL 5.6 portability. The branch stored three policy columns as sa.JSON, the
only JSON columns in the product, and 5.6 has no JSON type: the migration failed
with a bare syntax error near the word JSON. They are TEXT now, through a
JSONText type decorator, so all seventeen call sites still read and write dicts.
The convention elsewhere is already TEXT (guides.blocksjson,
geenforce.manifestjson).
Review fixes carried on top:
- six policy GETs were jwt_required(optional=True), which authenticates a
caller without checking anything; they require computers.view now, and six
redundant jwt_required decorators are gone
- the agent installer took a default BaseUrl and CollectorKey, so a mistyped
run silently pointed an endpoint at the wrong instance; both are mandatory
and a non-https BaseUrl throws unless -AllowInsecureHttp is passed
- a committing CSV import wrote no audit row
Documentation: the 34 new routes are described in docs/api-inventory.json, which
is hand-maintained on purpose, and the generated spec now covers 331 paths and
477 operations across 22 surfaces. DEVELOPMENT-SETUP's 1071 troubleshooting row
said "use MySQL 8 for dev" and now gives the actual fix, including the trap that
5.6 downgrades ROW_FORMAT=DYNAMIC to Compact with a warning instead of an error.
Full suite 2123 passed, vitest 260 passed, all seventeen plugin chains migrate
clean on MySQL 5.6 and the naming, docs, parity and read-surface gates are green.
122 lines
4.8 KiB
Bash
Executable File
122 lines
4.8 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
#
|
|
# test-external-plugin.sh
|
|
#
|
|
# Verify an out-of-tree shopdb-flask plugin against a pinned framework build.
|
|
# Stand up a throwaway copy of the framework, drop the plugin into
|
|
# plugins/<name>/ as a symlink (the mechanism ADR-003 documents for sister
|
|
# sites), and run the framework contract tests plus the plugin's own tests.
|
|
# Nonzero exit means the plugin is not compatible with that framework ref.
|
|
#
|
|
# Two modes:
|
|
#
|
|
# CI / remote (default): clone the framework at FRAMEWORK_REF from
|
|
# FRAMEWORK_URL, build a fresh venv, pip install requirements. Needs
|
|
# network access to git and PyPI.
|
|
#
|
|
# Local / offline: set LOCAL_FRAMEWORK to a framework checkout on disk.
|
|
# The script exports that checkout at HEAD with `git archive` (no network)
|
|
# and reuses the checkout's existing venv, so it runs with no internet.
|
|
#
|
|
# Inputs (env var, or positional):
|
|
# PLUGIN_DIR ($1) path to the plugin directory (holds manifest.json). Required.
|
|
# FRAMEWORK_REF ($2) git ref to test against in CI mode. Default: main.
|
|
# FRAMEWORK_URL framework git URL for CI mode.
|
|
# Default: https://github.com/ge-aero/shopdb-flask.git
|
|
# LOCAL_FRAMEWORK path to an existing framework checkout. Set it to run offline.
|
|
#
|
|
# Examples:
|
|
# # CI: test the plugin in the current repo against a pinned tag
|
|
# PLUGIN_DIR=. FRAMEWORK_REF=v0.5.0 scripts/test-external-plugin.sh
|
|
#
|
|
# # Offline: test a bundled plugin against this checkout, no network
|
|
# LOCAL_FRAMEWORK=. PLUGIN_DIR=plugins/warranty scripts/test-external-plugin.sh
|
|
#
|
|
# Coverage: a symlinked plugin is discovered and loaded by the plugin loader
|
|
# (loadability, manifest validity, core_version range) AND scanned by the
|
|
# import-surface contract test - the scanner resolves each plugin dir before
|
|
# walking, since bare Path.rglob does not descend symlinks. Optionally keep an
|
|
# equivalent import-surface assertion in your own tests/ so violations fail
|
|
# in your repo's CI too (see the PLUGIN-EXTERNAL-REPO wiki page).
|
|
|
|
set -eu
|
|
|
|
PLUGIN_DIR="${PLUGIN_DIR:-${1:-}}"
|
|
FRAMEWORK_REF="${FRAMEWORK_REF:-${2:-main}}"
|
|
FRAMEWORK_URL="${FRAMEWORK_URL:-https://github.com/ge-aero/shopdb-flask.git}"
|
|
LOCAL_FRAMEWORK="${LOCAL_FRAMEWORK:-}"
|
|
|
|
if [ -z "$PLUGIN_DIR" ]; then
|
|
echo "ERROR: PLUGIN_DIR is required (env var or first argument)." >&2
|
|
exit 2
|
|
fi
|
|
if [ ! -f "$PLUGIN_DIR/manifest.json" ]; then
|
|
echo "ERROR: $PLUGIN_DIR has no manifest.json - not a plugin directory." >&2
|
|
exit 2
|
|
fi
|
|
|
|
# Absolute path so the symlink still resolves after we cd into the temp tree.
|
|
PLUGIN_ABS="$(cd "$PLUGIN_DIR" && pwd)"
|
|
# Plugin name: prefer the manifest name, fall back to the directory basename.
|
|
PLUGIN_NAME="$(sed -n 's/.*"name"[[:space:]]*:[[:space:]]*"\([^"]*\)".*/\1/p' "$PLUGIN_ABS/manifest.json" | head -n1)"
|
|
if [ -z "$PLUGIN_NAME" ]; then
|
|
PLUGIN_NAME="$(basename "$PLUGIN_ABS")"
|
|
fi
|
|
|
|
WORKDIR="$(mktemp -d)"
|
|
cleanup() { rm -rf "$WORKDIR"; }
|
|
trap cleanup EXIT
|
|
|
|
FRAMEWORK="$WORKDIR/framework"
|
|
mkdir -p "$FRAMEWORK"
|
|
|
|
if [ -n "$LOCAL_FRAMEWORK" ]; then
|
|
echo "==> Local mode: exporting framework from $LOCAL_FRAMEWORK (HEAD)"
|
|
LOCAL_ABS="$(cd "$LOCAL_FRAMEWORK" && pwd)"
|
|
git -C "$LOCAL_ABS" archive HEAD | tar -x -C "$FRAMEWORK"
|
|
# Reuse the checkout's venv so no pip and no network are needed.
|
|
if [ -x "$LOCAL_ABS/venv/bin/python" ]; then
|
|
PYTHON="$LOCAL_ABS/venv/bin/python"
|
|
elif [ -x "$LOCAL_ABS/.venv/bin/python" ]; then
|
|
PYTHON="$LOCAL_ABS/.venv/bin/python"
|
|
else
|
|
echo "ERROR: no venv found under $LOCAL_ABS (looked for venv/ and .venv/)." >&2
|
|
exit 2
|
|
fi
|
|
else
|
|
echo "==> CI mode: cloning $FRAMEWORK_URL @ $FRAMEWORK_REF"
|
|
git clone --depth 1 --branch "$FRAMEWORK_REF" "$FRAMEWORK_URL" "$FRAMEWORK"
|
|
echo "==> Creating venv and installing requirements"
|
|
python3 -m venv "$WORKDIR/venv"
|
|
PYTHON="$WORKDIR/venv/bin/python"
|
|
"$PYTHON" -m pip install --upgrade pip >/dev/null
|
|
"$PYTHON" -m pip install -r "$FRAMEWORK/requirements-dev.txt"
|
|
fi
|
|
|
|
echo "==> Linking plugin '$PLUGIN_NAME' into framework plugins/"
|
|
rm -rf "$FRAMEWORK/plugins/$PLUGIN_NAME"
|
|
ln -s "$PLUGIN_ABS" "$FRAMEWORK/plugins/$PLUGIN_NAME"
|
|
|
|
# Drop any exported registry so the loader re-discovers and enables the plugin
|
|
# (the test conftest seeds a fresh registry from plugins/*/manifest.json).
|
|
rm -f "$FRAMEWORK/instance/plugins.json"
|
|
|
|
RC=0
|
|
|
|
echo "==> Running framework contract tests"
|
|
( cd "$FRAMEWORK" && "$PYTHON" -m pytest tests/test_plugin_contract.py -q ) || RC=1
|
|
|
|
if [ -d "$PLUGIN_ABS/tests" ]; then
|
|
echo "==> Running plugin's own tests"
|
|
( cd "$FRAMEWORK" && "$PYTHON" -m pytest "$PLUGIN_ABS/tests" -q ) || RC=1
|
|
else
|
|
echo "==> Plugin has no tests/ directory - skipping plugin test step"
|
|
fi
|
|
|
|
if [ "$RC" -eq 0 ]; then
|
|
echo "==> PASS: plugin '$PLUGIN_NAME' is compatible with framework ref '$FRAMEWORK_REF'"
|
|
else
|
|
echo "==> FAIL: plugin '$PLUGIN_NAME' - see output above" >&2
|
|
fi
|
|
exit "$RC"
|