750 lines
29 KiB
TypeScript
750 lines
29 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 { parseAttributeSelector, parseSelector, stringifySelector } from './selectorParser';
|
|
import { escapeWithQuotes, normalizeEscapedRegexQuotes, toSnakeCase, toTitleCase } from './stringUtils';
|
|
|
|
import type { NestedSelectorBody } from './selectorParser';
|
|
import type { ParsedSelector } from './selectorParser';
|
|
|
|
export type Language = 'javascript' | 'python' | 'java' | 'csharp' | 'jsonl';
|
|
export type LocatorType = 'default' | 'role' | 'text' | 'label' | 'placeholder' | 'alt' | 'title' | 'test-id' | 'nth' | 'first' | 'last' | 'visible' | 'has-text' | 'has-not-text' | 'has' | 'hasNot' | 'frame' | 'frame-locator' | 'and' | 'or' | 'chain';
|
|
export type LocatorBase = 'page' | 'locator' | 'frame-locator';
|
|
export type Quote = '\'' | '"' | '`';
|
|
|
|
type LocatorOptions = {
|
|
attrs?: { name: string, value: string | boolean | number }[],
|
|
exact?: boolean,
|
|
name?: string | RegExp,
|
|
description?: string | RegExp,
|
|
hasText?: string | RegExp,
|
|
hasNotText?: string | RegExp,
|
|
};
|
|
export interface LocatorFactory {
|
|
generateLocator(base: LocatorBase, kind: LocatorType, body: string | RegExp, options?: LocatorOptions): string;
|
|
chainLocators(locators: string[]): string;
|
|
}
|
|
|
|
export function asLocatorDescription(lang: Language, selector: string): string {
|
|
try {
|
|
const parsed = parseSelector(selector);
|
|
const customDescription = parseCustomDescription(parsed);
|
|
if (customDescription)
|
|
return customDescription;
|
|
return innerAsLocators(new generators[lang](), parsed, false, 1)[0];
|
|
} catch (e) {
|
|
// Tolerate invalid input.
|
|
return selector;
|
|
}
|
|
}
|
|
|
|
export function locatorCustomDescription(selector: string): string | undefined {
|
|
try {
|
|
const parsed = parseSelector(selector);
|
|
return parseCustomDescription(parsed);
|
|
} catch (e) {
|
|
return undefined;
|
|
}
|
|
}
|
|
|
|
function parseCustomDescription(parsed: ParsedSelector): string | undefined {
|
|
const lastPart = parsed.parts[parsed.parts.length - 1];
|
|
if (lastPart?.name === 'internal:describe') {
|
|
const description = JSON.parse(lastPart.body as string);
|
|
if (typeof description === 'string')
|
|
return description;
|
|
}
|
|
return undefined;
|
|
}
|
|
|
|
export function asLocator(lang: Language, selector: string, isFrameLocator: boolean = false): string {
|
|
return asLocators(lang, selector, isFrameLocator, 1)[0];
|
|
}
|
|
|
|
export function asLocators(lang: Language, selector: string, isFrameLocator: boolean = false, maxOutputSize = 20, preferredQuote?: Quote): string[] {
|
|
try {
|
|
return innerAsLocators(new generators[lang](preferredQuote), parseSelector(selector), isFrameLocator, maxOutputSize);
|
|
} catch (e) {
|
|
// Tolerate invalid input.
|
|
return [selector];
|
|
}
|
|
}
|
|
|
|
function innerAsLocators(factory: LocatorFactory, parsed: ParsedSelector, isFrameLocator: boolean = false, maxOutputSize = 20): string[] {
|
|
const parts = [...parsed.parts];
|
|
const tokens: string[][] = [];
|
|
let nextBase: LocatorBase = isFrameLocator ? 'frame-locator' : 'page';
|
|
for (let index = 0; index < parts.length; index++) {
|
|
const part = parts[index];
|
|
const base = nextBase;
|
|
nextBase = 'locator';
|
|
|
|
if (part.name === 'internal:describe')
|
|
continue;
|
|
if (part.name === 'nth') {
|
|
if (part.body === '0')
|
|
tokens.push([factory.generateLocator(base, 'first', ''), factory.generateLocator(base, 'nth', '0')]);
|
|
else if (part.body === '-1')
|
|
tokens.push([factory.generateLocator(base, 'last', ''), factory.generateLocator(base, 'nth', '-1')]);
|
|
else
|
|
tokens.push([factory.generateLocator(base, 'nth', part.body as string)]);
|
|
continue;
|
|
}
|
|
if (part.name === 'visible') {
|
|
tokens.push([factory.generateLocator(base, 'visible', part.body as string), factory.generateLocator(base, 'default', `visible=${part.body}`)]);
|
|
continue;
|
|
}
|
|
if (part.name === 'internal:text') {
|
|
const { exact, text } = detectExact(part.body as string);
|
|
tokens.push([factory.generateLocator(base, 'text', text, { exact })]);
|
|
continue;
|
|
}
|
|
if (part.name === 'internal:has-text') {
|
|
const { exact, text } = detectExact(part.body as string);
|
|
// There is no locator equivalent for strict has-text, leave it as is.
|
|
if (!exact) {
|
|
tokens.push([factory.generateLocator(base, 'has-text', text, { exact })]);
|
|
continue;
|
|
}
|
|
}
|
|
if (part.name === 'internal:has-not-text') {
|
|
const { exact, text } = detectExact(part.body as string);
|
|
// There is no locator equivalent for strict has-not-text, leave it as is.
|
|
if (!exact) {
|
|
tokens.push([factory.generateLocator(base, 'has-not-text', text, { exact })]);
|
|
continue;
|
|
}
|
|
}
|
|
if (part.name === 'internal:has') {
|
|
const inners = innerAsLocators(factory, (part.body as NestedSelectorBody).parsed, false, maxOutputSize);
|
|
tokens.push(inners.map(inner => factory.generateLocator(base, 'has', inner)));
|
|
continue;
|
|
}
|
|
if (part.name === 'internal:has-not') {
|
|
const inners = innerAsLocators(factory, (part.body as NestedSelectorBody).parsed, false, maxOutputSize);
|
|
tokens.push(inners.map(inner => factory.generateLocator(base, 'hasNot', inner)));
|
|
continue;
|
|
}
|
|
if (part.name === 'internal:and') {
|
|
const inners = innerAsLocators(factory, (part.body as NestedSelectorBody).parsed, false, maxOutputSize);
|
|
tokens.push(inners.map(inner => factory.generateLocator(base, 'and', inner)));
|
|
continue;
|
|
}
|
|
if (part.name === 'internal:or') {
|
|
const inners = innerAsLocators(factory, (part.body as NestedSelectorBody).parsed, false, maxOutputSize);
|
|
tokens.push(inners.map(inner => factory.generateLocator(base, 'or', inner)));
|
|
continue;
|
|
}
|
|
if (part.name === 'internal:chain') {
|
|
const inners = innerAsLocators(factory, (part.body as NestedSelectorBody).parsed, false, maxOutputSize);
|
|
tokens.push(inners.map(inner => factory.generateLocator(base, 'chain', inner)));
|
|
continue;
|
|
}
|
|
if (part.name === 'internal:label') {
|
|
const { exact, text } = detectExact(part.body as string);
|
|
tokens.push([factory.generateLocator(base, 'label', text, { exact })]);
|
|
continue;
|
|
}
|
|
if (part.name === 'internal:role') {
|
|
const attrSelector = parseAttributeSelector(part.body as string, true);
|
|
const options: LocatorOptions = { attrs: [] };
|
|
for (const attr of attrSelector.attributes) {
|
|
if (attr.name === 'name') {
|
|
options.exact = attr.caseSensitive;
|
|
options.name = attr.value;
|
|
} else if (attr.name === 'description') {
|
|
options.exact = attr.caseSensitive;
|
|
options.description = attr.value;
|
|
} else {
|
|
if (attr.name === 'level' && typeof attr.value === 'string')
|
|
attr.value = +attr.value;
|
|
options.attrs!.push({ name: attr.name === 'include-hidden' ? 'includeHidden' : attr.name, value: attr.value });
|
|
}
|
|
}
|
|
tokens.push([factory.generateLocator(base, 'role', attrSelector.name, options)]);
|
|
continue;
|
|
}
|
|
if (part.name === 'internal:testid') {
|
|
const attrSelector = parseAttributeSelector(part.body as string, true);
|
|
const { value } = attrSelector.attributes[0];
|
|
tokens.push([factory.generateLocator(base, 'test-id', value)]);
|
|
continue;
|
|
}
|
|
if (part.name === 'internal:attr') {
|
|
const attrSelector = parseAttributeSelector(part.body as string, true);
|
|
const { name, value, caseSensitive } = attrSelector.attributes[0];
|
|
const text = value as string | RegExp;
|
|
const exact = !!caseSensitive;
|
|
if (name === 'placeholder') {
|
|
tokens.push([factory.generateLocator(base, 'placeholder', text, { exact })]);
|
|
continue;
|
|
}
|
|
if (name === 'alt') {
|
|
tokens.push([factory.generateLocator(base, 'alt', text, { exact })]);
|
|
continue;
|
|
}
|
|
if (name === 'title') {
|
|
tokens.push([factory.generateLocator(base, 'title', text, { exact })]);
|
|
continue;
|
|
}
|
|
}
|
|
if (part.name === 'internal:control' && (part.body as string) === 'enter-frame') {
|
|
// transform last tokens from `${selector}` into `${selector}.contentFrame()` and `frameLocator(${selector})`
|
|
const lastTokens = tokens[tokens.length - 1];
|
|
const lastPart = parts[index - 1];
|
|
|
|
const transformed = lastTokens.map(token => factory.chainLocators([token, factory.generateLocator(base, 'frame', '')]));
|
|
if (['xpath', 'css'].includes(lastPart.name)) {
|
|
transformed.push(
|
|
factory.generateLocator(base, 'frame-locator', stringifySelector({ parts: [lastPart] })),
|
|
factory.generateLocator(base, 'frame-locator', stringifySelector({ parts: [lastPart] }, true))
|
|
);
|
|
}
|
|
|
|
lastTokens.splice(0, lastTokens.length, ...transformed);
|
|
nextBase = 'frame-locator';
|
|
continue;
|
|
}
|
|
|
|
const nextPart = parts[index + 1];
|
|
|
|
const selectorPart = stringifySelector({ parts: [part] });
|
|
const locatorPart = factory.generateLocator(base, 'default', selectorPart);
|
|
|
|
if (nextPart && ['internal:has-text', 'internal:has-not-text'].includes(nextPart.name)) {
|
|
const { exact, text } = detectExact(nextPart.body as string);
|
|
// There is no locator equivalent for strict has-text and has-not-text, leave it as is.
|
|
if (!exact) {
|
|
const nextLocatorPart = factory.generateLocator('locator', nextPart.name === 'internal:has-text' ? 'has-text' : 'has-not-text', text, { exact });
|
|
const options: LocatorOptions = {};
|
|
if (nextPart.name === 'internal:has-text')
|
|
options.hasText = text;
|
|
else
|
|
options.hasNotText = text;
|
|
const combinedPart = factory.generateLocator(base, 'default', selectorPart, options);
|
|
// Two options:
|
|
// - locator('div').filter({ hasText: 'foo' })
|
|
// - locator('div', { hasText: 'foo' })
|
|
tokens.push([factory.chainLocators([locatorPart, nextLocatorPart]), combinedPart]);
|
|
index++;
|
|
continue;
|
|
}
|
|
}
|
|
|
|
// Selectors can be prefixed with engine name, e.g. xpath=//foo
|
|
let locatorPartWithEngine: string | undefined;
|
|
if (['xpath', 'css'].includes(part.name)) {
|
|
const selectorPart = stringifySelector({ parts: [part] }, /* forceEngineName */ true);
|
|
locatorPartWithEngine = factory.generateLocator(base, 'default', selectorPart);
|
|
}
|
|
|
|
tokens.push([locatorPart, locatorPartWithEngine].filter(Boolean) as string[]);
|
|
}
|
|
|
|
return combineTokens(factory, tokens, maxOutputSize);
|
|
}
|
|
|
|
function combineTokens(factory: LocatorFactory, tokens: string[][], maxOutputSize: number): string[] {
|
|
const currentTokens = tokens.map(() => '');
|
|
const result: string[] = [];
|
|
|
|
const visit = (index: number) => {
|
|
if (index === tokens.length) {
|
|
result.push(factory.chainLocators(currentTokens));
|
|
return result.length < maxOutputSize;
|
|
}
|
|
for (const taken of tokens[index]) {
|
|
currentTokens[index] = taken;
|
|
if (!visit(index + 1))
|
|
return false;
|
|
}
|
|
return true;
|
|
};
|
|
|
|
visit(0);
|
|
return result;
|
|
}
|
|
|
|
function detectExact(text: string): { exact?: boolean, text: string | RegExp } {
|
|
let exact = false;
|
|
const match = text.match(/^\/(.*)\/([igm]*)$/);
|
|
if (match)
|
|
return { text: new RegExp(match[1], match[2]) };
|
|
if (text.endsWith('"')) {
|
|
text = JSON.parse(text);
|
|
exact = true;
|
|
} else if (text.endsWith('"s')) {
|
|
text = JSON.parse(text.substring(0, text.length - 1));
|
|
exact = true;
|
|
} else if (text.endsWith('"i')) {
|
|
text = JSON.parse(text.substring(0, text.length - 1));
|
|
exact = false;
|
|
}
|
|
return { exact, text };
|
|
}
|
|
|
|
export class JavaScriptLocatorFactory implements LocatorFactory {
|
|
constructor(private preferredQuote?: Quote) {}
|
|
|
|
generateLocator(base: LocatorBase, kind: LocatorType, body: string | RegExp, options: LocatorOptions = {}): string {
|
|
switch (kind) {
|
|
case 'default':
|
|
if (options.hasText !== undefined)
|
|
return `locator(${this.quote(body as string)}, { hasText: ${this.toHasText(options.hasText)} })`;
|
|
if (options.hasNotText !== undefined)
|
|
return `locator(${this.quote(body as string)}, { hasNotText: ${this.toHasText(options.hasNotText)} })`;
|
|
return `locator(${this.quote(body as string)})`;
|
|
case 'frame-locator':
|
|
return `frameLocator(${this.quote(body as string)})`;
|
|
case 'frame':
|
|
return `contentFrame()`;
|
|
case 'nth':
|
|
return `nth(${body})`;
|
|
case 'first':
|
|
return `first()`;
|
|
case 'last':
|
|
return `last()`;
|
|
case 'visible':
|
|
return `filter({ visible: ${body === 'true' ? 'true' : 'false'} })`;
|
|
case 'role':
|
|
const attrs: string[] = [];
|
|
if (isRegExp(options.name))
|
|
attrs.push(`name: ${this.regexToSourceString(options.name)}`);
|
|
else if (typeof options.name === 'string')
|
|
attrs.push(`name: ${this.quote(options.name)}`);
|
|
if (isRegExp(options.description))
|
|
attrs.push(`description: ${this.regexToSourceString(options.description)}`);
|
|
else if (typeof options.description === 'string')
|
|
attrs.push(`description: ${this.quote(options.description)}`);
|
|
if (options.exact && (typeof options.name === 'string' || typeof options.description === 'string'))
|
|
attrs.push(`exact: true`);
|
|
for (const { name, value } of options.attrs!)
|
|
attrs.push(`${name}: ${typeof value === 'string' ? this.quote(value) : value}`);
|
|
const attrString = attrs.length ? `, { ${attrs.join(', ')} }` : '';
|
|
return `getByRole(${this.quote(body as string)}${attrString})`;
|
|
case 'has-text':
|
|
return `filter({ hasText: ${this.toHasText(body)} })`;
|
|
case 'has-not-text':
|
|
return `filter({ hasNotText: ${this.toHasText(body)} })`;
|
|
case 'has':
|
|
return `filter({ has: ${body} })`;
|
|
case 'hasNot':
|
|
return `filter({ hasNot: ${body} })`;
|
|
case 'and':
|
|
return `and(${body})`;
|
|
case 'or':
|
|
return `or(${body})`;
|
|
case 'chain':
|
|
return `locator(${body})`;
|
|
case 'test-id':
|
|
return `getByTestId(${this.toTestIdValue(body)})`;
|
|
case 'text':
|
|
return this.toCallWithExact('getByText', body, !!options.exact);
|
|
case 'alt':
|
|
return this.toCallWithExact('getByAltText', body, !!options.exact);
|
|
case 'placeholder':
|
|
return this.toCallWithExact('getByPlaceholder', body, !!options.exact);
|
|
case 'label':
|
|
return this.toCallWithExact('getByLabel', body, !!options.exact);
|
|
case 'title':
|
|
return this.toCallWithExact('getByTitle', body, !!options.exact);
|
|
default:
|
|
throw new Error('Unknown selector kind ' + kind);
|
|
}
|
|
}
|
|
|
|
chainLocators(locators: string[]): string {
|
|
return locators.join('.');
|
|
}
|
|
|
|
private regexToSourceString(re: RegExp) {
|
|
return normalizeEscapedRegexQuotes(String(re));
|
|
}
|
|
|
|
private toCallWithExact(method: string, body: string | RegExp, exact?: boolean) {
|
|
if (isRegExp(body))
|
|
return `${method}(${this.regexToSourceString(body)})`;
|
|
return exact ? `${method}(${this.quote(body)}, { exact: true })` : `${method}(${this.quote(body)})`;
|
|
}
|
|
|
|
private toHasText(body: string | RegExp) {
|
|
if (isRegExp(body))
|
|
return this.regexToSourceString(body);
|
|
return this.quote(body);
|
|
}
|
|
|
|
private toTestIdValue(value: string | RegExp): string {
|
|
if (isRegExp(value))
|
|
return this.regexToSourceString(value);
|
|
return this.quote(value);
|
|
}
|
|
|
|
private quote(text: string) {
|
|
return escapeWithQuotes(text, this.preferredQuote ?? '\'');
|
|
}
|
|
}
|
|
|
|
export class PythonLocatorFactory implements LocatorFactory {
|
|
generateLocator(base: LocatorBase, kind: LocatorType, body: string | RegExp, options: LocatorOptions = {}): string {
|
|
switch (kind) {
|
|
case 'default':
|
|
if (options.hasText !== undefined)
|
|
return `locator(${this.quote(body as string)}, has_text=${this.toHasText(options.hasText)})`;
|
|
if (options.hasNotText !== undefined)
|
|
return `locator(${this.quote(body as string)}, has_not_text=${this.toHasText(options.hasNotText)})`;
|
|
return `locator(${this.quote(body as string)})`;
|
|
case 'frame-locator':
|
|
return `frame_locator(${this.quote(body as string)})`;
|
|
case 'frame':
|
|
return `content_frame`;
|
|
case 'nth':
|
|
return `nth(${body})`;
|
|
case 'first':
|
|
return `first`;
|
|
case 'last':
|
|
return `last`;
|
|
case 'visible':
|
|
return `filter(visible=${body === 'true' ? 'True' : 'False'})`;
|
|
case 'role':
|
|
const attrs: string[] = [];
|
|
if (isRegExp(options.name))
|
|
attrs.push(`name=${this.regexToString(options.name)}`);
|
|
else if (typeof options.name === 'string')
|
|
attrs.push(`name=${this.quote(options.name)}`);
|
|
if (isRegExp(options.description))
|
|
attrs.push(`description=${this.regexToString(options.description)}`);
|
|
else if (typeof options.description === 'string')
|
|
attrs.push(`description=${this.quote(options.description)}`);
|
|
if (options.exact && (typeof options.name === 'string' || typeof options.description === 'string'))
|
|
attrs.push(`exact=True`);
|
|
for (const { name, value } of options.attrs!) {
|
|
let valueString = typeof value === 'string' ? this.quote(value) : value;
|
|
if (typeof value === 'boolean')
|
|
valueString = value ? 'True' : 'False';
|
|
attrs.push(`${toSnakeCase(name)}=${valueString}`);
|
|
}
|
|
const attrString = attrs.length ? `, ${attrs.join(', ')}` : '';
|
|
return `get_by_role(${this.quote(body as string)}${attrString})`;
|
|
case 'has-text':
|
|
return `filter(has_text=${this.toHasText(body)})`;
|
|
case 'has-not-text':
|
|
return `filter(has_not_text=${this.toHasText(body)})`;
|
|
case 'has':
|
|
return `filter(has=${body})`;
|
|
case 'hasNot':
|
|
return `filter(has_not=${body})`;
|
|
case 'and':
|
|
return `and_(${body})`;
|
|
case 'or':
|
|
return `or_(${body})`;
|
|
case 'chain':
|
|
return `locator(${body})`;
|
|
case 'test-id':
|
|
return `get_by_test_id(${this.toTestIdValue(body)})`;
|
|
case 'text':
|
|
return this.toCallWithExact('get_by_text', body, !!options.exact);
|
|
case 'alt':
|
|
return this.toCallWithExact('get_by_alt_text', body, !!options.exact);
|
|
case 'placeholder':
|
|
return this.toCallWithExact('get_by_placeholder', body, !!options.exact);
|
|
case 'label':
|
|
return this.toCallWithExact('get_by_label', body, !!options.exact);
|
|
case 'title':
|
|
return this.toCallWithExact('get_by_title', body, !!options.exact);
|
|
default:
|
|
throw new Error('Unknown selector kind ' + kind);
|
|
}
|
|
}
|
|
|
|
chainLocators(locators: string[]): string {
|
|
return locators.join('.');
|
|
}
|
|
|
|
private regexToString(body: RegExp) {
|
|
const suffix = body.flags.includes('i') ? ', re.IGNORECASE' : '';
|
|
return `re.compile(r"${normalizeEscapedRegexQuotes(body.source).replace(/\\\//, '/').replace(/"/g, '\\"')}"${suffix})`;
|
|
}
|
|
|
|
private toCallWithExact(method: string, body: string | RegExp, exact: boolean) {
|
|
if (isRegExp(body))
|
|
return `${method}(${this.regexToString(body)})`;
|
|
if (exact)
|
|
return `${method}(${this.quote(body)}, exact=True)`;
|
|
return `${method}(${this.quote(body)})`;
|
|
}
|
|
|
|
private toHasText(body: string | RegExp) {
|
|
if (isRegExp(body))
|
|
return this.regexToString(body);
|
|
return `${this.quote(body)}`;
|
|
}
|
|
|
|
private toTestIdValue(value: string | RegExp) {
|
|
if (isRegExp(value))
|
|
return this.regexToString(value);
|
|
return this.quote(value);
|
|
}
|
|
|
|
private quote(text: string) {
|
|
return escapeWithQuotes(text, '\"');
|
|
}
|
|
}
|
|
|
|
export class JavaLocatorFactory implements LocatorFactory {
|
|
generateLocator(base: LocatorBase, kind: LocatorType, body: string | RegExp, options: LocatorOptions = {}): string {
|
|
let clazz: string;
|
|
switch (base) {
|
|
case 'page': clazz = 'Page'; break;
|
|
case 'frame-locator': clazz = 'FrameLocator'; break;
|
|
case 'locator': clazz = 'Locator'; break;
|
|
}
|
|
switch (kind) {
|
|
case 'default':
|
|
if (options.hasText !== undefined)
|
|
return `locator(${this.quote(body as string)}, new ${clazz}.LocatorOptions().setHasText(${this.toHasText(options.hasText)}))`;
|
|
if (options.hasNotText !== undefined)
|
|
return `locator(${this.quote(body as string)}, new ${clazz}.LocatorOptions().setHasNotText(${this.toHasText(options.hasNotText)}))`;
|
|
return `locator(${this.quote(body as string)})`;
|
|
case 'frame-locator':
|
|
return `frameLocator(${this.quote(body as string)})`;
|
|
case 'frame':
|
|
return `contentFrame()`;
|
|
case 'nth':
|
|
return `nth(${body})`;
|
|
case 'first':
|
|
return `first()`;
|
|
case 'last':
|
|
return `last()`;
|
|
case 'visible':
|
|
return `filter(new ${clazz}.FilterOptions().setVisible(${body === 'true' ? 'true' : 'false'}))`;
|
|
case 'role':
|
|
const attrs: string[] = [];
|
|
if (isRegExp(options.name))
|
|
attrs.push(`.setName(${this.regexToString(options.name)})`);
|
|
else if (typeof options.name === 'string')
|
|
attrs.push(`.setName(${this.quote(options.name)})`);
|
|
if (isRegExp(options.description))
|
|
attrs.push(`.setDescription(${this.regexToString(options.description)})`);
|
|
else if (typeof options.description === 'string')
|
|
attrs.push(`.setDescription(${this.quote(options.description)})`);
|
|
if (options.exact && (typeof options.name === 'string' || typeof options.description === 'string'))
|
|
attrs.push(`.setExact(true)`);
|
|
for (const { name, value } of options.attrs!)
|
|
attrs.push(`.set${toTitleCase(name)}(${typeof value === 'string' ? this.quote(value) : value})`);
|
|
const attrString = attrs.length ? `, new ${clazz}.GetByRoleOptions()${attrs.join('')}` : '';
|
|
return `getByRole(AriaRole.${toSnakeCase(body as string).toUpperCase()}${attrString})`;
|
|
case 'has-text':
|
|
return `filter(new ${clazz}.FilterOptions().setHasText(${this.toHasText(body)}))`;
|
|
case 'has-not-text':
|
|
return `filter(new ${clazz}.FilterOptions().setHasNotText(${this.toHasText(body)}))`;
|
|
case 'has':
|
|
return `filter(new ${clazz}.FilterOptions().setHas(${body}))`;
|
|
case 'hasNot':
|
|
return `filter(new ${clazz}.FilterOptions().setHasNot(${body}))`;
|
|
case 'and':
|
|
return `and(${body})`;
|
|
case 'or':
|
|
return `or(${body})`;
|
|
case 'chain':
|
|
return `locator(${body})`;
|
|
case 'test-id':
|
|
return `getByTestId(${this.toTestIdValue(body)})`;
|
|
case 'text':
|
|
return this.toCallWithExact(clazz, 'getByText', body, !!options.exact);
|
|
case 'alt':
|
|
return this.toCallWithExact(clazz, 'getByAltText', body, !!options.exact);
|
|
case 'placeholder':
|
|
return this.toCallWithExact(clazz, 'getByPlaceholder', body, !!options.exact);
|
|
case 'label':
|
|
return this.toCallWithExact(clazz, 'getByLabel', body, !!options.exact);
|
|
case 'title':
|
|
return this.toCallWithExact(clazz, 'getByTitle', body, !!options.exact);
|
|
default:
|
|
throw new Error('Unknown selector kind ' + kind);
|
|
}
|
|
}
|
|
|
|
chainLocators(locators: string[]): string {
|
|
return locators.join('.');
|
|
}
|
|
|
|
private regexToString(body: RegExp) {
|
|
const suffix = body.flags.includes('i') ? ', Pattern.CASE_INSENSITIVE' : '';
|
|
return `Pattern.compile(${this.quote(normalizeEscapedRegexQuotes(body.source))}${suffix})`;
|
|
}
|
|
|
|
private toCallWithExact(clazz: string, method: string, body: string | RegExp, exact: boolean) {
|
|
if (isRegExp(body))
|
|
return `${method}(${this.regexToString(body)})`;
|
|
if (exact)
|
|
return `${method}(${this.quote(body)}, new ${clazz}.${toTitleCase(method)}Options().setExact(true))`;
|
|
return `${method}(${this.quote(body)})`;
|
|
}
|
|
|
|
private toHasText(body: string | RegExp) {
|
|
if (isRegExp(body))
|
|
return this.regexToString(body);
|
|
return this.quote(body);
|
|
}
|
|
|
|
private toTestIdValue(value: string | RegExp) {
|
|
if (isRegExp(value))
|
|
return this.regexToString(value);
|
|
return this.quote(value);
|
|
}
|
|
|
|
private quote(text: string) {
|
|
return escapeWithQuotes(text, '\"');
|
|
}
|
|
}
|
|
|
|
export class CSharpLocatorFactory implements LocatorFactory {
|
|
generateLocator(base: LocatorBase, kind: LocatorType, body: string | RegExp, options: LocatorOptions = {}): string {
|
|
switch (kind) {
|
|
case 'default':
|
|
if (options.hasText !== undefined)
|
|
return `Locator(${this.quote(body as string)}, new() { ${this.toHasText(options.hasText)} })`;
|
|
if (options.hasNotText !== undefined)
|
|
return `Locator(${this.quote(body as string)}, new() { ${this.toHasNotText(options.hasNotText)} })`;
|
|
return `Locator(${this.quote(body as string)})`;
|
|
case 'frame-locator':
|
|
return `FrameLocator(${this.quote(body as string)})`;
|
|
case 'frame':
|
|
return `ContentFrame`;
|
|
case 'nth':
|
|
return `Nth(${body})`;
|
|
case 'first':
|
|
return `First`;
|
|
case 'last':
|
|
return `Last`;
|
|
case 'visible':
|
|
return `Filter(new() { Visible = ${body === 'true' ? 'true' : 'false'} })`;
|
|
case 'role':
|
|
const attrs: string[] = [];
|
|
if (isRegExp(options.name))
|
|
attrs.push(`NameRegex = ${this.regexToString(options.name)}`);
|
|
else if (typeof options.name === 'string')
|
|
attrs.push(`Name = ${this.quote(options.name)}`);
|
|
if (isRegExp(options.description))
|
|
attrs.push(`DescriptionRegex = ${this.regexToString(options.description)}`);
|
|
else if (typeof options.description === 'string')
|
|
attrs.push(`Description = ${this.quote(options.description)}`);
|
|
if (options.exact && (typeof options.name === 'string' || typeof options.description === 'string'))
|
|
attrs.push(`Exact = true`);
|
|
for (const { name, value } of options.attrs!)
|
|
attrs.push(`${toTitleCase(name)} = ${typeof value === 'string' ? this.quote(value) : value}`);
|
|
const attrString = attrs.length ? `, new() { ${attrs.join(', ')} }` : '';
|
|
return `GetByRole(AriaRole.${toTitleCase(body as string)}${attrString})`;
|
|
case 'has-text':
|
|
return `Filter(new() { ${this.toHasText(body)} })`;
|
|
case 'has-not-text':
|
|
return `Filter(new() { ${this.toHasNotText(body)} })`;
|
|
case 'has':
|
|
return `Filter(new() { Has = ${body} })`;
|
|
case 'hasNot':
|
|
return `Filter(new() { HasNot = ${body} })`;
|
|
case 'and':
|
|
return `And(${body})`;
|
|
case 'or':
|
|
return `Or(${body})`;
|
|
case 'chain':
|
|
return `Locator(${body})`;
|
|
case 'test-id':
|
|
return `GetByTestId(${this.toTestIdValue(body)})`;
|
|
case 'text':
|
|
return this.toCallWithExact('GetByText', body, !!options.exact);
|
|
case 'alt':
|
|
return this.toCallWithExact('GetByAltText', body, !!options.exact);
|
|
case 'placeholder':
|
|
return this.toCallWithExact('GetByPlaceholder', body, !!options.exact);
|
|
case 'label':
|
|
return this.toCallWithExact('GetByLabel', body, !!options.exact);
|
|
case 'title':
|
|
return this.toCallWithExact('GetByTitle', body, !!options.exact);
|
|
default:
|
|
throw new Error('Unknown selector kind ' + kind);
|
|
}
|
|
}
|
|
|
|
chainLocators(locators: string[]): string {
|
|
return locators.join('.');
|
|
}
|
|
|
|
private regexToString(body: RegExp): string {
|
|
const suffix = body.flags.includes('i') ? ', RegexOptions.IgnoreCase' : '';
|
|
return `new Regex(${this.quote(normalizeEscapedRegexQuotes(body.source))}${suffix})`;
|
|
}
|
|
|
|
private toCallWithExact(method: string, body: string | RegExp, exact: boolean) {
|
|
if (isRegExp(body))
|
|
return `${method}(${this.regexToString(body)})`;
|
|
if (exact)
|
|
return `${method}(${this.quote(body)}, new() { Exact = true })`;
|
|
return `${method}(${this.quote(body)})`;
|
|
}
|
|
|
|
private toHasText(body: string | RegExp) {
|
|
if (isRegExp(body))
|
|
return `HasTextRegex = ${this.regexToString(body)}`;
|
|
return `HasText = ${this.quote(body)}`;
|
|
}
|
|
|
|
private toTestIdValue(value: string | RegExp) {
|
|
if (isRegExp(value))
|
|
return this.regexToString(value);
|
|
return this.quote(value);
|
|
}
|
|
|
|
private toHasNotText(body: string | RegExp) {
|
|
if (isRegExp(body))
|
|
return `HasNotTextRegex = ${this.regexToString(body)}`;
|
|
return `HasNotText = ${this.quote(body)}`;
|
|
}
|
|
|
|
private quote(text: string) {
|
|
return escapeWithQuotes(text, '\"');
|
|
}
|
|
}
|
|
|
|
export class JsonlLocatorFactory implements LocatorFactory {
|
|
generateLocator(base: LocatorBase, kind: LocatorType, body: string | RegExp, options: LocatorOptions = {}): string {
|
|
return JSON.stringify({
|
|
kind,
|
|
body,
|
|
options,
|
|
});
|
|
}
|
|
|
|
chainLocators(locators: string[]): string {
|
|
const objects = locators.map(l => JSON.parse(l));
|
|
for (let i = 0; i < objects.length - 1; ++i)
|
|
objects[i].next = objects[i + 1];
|
|
return JSON.stringify(objects[0]);
|
|
}
|
|
}
|
|
|
|
const generators: Record<Language, new (preferredQuote?: Quote) => LocatorFactory> = {
|
|
javascript: JavaScriptLocatorFactory,
|
|
python: PythonLocatorFactory,
|
|
java: JavaLocatorFactory,
|
|
csharp: CSharpLocatorFactory,
|
|
jsonl: JsonlLocatorFactory,
|
|
};
|
|
|
|
function isRegExp(obj: any): obj is RegExp {
|
|
return obj instanceof RegExp;
|
|
}
|