playwright/tests/library/debug-controller.spec.ts

185 lines
6.5 KiB
TypeScript

/**
* 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 { expect, playwrightTest as baseTest } from '../config/browserTest';
import { PlaywrightServer } from '../../packages/playwright-core/lib/remote/playwrightServer';
import { createGuid } from '../../packages/playwright-core/lib/utils';
import { Backend } from '../config/debugControllerBackend';
import type { Browser, BrowserContext } from '@playwright/test';
type Fixtures = {
wsEndpoint: string;
backend: Backend;
connectedBrowser: Browser & { _newContextForReuse: () => Promise<BrowserContext> };
};
const test = baseTest.extend<Fixtures>({
wsEndpoint: async ({ }, use) => {
process.env.PW_DEBUG_CONTROLLER_HEADLESS = '1';
const server = new PlaywrightServer({ path: '/' + createGuid(), maxConnections: Number.MAX_VALUE, enableSocksProxy: false });
const wsEndpoint = await server.listen();
await use(wsEndpoint);
await server.close();
},
backend: async ({ wsEndpoint }, use) => {
const backend = new Backend();
await backend.connect(wsEndpoint);
await use(backend);
await backend.close();
},
connectedBrowser: async ({ wsEndpoint, browserType }, use) => {
const oldValue = (browserType as any)._defaultConnectOptions;
(browserType as any)._defaultConnectOptions = {
wsEndpoint,
headers: { 'x-playwright-reuse-context': '1', },
};
const browser = await browserType.launch();
(browserType as any)._defaultConnectOptions = oldValue;
await use(browser as any);
await browser.close();
},
});
test.slow(true, 'All controller tests are slow');
test('should pick element', async ({ backend, connectedBrowser }) => {
const events = [];
backend.on('inspectRequested', event => events.push(event));
await backend.setMode({ mode: 'inspecting' });
const context = await connectedBrowser._newContextForReuse();
const [page] = context.pages();
await page.setContent('<button>Submit</button>');
await page.getByRole('button').click();
await page.getByRole('button').click();
expect(events).toEqual([
{
selector: 'internal:role=button[name=\"Submit\"s]',
locator: 'getByRole(\'button\', { name: \'Submit\' })',
}, {
selector: 'internal:role=button[name=\"Submit\"s]',
locator: 'getByRole(\'button\', { name: \'Submit\' })',
},
]);
// No events after mode disabled
await backend.setMode({ mode: 'none' });
await page.locator('body').click();
expect(events).toHaveLength(2);
});
test('should report pages', async ({ backend, connectedBrowser }) => {
const events = [];
backend.on('stateChanged', event => events.push(event));
await backend.setReportStateChanged({ enabled: true });
const context = await connectedBrowser._newContextForReuse();
const page1 = await context.newPage();
const page2 = await context.newPage();
await page1.close();
await page2.close();
await backend.setReportStateChanged({ enabled: false });
const page3 = await context.newPage();
await page3.close();
expect(events).toEqual([
{
pageCount: 1,
}, {
pageCount: 2,
}, {
pageCount: 1,
}, {
pageCount: 0,
}
]);
});
test('should navigate all', async ({ backend, connectedBrowser }) => {
const context = await connectedBrowser._newContextForReuse();
const page1 = await context.newPage();
const page2 = await context.newPage();
await backend.navigate({ url: 'data:text/plain,Hello world' });
expect(await page1.evaluate(() => window.location.href)).toBe('data:text/plain,Hello world');
expect(await page2.evaluate(() => window.location.href)).toBe('data:text/plain,Hello world');
});
test('should reset for reuse', async ({ backend, connectedBrowser }) => {
const context = await connectedBrowser._newContextForReuse();
const page1 = await context.newPage();
const page2 = await context.newPage();
await backend.navigate({ url: 'data:text/plain,Hello world' });
const context2 = await connectedBrowser._newContextForReuse();
expect(await context2.pages()[0].evaluate(() => window.location.href)).toBe('about:blank');
expect(await page1.evaluate(() => window.location.href)).toBe('about:blank');
expect(await page2.evaluate(() => window.location.href).catch(e => e.message)).toContain('Target page, context or browser has been closed');
});
test('should highlight all', async ({ backend, connectedBrowser }) => {
const context = await connectedBrowser._newContextForReuse();
const page1 = await context.newPage();
const page2 = await context.newPage();
await backend.navigate({ url: 'data:text/html,<button>Submit</button>' });
await backend.highlight({ selector: 'button' });
await expect(page1.getByText('locator(\'button\')')).toBeVisible();
await expect(page2.getByText('locator(\'button\')')).toBeVisible();
await backend.hideHighlight();
await expect(page1.getByText('locator(\'button\')')).toBeHidden({ timeout: 1000000 });
await expect(page2.getByText('locator(\'button\')')).toBeHidden();
});
test('should record', async ({ backend, connectedBrowser }) => {
const events = [];
backend.on('sourceChanged', event => events.push(event));
await backend.setMode({ mode: 'recording' });
const context = await connectedBrowser._newContextForReuse();
const [page] = context.pages();
await page.setContent('<button>Submit</button>');
await page.getByRole('button').click();
await expect.poll(() => events[events.length - 1]).toEqual({
header: `import { test, expect } from '@playwright/test';
test('test', async ({ page }) => {`,
footer: `});`,
actions: [
` await page.goto('about:blank');`,
` await page.getByRole('button', { name: 'Submit' }).click();`,
],
text: `import { test, expect } from '@playwright/test';
test('test', async ({ page }) => {
await page.goto('about:blank');
await page.getByRole('button', { name: 'Submit' }).click();
});`
});
const length = events.length;
// No events after mode disabled
await backend.setMode({ mode: 'none' });
await page.getByRole('button').click();
expect(events).toHaveLength(length);
});