Filip/playwright
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

feat(codegen): brush up context options in pytest codegen (#13924)

Browse source
This commit is contained in:
Dmitry Gozman 2022-05-04 11:14:53 +01:00 committed by GitHub
parent 315fc3751e
commit 9e0aa67d28
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 28 additions and 30 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

46
packages/playwright-core/src/server/recorder/python.ts
View file

@ -33,20 +33,20 @@ export class PythonLanguageGenerator implements LanguageGenerator {
private _awaitPrefix: '' | 'await '; private _awaitPrefix: '' | 'await ';
private _asyncPrefix: '' | 'async '; private _asyncPrefix: '' | 'async ';
private _isAsync: boolean; private _isAsync: boolean;
private _isTest: boolean; private _isPyTest: boolean;
constructor(isAsync: boolean, isTest: boolean) { constructor(isAsync: boolean, isPyTest: boolean) {
this.id = isTest ? 'pytest' : (isAsync ? 'python-async' : 'python'); this.id = isPyTest ? 'pytest' : (isAsync ? 'python-async' : 'python');
this.fileName = isTest ? 'Pytest' : (isAsync ? 'Python Async' : 'Python'); this.fileName = isPyTest ? 'Pytest' : (isAsync ? 'Python Async' : 'Python');
this._isAsync = isAsync; this._isAsync = isAsync;
this._isTest = isTest; this._isPyTest = isPyTest;
this._awaitPrefix = isAsync ? 'await ' : ''; this._awaitPrefix = isAsync ? 'await ' : '';
this._asyncPrefix = isAsync ? 'async ' : ''; this._asyncPrefix = isAsync ? 'async ' : '';
} }
generateAction(actionInContext: ActionInContext): string { generateAction(actionInContext: ActionInContext): string {
const action = actionInContext.action; const action = actionInContext.action;
if (this._isTest && (action.name === 'openPage' || action.name === 'closePage')) if (this._isPyTest && (action.name === 'openPage' || action.name === 'closePage'))
return ''; return '';
const pageAlias = actionInContext.frame.pageAlias; const pageAlias = actionInContext.frame.pageAlias;
@ -155,20 +155,18 @@ export class PythonLanguageGenerator implements LanguageGenerator {
generateHeader(options: LanguageGeneratorOptions): string { generateHeader(options: LanguageGeneratorOptions): string {
const formatter = new PythonFormatter(); const formatter = new PythonFormatter();
if (this._isTest) { if (this._isPyTest) {
formatter.add(`${options.deviceName ? 'import pytest\n' : ''} const contextOptions = formatContextOptions(options.contextOptions, options.deviceName, true /* asDict */);
from playwright.sync_api import Page, expect const fixture = contextOptions ? `
${options.deviceName ? `
@pytest.fixture(scope="session") @pytest.fixture(scope="session")
def browser_context_args(browser_context_args, playwright) { def browser_context_args(browser_context_args, playwright) {
device = playwright.devices["${options.deviceName}"] return {${contextOptions}}
return dict(
**browser_context_args,
**device,
)
} }
` : ''} ` : '';
formatter.add(`${options.deviceName ? 'import pytest\n' : ''}
from playwright.sync_api import Page, expect
${fixture}
def test_example(page: Page) -> None {`); def test_example(page: Page) -> None {`);
} else if (this._isAsync) { } else if (this._isAsync) {
@ -194,7 +192,7 @@ def run(playwright: Playwright) -> None {
} }
generateFooter(saveStorage: string | undefined): string { generateFooter(saveStorage: string | undefined): string {
if (this._isTest) { if (this._isPyTest) {
return ''; return '';
} else if (this._isAsync) { } else if (this._isAsync) {
const storageStateLine = saveStorage ? `\n await context.storage_state(path=${quote(saveStorage)})` : ''; const storageStateLine = saveStorage ? `\n await context.storage_state(path=${quote(saveStorage)})` : '';
@ -245,18 +243,22 @@ function toSnakeCase(name: string): string {
return name.replace(toSnakeCaseRegex, `_$1`).toLowerCase(); return name.replace(toSnakeCaseRegex, `_$1`).toLowerCase();
} }
function formatOptions(value: any, hasArguments: boolean): string { function formatOptions(value: any, hasArguments: boolean, asDict?: boolean): string {
const keys = Object.keys(value); const keys = Object.keys(value);
if (!keys.length) if (!keys.length)
return ''; return '';
return (hasArguments ? ', ' : '') + keys.map(key => `${toSnakeCase(key)}=${formatValue(value[key])}`).join(', '); return (hasArguments ? ', ' : '') + keys.map(key => {
if (asDict)
return `"${toSnakeCase(key)}": ${formatValue(value[key])}`;
return `${toSnakeCase(key)}=${formatValue(value[key])}`;
}).join(', ');
} }
function formatContextOptions(options: BrowserContextOptions, deviceName: string | undefined): string { function formatContextOptions(options: BrowserContextOptions, deviceName: string | undefined, asDict?: boolean): string {
const device = deviceName && deviceDescriptors[deviceName]; const device = deviceName && deviceDescriptors[deviceName];
if (!device) if (!device)
return formatOptions(options, false); return formatOptions(options, false, asDict);
return `**playwright.devices[${quote(deviceName!)}]` + formatOptions(sanitizeDeviceOptions(device, options), true); return `**playwright.devices[${quote(deviceName!)}]` + formatOptions(sanitizeDeviceOptions(device, options), true, asDict);
} }
class PythonFormatter { class PythonFormatter {

12
tests/library/inspector/cli-codegen-pytest.spec.ts
View file

@ -30,11 +30,11 @@ def test_example(page: Page) -> None:`;
expect(cli.text()).toContain(expectedResult); expect(cli.text()).toContain(expectedResult);
}); });
test('should print the correct context options when using a device', async ({ browserName, runCLI }, testInfo) => { test('should print the correct context options when using a device and lang', async ({ browserName, runCLI }, testInfo) => {
test.skip(browserName !== 'webkit'); test.skip(browserName !== 'webkit');
const tmpFile = testInfo.outputPath('script.js'); const tmpFile = testInfo.outputPath('script.js');
const cli = runCLI(['--target=pytest', '--device=iPhone 11', '--output', tmpFile, emptyHTML]); const cli = runCLI(['--target=pytest', '--device=iPhone 11', '--lang=en-US', '--output', tmpFile, emptyHTML]);
await cli.exited; await cli.exited;
const content = fs.readFileSync(tmpFile); const content = fs.readFileSync(tmpFile);
expect(content.toString()).toBe(`import pytest expect(content.toString()).toBe(`import pytest
@ -44,11 +44,7 @@ from playwright.sync_api import Page, expect
@pytest.fixture(scope="session") @pytest.fixture(scope="session")
def browser_context_args(browser_context_args, playwright): def browser_context_args(browser_context_args, playwright):
device = playwright.devices["iPhone 11"] return {**playwright.devices["iPhone 11"], "locale": "en-US"}
return dict(
**browser_context_args,
**device,
)
def test_example(page: Page) -> None: def test_example(page: Page) -> None:
@ -59,7 +55,7 @@ def test_example(page: Page) -> None:
}); });
test('should save the codegen output to a file if specified', async ({ runCLI }, testInfo) => { test('should save the codegen output to a file if specified', async ({ runCLI }, testInfo) => {
const tmpFile = testInfo.outputPath('script.js'); const tmpFile = testInfo.outputPath('test_example.py');
const cli = runCLI(['--target=pytest', '--output', tmpFile, emptyHTML]); const cli = runCLI(['--target=pytest', '--output', tmpFile, emptyHTML]);
await cli.exited; await cli.exited;
const content = fs.readFileSync(tmpFile); const content = fs.readFileSync(tmpFile);