feat(import): add central yaml import for all exportable kinds
- add POST /import, an import page and the import_yaml mcp tool; items are validated up front and imported in dependency order - switch list page import buttons to the central import - write scenario exports as separate --- yaml documents per entity - give each test app its own files dir to avoid cross-suite races - use node: prefix for node built-in imports - bump version to 1.18.0
This commit is contained in:
1 parent
cf56840df9
commit
8935783371
39 files changed
+848
-130
No files matched your search
@@ -2,6 +2,22 @@
|
||||
|
||||
All notable changes to this project will be documented in this file.
|
||||
|
||||
## 1.18.0 - 2026-09-30
|
||||
|
||||
Changes since 1.17.0:
|
||||
|
||||
### Added
|
||||
|
||||
- Added a central import: `POST /import`, an Import page in the UI, and the `import_yaml` MCP tool. It takes YAML made of `---`-separated documents, each holding one exported item or a list of items (JSON is accepted too), with any mix of environments, credentials, snippets and scenarios. All items are validated before anything is imported, and they are imported in dependency order (environments, credentials, snippets, scenarios), so a scenario can reference an environment or credential from the same file.
|
||||
|
||||
### Changed
|
||||
|
||||
- The Import buttons on the scenario, snippet, credential and environment list pages use the central import. When the file holds exactly one item of the page's kind, that item is opened; otherwise the Import page shows everything that was imported.
|
||||
|
||||
### Fixed
|
||||
|
||||
- Scenario exports that included the environment or credentials were not valid YAML (all entities were written into one document). Each entity is now a separate `---` document.
|
||||
|
||||
## 1.17.0 - 2026-09-30
|
||||
|
||||
Changes since 1.16.1:
|
||||
|
||||
@@ -43,7 +43,8 @@ cd client && npm run lint && npm run build
|
||||
|
||||
- Lint must stay clean in both packages (no errors, no warnings).
|
||||
- Don't run prettier over whole existing files; several aren't prettier-clean and it produces unrelated diffs. Format only new files or the lines you changed.
|
||||
- Server tests use an in-memory DB and a Playwright mock (`server/test/__mocks__/playwright.ts`). They create `server/data/` (git-ignored).
|
||||
- Server tests use an in-memory DB, a Playwright mock (`server/test/__mocks__/playwright.ts`), and a temporary files directory per test app (see `server/test/app.harness.ts`).
|
||||
- Import Node.js built-in modules with the `node:` prefix (`node:fs`, `node:path`, `node:crypto`, ...).
|
||||
|
||||
## Committing a new version
|
||||
|
||||
|
||||
+7
-1
@@ -1,7 +1,7 @@
|
||||
import { lazy, Suspense } from 'react';
|
||||
import { NavLink, Navigate, Route, Routes } from 'react-router-dom';
|
||||
import { useTranslation } from 'react-i18next';
|
||||
import { Globe, Monitor, ClipboardList, Activity, KeyRound, Braces } from 'lucide-react';
|
||||
import { Globe, Monitor, ClipboardList, Activity, KeyRound, Braces, Upload } from 'lucide-react';
|
||||
import type { LucideIcon } from 'lucide-react';
|
||||
import styles from './App.module.css';
|
||||
import { SidePanel, ThemeSwitcher } from './ui';
|
||||
@@ -89,6 +89,9 @@ const EditSnippetPage = lazy(() =>
|
||||
const SnippetDetailPage = lazy(() =>
|
||||
import('./pages/snippet/SnippetDetailPage').then((m) => ({ default: m.SnippetDetailPage })),
|
||||
);
|
||||
const ImportPage = lazy(() =>
|
||||
import('./pages/import/ImportPage').then((m) => ({ default: m.ImportPage })),
|
||||
);
|
||||
|
||||
const NAV: ({ path: string; labelKey: string; Icon: LucideIcon } | { separator: true })[] = [
|
||||
{ path: '/runs', labelKey: 'nav.runs', Icon: Activity },
|
||||
@@ -98,6 +101,8 @@ const NAV: ({ path: string; labelKey: string; Icon: LucideIcon } | { separator:
|
||||
{ path: '/snippets', labelKey: 'nav.snippets', Icon: Braces },
|
||||
{ path: '/credentials', labelKey: 'nav.credentials', Icon: KeyRound },
|
||||
{ path: '/environments', labelKey: 'nav.environments', Icon: Globe },
|
||||
{ separator: true },
|
||||
{ path: '/import', labelKey: 'nav.import', Icon: Upload },
|
||||
];
|
||||
|
||||
export default function App() {
|
||||
@@ -163,6 +168,7 @@ export default function App() {
|
||||
<Route path="/credentials/:id/edit" element={<EditCredentialPage />} />
|
||||
<Route path="/credentials/:id" element={<CredentialDetailPage />} />
|
||||
<Route path="/snippets" element={<SnippetsPage />} />
|
||||
<Route path="/import" element={<ImportPage />} />
|
||||
<Route path="/snippets/new" element={<CreateSnippetPage />} />
|
||||
<Route path="/snippets/:id/edit" element={<EditSnippetPage />} />
|
||||
<Route path="/snippets/:id" element={<SnippetDetailPage />} />
|
||||
|
||||
+17
-24
@@ -4,6 +4,7 @@ import type {
|
||||
Environment,
|
||||
FileMetadata,
|
||||
FileListResponse,
|
||||
ImportResult,
|
||||
RunDefaults,
|
||||
ScenarioCredential,
|
||||
Session,
|
||||
@@ -88,12 +89,6 @@ export const credentials = {
|
||||
exportCredential(id: string): Promise<unknown> {
|
||||
return request(`/credentials/${id}/export`);
|
||||
},
|
||||
importCredential(payload: unknown): Promise<Credential> {
|
||||
return request('/credentials/import', {
|
||||
method: 'POST',
|
||||
body: JSON.stringify(payload),
|
||||
});
|
||||
},
|
||||
};
|
||||
|
||||
// ── Snippets ──────────────────────────────────────────────────────────────────
|
||||
@@ -131,12 +126,6 @@ export const snippets = {
|
||||
exportSnippet(id: string): Promise<unknown> {
|
||||
return request(`/snippets/${id}/export`);
|
||||
},
|
||||
importSnippet(payload: unknown): Promise<Snippet> {
|
||||
return request('/snippets/import', {
|
||||
method: 'POST',
|
||||
body: JSON.stringify(payload),
|
||||
});
|
||||
},
|
||||
};
|
||||
|
||||
// ── Environments ──────────────────────────────────────────────────────────────
|
||||
@@ -169,12 +158,6 @@ export const environments = {
|
||||
exportEnvironment(id: string): Promise<unknown> {
|
||||
return request(`/environments/${id}/export`);
|
||||
},
|
||||
importEnvironment(payload: unknown): Promise<Environment> {
|
||||
return request('/environments/import', {
|
||||
method: 'POST',
|
||||
body: JSON.stringify(payload),
|
||||
});
|
||||
},
|
||||
};
|
||||
|
||||
// ── Sessions ──────────────────────────────────────────────────────────────────
|
||||
@@ -276,12 +259,6 @@ export const scenarios = {
|
||||
}
|
||||
return request(`/scenarios/${id}/export?${params.toString()}`);
|
||||
},
|
||||
importScenario(payload: unknown): Promise<Scenario> {
|
||||
return request('/scenarios/import', {
|
||||
method: 'POST',
|
||||
body: JSON.stringify(payload),
|
||||
});
|
||||
},
|
||||
exportE2eTestUrl(id: string): string {
|
||||
return `${BASE_URL}/scenarios/${id}/export-e2e`;
|
||||
},
|
||||
@@ -415,3 +392,19 @@ export const runFiles = {
|
||||
});
|
||||
},
|
||||
};
|
||||
|
||||
// ── Import ────────────────────────────────────────────────────────────────────
|
||||
|
||||
export const imports = {
|
||||
/**
|
||||
* Imports any mix of environments, credentials, snippets and scenarios from
|
||||
* YAML (`---`-separated documents, each one item or a list of items).
|
||||
*/
|
||||
yaml(text: string): Promise<ImportResult> {
|
||||
return request('/import', {
|
||||
method: 'POST',
|
||||
headers: { 'Content-Type': 'application/yaml' },
|
||||
body: text,
|
||||
});
|
||||
},
|
||||
};
|
||||
@@ -214,3 +214,19 @@ export interface FileListResponse {
|
||||
items: FileMetadata[];
|
||||
total: number;
|
||||
}
|
||||
|
||||
// ── Import ────────────────────────────────────────────────────────────────────
|
||||
|
||||
export type ImportKind = 'environment' | 'credential' | 'snippet' | 'scenario';
|
||||
|
||||
export interface ImportedItem {
|
||||
kind: ImportKind;
|
||||
id: string;
|
||||
name: string;
|
||||
/** Version stored for versioned kinds (snippets, scenarios). */
|
||||
version?: number;
|
||||
}
|
||||
|
||||
export interface ImportResult {
|
||||
imported: ImportedItem[];
|
||||
}
|
||||
@@ -0,0 +1,43 @@
|
||||
import type { ChangeEvent } from 'react';
|
||||
import { useNavigate } from 'react-router-dom';
|
||||
import { useTranslation } from 'react-i18next';
|
||||
import { imports } from '../api';
|
||||
import type { ImportedItem, ImportKind } from '../api';
|
||||
import { useToast } from '../ui';
|
||||
|
||||
/** Detail page path of an imported item. */
|
||||
export function importedItemPath(item: ImportedItem): string {
|
||||
return `/${item.kind}s/${item.id}`;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a file input `onChange` handler that imports the chosen YAML file
|
||||
* through the central import. When the file holds exactly one item of `kind`
|
||||
* (e.g. a scenario export with its environment), opens that item; otherwise
|
||||
* opens the import page with the full result.
|
||||
*/
|
||||
export function useImportFile(kind: ImportKind) {
|
||||
const navigate = useNavigate();
|
||||
const toast = useToast();
|
||||
const { t } = useTranslation();
|
||||
|
||||
return async (e: ChangeEvent<HTMLInputElement>) => {
|
||||
const file = e.target.files?.[0];
|
||||
if (!file) return;
|
||||
e.target.value = '';
|
||||
try {
|
||||
const result = await imports.yaml(await file.text());
|
||||
const own = result.imported.filter((item) => item.kind === kind);
|
||||
if (own.length === 1) {
|
||||
if (result.imported.length > 1) {
|
||||
toast.success(t('import.imported_count', { count: result.imported.length }));
|
||||
}
|
||||
navigate(importedItemPath(own[0]));
|
||||
} else {
|
||||
navigate('/import', { state: { results: [{ fileName: file.name, result }] } });
|
||||
}
|
||||
} catch {
|
||||
// error toast is already emitted by the API client
|
||||
}
|
||||
};
|
||||
}
|
||||
@@ -28,7 +28,24 @@
|
||||
"keys": "Keys",
|
||||
"sessions": "Sessions",
|
||||
"scenarios": "Scenarios",
|
||||
"runs": "Runs"
|
||||
"runs": "Runs",
|
||||
"import": "Import"
|
||||
},
|
||||
"import": {
|
||||
"title": "Import",
|
||||
"action_choose": "Choose files",
|
||||
"description": "Import exported environments, credentials, snippets and scenarios. Each YAML file may hold several items as ---separated documents, and each document may hold one item or a list of items. JSON files work too.",
|
||||
"description_validation": "Every item in a file is checked before anything is imported: if one item is invalid, nothing from that file is imported. Items are imported in dependency order (environments, credentials, snippets, scenarios), and snippets and scenarios keep the version they were exported with.",
|
||||
"imported_count_one": "Imported {{count}} item",
|
||||
"imported_count_other": "Imported {{count}} items",
|
||||
"col_file": "File",
|
||||
"col_kind": "Kind",
|
||||
"col_name": "Name",
|
||||
"col_version": "Version",
|
||||
"kind_environment": "Environment",
|
||||
"kind_credential": "Credential",
|
||||
"kind_snippet": "Snippet",
|
||||
"kind_scenario": "Scenario"
|
||||
},
|
||||
"environments": {
|
||||
"title": "Environments",
|
||||
|
||||
@@ -2,8 +2,8 @@ import { useEffect, useRef, useState } from 'react';
|
||||
import { useNavigate } from 'react-router-dom';
|
||||
import { useTranslation } from 'react-i18next';
|
||||
import { usePageTitle } from '../../hooks/usePageTitle';
|
||||
import { useImportFile } from '../../hooks/useImportFile';
|
||||
import { Settings, Pencil, Trash2, Plus, Download, KeyRound } from 'lucide-react';
|
||||
import { parse as yamlParse } from 'yaml';
|
||||
import { credentials } from '../../api';
|
||||
import type { Credential } from '../../api';
|
||||
import {
|
||||
@@ -102,7 +102,6 @@ function AddCredentialCard() {
|
||||
export function CredentialsPage() {
|
||||
const { t } = useTranslation();
|
||||
usePageTitle(t('credentials.title'));
|
||||
const navigate = useNavigate();
|
||||
const [items, setItems] = useState<Credential[]>([]);
|
||||
const [loading, setLoading] = useState(true);
|
||||
const [deleteId, setDeleteId] = useState<string | null>(null);
|
||||
@@ -136,19 +135,7 @@ export function CredentialsPage() {
|
||||
}
|
||||
};
|
||||
|
||||
const handleImport = async (e: React.ChangeEvent<HTMLInputElement>) => {
|
||||
const file = e.target.files?.[0];
|
||||
if (!file) return;
|
||||
e.target.value = '';
|
||||
try {
|
||||
const text = await file.text();
|
||||
const payload = yamlParse(text) as unknown;
|
||||
const imported = await credentials.importCredential(payload);
|
||||
navigate(`/credentials/${imported.id}`);
|
||||
} catch {
|
||||
// Import errors are silently ignored
|
||||
}
|
||||
};
|
||||
const handleImport = useImportFile('credential');
|
||||
|
||||
return (
|
||||
<div>
|
||||
|
||||
@@ -2,8 +2,8 @@ import { useEffect, useRef, useState } from 'react';
|
||||
import { useNavigate } from 'react-router-dom';
|
||||
import { useTranslation } from 'react-i18next';
|
||||
import { usePageTitle } from '../../hooks/usePageTitle';
|
||||
import { useImportFile } from '../../hooks/useImportFile';
|
||||
import { Settings, ExternalLink, Pencil, Trash2, Plus, Globe, Download } from 'lucide-react';
|
||||
import { parse as yamlParse } from 'yaml';
|
||||
import { stringify as yamlStringify } from 'yaml';
|
||||
import { environments } from '../../api';
|
||||
import type { Environment } from '../../api';
|
||||
@@ -119,7 +119,6 @@ function AddEnvironmentCard() {
|
||||
export function EnvironmentsPage() {
|
||||
const { t } = useTranslation();
|
||||
usePageTitle(t('environments.title'));
|
||||
const navigate = useNavigate();
|
||||
const [items, setItems] = useState<Environment[]>([]);
|
||||
const [loading, setLoading] = useState(true);
|
||||
const [deleteId, setDeleteId] = useState<string | null>(null);
|
||||
@@ -153,19 +152,7 @@ export function EnvironmentsPage() {
|
||||
}
|
||||
};
|
||||
|
||||
const handleImport = async (e: React.ChangeEvent<HTMLInputElement>) => {
|
||||
const file = e.target.files?.[0];
|
||||
if (!file) return;
|
||||
e.target.value = '';
|
||||
try {
|
||||
const text = await file.text();
|
||||
const payload = yamlParse(text) as unknown;
|
||||
const imported = await environments.importEnvironment(payload);
|
||||
navigate(`/environments/${imported.id}`);
|
||||
} catch {
|
||||
// Import errors are silently ignored
|
||||
}
|
||||
};
|
||||
const handleImport = useImportFile('environment');
|
||||
|
||||
return (
|
||||
<div>
|
||||
|
||||
@@ -0,0 +1,116 @@
|
||||
import { useRef, useState, type ChangeEvent } from 'react';
|
||||
import { useLocation, useNavigate } from 'react-router-dom';
|
||||
import { useTranslation } from 'react-i18next';
|
||||
import { Upload } from 'lucide-react';
|
||||
import { usePageTitle } from '../../hooks/usePageTitle';
|
||||
import { importedItemPath } from '../../hooks/useImportFile';
|
||||
import { imports } from '../../api';
|
||||
import type { ImportedItem, ImportResult } from '../../api';
|
||||
import { Badge, Breadcrumbs, Button, Card, Table, type TableColumn } from '../../ui';
|
||||
import styles from '../Page.module.css';
|
||||
|
||||
interface FileResult {
|
||||
fileName: string;
|
||||
result: ImportResult;
|
||||
}
|
||||
|
||||
type Row = ImportedItem & { fileName: string; rowKey: string };
|
||||
|
||||
export function ImportPage() {
|
||||
const { t } = useTranslation();
|
||||
usePageTitle(t('import.title'));
|
||||
const navigate = useNavigate();
|
||||
const location = useLocation();
|
||||
const fileInputRef = useRef<HTMLInputElement>(null);
|
||||
// List pages hand over the result of an import they ran
|
||||
const [results, setResults] = useState<FileResult[]>(
|
||||
() => (location.state as { results?: FileResult[] } | null)?.results ?? [],
|
||||
);
|
||||
const [importing, setImporting] = useState(false);
|
||||
|
||||
const handleFiles = async (e: ChangeEvent<HTMLInputElement>) => {
|
||||
const files = Array.from(e.target.files ?? []);
|
||||
e.target.value = '';
|
||||
if (files.length === 0) return;
|
||||
setImporting(true);
|
||||
const next: FileResult[] = [];
|
||||
try {
|
||||
for (const file of files) {
|
||||
try {
|
||||
next.push({ fileName: file.name, result: await imports.yaml(await file.text()) });
|
||||
} catch {
|
||||
// error toast is already emitted by the API client; nothing from
|
||||
// this file was imported, continue with the next one
|
||||
}
|
||||
}
|
||||
} finally {
|
||||
setResults(next);
|
||||
setImporting(false);
|
||||
}
|
||||
};
|
||||
|
||||
const rows: Row[] = results.flatMap(({ fileName, result }) =>
|
||||
result.imported.map((item, i) => ({ ...item, fileName, rowKey: `${fileName}-${i}` })),
|
||||
);
|
||||
|
||||
const columns: TableColumn<Row>[] = [
|
||||
{ key: 'fileName', header: t('import.col_file'), render: (r) => r.fileName },
|
||||
{
|
||||
key: 'kind',
|
||||
header: t('import.col_kind'),
|
||||
width: 120,
|
||||
render: (r) => <Badge variant="neutral">{t(`import.kind_${r.kind}`)}</Badge>,
|
||||
},
|
||||
{ key: 'name', header: t('import.col_name'), render: (r) => r.name },
|
||||
{
|
||||
key: 'version',
|
||||
header: t('import.col_version'),
|
||||
width: 90,
|
||||
render: (r) =>
|
||||
r.version != null ? `v${r.version}` : <span className={styles.muted}>–</span>,
|
||||
},
|
||||
];
|
||||
|
||||
return (
|
||||
<div>
|
||||
<div className={styles.pageToolbar}>
|
||||
<Breadcrumbs items={[{ label: t('import.title'), icon: <Upload size={14} /> }]} />
|
||||
<div className={styles.toolbarActions}>
|
||||
<input
|
||||
ref={fileInputRef}
|
||||
type="file"
|
||||
accept=".yaml,.yml,.json"
|
||||
multiple
|
||||
style={{ display: 'none' }}
|
||||
onChange={handleFiles}
|
||||
/>
|
||||
<Button size="sm" onClick={() => fileInputRef.current?.click()} disabled={importing}>
|
||||
<Upload size={14} />
|
||||
{t('import.action_choose')}
|
||||
</Button>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<Card>
|
||||
<p>{t('import.description')}</p>
|
||||
<p className={styles.muted}>{t('import.description_validation')}</p>
|
||||
</Card>
|
||||
|
||||
{rows.length > 0 && (
|
||||
<div className={styles.stepsSection}>
|
||||
<h2 className={styles.sectionHeading}>
|
||||
{t('import.imported_count', { count: rows.length })}
|
||||
</h2>
|
||||
<Table<Row>
|
||||
columns={columns}
|
||||
data={rows}
|
||||
rowKey={(r) => r.rowKey}
|
||||
loading={false}
|
||||
emptyMessage=""
|
||||
onRowClick={(r) => navigate(importedItemPath(r))}
|
||||
/>
|
||||
</div>
|
||||
)}
|
||||
</div>
|
||||
);
|
||||
}
|
||||
@@ -2,8 +2,8 @@ import { useCallback, useEffect, useRef, useState } from 'react';
|
||||
import { useNavigate } from 'react-router-dom';
|
||||
import { useTranslation } from 'react-i18next';
|
||||
import { usePageTitle } from '../../hooks/usePageTitle';
|
||||
import { useImportFile } from '../../hooks/useImportFile';
|
||||
import { Play, Plus, Trash2, Download, ClipboardList } from 'lucide-react';
|
||||
import { parse as yamlParse } from 'yaml';
|
||||
import { environments, scenarios } from '../../api';
|
||||
import type { Environment, Scenario, ScenarioVersion, TraceMode } from '../../api';
|
||||
import { RunScenarioModal } from '../../components/modals';
|
||||
@@ -159,19 +159,7 @@ export function ScenariosPage() {
|
||||
}
|
||||
};
|
||||
|
||||
const handleImport = async (e: React.ChangeEvent<HTMLInputElement>) => {
|
||||
const file = e.target.files?.[0];
|
||||
if (!file) return;
|
||||
e.target.value = '';
|
||||
try {
|
||||
const text = await file.text();
|
||||
const payload = yamlParse(text) as unknown;
|
||||
const imported = await scenarios.importScenario(payload);
|
||||
navigate(`/scenarios/${imported.id}`);
|
||||
} catch {
|
||||
// Import errors are silently ignored
|
||||
}
|
||||
};
|
||||
const handleImport = useImportFile('scenario');
|
||||
|
||||
const columns: TableColumn<Scenario>[] = [
|
||||
{ key: 'id', header: t('scenarios.col_id'), render: (s) => <UuidBadge id={s.id} />, width: 60 },
|
||||
|
||||
@@ -2,8 +2,8 @@ import { useEffect, useRef, useState } from 'react';
|
||||
import { useNavigate } from 'react-router-dom';
|
||||
import { useTranslation } from 'react-i18next';
|
||||
import { usePageTitle } from '../../hooks/usePageTitle';
|
||||
import { useImportFile } from '../../hooks/useImportFile';
|
||||
import { Settings, Pencil, Trash2, Plus, Download, Braces } from 'lucide-react';
|
||||
import { parse as yamlParse } from 'yaml';
|
||||
import { snippets } from '../../api';
|
||||
import type { Snippet } from '../../api';
|
||||
import {
|
||||
@@ -117,7 +117,6 @@ function AddSnippetCard() {
|
||||
export function SnippetsPage() {
|
||||
const { t } = useTranslation();
|
||||
usePageTitle(t('snippets.title'));
|
||||
const navigate = useNavigate();
|
||||
const [items, setItems] = useState<Snippet[]>([]);
|
||||
const [loading, setLoading] = useState(true);
|
||||
const [deleteId, setDeleteId] = useState<string | null>(null);
|
||||
@@ -151,19 +150,7 @@ export function SnippetsPage() {
|
||||
}
|
||||
};
|
||||
|
||||
const handleImport = async (e: React.ChangeEvent<HTMLInputElement>) => {
|
||||
const file = e.target.files?.[0];
|
||||
if (!file) return;
|
||||
e.target.value = '';
|
||||
try {
|
||||
const text = await file.text();
|
||||
const payload = yamlParse(text) as unknown;
|
||||
const imported = await snippets.importSnippet(payload);
|
||||
navigate(`/snippets/${imported.id}`);
|
||||
} catch {
|
||||
// Import errors are silently ignored
|
||||
}
|
||||
};
|
||||
const handleImport = useImportFile('snippet');
|
||||
|
||||
return (
|
||||
<div>
|
||||
|
||||
@@ -51,6 +51,7 @@ The server currently registers the following tools.
|
||||
| `wait_for_scenario_run` | Wait until run is `pass` or `fail` |
|
||||
| `export_scenario` | Export one scenario version (optional `version`, defaults to latest) |
|
||||
| `import_scenario` | Import one scenario version; `version` is required (see "Versioning" in `scenario.md`) |
|
||||
| `import_yaml` | Import any mix of environments, credentials, snippets and scenarios from YAML (see "Import" in `scenario.md`) |
|
||||
|
||||
## Snippets
|
||||
|
||||
|
||||
@@ -61,6 +61,38 @@ Exports hold exactly one version and always include its `version` number (the la
|
||||
- Otherwise it is stored under that number, and becomes the latest if it is higher than the current latest version.
|
||||
- Without an `id`, a new scenario or snippet is created at the given version.
|
||||
|
||||
## Import
|
||||
|
||||
`POST /import` (the Import page in the UI, and the Import buttons on the list pages; the `import_yaml` MCP tool) imports any mix of environments, credentials, snippets and scenarios.
|
||||
|
||||
- Send YAML with `Content-Type: application/yaml`. A file is a stream of `---`-separated documents; each document holds one exported item or a list of items. JSON is valid YAML, and a JSON body (one item or an array) is accepted too.
|
||||
- Every item needs a `kind`: `environment`, `credential`, `snippet` or `scenario`. Snippets and scenarios also need `version` (see above).
|
||||
- All items are validated before anything is imported, so one invalid item means nothing from that request is imported. The error lists every invalid item by its position.
|
||||
- Items are imported in dependency order - environments, credentials, snippets, scenarios - regardless of their order in the file, so a scenario can reference an environment or credential from the same file.
|
||||
- The response lists what was imported: `{ imported: [{ kind, id, name, version? }] }`.
|
||||
|
||||
A scenario export (`GET /scenarios/:id/export`, optionally with its environment and credentials) is in this format, one document per entity, and can be imported back as is.
|
||||
|
||||
```yaml
|
||||
---
|
||||
# Environment: staging
|
||||
kind: environment
|
||||
id: 5b0c…
|
||||
name: staging
|
||||
data:
|
||||
base_url: https://staging.example
|
||||
---
|
||||
# Scenario: Login flow
|
||||
kind: scenario
|
||||
id: 9e1f…
|
||||
version: 3
|
||||
name: Login flow
|
||||
environmentId: 5b0c…
|
||||
steps:
|
||||
- title: Open login page
|
||||
execCode: await context.page.goto(context.getEnv("base_url"));
|
||||
```
|
||||
|
||||
## 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.
|
||||
|
||||
Generated
+2
-2
@@ -1,12 +1,12 @@
|
||||
{
|
||||
"name": "liqa",
|
||||
"version": "1.17.0",
|
||||
"version": "1.18.0",
|
||||
"lockfileVersion": 3,
|
||||
"requires": true,
|
||||
"packages": {
|
||||
"": {
|
||||
"name": "liqa",
|
||||
"version": "1.17.0",
|
||||
"version": "1.18.0",
|
||||
"workspaces": [
|
||||
"server",
|
||||
"client"
|
||||
|
||||
+1
-1
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "liqa",
|
||||
"version": "1.17.0",
|
||||
"version": "1.18.0",
|
||||
"private": true,
|
||||
"workspaces": [
|
||||
"server",
|
||||
|
||||
@@ -13,6 +13,7 @@ import { FileModule } from "./file/file.module";
|
||||
import { ScenarioFileEntity } from "./file/scenario-file.entity";
|
||||
import { ScenarioRunFileEntity } from "./file/scenario-run-file.entity";
|
||||
import { HealthModule } from "./health/health.module";
|
||||
import { ImportModule } from "./import/import.module";
|
||||
import { McpModule } from "./mcp/mcp.module";
|
||||
import { ScenarioCredentialEntity } from "./scenario/scenario-credential.entity";
|
||||
import { ScenarioRunLogEntity } from "./scenario/scenario-run-log.entity";
|
||||
@@ -66,6 +67,7 @@ import { SnippetModule } from "./snippet/snippet.module";
|
||||
ScenarioModule,
|
||||
SnippetModule,
|
||||
FileModule,
|
||||
ImportModule,
|
||||
McpModule,
|
||||
HealthModule,
|
||||
],
|
||||
|
||||
@@ -6,7 +6,7 @@ import {
|
||||
import { expect as playwrightExpect } from "@playwright/test";
|
||||
import { parse } from "acorn";
|
||||
import type { BrowserContext, Page } from "playwright";
|
||||
import { URL } from "url";
|
||||
import { URL } from "node:url";
|
||||
import { downloadFile as downloadFileImpl } from "../common/file-downloader";
|
||||
import { TraceLogger } from "../common/trace-logger";
|
||||
import type { EnvironmentData } from "../environment/environment.entity";
|
||||
|
||||
@@ -0,0 +1,14 @@
|
||||
import type { NestExpressApplication } from "@nestjs/platform-express";
|
||||
|
||||
/** Content types accepted as raw YAML text (e.g. by `POST /import`). */
|
||||
export const YAML_CONTENT_TYPES = [
|
||||
"application/yaml",
|
||||
"application/x-yaml",
|
||||
"text/yaml",
|
||||
"text/x-yaml",
|
||||
];
|
||||
|
||||
/** Registers body parsers beyond Nest's default JSON/urlencoded ones. */
|
||||
export function configureBodyParsers(app: NestExpressApplication): void {
|
||||
app.useBodyParser("text", { type: YAML_CONTENT_TYPES, limit: "10mb" });
|
||||
}
|
||||
@@ -1,6 +1,6 @@
|
||||
import * as https from "https";
|
||||
import * as http from "http";
|
||||
import { URL } from "url";
|
||||
import * as https from "node:https";
|
||||
import * as http from "node:http";
|
||||
import { URL } from "node:url";
|
||||
|
||||
const MAX_FILE_SIZE = 100 * 1024 * 1024; // 100 MB
|
||||
const TIMEOUT_MS = 30000; // 30 seconds
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
import { AsyncLocalStorage } from "async_hooks";
|
||||
import { AsyncLocalStorage } from "node:async_hooks";
|
||||
|
||||
export interface TraceStore {
|
||||
traceId: string;
|
||||
|
||||
@@ -2,9 +2,9 @@ import { Injectable, OnModuleInit } from "@nestjs/common";
|
||||
import { ConfigService } from "@nestjs/config";
|
||||
import { SchedulerRegistry } from "@nestjs/schedule";
|
||||
import { InjectRepository } from "@nestjs/typeorm";
|
||||
import * as crypto from "crypto";
|
||||
import * as fs from "fs/promises";
|
||||
import * as path from "path";
|
||||
import * as crypto from "node:crypto";
|
||||
import * as fs from "node:fs/promises";
|
||||
import * as path from "node:path";
|
||||
import { CronJob } from "cron";
|
||||
import { Repository } from "typeorm";
|
||||
import { TraceLogger } from "../common/trace-logger";
|
||||
|
||||
@@ -0,0 +1,45 @@
|
||||
import { BadRequestException, Body, Controller, Post } from "@nestjs/common";
|
||||
import {
|
||||
ApiBody,
|
||||
ApiConsumes,
|
||||
ApiOperation,
|
||||
ApiResponse,
|
||||
ApiTags,
|
||||
} from "@nestjs/swagger";
|
||||
import { YAML_CONTENT_TYPES } from "../common/body-parsers";
|
||||
import { ImportService } from "./import.service";
|
||||
|
||||
@ApiTags("import")
|
||||
@Controller("import")
|
||||
export class ImportController {
|
||||
constructor(private readonly importService: ImportService) {}
|
||||
|
||||
@Post()
|
||||
@ApiOperation({
|
||||
summary:
|
||||
"Import any mix of environments, credentials, snippets and scenarios",
|
||||
description:
|
||||
"Send YAML (Content-Type application/yaml): `---`-separated documents, each holding one exported item or a list of them. " +
|
||||
"A JSON array of items (or a single item) is accepted too. Every item needs a `kind`. " +
|
||||
"All items are validated before anything is imported, then imported in dependency order: environments, credentials, snippets, scenarios.",
|
||||
})
|
||||
@ApiConsumes(...YAML_CONTENT_TYPES, "application/json")
|
||||
@ApiBody({ schema: { type: "string" } })
|
||||
@ApiResponse({ status: 201, description: "Imported items" })
|
||||
@ApiResponse({
|
||||
status: 400,
|
||||
description: "Invalid YAML or items; nothing was imported",
|
||||
})
|
||||
import(@Body() body: unknown) {
|
||||
if (typeof body === "string") {
|
||||
return this.importService.importYaml(body);
|
||||
}
|
||||
if (Array.isArray(body)) return this.importService.importItems(body);
|
||||
if (body && typeof body === "object" && Object.keys(body).length > 0) {
|
||||
return this.importService.importItems([body]);
|
||||
}
|
||||
throw new BadRequestException(
|
||||
"Send YAML with Content-Type application/yaml, or a JSON item or array of items",
|
||||
);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,15 @@
|
||||
import { Module } from "@nestjs/common";
|
||||
import { CredentialModule } from "../credential/credential.module";
|
||||
import { EnvironmentModule } from "../environment/environment.module";
|
||||
import { ScenarioModule } from "../scenario/scenario.module";
|
||||
import { SnippetModule } from "../snippet/snippet.module";
|
||||
import { ImportController } from "./import.controller";
|
||||
import { ImportService } from "./import.service";
|
||||
|
||||
@Module({
|
||||
imports: [EnvironmentModule, CredentialModule, SnippetModule, ScenarioModule],
|
||||
controllers: [ImportController],
|
||||
providers: [ImportService],
|
||||
exports: [ImportService],
|
||||
})
|
||||
export class ImportModule {}
|
||||
@@ -0,0 +1,176 @@
|
||||
import { BadRequestException, Injectable } from "@nestjs/common";
|
||||
import { ClassConstructor, plainToInstance } from "class-transformer";
|
||||
import { validateSync, ValidationError } from "class-validator";
|
||||
import { parseAllDocuments } from "yaml";
|
||||
import { CredentialExportDto } from "../credential/dto/credential-export.dto";
|
||||
import { CredentialService } from "../credential/credential.service";
|
||||
import { EnvironmentExportDto } from "../environment/dto/environment-export.dto";
|
||||
import { EnvironmentService } from "../environment/environment.service";
|
||||
import { ScenarioExportDto } from "../scenario/dto/scenario-export.dto";
|
||||
import { ScenarioService } from "../scenario/scenario.service";
|
||||
import { SnippetExportDto } from "../snippet/dto/snippet-export.dto";
|
||||
import { SnippetService } from "../snippet/snippet.service";
|
||||
|
||||
export type ImportKind = "environment" | "credential" | "snippet" | "scenario";
|
||||
|
||||
/** Import order: later kinds may reference earlier ones (scenarios → environments/credentials). */
|
||||
const KIND_ORDER: ImportKind[] = [
|
||||
"environment",
|
||||
"credential",
|
||||
"snippet",
|
||||
"scenario",
|
||||
];
|
||||
|
||||
const DTO_BY_KIND: Record<ImportKind, ClassConstructor<object>> = {
|
||||
environment: EnvironmentExportDto,
|
||||
credential: CredentialExportDto,
|
||||
snippet: SnippetExportDto,
|
||||
scenario: ScenarioExportDto,
|
||||
};
|
||||
|
||||
export interface ImportedItem {
|
||||
kind: ImportKind;
|
||||
id: string;
|
||||
name: string;
|
||||
/** Version stored for versioned kinds (snippets, scenarios). */
|
||||
version?: number;
|
||||
}
|
||||
|
||||
export interface ImportResult {
|
||||
imported: ImportedItem[];
|
||||
}
|
||||
|
||||
function formatErrors(errors: ValidationError[], prefix = ""): string[] {
|
||||
return errors.flatMap((e) => {
|
||||
const field = prefix ? `${prefix}.${e.property}` : e.property;
|
||||
return [
|
||||
...Object.values(e.constraints ?? {}).map((msg) => `${field}: ${msg}`),
|
||||
...formatErrors(e.children ?? [], field),
|
||||
];
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Imports any mix of exported environments, credentials, snippets and
|
||||
* scenarios in one go. Each item must carry its `kind`.
|
||||
*/
|
||||
@Injectable()
|
||||
export class ImportService {
|
||||
constructor(
|
||||
private readonly environmentService: EnvironmentService,
|
||||
private readonly credentialService: CredentialService,
|
||||
private readonly snippetService: SnippetService,
|
||||
private readonly scenarioService: ScenarioService,
|
||||
) {}
|
||||
|
||||
/**
|
||||
* Parses a YAML stream: `---`-separated documents, each holding a single
|
||||
* item or a list of items. JSON is valid YAML, so JSON input works too.
|
||||
*/
|
||||
parseYaml(text: string): unknown[] {
|
||||
const docs = parseAllDocuments(text);
|
||||
const items: unknown[] = [];
|
||||
docs.forEach((doc, index) => {
|
||||
if (doc.errors.length > 0) {
|
||||
throw new BadRequestException(
|
||||
`YAML document ${index + 1}: ${doc.errors[0].message}`,
|
||||
);
|
||||
}
|
||||
const value: unknown = doc.toJS();
|
||||
if (value == null) return; // empty document, e.g. a trailing `---`
|
||||
items.push(...(Array.isArray(value) ? value : [value]));
|
||||
});
|
||||
return items;
|
||||
}
|
||||
|
||||
async importYaml(text: string): Promise<ImportResult> {
|
||||
return this.importItems(this.parseYaml(text));
|
||||
}
|
||||
|
||||
/**
|
||||
* Validates every item before importing any, then imports them in
|
||||
* dependency order (environments, credentials, snippets, scenarios).
|
||||
*/
|
||||
async importItems(items: unknown[]): Promise<ImportResult> {
|
||||
if (items.length === 0) {
|
||||
throw new BadRequestException("Nothing to import");
|
||||
}
|
||||
|
||||
const errors: string[] = [];
|
||||
const validated: { kind: ImportKind; dto: object }[] = [];
|
||||
items.forEach((item, index) => {
|
||||
const label = `Item ${index + 1}`;
|
||||
if (item == null || typeof item !== "object" || Array.isArray(item)) {
|
||||
errors.push(`${label}: must be an object`);
|
||||
return;
|
||||
}
|
||||
const kind = (item as { kind?: unknown }).kind;
|
||||
if (typeof kind !== "string" || !(kind in DTO_BY_KIND)) {
|
||||
errors.push(
|
||||
`${label}: kind must be one of ${KIND_ORDER.join(", ")} (got ${JSON.stringify(kind)})`,
|
||||
);
|
||||
return;
|
||||
}
|
||||
const dto = plainToInstance(DTO_BY_KIND[kind as ImportKind], item);
|
||||
const itemErrors = formatErrors(validateSync(dto, { whitelist: true }));
|
||||
if (itemErrors.length > 0) {
|
||||
errors.push(`${label} (${kind}): ${itemErrors.join("; ")}`);
|
||||
return;
|
||||
}
|
||||
validated.push({ kind: kind as ImportKind, dto });
|
||||
});
|
||||
if (errors.length > 0) {
|
||||
throw new BadRequestException(errors);
|
||||
}
|
||||
|
||||
const imported: ImportedItem[] = [];
|
||||
for (const kind of KIND_ORDER) {
|
||||
for (const item of validated.filter((v) => v.kind === kind)) {
|
||||
imported.push(await this.importOne(kind, item.dto));
|
||||
}
|
||||
}
|
||||
return { imported };
|
||||
}
|
||||
|
||||
private async importOne(
|
||||
kind: ImportKind,
|
||||
dto: object,
|
||||
): Promise<ImportedItem> {
|
||||
switch (kind) {
|
||||
case "environment": {
|
||||
const env = await this.environmentService.importEnvironment(
|
||||
dto as EnvironmentExportDto,
|
||||
);
|
||||
return { kind, id: env.id, name: env.name };
|
||||
}
|
||||
case "credential": {
|
||||
const cred = await this.credentialService.importCredential(
|
||||
dto as CredentialExportDto,
|
||||
);
|
||||
return { kind, id: cred.id, name: cred.name };
|
||||
}
|
||||
case "snippet": {
|
||||
const snippet = await this.snippetService.importSnippet(
|
||||
dto as SnippetExportDto,
|
||||
);
|
||||
return {
|
||||
kind,
|
||||
id: snippet.id,
|
||||
name: snippet.alias,
|
||||
version: snippet.version,
|
||||
};
|
||||
}
|
||||
case "scenario": {
|
||||
const scenario = await this.scenarioService.importScenario(
|
||||
dto as ScenarioExportDto,
|
||||
);
|
||||
return {
|
||||
kind,
|
||||
id: scenario.id,
|
||||
name: scenario.name,
|
||||
version: scenario.version,
|
||||
};
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -4,7 +4,7 @@ import {
|
||||
Injectable,
|
||||
NestInterceptor,
|
||||
} from "@nestjs/common";
|
||||
import * as crypto from "crypto";
|
||||
import * as crypto from "node:crypto";
|
||||
import type { Request } from "express";
|
||||
import { Observable } from "rxjs";
|
||||
import { traceStorage } from "../common/trace-context";
|
||||
|
||||
+4
-1
@@ -1,9 +1,11 @@
|
||||
import { RequestMethod, ValidationPipe } from "@nestjs/common";
|
||||
import { ConfigService } from "@nestjs/config";
|
||||
import { NestFactory } from "@nestjs/core";
|
||||
import type { NestExpressApplication } from "@nestjs/platform-express";
|
||||
import { DocumentBuilder, SwaggerModule } from "@nestjs/swagger";
|
||||
import { name as pkgName, version as pkgVersion } from "../package.json";
|
||||
import { AppModule } from "./app.module";
|
||||
import { configureBodyParsers } from "./common/body-parsers";
|
||||
import { TraceLogger } from "./common/trace-logger";
|
||||
import { AppConfig } from "./config/app.config";
|
||||
import { HttpExceptionFilter } from "./filters/http-exception.filter";
|
||||
@@ -28,7 +30,7 @@ process.on("unhandledRejection", (reason) => {
|
||||
async function bootstrap() {
|
||||
const API_PREFIX = "api/v1";
|
||||
const logger = new TraceLogger("Bootstrap");
|
||||
const app = await NestFactory.create(AppModule, {
|
||||
const app = await NestFactory.create<NestExpressApplication>(AppModule, {
|
||||
logger: new TraceLogger("Bootstrap", { timestamp: true }),
|
||||
});
|
||||
|
||||
@@ -40,6 +42,7 @@ async function bootstrap() {
|
||||
],
|
||||
});
|
||||
|
||||
configureBodyParsers(app);
|
||||
app.useGlobalPipes(new ValidationPipe({ transform: true }));
|
||||
app.useGlobalFilters(new HttpExceptionFilter());
|
||||
app.useGlobalInterceptors(new TraceInterceptor(), new LoggingInterceptor());
|
||||
|
||||
@@ -6,6 +6,7 @@ import { EnvironmentModule } from "../environment/environment.module";
|
||||
import { ScenarioModule } from "../scenario/scenario.module";
|
||||
import { SessionModule } from "../session/session.module";
|
||||
import { SnippetModule } from "../snippet/snippet.module";
|
||||
import { ImportModule } from "../import/import.module";
|
||||
import { McpController } from "./mcp.controller";
|
||||
import { McpService } from "./mcp.service";
|
||||
|
||||
@@ -18,6 +19,7 @@ import { McpService } from "./mcp.service";
|
||||
CodeExecutorModule,
|
||||
ScenarioModule,
|
||||
SnippetModule,
|
||||
ImportModule,
|
||||
],
|
||||
controllers: [McpController],
|
||||
providers: [McpService],
|
||||
|
||||
@@ -14,6 +14,7 @@ import { CodeExecutorService } from "../code-executor/code-executor.service";
|
||||
import { ScenarioService } from "../scenario/scenario.service";
|
||||
import { E2eExportService } from "../scenario/e2e-export.service";
|
||||
import { SnippetService } from "../snippet/snippet.service";
|
||||
import { ImportService } from "../import/import.service";
|
||||
|
||||
import pkg from "../../package.json";
|
||||
|
||||
@@ -29,6 +30,7 @@ export class McpService {
|
||||
private readonly scenarioService: ScenarioService,
|
||||
private readonly e2eExportService: E2eExportService,
|
||||
private readonly snippetService: SnippetService,
|
||||
private readonly importService: ImportService,
|
||||
) {}
|
||||
|
||||
private createServer(): McpServer {
|
||||
@@ -1307,6 +1309,35 @@ export class McpService {
|
||||
},
|
||||
);
|
||||
|
||||
server.registerTool(
|
||||
"import_yaml",
|
||||
{
|
||||
description:
|
||||
"Import any mix of exported environments, credentials, snippets and scenarios from YAML: `---`-separated documents, each holding one item or a list of items, each with a `kind`. All items are validated before anything is imported; versioned items (snippets, scenarios) must include `version`",
|
||||
inputSchema: {
|
||||
yaml: z.string().describe("YAML text, e.g. the content of an export file"),
|
||||
},
|
||||
},
|
||||
async ({ yaml }) => {
|
||||
try {
|
||||
const result = await this.importService.importYaml(yaml);
|
||||
return {
|
||||
content: [{ type: "text" as const, text: JSON.stringify(result) }],
|
||||
};
|
||||
} catch (err) {
|
||||
const response = (err as { getResponse?: () => unknown }).getResponse?.();
|
||||
const message =
|
||||
response && typeof response === "object" && "message" in response
|
||||
? JSON.stringify((response as { message: unknown }).message)
|
||||
: (err as Error).message;
|
||||
return {
|
||||
isError: true,
|
||||
content: [{ type: "text" as const, text: message }],
|
||||
};
|
||||
}
|
||||
},
|
||||
);
|
||||
|
||||
server.registerTool(
|
||||
"export_e2e_test",
|
||||
{
|
||||
|
||||
@@ -148,7 +148,7 @@ export class E2eExportService {
|
||||
const timeoutMs = (scenarioTimeoutSeconds ?? DEFAULT_SCENARIO_TIMEOUT_SEC) * 1000;
|
||||
return `import { defineConfig } from "@playwright/test";
|
||||
import * as dotenv from "dotenv";
|
||||
import * as path from "path";
|
||||
import * as path from "node:path";
|
||||
|
||||
dotenv.config({ path: path.resolve(__dirname, ".env") });
|
||||
|
||||
@@ -235,13 +235,13 @@ the scenario are bundled under \`files/\` and served locally by
|
||||
|
||||
return `import { test, expect } from "@playwright/test";
|
||||
import type { BrowserContext, Page } from "@playwright/test";
|
||||
import * as fs from "fs";
|
||||
import * as path from "path";
|
||||
import * as crypto from "crypto";
|
||||
import * as http from "http";
|
||||
import * as https from "https";
|
||||
import { URL } from "url";
|
||||
import { randomUUID } from "crypto";
|
||||
import * as fs from "node:fs";
|
||||
import * as path from "node:path";
|
||||
import * as crypto from "node:crypto";
|
||||
import * as http from "node:http";
|
||||
import * as https from "node:https";
|
||||
import { URL } from "node:url";
|
||||
import { randomUUID } from "node:crypto";
|
||||
|
||||
// Credential data resolved from this scenario's aliases at export time.
|
||||
// Stored in credentials.json (gitignored) - contains sensitive values.
|
||||
|
||||
@@ -2,10 +2,10 @@ import { Injectable, OnModuleInit } from "@nestjs/common";
|
||||
import { ConfigService } from "@nestjs/config";
|
||||
import { Interval } from "@nestjs/schedule";
|
||||
import { InjectRepository } from "@nestjs/typeorm";
|
||||
import * as crypto from "crypto";
|
||||
import * as fs from "fs/promises";
|
||||
import * as os from "os";
|
||||
import * as path from "path";
|
||||
import * as crypto from "node:crypto";
|
||||
import * as fs from "node:fs/promises";
|
||||
import * as os from "node:os";
|
||||
import * as path from "node:path";
|
||||
import { Effect } from "effect";
|
||||
import type { Browser, BrowserContext, Page } from "playwright";
|
||||
import { chromium } from "playwright";
|
||||
|
||||
@@ -150,20 +150,20 @@ export class ScenarioController {
|
||||
version,
|
||||
});
|
||||
res.setHeader("Content-Type", "application/yaml; charset=utf-8");
|
||||
// Serialize as YAML stream: each entity separated by a comment header
|
||||
// Serialize as a YAML stream: one `---` document per entity, each with a
|
||||
// comment naming it. POST /import reads this format back.
|
||||
const kindLabels: Record<string, string> = {
|
||||
environment: "Environment",
|
||||
credential: "Credential",
|
||||
scenario: "Scenario",
|
||||
};
|
||||
const parts = (entities as ExportEntity[]).map((entity) => {
|
||||
const label = kindLabels[entity.kind ?? ""] ?? entity.kind ?? "Entity";
|
||||
const comment = `# --- ${label}: ${
|
||||
entity.name ?? entity.id ?? ""
|
||||
} ---`;
|
||||
return `${comment}\n${yamlStringify(entity)}`;
|
||||
});
|
||||
return parts.join("\n");
|
||||
return (entities as ExportEntity[])
|
||||
.map((entity) => {
|
||||
const label = kindLabels[entity.kind ?? ""] ?? entity.kind ?? "Entity";
|
||||
const comment = `# ${label}: ${entity.name ?? entity.id ?? ""}`;
|
||||
return `---\n${comment}\n${yamlStringify(entity)}`;
|
||||
})
|
||||
.join("");
|
||||
}
|
||||
|
||||
@Get(":id/export-e2e")
|
||||
|
||||
@@ -7,8 +7,8 @@ import {
|
||||
} from "@nestjs/common";
|
||||
import { ConfigService } from "@nestjs/config";
|
||||
import { InjectRepository } from "@nestjs/typeorm";
|
||||
import * as fs from "fs/promises";
|
||||
import * as path from "path";
|
||||
import * as fs from "node:fs/promises";
|
||||
import * as path from "node:path";
|
||||
import { Like, Repository } from "typeorm";
|
||||
import {
|
||||
PaginatedResult,
|
||||
|
||||
@@ -18,7 +18,7 @@ const makeContext = () => ({
|
||||
stop: jest.fn().mockImplementation(async (opts?: { path?: string }) => {
|
||||
if (opts?.path) {
|
||||
// eslint-disable-next-line @typescript-eslint/no-require-imports
|
||||
await require("fs/promises").writeFile(opts.path, "fake trace zip");
|
||||
await require("node:fs/promises").writeFile(opts.path, "fake trace zip");
|
||||
}
|
||||
}),
|
||||
},
|
||||
|
||||
@@ -1,8 +1,16 @@
|
||||
import { INestApplication, ValidationPipe } from "@nestjs/common";
|
||||
import * as fs from "node:fs";
|
||||
import * as os from "node:os";
|
||||
import * as path from "node:path";
|
||||
import { Test, TestingModule } from "@nestjs/testing";
|
||||
import { TypeOrmModule } from "@nestjs/typeorm";
|
||||
import { ConfigModule } from "@nestjs/config";
|
||||
import type { NestExpressApplication } from "@nestjs/platform-express";
|
||||
import { ScheduleModule } from "@nestjs/schedule";
|
||||
|
||||
import { configureBodyParsers } from "../src/common/body-parsers";
|
||||
import { ImportModule } from "../src/import/import.module";
|
||||
|
||||
jest.mock("@nestjs/common", () => {
|
||||
const actual = jest.requireActual("@nestjs/common");
|
||||
// eslint-disable-next-line @typescript-eslint/no-require-imports
|
||||
@@ -55,6 +63,11 @@ import { ScenarioFileEntity } from "../src/file/scenario-file.entity";
|
||||
import { ScenarioRunFileEntity } from "../src/file/scenario-run-file.entity";
|
||||
|
||||
export async function buildTestApp(): Promise<INestApplication> {
|
||||
// Each test app stores files in its own temp dir: suites run in parallel and
|
||||
// some clean up their files dir, which must not affect other suites.
|
||||
const filesDir = fs.mkdtempSync(path.join(os.tmpdir(), "liqa-test-files-"));
|
||||
process.env.FILES_DIR = filesDir;
|
||||
|
||||
const module: TestingModule = await Test.createTestingModule({
|
||||
imports: [
|
||||
ConfigModule.forRoot({
|
||||
@@ -89,15 +102,23 @@ export async function buildTestApp(): Promise<INestApplication> {
|
||||
SessionModule,
|
||||
EnvironmentModule,
|
||||
ScenarioModule,
|
||||
ImportModule,
|
||||
McpModule,
|
||||
],
|
||||
controllers: [HealthController],
|
||||
}).compile();
|
||||
|
||||
const app = module.createNestApplication();
|
||||
const app = module.createNestApplication<NestExpressApplication>();
|
||||
configureBodyParsers(app);
|
||||
app.useGlobalPipes(new ValidationPipe({ transform: true, whitelist: true }));
|
||||
app.useGlobalFilters(new HttpExceptionFilter());
|
||||
app.useGlobalInterceptors(new LoggingInterceptor());
|
||||
await app.init();
|
||||
|
||||
const close = app.close.bind(app);
|
||||
app.close = async () => {
|
||||
await close();
|
||||
fs.rmSync(filesDir, { recursive: true, force: true });
|
||||
};
|
||||
return app;
|
||||
}
|
||||
@@ -1,7 +1,7 @@
|
||||
import { INestApplication } from "@nestjs/common";
|
||||
import { getRepositoryToken } from "@nestjs/typeorm";
|
||||
import * as http from "http";
|
||||
import * as fs from "fs/promises";
|
||||
import * as http from "node:http";
|
||||
import * as fs from "node:fs/promises";
|
||||
import { Repository } from "typeorm";
|
||||
import { buildTestApp } from "./app.harness";
|
||||
import { FileStorageService } from "../src/file/file-storage.service";
|
||||
@@ -13,7 +13,7 @@ import { ScenarioStepEntity } from "../src/scenario/scenario-step.entity";
|
||||
import { ScenarioRunEntity } from "../src/scenario/scenario-run.entity";
|
||||
import { ScenarioRunStepEntity } from "../src/scenario/scenario-run-step.entity";
|
||||
import { ScenarioSchedulerService } from "../src/scenario/scenario-scheduler.service";
|
||||
import type { AddressInfo } from "net";
|
||||
import type { AddressInfo } from "node:net";
|
||||
|
||||
describe("Exec Context File Methods Integration Tests", () => {
|
||||
let app: INestApplication;
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
import { INestApplication } from "@nestjs/common";
|
||||
import { getRepositoryToken } from "@nestjs/typeorm";
|
||||
import request from "supertest";
|
||||
import * as fs from "fs/promises";
|
||||
import * as fs from "node:fs/promises";
|
||||
import { Repository } from "typeorm";
|
||||
import { buildTestApp } from "./app.harness";
|
||||
import { FileStorageService } from "../src/file/file-storage.service";
|
||||
|
||||
@@ -0,0 +1,219 @@
|
||||
/**
|
||||
* Integration tests for the central import (`POST /import`) and the
|
||||
* multi-document YAML scenario export it reads back.
|
||||
*/
|
||||
|
||||
import { INestApplication } from "@nestjs/common";
|
||||
import request from "supertest";
|
||||
import { DataSource } from "typeorm";
|
||||
import { parseAllDocuments } from "yaml";
|
||||
import { buildTestApp } from "./app.harness";
|
||||
import { CredentialEntity } from "../src/credential/credential.entity";
|
||||
import { EnvironmentEntity } from "../src/environment/environment.entity";
|
||||
import { ScenarioService } from "../src/scenario/scenario.service";
|
||||
|
||||
describe("Central import", () => {
|
||||
let app: INestApplication;
|
||||
let dataSource: DataSource;
|
||||
let scenarioService: ScenarioService;
|
||||
|
||||
beforeAll(async () => {
|
||||
app = await buildTestApp();
|
||||
dataSource = app.get(DataSource);
|
||||
scenarioService = app.get(ScenarioService);
|
||||
});
|
||||
|
||||
afterAll(async () => {
|
||||
await app.close();
|
||||
});
|
||||
|
||||
const uniq = () => Math.random().toString(36).slice(2, 8);
|
||||
|
||||
function postYaml(yaml: string) {
|
||||
return request(app.getHttpServer())
|
||||
.post("/import")
|
||||
.set("Content-Type", "application/yaml")
|
||||
.send(yaml);
|
||||
}
|
||||
|
||||
it("imports every kind from a multi-document YAML in dependency order", async () => {
|
||||
const envId = crypto.randomUUID();
|
||||
const credId = crypto.randomUUID();
|
||||
const snippetAlias = `imp-${uniq()}`;
|
||||
// Scenario first in the file: it references the environment and credential
|
||||
const yaml = `---
|
||||
kind: scenario
|
||||
name: imported-${uniq()}
|
||||
version: 1
|
||||
environmentId: ${envId}
|
||||
credentials:
|
||||
- credentialId: ${credId}
|
||||
alias: main
|
||||
steps:
|
||||
- title: use snippet
|
||||
execCode: return context.runSnippet("${snippetAlias}");
|
||||
---
|
||||
kind: snippet
|
||||
alias: ${snippetAlias}
|
||||
title: Imported snippet
|
||||
version: 2
|
||||
code: return 1;
|
||||
---
|
||||
kind: credential
|
||||
id: ${credId}
|
||||
name: imported-cred
|
||||
data: '{"token":"t"}'
|
||||
---
|
||||
kind: environment
|
||||
id: ${envId}
|
||||
name: imported-env-${uniq()}
|
||||
data:
|
||||
base_url: https://example.test
|
||||
`;
|
||||
const res = await postYaml(yaml).expect(201);
|
||||
const kinds = res.body.imported.map((i: { kind: string }) => i.kind);
|
||||
expect(kinds).toEqual(["environment", "credential", "snippet", "scenario"]);
|
||||
|
||||
const scenario = res.body.imported[3];
|
||||
expect(scenario.version).toBe(1);
|
||||
const sc = await scenarioService.findOne(scenario.id);
|
||||
expect(sc.environmentId).toBe(envId);
|
||||
expect(sc.scenarioCredentials.map((c) => c.credentialId)).toEqual([credId]);
|
||||
expect(res.body.imported[2]).toMatchObject({
|
||||
name: snippetAlias,
|
||||
version: 2,
|
||||
});
|
||||
});
|
||||
|
||||
it("accepts a document holding a list of items", async () => {
|
||||
const yaml = `- kind: credential
|
||||
name: list-a-${uniq()}
|
||||
- kind: credential
|
||||
name: list-b-${uniq()}
|
||||
`;
|
||||
const res = await postYaml(yaml).expect(201);
|
||||
expect(res.body.imported).toHaveLength(2);
|
||||
});
|
||||
|
||||
it("accepts a JSON array", async () => {
|
||||
const res = await request(app.getHttpServer())
|
||||
.post("/import")
|
||||
.send([{ kind: "credential", name: `json-${uniq()}` }])
|
||||
.expect(201);
|
||||
expect(res.body.imported[0].kind).toBe("credential");
|
||||
});
|
||||
|
||||
it("imports nothing when any item is invalid", async () => {
|
||||
const envName = `not-imported-${uniq()}`;
|
||||
const yaml = `---
|
||||
kind: environment
|
||||
name: ${envName}
|
||||
data: {}
|
||||
---
|
||||
kind: snippet
|
||||
alias: no-version-${uniq()}
|
||||
code: return 1;
|
||||
---
|
||||
kind: gadget
|
||||
name: what
|
||||
`;
|
||||
const res = await postYaml(yaml).expect(400);
|
||||
const message = JSON.stringify(res.body);
|
||||
expect(message).toContain("Item 2 (snippet)");
|
||||
expect(message).toContain("version");
|
||||
expect(message).toContain("Item 3");
|
||||
const envRepo = dataSource.getRepository(EnvironmentEntity);
|
||||
expect(await envRepo.findOneBy({ name: envName })).toBeNull();
|
||||
});
|
||||
|
||||
it("rejects invalid YAML", async () => {
|
||||
const res = await postYaml("kind: scenario\n bad: [indent").expect(400);
|
||||
expect(JSON.stringify(res.body)).toContain("YAML document 1");
|
||||
});
|
||||
|
||||
it("rejects an empty body", async () => {
|
||||
await postYaml("").expect(400);
|
||||
});
|
||||
|
||||
describe("scenario export round trip", () => {
|
||||
it("exports one YAML document per entity and imports it back", async () => {
|
||||
const envRepo = dataSource.getRepository(EnvironmentEntity);
|
||||
const env = await envRepo.save(
|
||||
envRepo.create({ name: `rt-env-${uniq()}`, data: { a: "1" } }),
|
||||
);
|
||||
const credRepo = dataSource.getRepository(CredentialEntity);
|
||||
const cred = await credRepo.save(
|
||||
credRepo.create({ name: "rt-cred", data: null }),
|
||||
);
|
||||
const sc = await scenarioService.create({
|
||||
name: `rt-${uniq()}`,
|
||||
environmentId: env.id,
|
||||
});
|
||||
await scenarioService.createStep(sc.id, { execCode: "return 1;" });
|
||||
await scenarioService.addScenarioCredential(sc.id, {
|
||||
credentialId: cred.id,
|
||||
alias: "c",
|
||||
});
|
||||
|
||||
const exported = await request(app.getHttpServer())
|
||||
.get(
|
||||
`/scenarios/${sc.id}/export?includeEnvironment=true&credentialIds=${cred.id}`,
|
||||
)
|
||||
.expect(200);
|
||||
const docs = parseAllDocuments(exported.text);
|
||||
expect(docs.map((d) => d.errors)).toEqual([[], [], []]);
|
||||
expect(docs.map((d) => (d.toJS() as { kind: string }).kind)).toEqual([
|
||||
"environment",
|
||||
"credential",
|
||||
"scenario",
|
||||
]);
|
||||
|
||||
const res = await postYaml(exported.text).expect(201);
|
||||
expect(res.body.imported.map((i: { id: string }) => i.id)).toEqual([
|
||||
env.id,
|
||||
cred.id,
|
||||
sc.id,
|
||||
]);
|
||||
});
|
||||
});
|
||||
|
||||
describe("import_yaml MCP tool", () => {
|
||||
async function mcpCall(name: string, args: Record<string, unknown>) {
|
||||
const res = await request(app.getHttpServer())
|
||||
.post("/mcp")
|
||||
.set("Accept", "application/json, text/event-stream")
|
||||
.send({
|
||||
jsonrpc: "2.0",
|
||||
id: 1,
|
||||
method: "tools/call",
|
||||
params: { name, arguments: args },
|
||||
});
|
||||
const text = res.text.startsWith("event:")
|
||||
? res.text
|
||||
.split("\n")
|
||||
.find((l) => l.startsWith("data:"))!
|
||||
.slice(5)
|
||||
: res.text;
|
||||
return JSON.parse(text).result as {
|
||||
isError?: boolean;
|
||||
content: { text: string }[];
|
||||
};
|
||||
}
|
||||
|
||||
it("imports items from YAML text", async () => {
|
||||
const result = await mcpCall("import_yaml", {
|
||||
yaml: `kind: credential\nname: mcp-${uniq()}\n`,
|
||||
});
|
||||
expect(result.isError).toBeFalsy();
|
||||
expect(JSON.parse(result.content[0].text).imported).toHaveLength(1);
|
||||
});
|
||||
|
||||
it("returns the validation errors as an MCP error", async () => {
|
||||
const result = await mcpCall("import_yaml", {
|
||||
yaml: `kind: snippet\nalias: x\ncode: return 1;\n`,
|
||||
});
|
||||
expect(result.isError).toBe(true);
|
||||
expect(result.content[0].text).toContain("version");
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -1,7 +1,7 @@
|
||||
import { INestApplication } from "@nestjs/common";
|
||||
import { getRepositoryToken } from "@nestjs/typeorm";
|
||||
import request from "supertest";
|
||||
import * as http from "http";
|
||||
import * as http from "node:http";
|
||||
import { Repository } from "typeorm";
|
||||
import { buildTestApp } from "./app.harness";
|
||||
import { ScenarioEntity } from "../src/scenario/scenario.entity";
|
||||
@@ -9,7 +9,7 @@ import { ScenarioStepEntity } from "../src/scenario/scenario-step.entity";
|
||||
import { ScenarioRunEntity } from "../src/scenario/scenario-run.entity";
|
||||
import { ScenarioRunStepEntity } from "../src/scenario/scenario-run-step.entity";
|
||||
import { ScenarioSchedulerService } from "../src/scenario/scenario-scheduler.service";
|
||||
import type { AddressInfo } from "net";
|
||||
import type { AddressInfo } from "node:net";
|
||||
|
||||
/**
|
||||
* MCP controller integration tests.
|
||||
|
||||
Reference in new issue
Block a user