/**
* Copyright (c) Microsoft Corporation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { cliTest as test, expect } from '../config/cliTest';
import * as http from 'http';
test.describe('cli codegen', () => {
test.beforeEach(async ({ mode, browserName, headful }) => {
test.skip(mode !== 'default');
test.fixme(browserName === 'firefox' && headful, 'Focus is off');
});
test('should click', async ({ page, openRecorder }) => {
const recorder = await openRecorder();
await recorder.setContentAndWait(``);
const selector = await recorder.hoverOverElement('button');
expect(selector).toBe('text=Submit');
const [message, sources] = await Promise.all([
page.waitForEvent('console'),
recorder.waitForOutput('', 'click'),
page.dispatchEvent('button', 'click', { detail: 1 })
]);
expect(sources.get('').text).toContain(`
// Click text=Submit
await page.click('text=Submit');`);
expect(sources.get('').text).toContain(`
# Click text=Submit
page.click("text=Submit")`);
expect(sources.get('').text).toContain(`
# Click text=Submit
await page.click("text=Submit")`);
expect(sources.get('').text).toContain(`
// Click text=Submit
page.click("text=Submit");`);
expect(sources.get('').text).toContain(`
// Click text=Submit
await page.ClickAsync("text=Submit");`);
expect(message.text()).toBe('click');
});
test('should click after same-document navigation', async ({ page, openRecorder, httpServer }) => {
const recorder = await openRecorder();
httpServer.setHandler((req: http.IncomingMessage, res: http.ServerResponse) => {
res.setHeader('Content-Type', 'text/html; charset=utf-8');
res.end('');
});
await recorder.setContentAndWait(``, httpServer.PREFIX + '/foo.html');
await Promise.all([
page.waitForNavigation(),
page.evaluate(() => history.pushState({}, '', '/url.html')),
]);
// This is the only way to give recorder a chance to install
// the second unnecessary copy of the recorder script.
await page.waitForTimeout(1000);
const selector = await recorder.hoverOverElement('button');
expect(selector).toBe('text=Submit');
const [message, sources] = await Promise.all([
page.waitForEvent('console'),
recorder.waitForOutput('', 'click'),
page.dispatchEvent('button', 'click', { detail: 1 })
]);
expect(sources.get('').text).toContain(`
// Click text=Submit
await page.click('text=Submit');`);
expect(message.text()).toBe('click');
});
test('should work with TrustedTypes', async ({ page, openRecorder }) => {
const recorder = await openRecorder();
await recorder.setContentAndWait(`
`);
const selector = await recorder.hoverOverElement('button');
expect(selector).toBe('text=Submit');
const [message, sources] = await Promise.all([
page.waitForEvent('console'),
recorder.waitForOutput('', 'click'),
page.dispatchEvent('button', 'click', { detail: 1 })
]);
expect(sources.get('').text).toContain(`
// Click text=Submit
await page.click('text=Submit');`);
expect(sources.get('').text).toContain(`
# Click text=Submit
page.click("text=Submit")`);
expect(sources.get('').text).toContain(`
# Click text=Submit
await page.click("text=Submit")`);
expect(sources.get('').text).toContain(`
// Click text=Submit
page.click("text=Submit");`);
expect(sources.get('').text).toContain(`
// Click text=Submit
await page.ClickAsync("text=Submit");`);
expect(message.text()).toBe('click');
});
test('should not target selector preview by text regexp', async ({ page, openRecorder }) => {
const recorder = await openRecorder();
await recorder.setContentAndWait(`dummy`);
// Force highlight.
await recorder.hoverOverElement('span');
// Append text after highlight.
await page.evaluate(() => {
const div = document.createElement('div');
div.setAttribute('onclick', "console.log('click')");
div.textContent = ' Some long text here ';
document.documentElement.appendChild(div);
});
const selector = await recorder.hoverOverElement('div');
expect(selector).toBe('text=Some long text here');
// Sanity check that selector does not match our highlight.
const divContents = await page.$eval(selector, div => div.outerHTML);
expect(divContents).toBe(` Some long text here
`);
const [message, sources] = await Promise.all([
page.waitForEvent('console'),
recorder.waitForOutput('', 'click'),
page.dispatchEvent('div', 'click', { detail: 1 })
]);
expect(sources.get('').text).toContain(`
// Click text=Some long text here
await page.click('text=Some long text here');`);
expect(message.text()).toBe('click');
});
test('should fill', async ({ page, openRecorder }) => {
const recorder = await openRecorder();
await recorder.setContentAndWait(``);
const selector = await recorder.focusElement('input');
expect(selector).toBe('input[name="name"]');
const [message, sources] = await Promise.all([
page.waitForEvent('console'),
recorder.waitForOutput('', 'fill'),
page.fill('input', 'John')
]);
expect(sources.get('').text).toContain(`
// Fill input[name="name"]
await page.fill('input[name="name"]', 'John');`);
expect(sources.get('').text).toContain(`
// Fill input[name="name"]
page.fill("input[name=\\\"name\\\"]", "John");`);
expect(sources.get('').text).toContain(`
# Fill input[name="name"]
page.fill(\"input[name=\\\"name\\\"]\", \"John\")`);
expect(sources.get('').text).toContain(`
# Fill input[name="name"]
await page.fill(\"input[name=\\\"name\\\"]\", \"John\")`);
expect(sources.get('').text).toContain(`
// Fill input[name="name"]
await page.FillAsync(\"input[name=\\\"name\\\"]\", \"John\");`);
expect(message.text()).toBe('John');
});
test('should fill textarea', async ({ page, openRecorder }) => {
const recorder = await openRecorder();
await recorder.setContentAndWait(``);
const selector = await recorder.focusElement('textarea');
expect(selector).toBe('textarea[name="name"]');
const [message, sources] = await Promise.all([
page.waitForEvent('console'),
recorder.waitForOutput('', 'fill'),
page.fill('textarea', 'John')
]);
expect(sources.get('').text).toContain(`
// Fill textarea[name="name"]
await page.fill('textarea[name="name"]', 'John');`);
expect(message.text()).toBe('John');
});
test('should press', async ({ page, openRecorder }) => {
const recorder = await openRecorder();
await recorder.setContentAndWait(``);
const selector = await recorder.focusElement('input');
expect(selector).toBe('input[name="name"]');
const messages: any[] = [];
page.on('console', message => messages.push(message));
const [, sources] = await Promise.all([
recorder.waitForActionPerformed(),
recorder.waitForOutput('', 'press'),
page.press('input', 'Shift+Enter')
]);
expect(sources.get('').text).toContain(`
// Press Enter with modifiers
await page.press('input[name="name"]', 'Shift+Enter');`);
expect(sources.get('').text).toContain(`
// Press Enter with modifiers
page.press("input[name=\\\"name\\\"]", "Shift+Enter");`);
expect(sources.get('').text).toContain(`
# Press Enter with modifiers
page.press(\"input[name=\\\"name\\\"]\", \"Shift+Enter\")`);
expect(sources.get('').text).toContain(`
# Press Enter with modifiers
await page.press(\"input[name=\\\"name\\\"]\", \"Shift+Enter\")`);
expect(sources.get('').text).toContain(`
// Press Enter with modifiers
await page.PressAsync(\"input[name=\\\"name\\\"]\", \"Shift+Enter\");`);
expect(messages[0].text()).toBe('press');
});
test('should update selected element after pressing Tab', async ({ page, openRecorder }) => {
const recorder = await openRecorder();
await recorder.setContentAndWait(`
`);
await page.click('input[name="one"]');
await recorder.waitForOutput('', 'click');
await page.keyboard.type('foobar123');
await recorder.waitForOutput('', 'foobar123');
await page.keyboard.press('Tab');
await recorder.waitForOutput('', 'Tab');
await page.keyboard.type('barfoo321');
await recorder.waitForOutput('', 'barfoo321');
const text = recorder.sources().get('').text;
expect(text).toContain(`
// Fill input[name="one"]
await page.fill('input[name="one"]', 'foobar123');`);
expect(text).toContain(`
// Press Tab
await page.press('input[name="one"]', 'Tab');`);
expect(text).toContain(`
// Fill input[name="two"]
await page.fill('input[name="two"]', 'barfoo321');`);
});
test('should record ArrowDown', async ({ page, openRecorder }) => {
const recorder = await openRecorder();
await recorder.setContentAndWait(``);
const selector = await recorder.focusElement('input');
expect(selector).toBe('input[name="name"]');
const messages: any[] = [];
page.on('console', message => {
messages.push(message);
});
const [, sources] = await Promise.all([
recorder.waitForActionPerformed(),
recorder.waitForOutput('', 'press'),
page.press('input', 'ArrowDown')
]);
expect(sources.get('').text).toContain(`
// Press ArrowDown
await page.press('input[name="name"]', 'ArrowDown');`);
expect(messages[0].text()).toBe('press:ArrowDown');
});
test('should emit single keyup on ArrowDown', async ({ page, openRecorder }) => {
const recorder = await openRecorder();
await recorder.setContentAndWait(``);
const selector = await recorder.focusElement('input');
expect(selector).toBe('input[name="name"]');
const messages: any[] = [];
page.on('console', message => {
messages.push(message);
});
const [, sources] = await Promise.all([
recorder.waitForActionPerformed(),
recorder.waitForOutput('', 'press'),
page.press('input', 'ArrowDown')
]);
expect(sources.get('').text).toContain(`
// Press ArrowDown
await page.press('input[name="name"]', 'ArrowDown');`);
expect(messages.length).toBe(2);
expect(messages[0].text()).toBe('down:ArrowDown');
expect(messages[1].text()).toBe('up:ArrowDown');
});
test('should check', async ({ page, openRecorder }) => {
const recorder = await openRecorder();
await recorder.setContentAndWait(``);
const selector = await recorder.focusElement('input');
expect(selector).toBe('input[name="accept"]');
const [message, sources] = await Promise.all([
page.waitForEvent('console'),
recorder.waitForOutput('', 'check'),
page.click('input')
]);
expect(sources.get('').text).toContain(`
// Check input[name="accept"]
await page.check('input[name="accept"]');`);
expect(sources.get('').text).toContain(`
// Check input[name="accept"]
page.check("input[name=\\\"accept\\\"]");`);
expect(sources.get('').text).toContain(`
# Check input[name="accept"]
page.check(\"input[name=\\\"accept\\\"]\")`);
expect(sources.get('').text).toContain(`
# Check input[name="accept"]
await page.check(\"input[name=\\\"accept\\\"]\")`);
expect(sources.get('').text).toContain(`
// Check input[name="accept"]
await page.CheckAsync(\"input[name=\\\"accept\\\"]\");`);
expect(message.text()).toBe('true');
});
test('should check with keyboard', async ({ page, openRecorder }) => {
const recorder = await openRecorder();
await recorder.setContentAndWait(``);
const selector = await recorder.focusElement('input');
expect(selector).toBe('input[name="accept"]');
const [message, sources] = await Promise.all([
page.waitForEvent('console'),
recorder.waitForOutput('', 'check'),
page.keyboard.press('Space')
]);
expect(sources.get('').text).toContain(`
// Check input[name="accept"]
await page.check('input[name="accept"]');`);
expect(message.text()).toBe('true');
});
test('should uncheck', async ({ page, openRecorder }) => {
const recorder = await openRecorder();
await recorder.setContentAndWait(``);
const selector = await recorder.focusElement('input');
expect(selector).toBe('input[name="accept"]');
const [message, sources] = await Promise.all([
page.waitForEvent('console'),
recorder.waitForOutput('', 'uncheck'),
page.click('input')
]);
expect(sources.get('').text).toContain(`
// Uncheck input[name="accept"]
await page.uncheck('input[name="accept"]');`);
expect(sources.get('').text).toContain(`
// Uncheck input[name="accept"]
page.uncheck("input[name=\\\"accept\\\"]");`);
expect(sources.get('').text).toContain(`
# Uncheck input[name="accept"]
page.uncheck(\"input[name=\\\"accept\\\"]\")`);
expect(sources.get('').text).toContain(`
# Uncheck input[name="accept"]
await page.uncheck(\"input[name=\\\"accept\\\"]\")`);
expect(sources.get('').text).toContain(`
// Uncheck input[name="accept"]
await page.UncheckAsync(\"input[name=\\\"accept\\\"]\");`);
expect(message.text()).toBe('false');
});
test('should select', async ({ page, openRecorder }) => {
const recorder = await openRecorder();
await recorder.setContentAndWait('');
const selector = await recorder.hoverOverElement('select');
expect(selector).toBe('select');
const [message, sources] = await Promise.all([
page.waitForEvent('console'),
recorder.waitForOutput('', 'select'),
page.selectOption('select', '2')
]);
expect(sources.get('').text).toContain(`
// Select 2
await page.selectOption('select', '2');`);
expect(sources.get('').text).toContain(`
// Select 2
page.selectOption("select", "2");`);
expect(sources.get('').text).toContain(`
# Select 2
page.select_option(\"select\", \"2\")`);
expect(sources.get('').text).toContain(`
# Select 2
await page.select_option(\"select\", \"2\")`);
expect(sources.get('').text).toContain(`
// Select 2
await page.SelectOptionAsync(\"select\", \"2\");`);
expect(message.text()).toBe('2');
});
test('should await popup', async ({ page, openRecorder, browserName, headful }) => {
test.fixme(browserName === 'webkit' && headful, 'Middle click does not open a popup in our webkit embedder');
const recorder = await openRecorder();
await recorder.setContentAndWait('link');
const selector = await recorder.hoverOverElement('a');
expect(selector).toBe('text=link');
const [popup, sources] = await Promise.all([
page.context().waitForEvent('page'),
recorder.waitForOutput('', 'waitForEvent'),
page.dispatchEvent('a', 'click', { detail: 1 })
]);
expect(sources.get('').text).toContain(`
// Click text=link
const [page1] = await Promise.all([
page.waitForEvent('popup'),
page.click('text=link')
]);`);
expect(sources.get('').text).toContain(`
// Click text=link
Page page1 = page.waitForPopup(() -> {
page.click("text=link");
});`);
expect(sources.get('').text).toContain(`
# Click text=link
with page.expect_popup() as popup_info:
page.click(\"text=link\")
page1 = popup_info.value`);
expect(sources.get('').text).toContain(`
# Click text=link
async with page.expect_popup() as popup_info:
await page.click(\"text=link\")
page1 = await popup_info.value`);
expect(sources.get('').text).toContain(`
var page1Task = page.WaitForEventAsync(PageEvent.Popup)
await Task.WhenAll(
page1Task,
page.ClickAsync(\"text=link\"));`);
expect(popup.url()).toBe('about:blank');
});
test('should assert navigation', async ({ page, openRecorder }) => {
const recorder = await openRecorder();
await recorder.setContentAndWait(`link`);
const selector = await recorder.hoverOverElement('a');
expect(selector).toBe('text=link');
const [, sources] = await Promise.all([
page.waitForNavigation(),
recorder.waitForOutput('', 'assert'),
page.dispatchEvent('a', 'click', { detail: 1 })
]);
expect(sources.get('').text).toContain(`
// Click text=link
await page.click('text=link');
// assert.equal(page.url(), 'about:blank#foo');`);
expect(sources.get('').text).toContain(`
// Click text=link
page.click("text=link");
// assert page.url().equals("about:blank#foo");`);
expect(sources.get('').text).toContain(`
# Click text=link
page.click(\"text=link\")
# assert page.url == \"about:blank#foo\"`);
expect(sources.get('').text).toContain(`
# Click text=link
await page.click(\"text=link\")
# assert page.url == \"about:blank#foo\"`);
expect(sources.get('').text).toContain(`
// Click text=link
await page.ClickAsync(\"text=link\");
// Assert.Equal(\"about:blank#foo\", page.Url);`);
expect(page.url()).toContain('about:blank#foo');
});
test('should await navigation', async ({ page, openRecorder }) => {
const recorder = await openRecorder();
await recorder.setContentAndWait(`link`);
const selector = await recorder.hoverOverElement('a');
expect(selector).toBe('text=link');
const [, sources] = await Promise.all([
page.waitForNavigation(),
recorder.waitForOutput('', 'waitForNavigation'),
page.dispatchEvent('a', 'click', { detail: 1 })
]);
expect(sources.get('').text).toContain(`
// Click text=link
await Promise.all([
page.waitForNavigation(/*{ url: 'about:blank#foo' }*/),
page.click('text=link')
]);`);
expect(sources.get('').text).toContain(`
// Click text=link
// page.waitForNavigation(new Page.WaitForNavigationOptions().setUrl("about:blank#foo"), () ->
page.waitForNavigation(() -> {
page.click("text=link");
});`);
expect(sources.get('').text).toContain(`
# Click text=link
# with page.expect_navigation(url=\"about:blank#foo\"):
with page.expect_navigation():
page.click(\"text=link\")`);
expect(sources.get('').text).toContain(`
# Click text=link
# async with page.expect_navigation(url=\"about:blank#foo\"):
async with page.expect_navigation():
await page.click(\"text=link\")`);
expect(sources.get('').text).toContain(`
// Click text=link
await Task.WhenAll(
page.WaitForNavigationAsync(/*\"about:blank#foo\"*/),
page.ClickAsync(\"text=link\"));`);
expect(page.url()).toContain('about:blank#foo');
});
test('should ignore AltGraph', async ({ openRecorder, isFirefox }, testInfo) => {
testInfo.skip(isFirefox, 'The TextInputProcessor in Firefox does not work with AltGraph.');
const recorder = await openRecorder();
await recorder.setContentAndWait(``);
await recorder.page.type('input', 'playwright');
await recorder.page.keyboard.press('AltGraph');
await recorder.page.keyboard.insertText('@');
await recorder.page.keyboard.type('example.com');
await recorder.waitForOutput('', 'example.com');
expect(recorder.sources().get('').text).not.toContain(`await page.press('input', 'AltGraph');`);
expect(recorder.sources().get('').text).toContain(`await page.fill('input', 'playwright@example.com');`);
});
});