/** * Copyright (c) Microsoft Corporation. All rights reserved. * * 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 { contextTest as it, expect } from '../config/browserTest'; import { asLocator } from '../../packages/playwright-core/lib/server/isomorphic/locatorGenerators'; import type { Page, Frame, Locator } from 'playwright-core'; function generate(locator: Locator) { const result: any = {}; for (const lang of ['javascript', 'python', 'java', 'csharp']) result[lang] = asLocator(lang, (locator as any)._selector, false); return result; } async function generateForNode(pageOrFrame: Page | Frame, target: string): Promise { const selector = await pageOrFrame.locator(target).evaluate(e => (window as any).playwright.selector(e)); const result: any = {}; for (const lang of ['javascript', 'python', 'java', 'csharp']) result[lang] = asLocator(lang, selector, false); return result; } it('reverse engineer locators', async ({ page }) => { expect.soft(generate(page.getByTestId('Hello'))).toEqual({ javascript: "getByTestId('Hello')", python: 'get_by_test_id("Hello")', java: 'getByTestId("Hello")', csharp: 'GetByTestId("Hello")' }); expect.soft(generate(page.getByTestId('He"llo'))).toEqual({ javascript: 'getByTestId(\'He"llo\')', python: 'get_by_test_id("He\\\"llo")', java: 'getByTestId("He\\\"llo")', csharp: 'GetByTestId("He\\\"llo")' }); expect.soft(generate(page.getByText('Hello', { exact: true }))).toEqual({ csharp: 'GetByText("Hello", new() { Exact: true })', java: 'getByText("Hello", new Page.GetByTextOptions().setExact(exact))', javascript: 'getByText(\'Hello\', { exact: true })', python: 'get_by_text("Hello", exact=true)', }); expect.soft(generate(page.getByText('Hello'))).toEqual({ csharp: 'GetByText("Hello")', java: 'getByText("Hello")', javascript: 'getByText(\'Hello\')', python: 'get_by_text("Hello")', }); expect.soft(generate(page.getByText(/Hello/))).toEqual({ csharp: 'GetByText(new Regex("Hello"))', java: 'getByText(Pattern.compile("Hello"))', javascript: 'getByText(/Hello/)', python: 'get_by_text(re.compile(r"Hello"))', }); expect.soft(generate(page.getByLabel('Name'))).toEqual({ csharp: 'GetByLabel("Name")', java: 'getByLabel("Name")', javascript: 'getByLabel(\'Name\')', python: 'get_by_label("Name")', }); expect.soft(generate(page.getByLabel('Last Name', { exact: true }))).toEqual({ csharp: 'GetByLabel("Last Name", new() { Exact: true })', java: 'getByLabel("Last Name", new Page.GetByLabelOptions().setExact(exact))', javascript: 'getByLabel(\'Last Name\', { exact: true })', python: 'get_by_label("Last Name", exact=true)', }); expect.soft(generate(page.getByLabel(/Last\s+name/i))).toEqual({ csharp: 'GetByLabel(new Regex("Last\\\\s+name", RegexOptions.IgnoreCase))', java: 'getByLabel(Pattern.compile("Last\\\\s+name", Pattern.CASE_INSENSITIVE))', javascript: 'getByLabel(/Last\\s+name/i)', python: 'get_by_label(re.compile(r"Last\\\\s+name", re.IGNORECASE))', }); expect.soft(generate(page.getByPlaceholder('hello'))).toEqual({ csharp: 'GetByPlaceholder("hello")', java: 'getByPlaceholder("hello")', javascript: 'getByPlaceholder(\'hello\')', python: 'get_by_placeholder("hello")', }); expect.soft(generate(page.getByPlaceholder('Hello', { exact: true }))).toEqual({ csharp: 'GetByPlaceholder("Hello", new() { Exact: true })', java: 'getByPlaceholder("Hello", new Page.GetByPlaceholderOptions().setExact(exact))', javascript: 'getByPlaceholder(\'Hello\', { exact: true })', python: 'get_by_placeholder("Hello", exact=true)', }); expect.soft(generate(page.getByPlaceholder(/wor/i))).toEqual({ csharp: 'GetByPlaceholder(new Regex("wor", RegexOptions.IgnoreCase))', java: 'getByPlaceholder(Pattern.compile("wor", Pattern.CASE_INSENSITIVE))', javascript: 'getByPlaceholder(/wor/i)', python: 'get_by_placeholder(re.compile(r"wor", re.IGNORECASE))', }); expect.soft(generate(page.getByAltText('hello'))).toEqual({ csharp: 'GetByAltText("hello")', java: 'getByAltText("hello")', javascript: 'getByAltText(\'hello\')', python: 'get_by_alt_text("hello")', }); expect.soft(generate(page.getByAltText('Hello', { exact: true }))).toEqual({ csharp: 'GetByAltText("Hello", new() { Exact: true })', java: 'getByAltText("Hello", new Page.GetByAltTextOptions().setExact(exact))', javascript: 'getByAltText(\'Hello\', { exact: true })', python: 'get_by_alt_text("Hello", exact=true)', }); expect.soft(generate(page.getByAltText(/wor/i))).toEqual({ csharp: 'GetByAltText(new Regex("wor", RegexOptions.IgnoreCase))', java: 'getByAltText(Pattern.compile("wor", Pattern.CASE_INSENSITIVE))', javascript: 'getByAltText(/wor/i)', python: 'get_by_alt_text(re.compile(r"wor", re.IGNORECASE))', }); expect.soft(generate(page.getByTitle('hello'))).toEqual({ csharp: 'GetByTitle("hello")', java: 'getByTitle("hello")', javascript: 'getByTitle(\'hello\')', python: 'get_by_title("hello")', }); expect.soft(generate(page.getByTitle('Hello', { exact: true }))).toEqual({ csharp: 'GetByTitle("Hello", new() { Exact: true })', java: 'getByTitle("Hello", new Page.GetByTitleOptions().setExact(exact))', javascript: 'getByTitle(\'Hello\', { exact: true })', python: 'get_by_title("Hello", exact=true)', }); expect.soft(generate(page.getByTitle(/wor/i))).toEqual({ csharp: 'GetByTitle(new Regex("wor", RegexOptions.IgnoreCase))', java: 'getByTitle(Pattern.compile("wor", Pattern.CASE_INSENSITIVE))', javascript: 'getByTitle(/wor/i)', python: 'get_by_title(re.compile(r"wor", re.IGNORECASE))', }); expect.soft(generate(page.getByPlaceholder('hello my\nwo"rld'))).toEqual({ csharp: 'GetByPlaceholder("hello my\\nwo\\"rld")', java: 'getByPlaceholder("hello my\\nwo\\"rld")', javascript: 'getByPlaceholder(\'hello my\\nwo"rld\')', python: 'get_by_placeholder("hello my\\nwo\\"rld")', }); expect.soft(generate(page.getByAltText('hello my\nwo"rld'))).toEqual({ csharp: 'GetByAltText("hello my\\nwo\\"rld")', java: 'getByAltText("hello my\\nwo\\"rld")', javascript: 'getByAltText(\'hello my\\nwo"rld\')', python: 'get_by_alt_text("hello my\\nwo\\"rld")', }); expect.soft(generate(page.getByTitle('hello my\nwo"rld'))).toEqual({ csharp: 'GetByTitle("hello my\\nwo\\"rld")', java: 'getByTitle("hello my\\nwo\\"rld")', javascript: 'getByTitle(\'hello my\\nwo"rld\')', python: 'get_by_title("hello my\\nwo\\"rld")', }); }); it('reverse engineer ignore-case locators', async ({ page }) => { expect.soft(generate(page.getByText('hello my\nwo"rld'))).toEqual({ csharp: 'GetByText("hello my\\nwo\\"rld")', java: 'getByText("hello my\\nwo\\"rld")', javascript: 'getByText(\'hello my\\nwo"rld\')', python: 'get_by_text("hello my\\nwo\\"rld")', }); expect.soft(generate(page.getByText('hello my wo"rld'))).toEqual({ csharp: 'GetByText("hello my wo\\"rld")', java: 'getByText("hello my wo\\"rld")', javascript: 'getByText(\'hello my wo"rld\')', python: 'get_by_text("hello my wo\\"rld")', }); expect.soft(generate(page.getByLabel('hello my\nwo"rld'))).toEqual({ csharp: 'GetByLabel("hello my\\nwo\\"rld")', java: 'getByLabel("hello my\\nwo\\"rld")', javascript: 'getByLabel(\'hello my\\nwo"rld\')', python: 'get_by_label("hello my\\nwo\\"rld")', }); }); it.describe('selector generator', () => { it.skip(({ mode }) => mode !== 'default'); it.beforeEach(async ({ context }) => { await (context as any)._enableRecorder({ language: 'javascript' }); }); it('reverse engineer internal:has-text locators', async ({ page }) => { await page.setContent(`
Hello world
Hello world Goodbye world `); expect.soft(await generateForNode(page, 'a:has-text("Hello")')).toEqual({ csharp: 'Locator("a").Filter(new() { HasTextString: "Hello world" })', java: 'locator("a").filter(new Locator.LocatorOptions().setHasText("Hello world"))', javascript: `locator('a').filter({ hasText: 'Hello world' })`, python: 'locator("a").filter(has_text="Hello world")', }); await page.setContent(`
Hello world
Hello world `); expect.soft(await generateForNode(page, '[mark="1"]')).toEqual({ csharp: 'Locator("b").Filter(new() { HasTextString: "Hello world" }).Locator("span")', java: 'locator("b").filter(new Locator.LocatorOptions().setHasText("Hello world")).locator("span")', javascript: `locator('b').filter({ hasText: 'Hello world' }).locator('span')`, python: 'locator("b").filter(has_text="Hello world").locator("span")', }); await page.setContent(`
Hello world
Goodbye world
`); expect.soft(await generateForNode(page, '[mark="1"]')).toEqual({ csharp: 'Locator("div").Filter(new() { HasTextString: "Goodbye world" }).Locator("span")', java: 'locator("div").filter(new Locator.LocatorOptions().setHasText("Goodbye world")).locator("span")', javascript: `locator('div').filter({ hasText: 'Goodbye world' }).locator('span')`, python: 'locator("div").filter(has_text="Goodbye world").locator("span")', }); }); });