mirror of
https://github.com/penpot/penpot.git
synced 2026-08-10 06:48:49 +00:00
* ✨ Add plugin with composable test framework and component tests The plugin provides a framework for writing composable tests against the Plugin API, and applies it to systematic end-to-end testing of component semantics. The framework's core ideas: a test is written once as a composition of operations over a starting configuration; choice points among the operations (optional steps, alternatives) expand the composition into a full sweep of test variants, so a single case definition yields broad combinatorial coverage; and the operations drive the real Plugin API with real change propagation, testing the full production implementation. The initial application is a suite of component test cases covering synchronization, overrides, swap slots and variants — the TypeScript/e2e continuation of the ClojureScript composable test suite (frontend_tests.composable_tests). Several cases originate from reproducing real defects (e.g. #10109 and the swap-slot corruptions). Tests run from an interactive panel in Penpot: cases are listed with plain-language descriptions, tests can be run selectively, results stream in live, and every checkbox carries a stable DOM id — so the panel can equally be driven programmatically (the basis for running the suite in CI), as documented in the plugin's README. Lives at plugins/apps/composable-test-suite as a regular member of the plugins workspace (init script, start:plugin:composable-test-suite, shared dev port 4202, covered by build:plugins via the new ./apps/*-test-suite filter). Related to #10584. AI-assisted-by: claude-fable-5 * ✨ Run the composable test suite headlessly in CI Adds a headless run mode for the composable test suite, following the plugin-api-test-suite's CI architecture, and a workflow that runs it as a per-PR gate. An in-sandbox entry (src/ci/headless.ts) runs the suite without the panel UI — the framework's runner was UI-free by construction, so no refactoring was needed — and streams each result through console markers, addressed by the same composite identifiers the panel uses (e.g. MainEditSyncs-2), with durations and, on failure, the error and the applied-steps transcript. It is built as a single self-executing bundle and evaluated directly inside a real Penpot plugin sandbox by the driver (ci/run-ci.ts), so no plugin dev server or port is involved. The driver needs no backend and no login: it serves the prebuilt frontend bundle via the frontend e2e static server and intercepts every backend RPC with Playwright fixtures. The mocked backend is not a limitation for this suite — everything it asserts is frontend store logic executed in memory — which the full run confirms: all 48 tests behave identically to the interactive panel, including variants and swap slots, with the single (currently expected) failure of MainEditSyncs-2 reproducing bug #10109 under the mock. TEST_FILTER selects tests by identifier substring; CI_TIMEOUT_MS bounds the run. The mock harness mirrors the frontend e2e harness (see the provenance note in the driver). Related to #10584. AI-assisted-by: claude-fable-5 * 📚 Restructure the composable-tests memory around both suites Present the composable component tests top-down: the shared framework principles upfront, then the two implementations — the ClojureScript suite in the frontend test tree and the TypeScript suite in the plugin, which tests fully end-to-end with a slightly more elaborate set of abstractions — and the plugin's headless CI run, pointing to the plugin's README for operational details. Also records this session's additions (geometry operations, case N, the CI harness). AI-assisted-by: claude-fable-5 * 📎 Refine the PR-description conventions in the creating-prs memory Encourage digestible descriptions: bullet items over prose (grouped by area with bold lead-ins for larger PRs) and no manual line wraps, since the rendered markdown adapts to the viewport. Also drop the outdated 'MCP' from the standard Note line. AI-assisted-by: claude-fable-5 * 🔧 Set Prettier endOfLine to auto in plugins workspace Prettier defaults to endOfLine "lf", which is incompatible with checkouts on Windows that use core.autocrlf=true * 🐛 Fix problems with suite --------- Co-authored-by: alonso.torres <alonso.torres@kaleidos.net>
60 lines
2.2 KiB
TypeScript
60 lines
2.2 KiB
TypeScript
import { createTestSuite, TestSuite, TestRunObserver, TestResult } from "./composable-tests";
|
|
|
|
// The plugin sandbox: it has the `penpot` API but no DOM. It enumerates the test
|
|
// suite once, sends the tree to the UI to render, and runs whichever tests the UI
|
|
// selects — forwarding each test's start/finish (addressed by stable id) so the UI
|
|
// can update the matching row.
|
|
|
|
penpot.ui.open("Composable Tests", `?theme=${penpot.theme}`, { width: 420, height: 640 });
|
|
|
|
penpot.on("themechange", (theme) => {
|
|
penpot.ui.sendMessage({ type: "theme", theme });
|
|
});
|
|
|
|
// enumerate once; the tree the UI renders and the runs it requests share these ids
|
|
const suite: TestSuite = createTestSuite();
|
|
|
|
/** Sends the enumerated tree for the UI to render (all tests, not yet run). */
|
|
function sendTree(): void {
|
|
penpot.ui.sendMessage({ type: "test-tree", tree: suite.tree() });
|
|
}
|
|
|
|
/** A `TestRunObserver` that forwards each test's state change to the UI by id. */
|
|
class UiReportingObserver implements TestRunObserver {
|
|
onTestStarted(id: string): void {
|
|
penpot.ui.sendMessage({ type: "test-started", id });
|
|
}
|
|
|
|
onTestFinished(id: string, result: TestResult): void {
|
|
penpot.ui.sendMessage({
|
|
type: "test-finished",
|
|
id,
|
|
result: {
|
|
passed: result.passed,
|
|
errorMessage: result.errorMessage,
|
|
transcript: [...result.transcript],
|
|
},
|
|
});
|
|
}
|
|
}
|
|
|
|
penpot.ui.onMessage<{ type?: string; ids?: string[] }>((message) => {
|
|
if (typeof message !== "object" || message === null) return;
|
|
|
|
if (message.type === "ready") {
|
|
sendTree();
|
|
} else if (message.type === "run-tests") {
|
|
const ids = message.ids ?? [];
|
|
suite
|
|
.run(ids, new UiReportingObserver())
|
|
.then(() => penpot.ui.sendMessage({ type: "run-complete" }))
|
|
.catch((error: unknown) => {
|
|
const errorMessage = error instanceof Error ? error.message : String(error);
|
|
penpot.ui.sendMessage({ type: "run-error", errorMessage });
|
|
});
|
|
}
|
|
});
|
|
|
|
// in case the UI loaded before this handler was registered, also send the tree now
|
|
sendTree();
|