playwright-e2e-mcp 0.6.1 → 0.8.0

package/dist/utils/pytest-runner.d.ts

@@ -0,0 +1,102 @@
+/**
+ * Python support: run pytest-playwright suites through the same tools.
+ *
+ * A Python project has no node_modules and no playwright.config, so the
+ * Node runner cannot touch it. This module runs `python -m pytest` instead
+ * and turns its results into the same RunTestResult the Node runner
+ * returns, so run-test, get-failure (traces included), list-tests,
+ * analyze-history and the ci command work unchanged.
+ *
+ * Results come from a small pytest plugin the server writes to its temp
+ * directory and loads with `-p` (nothing is installed in the project). It
+ * appends one JSON line per test as the test finishes: node id, absolute
+ * file and line, outcome, the full failure text, the crash location and
+ * the trace files pytest-playwright kept. Because lines are written as
+ * tests end, a run that is killed still reports the tests that finished.
+ *
+ * The project's own Python is used: PW_MCP_PYTHON, else a virtualenv in
+ * the project (.venv, venv, env), else python3 / python on PATH.
+ */
+import type { DiscoveredTest, ErrorKind, ListTestsResult, ReportStats, RunTestOptions, RunTestResult, TestFailure, TestOutcome } from '../types/index.js';
+/** Environment variable naming the JSONL file the plugin appends to. */
+export declare const PYTEST_RESULTS_ENV = "PW_MCP_PYTEST_RESULTS";
+/**
+ * Whether the folder is a pytest project, and which file says so:
+ * pytest.ini, a [tool.pytest…] table in pyproject.toml, [tool:pytest] in
+ * setup.cfg, [pytest] in tox.ini, or a conftest.py at the root or in tests/.
+ */
+export declare function detectPytestProject(root: string): Promise<{
+    marker: string;
+} | null>;
+/** The Python to run: PW_MCP_PYTHON, a project virtualenv, or python3 / python. */
+export declare function resolvePython(root: string): Promise<string>;
+/** Folder holding the plugin module, added to PYTHONPATH for the run. */
+export declare function pytestPluginDir(): Promise<string>;
+export interface ParsedPytestResults {
+    stats: ReportStats;
+    failures: TestFailure[];
+    failuresTruncated: boolean;
+    outcomes: TestOutcome[];
+    tests: DiscoveredTest[];
+    collected?: number;
+    exitStatus?: number;
+}
+/** Split a node id into file, readable title and browser project. */
+export declare function describeNodeId(nodeid: string): {
+    file: string;
+    title: string;
+    project?: string;
+};
+/**
+ * The failure's code frame: the source lines pytest prints with `>` at the
+ * failing line, up to the first `E` line that follows.
+ */
+export declare function pytestCodeFrame(longrepr: string): string | undefined;
+/**
+ * The test file's own line in a traceback: pytest prints `path:LINE: Error`
+ * for each frame, and the crash itself is often inside Playwright, so take
+ * the last frame that is in the test file.
+ */
+export declare function testFileLine(longrepr: string, file: string): number | undefined;
+/**
+ * The traceback without the frames inside Playwright and other libraries:
+ * pytest separates frames with \`_ _ _\` lines; keep the test's own frames
+ * (those that mention the test file) and the final \`E\` lines.
+ */
+export declare function shortTraceback(longrepr: string, max?: number): string;
+/** Expected / actual values from a Playwright Python assertion message. */
+export declare function expectedActual(message: string): {
+    expected?: string;
+    actual?: string;
+};
+/**
+ * Turn the plugin's JSONL into failures, outcomes and stats. Paths become
+ * project-relative; malformed lines (a write cut off by a kill) are skipped.
+ */
+export declare function parsePytestResults(raw: string, root: string, maxFailures?: number): ParsedPytestResults;
+/**
+ * Turn `file.py:LINE` into the node id of the test defined at or above that
+ * line (`file.py::TestCart::test_add`), so get-failure's re-run hints work
+ * for pytest too. `file.py::name` and plain paths pass through.
+ */
+export declare function nodeIdForLine(relativeFile: string, source: string, line: number): string;
+/** Run-level problems pytest reports on stderr/stdout instead of per test. */
+export declare function diagnosePytestOutput(text: string, exitCode: number | null): {
+    errorKind: ErrorKind;
+    errorMessage: string;
+    hint: string;
+} | null;
+/** Run a pytest-playwright suite and return the same result shape as the Node runner. */
+export declare function runPytest(options: RunTestOptions): Promise<RunTestResult>;
+/**
+ * List a pytest project's tests: `pytest --collect-only -q` when allowed to
+ * run project code, a scan of test_*.py / *_test.py files otherwise (or
+ * when collection fails, with the reason).
+ */
+export declare function listPytestTests(options: {
+    projectRoot: string;
+    filter?: string;
+    limit?: number;
+    signal?: AbortSignal;
+    noSpawn?: boolean;
+}): Promise<ListTestsResult>;