@xylentis/testgen 1.1.0 → 1.2.0

package/dist/generators/playwright-go.js

@@ -2,6 +2,8 @@ import { devices } from 'playwright-core';
 import { isRegex, parseLocator } from '../locator.js';
 import { pascalCase, snakeCase } from '../naming.js';
 import { PageAliases, isBlankUrl, shortcutOf, signalsOf, toKeyboardModifiers } from '../recording.js';
+import { readRuntimeFile } from './runtime.js';
+import { collectTestValues, isEmpty, joinPieces, toCsv } from './test-data.js';
 import { CodeWriter, doubleQuote } from './writer.js';
 const playwrightGoModule = 'github.com/mxschmitt/playwright-go';
 // Roles with a playwright.AriaRole<Name> constant in playwright-go.
@@ -12,15 +14,29 @@ const ariaRoles = new Set(('alert alertdialog application article banner blockqu
     'radiogroup region row rowgroup rowheader scrollbar search searchbox separator slider spinbutton status strong ' +
     'subscript superscript switch tab table tablist tabpanel term textbox time timer toolbar tooltip tree treegrid treeitem').split(' '));
 const capitalize = (text) => text.charAt(0).toUpperCase() + text.slice(1);
+// Names a secret's variable cannot take: Go keywords, imported packages and the test's own variables.
+const goNames = new Set(('break case chan const continue default defer else fallthrough for func go goto if import interface ' +
+    'map package range return select struct switch type var fmt os playwright regexp require testing ' +
+    'pw err browser context page expect device dialog t i row ok').split(' '));
+const reservedName = (name) => goNames.has(name) || /^page\d+$/.test(name);
 export const playwrightGo = {
     id: 'playwright-go',
     framework: 'Playwright for Go (playwright-go)',
     language: 'Go',
     highlight: 'go',
+    features: ['dataDriven'],
     testFileName: name => `${snakeCase(name)}_test.go`,
     generate(recording, options) {
         const imports = new Set(['os', 'testing']);
         const locators = new GoLocators(() => imports.add('regexp'));
+        const values = collectTestValues(recording, { dataDriven: options.dataDriven, reserved: reservedName });
+        const { columns } = values;
+        const dataFile = `testdata/${snakeCase(options.name)}.csv`;
+        const goPieces = {
+            text: doubleQuote,
+            column: (column) => `row[${doubleQuote(column.name)}]`,
+            secret: (secret) => values.variable(secret),
+        };
         const body = new CodeWriter('\t');
         const aliases = new PageAliases();
         const declared = new Set();
@@ -60,7 +76,12 @@ export const playwrightGo = {
                     body.line('_ = dialog.Dismiss()');
                 }, '})');
             }
-            const call = actionCall(pageAlias, action, locators);
+            const literals = {
+                value: text => joinPieces(values.value(index, text), goPieces),
+                isEmpty: text => isEmpty(values.value(index, text)),
+                locator: text => joinPieces(values.locator(index, text), goPieces),
+            };
+            const call = actionCall(pageAlias, action, locators, literals);
             if (action.name.startsWith('assert'))
                 usesExpect = true;
             if (call.todo)
@@ -81,15 +102,18 @@ export const playwrightGo = {
             }
             if (recording.header.generateExpectSignal && signals.expect) {
                 usesExpect = true;
-                emit(body, { expr: `expect.Locator(${locators.render(pageAlias, parseLocator(signals.expect.selector))}).ToBeVisible()`, returnsValue: false });
+                emit(body, { expr: `expect.Locator(${locators.render(pageAlias, parseLocator(signals.expect.selector), literals.locator)}).ToBeVisible()`, returnsValue: false });
             }
         });
         if (!declared.size && !recording.header.saveStorage)
             body.line('_ = context');
         if (recording.header.saveStorage)
             emit(body, { expr: `context.StorageState(playwright.BrowserContextStorageStateOptions{Path: playwright.String(${doubleQuote(recording.header.saveStorage)})})`, returnsValue: true });
+        if (columns.length)
+            imports.add('fmt');
+        const packageName = goPackageName(options.packageName);
         const w = new CodeWriter('\t');
-        w.line(`package ${goPackageName(options.packageName)}`);
+        w.line(`package ${packageName}`);
         w.line();
         w.line('import (');
         w.indent(() => {
@@ -103,6 +127,14 @@ export const playwrightGo = {
         w.line();
         w.line('// Generated by testgen from a Playwright recording. Set HEADED=1 to watch the browser.');
         w.block(`func Test${pascalCase(options.name)}(t *testing.T) {`, () => {
+            if (values.secrets.length) {
+                w.line('// Values typed into password fields are not kept in the test: set them as environment variables.');
+                for (const secret of values.secrets) {
+                    w.line(`${values.variable(secret)}, ok := os.LookupEnv(${doubleQuote(secret.name)})`);
+                    w.line(`require.True(t, ok, ${doubleQuote(`set the environment variable ${secret.name}, the value to type into a password field`)})`);
+                }
+                w.line();
+            }
             w.line('pw, err := playwright.Run()');
             w.line('require.NoError(t, err)');
             w.line('t.Cleanup(func() { _ = pw.Stop() })');
@@ -118,16 +150,42 @@ export const playwrightGo = {
             const context = contextOptions(recording.header, options.testIdAttribute);
             for (const line of context.before)
                 w.line(line);
-            w.line(`context, err := browser.NewContext(${context.fields.length ? structLiteral('playwright.BrowserNewContextOptions', context.fields) : ''})`);
-            w.line('require.NoError(t, err)');
+            const newContext = `context, err := browser.NewContext(${context.fields.length ? structLiteral('playwright.BrowserNewContextOptions', context.fields) : ''})`;
+            const setTestIdAttribute = `pw.Selectors.SetTestIdAttribute(${doubleQuote(options.testIdAttribute)})`;
+            if (!columns.length) {
+                w.line(newContext);
+                w.line('require.NoError(t, err)');
+                if (options.testIdAttribute !== 'data-testid')
+                    w.line(setTestIdAttribute);
+                if (usesExpect)
+                    w.line('expect := playwright.NewPlaywrightAssertions()');
+                w.line();
+                if (options.dataDriven)
+                    w.line('// Data-driven: nothing in the recording is typed, selected or asserted with a value, so there is no data file.');
+                w.line(body.toString().trimEnd());
+                return;
+            }
             if (options.testIdAttribute !== 'data-testid')
-                w.line(`pw.Selectors.SetTestIdAttribute(${doubleQuote(options.testIdAttribute)})`);
+                w.line(setTestIdAttribute);
             if (usesExpect)
                 w.line('expect := playwright.NewPlaywrightAssertions()');
             w.line();
-            w.line(body.toString().trimEnd());
+            w.line(`// Data-driven: a subtest runs for each row of ${dataFile}. Its first row holds the recorded values.`);
+            w.block(`for i, row := range readTestgenCSV(t, ${[dataFile, ...columns.map(c => c.name)].map(doubleQuote).join(', ')}) {`, () => {
+                w.block('t.Run(fmt.Sprintf("row %d", i+1), func(t *testing.T) {', () => {
+                    w.line(newContext);
+                    w.line('require.NoError(t, err)');
+                    w.line('t.Cleanup(func() { _ = context.Close() })');
+                    w.line();
+                    w.line(body.toString().trimEnd());
+                }, '})');
+            });
         });
-        return [{ path: this.testFileName(options.name), content: w.toString() }];
+        const files = [{ path: this.testFileName(options.name), content: w.toString() }];
+        if (columns.length) {
+            files.push({ path: 'testgen_data_test.go', content: readRuntimeFile('playwright-go/testgen_data_test.go').replace(/^package \w+$/m, `package ${packageName}`), support: true }, { path: dataFile, content: toCsv([columns.map(c => c.name), columns.map(c => c.value)]), data: true });
+        }
+        return files;
     },
 };
 function goPackageName(name) {
@@ -230,8 +288,8 @@ function contextOptions(header, testIdAttribute) {
         before.unshift(`// TODO(testgen): context options not converted: ${unsupported.join(', ')}.`);
     return { before, fields };
 }
-function actionCall(subject, action, locators) {
-    const locator = 'selector' in action ? locators.render(subject, parseLocator(action.selector)) : subject;
+function actionCall(subject, action, locators, literals) {
+    const locator = 'selector' in action ? locators.render(subject, parseLocator(action.selector), literals.locator) : subject;
     const expect = (assertion) => ({ expr: `expect.Locator(${locator}).${assertion}`, returnsValue: false });
     switch (action.name) {
         case 'click': {
@@ -258,7 +316,7 @@ function actionCall(subject, action, locators) {
         case 'uncheck':
             return { expr: `${locator}.Uncheck()`, returnsValue: false };
         case 'fill':
-            return { expr: `${locator}.Fill(${doubleQuote(action.text)})`, returnsValue: false };
+            return { expr: `${locator}.Fill(${literals.value(action.text)})`, returnsValue: false };
         case 'setInputFiles': {
             const files = action.files.length === 1 ? doubleQuote(action.files[0]) : `[]string{${action.files.map(doubleQuote).join(', ')}}`;
             return { expr: `${locator}.SetInputFiles(${files})`, returnsValue: false };
@@ -268,15 +326,15 @@ function actionCall(subject, action, locators) {
         case 'navigate':
             return { expr: `${subject}.Goto(${doubleQuote(action.url)})`, returnsValue: true };
         case 'select':
-            return { expr: `${locator}.SelectOption(playwright.SelectOptionValues{ValuesOrLabels: playwright.StringSlice(${action.options.map(doubleQuote).join(', ')})})`, returnsValue: true };
+            return { expr: `${locator}.SelectOption(playwright.SelectOptionValues{ValuesOrLabels: playwright.StringSlice(${action.options.length === 1 ? literals.value(action.options[0]) : action.options.map(doubleQuote).join(', ')})})`, returnsValue: true };
         case 'assertText':
-            return expect(`${action.substring ? 'ToContainText' : 'ToHaveText'}(${doubleQuote(action.text)})`);
+            return expect(`${action.substring ? 'ToContainText' : 'ToHaveText'}(${literals.value(action.text)})`);
         case 'assertChecked':
             return expect(action.checked ? 'ToBeChecked()' : 'Not().ToBeChecked()');
         case 'assertVisible':
             return expect('ToBeVisible()');
         case 'assertValue':
-            return expect(action.value ? `ToHaveValue(${doubleQuote(action.value)})` : 'ToBeEmpty()');
+            return expect(literals.isEmpty(action.value) ? 'ToBeEmpty()' : `ToHaveValue(${literals.value(action.value)})`);
         case 'assertSnapshot':
             if (action.ariaSnapshot)
                 return expect(`ToMatchAriaSnapshot(${doubleQuote(action.ariaSnapshot)})`);
@@ -289,15 +347,21 @@ function actionCall(subject, action, locators) {
 // Renders Playwright locator steps as playwright-go calls.
 class GoLocators {
     _onRegexp;
+    _literal = doubleQuote;
     constructor(_onRegexp) {
         this._onRegexp = _onRegexp;
     }
-    render(subject, steps) {
+    // `literal` writes the text arguments of GetBy* and Filter calls.
+    render(subject, steps, literal = doubleQuote) {
+        this._literal = literal;
+        return this._render(subject, steps);
+    }
+    _render(subject, steps) {
         return subject + steps.map(step => '.' + this._step(subject, step)).join('');
     }
     _value(matcher) {
         if (!isRegex(matcher))
-            return doubleQuote(matcher);
+            return this._literal(matcher);
         this._onRegexp();
         const flags = matcher.flags.replace(/[^ims]/g, '');
         const source = (flags ? `(?${flags})` : '') + matcher.source;
@@ -335,15 +399,15 @@ class GoLocators {
             case 'has-not-text':
                 return filter('HasNotText', this._value(step.body));
             case 'has':
-                return filter('Has', this.render(subject, step.inner));
+                return filter('Has', this._render(subject, step.inner));
             case 'hasNot':
-                return filter('HasNot', this.render(subject, step.inner));
+                return filter('HasNot', this._render(subject, step.inner));
             case 'and':
-                return `And(${this.render(subject, step.inner)})`;
+                return `And(${this._render(subject, step.inner)})`;
             case 'or':
-                return `Or(${this.render(subject, step.inner)})`;
+                return `Or(${this._render(subject, step.inner)})`;
             case 'chain':
-                return `Locator(${this.render(subject, step.inner)})`;
+                return `Locator(${this._render(subject, step.inner)})`;
             case 'test-id':
                 return `GetByTestId(${this._value(step.body)})`;
             case 'role':

package/dist/generators/playwright-ts.js

@@ -1,31 +1,68 @@
 import { devices } from 'playwright-core';
 import { formatObject } from '../vendor/playwright/stringUtils.js';
 import { kebabCase, words } from '../naming.js';
-import { writeJavaScriptBody } from './javascript-body.js';
+import { writeJavaScriptBody, writeReadCsv } from './javascript-body.js';
+import { readRuntimeFile } from './runtime.js';
+import { collectTestValues, toCsv } from './test-data.js';
 import { CodeWriter, singleQuote } from './writer.js';
 export const playwrightTs = {
     id: 'playwright-ts',
     framework: 'Playwright Test',
     language: 'TypeScript',
     highlight: 'typescript',
+    features: ['dataDriven'],
     testFileName: name => `${kebabCase(name)}.spec.ts`,
     generate(recording, options) {
         const { header } = recording;
+        // Data columns are read as row.<name>, so they cannot clash with the test's own names.
+        const values = collectTestValues(recording, { dataDriven: options.dataDriven, reserved: () => false });
+        const { columns } = values;
+        const dataFile = `${kebabCase(options.name)}.csv`;
+        const title = words(options.name).join(' ');
         const w = new CodeWriter('  ');
+        const body = () => writeJavaScriptBody(w, recording, {
+            supportsDownloads: true,
+            todo: message => `// TODO(testgen): ${message}`,
+            values,
+        });
         w.line(`import { test, expect${header.deviceName ? ', devices' : ''} } from '@playwright/test';`);
+        if (columns.length) {
+            w.line(`import path from 'node:path';`);
+            w.line(`import { readCsv } from './testgen-data';`);
+        }
         const use = useOptions(header, options.testIdAttribute);
         if (use) {
             w.line();
             w.line(`test.use(${use});`);
         }
         w.line();
-        w.block(`test(${singleQuote(words(options.name).join(' '))}, async ({ page }) => {`, () => {
-            writeJavaScriptBody(w, recording, {
-                supportsDownloads: true,
-                todo: message => `// TODO(testgen): ${message}`,
+        if (columns.length) {
+            writeReadCsv(w, dataFile, columns);
+            w.line();
+            w.block('for (const [index, row] of rows.entries()) {', () => {
+                w.block(`test(\`${title} (row \${index + 1})\`, async ({ page }) => {`, body, '});');
+            });
+        }
+        else {
+            if (options.dataDriven)
+                w.line('// Data-driven: nothing in the recording is typed, selected or asserted with a value, so there is no data file.');
+            w.block(`test(${singleQuote(title)}, async ({ page }) => {`, body, '});');
+        }
+        if (values.secrets.length) {
+            w.line();
+            w.line('// Values typed into password fields are not kept in the test: set them as environment variables.');
+            w.block('function secret(name: string): string {', () => {
+                w.line('const value = process.env[name];');
+                w.line('if (value === undefined)');
+                w.line('  throw new Error(`testgen: set the environment variable ${name}, the value to type into a password field`);');
+                w.line('return value;');
             });
-        }, '});');
-        return [{ path: this.testFileName(options.name), content: w.toString() }];
+        }
+        const files = [{ path: this.testFileName(options.name), content: w.toString() }];
+        if (columns.length) {
+            files.push({ path: 'testgen-data.ts', content: readRuntimeFile('playwright-ts/testgen-data.ts'), support: true }, { path: dataFile, content: toCsv([columns.map(c => c.name), columns.map(c => c.value)]), data: true });
+        }
+        return files;
     },
 };
 // Context options for test.use(), spreading the device descriptor like Playwright's codegen.