Compare commits
1
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
81164f8494 |
No files matched your search
@@ -275,8 +275,9 @@ export const scenarios = {
|
|||||||
}
|
}
|
||||||
return request(`/scenarios/${id}/export?${params.toString()}`);
|
return request(`/scenarios/${id}/export?${params.toString()}`);
|
||||||
},
|
},
|
||||||
exportE2eTestUrl(id: string): string {
|
exportE2eTestUrl(id: string, version?: number): string {
|
||||||
return `${BASE_URL}/scenarios/${id}/export-e2e`;
|
const query = version === undefined ? '' : `?version=${version}`;
|
||||||
|
return `${BASE_URL}/scenarios/${id}/export-e2e${query}`;
|
||||||
},
|
},
|
||||||
usedSnippets(id: string): Promise<UsedSnippet[]> {
|
usedSnippets(id: string): Promise<UsedSnippet[]> {
|
||||||
return request(`/scenarios/${id}/used-snippets`);
|
return request(`/scenarios/${id}/used-snippets`);
|
||||||
|
|||||||
@@ -504,7 +504,10 @@ export function ScenarioDetailPage() {
|
|||||||
variant="secondary"
|
variant="secondary"
|
||||||
size="sm"
|
size="sm"
|
||||||
onClick={() =>
|
onClick={() =>
|
||||||
handleFileDownload(scenarios.exportE2eTestUrl(id!), `${scenario.name}-e2e-test.zip`)
|
handleFileDownload(
|
||||||
|
scenarios.exportE2eTestUrl(id!, scenario.version),
|
||||||
|
`${scenario.name}-v${scenario.version}-e2e-test.zip`,
|
||||||
|
)
|
||||||
}
|
}
|
||||||
>
|
>
|
||||||
<FileArchive size={14} />
|
<FileArchive size={14} />
|
||||||
|
|||||||
+1
-1
@@ -61,7 +61,7 @@ The server registers the following tools. All entity IDs are UUIDs; list tools a
|
|||||||
| `export_scenario` | Export one scenario version (optional `version`, defaults to the latest) |
|
| `export_scenario` | Export one scenario version (optional `version`, defaults to the latest) |
|
||||||
| `import_scenario` | Import one scenario version; `version` is required (see "Versioning" in [scenario.md](scenario.md)) |
|
| `import_scenario` | Import one scenario version; `version` is required (see "Versioning" in [scenario.md](scenario.md)) |
|
||||||
| `import_yaml` | Import any mix of environments, credentials, snippets and scenarios from YAML (see "Import" in [scenario.md](scenario.md)) |
|
| `import_yaml` | Import any mix of environments, credentials, snippets and scenarios from YAML (see "Import" in [scenario.md](scenario.md)) |
|
||||||
| `export_e2e_test` | Export a scenario as a standalone Playwright test project (zip, base64) |
|
| `export_e2e_test` | Export one scenario version as a standalone Playwright test project (zip, base64; optional `version`, defaults to the latest) |
|
||||||
|
|
||||||
Changes to scenario content (fields and steps) create a new scenario version; credential assignments and files are not versioned.
|
Changes to scenario content (fields and steps) create a new scenario version; credential assignments and files are not versioned.
|
||||||
|
|
||||||
|
|||||||
@@ -114,6 +114,10 @@ steps:
|
|||||||
execCode: await context.page.goto(context.getEnv("base_url"));
|
execCode: await context.page.goto(context.getEnv("base_url"));
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### E2e test export
|
||||||
|
|
||||||
|
`GET /scenarios/:id/export-e2e` (the "Export e2e test" button, the `export_e2e_test` MCP tool) exports one scenario version as a standalone Playwright test project, zipped as `<scenario>-v<N>-e2e-test.zip`. It takes an optional `version` (default: the latest). Snippets are bundled the same way as in the scenario export: the latest version for plain `runSnippet("alias")` calls, plus each version pinned with `alias@N`. The environment, credentials and files are the scenario's current ones; they are not versioned.
|
||||||
|
|
||||||
## Playwright traces
|
## Playwright traces
|
||||||
|
|
||||||
A run can record a [Playwright trace](https://playwright.dev/docs/trace-viewer) of its browser context (screenshots and DOM snapshots). When the run finishes, the trace is uploaded to the run's files as `trace.zip`. Download it from the run detail page, then open it with `npx playwright show-trace trace.zip` or at https://trace.playwright.dev.
|
A run can record a [Playwright trace](https://playwright.dev/docs/trace-viewer) of its browser context (screenshots and DOM snapshots). When the run finishes, the trace is uploaded to the run's files as `trace.zip`. Download it from the run detail page, then open it with `npx playwright show-trace trace.zip` or at https://trace.playwright.dev.
|
||||||
|
|||||||
@@ -1343,15 +1343,21 @@ export class McpService {
|
|||||||
"export_e2e_test",
|
"export_e2e_test",
|
||||||
{
|
{
|
||||||
description:
|
description:
|
||||||
"Export a scenario as a standalone, plug-and-play Playwright e2e test project (package.json, playwright.config.ts, test.spec.ts, .env), zipped and returned as base64",
|
"Export one version of a scenario as a standalone, plug-and-play Playwright e2e test project (package.json, playwright.config.ts, test.spec.ts, .env), zipped and returned as base64",
|
||||||
inputSchema: {
|
inputSchema: {
|
||||||
id: z.uuid().describe("Scenario ID to export"),
|
id: z.uuid().describe("Scenario ID to export"),
|
||||||
|
version: z
|
||||||
|
.number()
|
||||||
|
.int()
|
||||||
|
.min(1)
|
||||||
|
.optional()
|
||||||
|
.describe("Scenario version to export. Defaults to the latest"),
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
async ({ id }) => {
|
async ({ id, version }) => {
|
||||||
try {
|
try {
|
||||||
const { filename, buffer } =
|
const { filename, buffer } =
|
||||||
await this.e2eExportService.buildE2eTestPackage(id);
|
await this.e2eExportService.buildE2eTestPackage(id, version);
|
||||||
return {
|
return {
|
||||||
content: [
|
content: [
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -42,8 +42,16 @@ export class E2eExportService {
|
|||||||
private readonly snippetService: SnippetService,
|
private readonly snippetService: SnippetService,
|
||||||
) {}
|
) {}
|
||||||
|
|
||||||
async buildE2eTestPackage(scenarioId: string): Promise<{ filename: string; buffer: Buffer }> {
|
/** Builds the package for the latest version, or `version` when given. */
|
||||||
|
async buildE2eTestPackage(
|
||||||
|
scenarioId: string,
|
||||||
|
version?: number,
|
||||||
|
): Promise<{ filename: string; buffer: Buffer }> {
|
||||||
const scenario = await this.scenarioService.findOne(scenarioId);
|
const scenario = await this.scenarioService.findOne(scenarioId);
|
||||||
|
const content = await this.scenarioService.findVersion(
|
||||||
|
scenarioId,
|
||||||
|
version ?? scenario.version,
|
||||||
|
);
|
||||||
const [credentialMap, snippetMap, attachedFiles] = await Promise.all([
|
const [credentialMap, snippetMap, attachedFiles] = await Promise.all([
|
||||||
this.scenarioService.buildCredentialMap(scenarioId),
|
this.scenarioService.buildCredentialMap(scenarioId),
|
||||||
this.snippetService.buildSnippetMap(),
|
this.snippetService.buildSnippetMap(),
|
||||||
@@ -51,10 +59,10 @@ export class E2eExportService {
|
|||||||
]);
|
]);
|
||||||
const envData = scenario.environment?.data ?? {};
|
const envData = scenario.environment?.data ?? {};
|
||||||
|
|
||||||
const slug = slugify(scenario.name);
|
const slug = `${slugify(content.name)}-v${content.version}`;
|
||||||
const files: Record<string, string | Buffer> = {
|
const files: Record<string, string | Buffer> = {
|
||||||
"package.json": this.buildPackageJson(slug),
|
"package.json": this.buildPackageJson(slug),
|
||||||
"playwright.config.ts": this.buildPlaywrightConfig(scenario.timeoutSeconds),
|
"playwright.config.ts": this.buildPlaywrightConfig(content.timeoutSeconds),
|
||||||
".env": this.buildEnvFile(envData),
|
".env": this.buildEnvFile(envData),
|
||||||
"credentials.json": JSON.stringify(credentialMap, null, 2) + "\n",
|
"credentials.json": JSON.stringify(credentialMap, null, 2) + "\n",
|
||||||
".gitignore": [
|
".gitignore": [
|
||||||
@@ -65,7 +73,7 @@ export class E2eExportService {
|
|||||||
".env",
|
".env",
|
||||||
"credentials.json",
|
"credentials.json",
|
||||||
].join("\n") + "\n",
|
].join("\n") + "\n",
|
||||||
"README.md": this.buildReadme(scenario.name, scenario.description),
|
"README.md": this.buildReadme(content.name, content.version, content.description),
|
||||||
};
|
};
|
||||||
|
|
||||||
// Bundle any files attached to the scenario so getScenarioFiles works offline.
|
// Bundle any files attached to the scenario so getScenarioFiles works offline.
|
||||||
@@ -97,7 +105,7 @@ export class E2eExportService {
|
|||||||
// Bundle only the snippets actually referenced (directly or transitively via
|
// Bundle only the snippets actually referenced (directly or transitively via
|
||||||
// other snippets) by this scenario's steps, as individual .js files under snippets/.
|
// other snippets) by this scenario's steps, as individual .js files under snippets/.
|
||||||
const usedAliases = resolveUsedSnippetAliases(
|
const usedAliases = resolveUsedSnippetAliases(
|
||||||
scenario.steps.map((s) => s.execCode ?? ""),
|
content.steps.map((s) => s.execCode ?? ""),
|
||||||
snippetMap,
|
snippetMap,
|
||||||
);
|
);
|
||||||
const snippetManifest: { alias: string; filename: string }[] = [];
|
const snippetManifest: { alias: string; filename: string }[] = [];
|
||||||
@@ -116,7 +124,7 @@ export class E2eExportService {
|
|||||||
snippetManifest.push({ alias, filename });
|
snippetManifest.push({ alias, filename });
|
||||||
}
|
}
|
||||||
|
|
||||||
files["test.spec.ts"] = this.buildTestSpec(scenario, snippetManifest, fileManifest);
|
files["test.spec.ts"] = this.buildTestSpec(content, snippetManifest, fileManifest);
|
||||||
|
|
||||||
const buffer = await this.zip(files);
|
const buffer = await this.zip(files);
|
||||||
return { filename: `${slug}-e2e-test.zip`, buffer };
|
return { filename: `${slug}-e2e-test.zip`, buffer };
|
||||||
@@ -173,9 +181,9 @@ export default defineConfig({
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
private buildReadme(scenarioName: string, description: string | null): string {
|
private buildReadme(scenarioName: string, version: number, description: string | null): string {
|
||||||
const descriptionSection = description?.trim() ? `${description.trim()}\n\n` : "";
|
const descriptionSection = description?.trim() ? `${description.trim()}\n\n` : "";
|
||||||
return `# ${scenarioName} - standalone e2e test
|
return `# ${scenarioName} (v${version}) - standalone e2e test
|
||||||
|
|
||||||
${descriptionSection}## Setup
|
${descriptionSection}## Setup
|
||||||
|
|
||||||
|
|||||||
@@ -203,12 +203,17 @@ export class ScenarioController {
|
|||||||
summary: "Export a scenario as a standalone, plug-and-play Playwright e2e test (zip)",
|
summary: "Export a scenario as a standalone, plug-and-play Playwright e2e test (zip)",
|
||||||
})
|
})
|
||||||
@ApiResponse({ status: 200, description: "Zip archive" })
|
@ApiResponse({ status: 200, description: "Zip archive" })
|
||||||
@ApiResponse({ status: 404, description: "Scenario not found" })
|
@ApiResponse({ status: 404, description: "Scenario or version not found" })
|
||||||
async exportE2eTest(
|
async exportE2eTest(
|
||||||
@Param("id", ParseUUIDPipe) id: string,
|
@Param("id", ParseUUIDPipe) id: string,
|
||||||
|
@Query("version", new ParseIntPipe({ optional: true }))
|
||||||
|
version: number | undefined,
|
||||||
@Res() res: Response,
|
@Res() res: Response,
|
||||||
) {
|
) {
|
||||||
const { filename, buffer } = await this.e2eExportService.buildE2eTestPackage(id);
|
const { filename, buffer } = await this.e2eExportService.buildE2eTestPackage(
|
||||||
|
id,
|
||||||
|
version,
|
||||||
|
);
|
||||||
res.setHeader("Content-Type", "application/zip");
|
res.setHeader("Content-Type", "application/zip");
|
||||||
res.setHeader("Content-Disposition", `attachment; filename="${filename}"`);
|
res.setHeader("Content-Disposition", `attachment; filename="${filename}"`);
|
||||||
res.setHeader("Content-Length", buffer.length);
|
res.setHeader("Content-Length", buffer.length);
|
||||||
|
|||||||
@@ -4,6 +4,7 @@
|
|||||||
* - runs record and execute the scenario version they were created with
|
* - runs record and execute the scenario version they were created with
|
||||||
* - runSnippet("alias@N") pins a snippet version
|
* - runSnippet("alias@N") pins a snippet version
|
||||||
* - export/import carry and restore exact versions
|
* - export/import carry and restore exact versions
|
||||||
|
* - e2e test exports build the requested version
|
||||||
*/
|
*/
|
||||||
|
|
||||||
import { INestApplication } from "@nestjs/common";
|
import { INestApplication } from "@nestjs/common";
|
||||||
@@ -12,6 +13,7 @@ import { DataSource } from "typeorm";
|
|||||||
import { buildTestApp } from "./app.harness";
|
import { buildTestApp } from "./app.harness";
|
||||||
import { CredentialEntity } from "../src/credential/credential.entity";
|
import { CredentialEntity } from "../src/credential/credential.entity";
|
||||||
import { EnvironmentEntity } from "../src/environment/environment.entity";
|
import { EnvironmentEntity } from "../src/environment/environment.entity";
|
||||||
|
import { E2eExportService } from "../src/scenario/e2e-export.service";
|
||||||
import { ScenarioSchedulerService } from "../src/scenario/scenario-scheduler.service";
|
import { ScenarioSchedulerService } from "../src/scenario/scenario-scheduler.service";
|
||||||
import { ScenarioService } from "../src/scenario/scenario.service";
|
import { ScenarioService } from "../src/scenario/scenario.service";
|
||||||
import { SnippetService } from "../src/snippet/snippet.service";
|
import { SnippetService } from "../src/snippet/snippet.service";
|
||||||
@@ -367,6 +369,62 @@ describe("Versioning", () => {
|
|||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
|
describe("e2e test export", () => {
|
||||||
|
/** Captures the files the next e2e export zips. */
|
||||||
|
function captureZippedFiles() {
|
||||||
|
const service = app.get(E2eExportService) as unknown as {
|
||||||
|
zip: (files: Record<string, string | Buffer>) => Promise<Buffer>;
|
||||||
|
};
|
||||||
|
const spy = jest.spyOn(service, "zip");
|
||||||
|
return () => {
|
||||||
|
const files = spy.mock.calls[0][0];
|
||||||
|
spy.mockRestore();
|
||||||
|
return files;
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
it("exports the latest version, or the one asked for", async () => {
|
||||||
|
const name = `E2e ${uniq()}`;
|
||||||
|
const slug = name.toLowerCase().replace(" ", "-");
|
||||||
|
const sc = await scenarioService.create({ name });
|
||||||
|
await scenarioService.createStep(sc.id, { execCode: "return 'v2';" });
|
||||||
|
|
||||||
|
let files = captureZippedFiles();
|
||||||
|
const latest = await request(app.getHttpServer())
|
||||||
|
.get(`/scenarios/${sc.id}/export-e2e`)
|
||||||
|
.expect(200);
|
||||||
|
expect(latest.headers["content-disposition"]).toBe(
|
||||||
|
`attachment; filename="${slug}-v2-e2e-test.zip"`,
|
||||||
|
);
|
||||||
|
let zipped = files();
|
||||||
|
expect(zipped["test.spec.ts"]).toContain("return 'v2';");
|
||||||
|
expect(JSON.parse(zipped["package.json"] as string).name).toBe(
|
||||||
|
`${slug}-v2-e2e-test`,
|
||||||
|
);
|
||||||
|
expect(zipped["README.md"]).toContain(`# ${name} (v2)`);
|
||||||
|
|
||||||
|
files = captureZippedFiles();
|
||||||
|
const first = await request(app.getHttpServer())
|
||||||
|
.get(`/scenarios/${sc.id}/export-e2e?version=1`)
|
||||||
|
.expect(200);
|
||||||
|
expect(first.headers["content-disposition"]).toBe(
|
||||||
|
`attachment; filename="${slug}-v1-e2e-test.zip"`,
|
||||||
|
);
|
||||||
|
zipped = files();
|
||||||
|
expect(zipped["test.spec.ts"]).not.toContain("return 'v2';");
|
||||||
|
});
|
||||||
|
|
||||||
|
it("rejects a missing or invalid version", async () => {
|
||||||
|
const sc = await scenarioService.create({ name: `e2e-${uniq()}` });
|
||||||
|
await request(app.getHttpServer())
|
||||||
|
.get(`/scenarios/${sc.id}/export-e2e?version=9`)
|
||||||
|
.expect(404);
|
||||||
|
await request(app.getHttpServer())
|
||||||
|
.get(`/scenarios/${sc.id}/export-e2e?version=abc`)
|
||||||
|
.expect(400);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
describe("snippet export/import", () => {
|
describe("snippet export/import", () => {
|
||||||
it("export includes the version and import requires it", async () => {
|
it("export includes the version and import requires it", async () => {
|
||||||
const alias = `sexp-${uniq()}`;
|
const alias = `sexp-${uniq()}`;
|
||||||
|
|||||||
Reference in new issue
Block a user