@provartesting/provardx-cli 1.5.0-beta.1 → 1.5.0-beta.10

package/lib/mcp/prompts/migrationPrompts.js

@@ -0,0 +1,207 @@
+/*
+ * Copyright (c) 2024 Provar Limited.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.md file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+import { z } from 'zod';
+// Source-framework context injected into each migration prompt.
+// Lightweight: just enough to interpret the source. Format knowledge lives
+// in the corpus (provar.qualityhub.examples.retrieve) and the validator
+// (provar.testcase.validate) — not hardcoded here.
+const CRT_CONTEXT = `
+CRT (Copado Robotic Testing) is a keyword-driven framework built on Robot Framework.
+Tests are authored in QEditor using QWords:
+- ClickText <label>         → click an element by visible label
+- TypeText <field> <value>  → type a value into a field
+- VerifyText <text>         → assert text is present on the page
+- SelectDropdown <field> <val> → choose a picklist option
+- OpenBrowser <url>         → open a browser session (maps to Salesforce login)
+
+Robot Framework sections: *** Keywords *** define reusable blocks; *** Test Cases *** are the test entries.
+Suite Setup/Teardown → login at the start and cleanup at the end.
+`.trim();
+const SELENIUM_CONTEXT = `
+Selenium WebDriver test patterns (Java/Python/JavaScript):
+- driver.get(url) / navigate().to() → navigate to a URL (maps to Salesforce login)
+- findElement(By.linkText/name).click() → click by visible label
+- findElement(...).sendKeys(value) → type into a field
+- Select.selectByVisibleText(val) → select a picklist option
+- findElement(...).getText() + assertion → verify a field value
+- WebDriverWait / ExpectedConditions → wait for element visibility
+- @Before / setUp() → test setup including login
+- @After / tearDown() → cleanup
+`.trim();
+const PLAYWRIGHT_CONTEXT = `
+Playwright test patterns (TypeScript/JavaScript):
+- page.goto(url) / login fixture → navigate to Salesforce (maps to login)
+- getByLabel(label).click() → click by visible label
+- getByRole('button', {name}).click() → click by button name
+- getByLabel(label).fill(value) → fill a field by label
+- locator(selector).fill(value) → fill by XPath/CSS selector
+- locator.selectOption(value) → choose a picklist option
+- expect(locator).toHaveValue(val) → assert a field value
+- expect(locator).toBeVisible() → assert element is visible
+- expect(page).toContainText(text) → assert text on page
+- page.waitForLoadState() / waitForSelector() → wait conditions
+- beforeEach → test setup including login
+`.trim();
+// ── Shared orchestration instructions ────────────────────────────────────────
+function migrationOrchestration(projectPath) {
+    const projectHint = projectPath
+        ? `The target Provar project is at: ${projectPath}`
+        : 'Ask the user for the Provar project path if needed.';
+    return `
+## Migration workflow
+
+Follow these steps in order:
+
+1. **Get corpus examples** — call \`provar.qualityhub.examples.retrieve\` with keywords that
+   describe the source test's main scenario (e.g. "create opportunity", "close case", "convert lead").
+   Use the returned examples as few-shot grounding for the Provar XML format and step patterns.
+   If the response has \`"count": 0\` with a \`"warning"\` field (API unavailable or not configured),
+   fall back: read the \`provar://docs/step-reference\` MCP resource for step types and attribute
+   formats, then continue with generation based on that reference.
+
+2. **Generate the test case** — produce a valid Provar XML test case that faithfully captures
+   the intent of the source test. Base the structure entirely on the corpus examples, not on
+   prior knowledge of Provar XML. Omit Salesforce login/navigation setup — Provar handles
+   that via Connection Manager.
+
+3. **Write the file** — save the generated XML to the appropriate \`tests/\` subdirectory
+   inside the Provar project. ${projectHint}
+
+4. **Validate** — call \`provar.testcase.validate\` on the saved file. If it reports errors,
+   fix them and re-validate until the file passes clean.
+
+5. **Report** — summarise what was migrated, any steps that could not be mapped (add them
+   as \`<!-- TODO: manual step -->\` comments in the XML), and any validation warnings.
+`.trim();
+}
+// ── Prompt: provar.migrate.crt ────────────────────────────────────────────────
+export function registerCrtMigrationPrompt(server) {
+    server.prompt('provar.migrate.crt', 'Convert a Copado Robotic Testing (CRT) test — either a QWord step sequence or a Robot Framework .robot file — into a Provar XML test case. Retrieves corpus examples for grounding, generates the test case, then validates it with provar.testcase.validate.', {
+        source: z
+            .string()
+            .describe('The CRT test content to migrate. Accepts either: (1) a numbered QWord step sequence (e.g. "Step 1: ClickText Accounts"), or (2) a Robot Framework .robot file with *** Settings ***, *** Keywords ***, and *** Test Cases *** sections.'),
+        projectPath: z
+            .string()
+            .optional()
+            .describe('Absolute path to the Provar project root. Used to locate the tests/ directory when writing the output file.'),
+        testName: z
+            .string()
+            .optional()
+            .describe('Optional name for the output Provar test case. Inferred from the source if omitted.'),
+    }, ({ source, projectPath, testName }) => ({
+        messages: [
+            {
+                role: 'user',
+                content: {
+                    type: 'text',
+                    text: `You are a Provar test migration expert. Migrate the following CRT test to Provar.
+
+## Source format — CRT
+
+${CRT_CONTEXT}
+
+${migrationOrchestration(projectPath)}
+
+## Source CRT Test
+
+\`\`\`
+${source}
+\`\`\`
+
+${testName ? `Target test case name: ${testName}` : 'Infer the test case name from the source content.'}
+
+Begin with step 1: call provar.qualityhub.examples.retrieve.`,
+                },
+            },
+        ],
+    }));
+}
+// ── Prompt: provar.migrate.selenium ──────────────────────────────────────────
+export function registerSeleniumMigrationPrompt(server) {
+    server.prompt('provar.migrate.selenium', 'Convert a Selenium WebDriver test (Java, Python, or JavaScript) that tests a Salesforce org into a Provar XML test case. Retrieves corpus examples for grounding, generates the test case, then validates it with provar.testcase.validate.', {
+        source: z
+            .string()
+            .describe('The Selenium test file content to migrate. Accepts Java (JUnit/TestNG), Python (unittest/pytest), or JavaScript (Jest/Mocha) with selenium-webdriver. Include the full file or the relevant test method(s).'),
+        projectPath: z
+            .string()
+            .optional()
+            .describe('Absolute path to the Provar project root. Used to locate the tests/ directory when writing the output file.'),
+        testName: z
+            .string()
+            .optional()
+            .describe('Optional name for the output Provar test case. Inferred from the source class/method name if omitted.'),
+    }, ({ source, projectPath, testName }) => ({
+        messages: [
+            {
+                role: 'user',
+                content: {
+                    type: 'text',
+                    text: `You are a Provar test migration expert. Migrate the following Selenium WebDriver test to Provar.
+
+## Source format — Selenium WebDriver
+
+${SELENIUM_CONTEXT}
+
+${migrationOrchestration(projectPath)}
+
+## Source Selenium Test
+
+\`\`\`
+${source}
+\`\`\`
+
+${testName ? `Target test case name: ${testName}` : 'Infer the test case name from the class and method name.'}
+
+Begin with step 1: call provar.qualityhub.examples.retrieve.`,
+                },
+            },
+        ],
+    }));
+}
+// ── Prompt: provar.migrate.playwright ────────────────────────────────────────
+export function registerPlaywrightMigrationPrompt(server) {
+    server.prompt('provar.migrate.playwright', 'Convert a Playwright test (TypeScript or JavaScript) that tests a Salesforce org into a Provar XML test case. Retrieves corpus examples for grounding, generates the test case, then validates it with provar.testcase.validate.', {
+        source: z
+            .string()
+            .describe('The Playwright test file content to migrate. Accepts TypeScript or JavaScript using @playwright/test or the playwright library. Include the full file or the relevant test block(s).'),
+        projectPath: z
+            .string()
+            .optional()
+            .describe('Absolute path to the Provar project root. Used to locate the tests/ directory when writing the output file.'),
+        testName: z
+            .string()
+            .optional()
+            .describe('Optional name for the output Provar test case. Inferred from the test() block description if omitted.'),
+    }, ({ source, projectPath, testName }) => ({
+        messages: [
+            {
+                role: 'user',
+                content: {
+                    type: 'text',
+                    text: `You are a Provar test migration expert. Migrate the following Playwright test to Provar.
+
+## Source format — Playwright
+
+${PLAYWRIGHT_CONTEXT}
+
+${migrationOrchestration(projectPath)}
+
+## Source Playwright Test
+
+\`\`\`
+${source}
+\`\`\`
+
+${testName ? `Target test case name: ${testName}` : 'Infer the test case name from the test() block description.'}
+
+Begin with step 1: call provar.qualityhub.examples.retrieve.`,
+                },
+            },
+        ],
+    }));
+}
+//# sourceMappingURL=migrationPrompts.js.map

package/lib/mcp/prompts/migrationPrompts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"migrationPrompts.js","sourceRoot":"","sources":["../../../src/mcp/prompts/migrationPrompts.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,gEAAgE;AAChE,2EAA2E;AAC3E,wEAAwE;AACxE,mDAAmD;AAEnD,MAAM,WAAW,GAAG;;;;;;;;;;;CAWnB,CAAC,IAAI,EAAE,CAAC;AAET,MAAM,gBAAgB,GAAG;;;;;;;;;;CAUxB,CAAC,IAAI,EAAE,CAAC;AAET,MAAM,kBAAkB,GAAG;;;;;;;;;;;;;CAa1B,CAAC,IAAI,EAAE,CAAC;AAET,gFAAgF;AAEhF,SAAS,sBAAsB,CAAC,WAA+B;IAC7D,MAAM,WAAW,GAAG,WAAW;QAC7B,CAAC,CAAC,oCAAoC,WAAW,EAAE;QACnD,CAAC,CAAC,qDAAqD,CAAC;IAE1D,OAAO;;;;;;;;;;;;;;;;;;gCAkBuB,WAAW;;;;;;;CAO1C,CAAC,IAAI,EAAE,CAAC;AACT,CAAC;AAED,iFAAiF;AAEjF,MAAM,UAAU,0BAA0B,CAAC,MAAiB;IAC1D,MAAM,CAAC,MAAM,CACX,oBAAoB,EACpB,+PAA+P,EAC/P;QACE,MAAM,EAAE,CAAC;aACN,MAAM,EAAE;aACR,QAAQ,CACP,yOAAyO,CAC1O;QACH,WAAW,EAAE,CAAC;aACX,MAAM,EAAE;aACR,QAAQ,EAAE;aACV,QAAQ,CACP,6GAA6G,CAC9G;QACH,QAAQ,EAAE,CAAC;aACR,MAAM,EAAE;aACR,QAAQ,EAAE;aACV,QAAQ,CAAC,qFAAqF,CAAC;KACnG,EACD,CAAC,EAAE,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,CAAC;QACtC,QAAQ,EAAE;YACR;gBACE,IAAI,EAAE,MAAe;gBACrB,OAAO,EAAE;oBACP,IAAI,EAAE,MAAe;oBACrB,IAAI,EAAE;;;;EAIhB,WAAW;;EAEX,sBAAsB,CAAC,WAAW,CAAC;;;;;EAKnC,MAAM;;;EAGN,QAAQ,CAAC,CAAC,CAAC,0BAA0B,QAAQ,EAAE,CAAC,CAAC,CAAC,mDAAmD;;6DAE1C;iBAClD;aACF;SACF;KACF,CAAC,CACH,CAAC;AACJ,CAAC;AAED,gFAAgF;AAEhF,MAAM,UAAU,+BAA+B,CAAC,MAAiB;IAC/D,MAAM,CAAC,MAAM,CACX,yBAAyB,EACzB,6OAA6O,EAC7O;QACE,MAAM,EAAE,CAAC;aACN,MAAM,EAAE;aACR,QAAQ,CACP,6MAA6M,CAC9M;QACH,WAAW,EAAE,CAAC;aACX,MAAM,EAAE;aACR,QAAQ,EAAE;aACV,QAAQ,CACP,6GAA6G,CAC9G;QACH,QAAQ,EAAE,CAAC;aACR,MAAM,EAAE;aACR,QAAQ,EAAE;aACV,QAAQ,CACP,uGAAuG,CACxG;KACJ,EACD,CAAC,EAAE,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,CAAC;QACtC,QAAQ,EAAE;YACR;gBACE,IAAI,EAAE,MAAe;gBACrB,OAAO,EAAE;oBACP,IAAI,EAAE,MAAe;oBACrB,IAAI,EAAE;;;;EAIhB,gBAAgB;;EAEhB,sBAAsB,CAAC,WAAW,CAAC;;;;;EAKnC,MAAM;;;EAGN,QAAQ,CAAC,CAAC,CAAC,0BAA0B,QAAQ,EAAE,CAAC,CAAC,CAAC,0DAA0D;;6DAEjD;iBAClD;aACF;SACF;KACF,CAAC,CACH,CAAC;AACJ,CAAC;AAED,gFAAgF;AAEhF,MAAM,UAAU,iCAAiC,CAAC,MAAiB;IACjE,MAAM,CAAC,MAAM,CACX,2BAA2B,EAC3B,kOAAkO,EAClO;QACE,MAAM,EAAE,CAAC;aACN,MAAM,EAAE;aACR,QAAQ,CACP,sLAAsL,CACvL;QACH,WAAW,EAAE,CAAC;aACX,MAAM,EAAE;aACR,QAAQ,EAAE;aACV,QAAQ,CACP,6GAA6G,CAC9G;QACH,QAAQ,EAAE,CAAC;aACR,MAAM,EAAE;aACR,QAAQ,EAAE;aACV,QAAQ,CACP,uGAAuG,CACxG;KACJ,EACD,CAAC,EAAE,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,CAAC;QACtC,QAAQ,EAAE;YACR;gBACE,IAAI,EAAE,MAAe;gBACrB,OAAO,EAAE;oBACP,IAAI,EAAE,MAAe;oBACrB,IAAI,EAAE;;;;EAIhB,kBAAkB;;EAElB,sBAAsB,CAAC,WAAW,CAAC;;;;;EAKnC,MAAM;;;EAGN,QAAQ,CAAC,CAAC,CAAC,0BAA0B,QAAQ,EAAE,CAAC,CAAC,CAAC,6DAA6D;;6DAEpD;iBAClD;aACF;SACF;KACF,CAAC,CACH,CAAC;AACJ,CAAC"}