Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[plugin-web-app-playwright] Add more locator types #5288

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions docs/modules/plugins/pages/plugin-web-app-playwright.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,39 @@ By. prefix is optional.
|Locates elements whose class name matches the specified search value. This locator is translated to `css(.<className>)` locator.
|className(bold)

|`linkText`
|Locates elements whose text of the link matches the specified search value.
|linkText(Google)

|`linkUrl`
|Locates elements whose `href` attribute matches the specified search value. This locator is translated to `css([href='<tagName>'])` locator.
|linkUrl(/faq)

|`linkUrlPart`
|Locates elements whose part of `href` attribute matches the specified search value. This locator is translated to `css([href*='<tagName>'])` locator.
|linkUrlPart(faq)

|`imageSrc`
|Locates elements whose `src` attribute matches the specified search value. This locator is translated to `css(img[src='<imageSrc>'])` locator.
|imgSrc(/images/kote.png)

|`imageSrcPart`
|Locates elements whose part of `src` attribute matches the specified search value. This locator is translated to `css(img[src*='<imageSrc>'])` locator.
|imgSrcPart(kote.png)

|`fieldName`
|Locate elements that are either input or textarea and their text or any attribute value matches the specified search value.
|fieldName(editor)

|`radioButton`
|Locate elements that are input with @type="radio" and their label text value matches the specified searh value
|radioButton(One)

|`name`
|Locate elements where any attribute or text value matches the specified search value. This locator is translated to `xpath(.//\*[@*='<elementName>' or text()='<elementName>'])`
locator.
|elementName(OK)

|===

=== Visibility types
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ public PlaywrightLocator createLocator(String value)
@Override
public PlaywrightLocator createLocator(String value)
{
return new PlaywrightLocator("xpath", value);
return createXpathLocator(value);
}
},
TAG_NAME
Expand All @@ -57,6 +57,74 @@ public PlaywrightLocator createLocator(String value)
{
return createCssLocator("." + value);
}
},
LINK_TEXT
{
@Override
public PlaywrightLocator createLocator(String value)
{
return createXpathLocator(".//a[text()='%1$s' or @*='%1$s' or *='%1$s']", value);
}
},
LINK_URL
{
@Override
public PlaywrightLocator createLocator(String value)
{
return createCssLocator("a[href='%s']", value);
}
},
LINK_URL_PART
{
@Override
public PlaywrightLocator createLocator(String value)
{
return createCssLocator("a[href*='%s']", value);
}
},
IMAGE_SRC
{
@Override
public PlaywrightLocator createLocator(String value)
{
return createCssLocator("img[src='%s']", value);
}
},
IMAGE_SRC_PART
{
@Override
public PlaywrightLocator createLocator(String value)
{
return createCssLocator("img[src*='%s']", value);
}
},
FIELD_NAME
{
@Override
public PlaywrightLocator createLocator(String value)
{
// due to firefox bug, we can't use name() and must use local-name()
// as workaround 'body' represents CKE editor
return createXpathLocator(".//*[(local-name() = 'input' or local-name() = 'textarea' or "
+ "local-name()='body') and ((@* | text())='%1$s' or @id=(//label[text() = '%1$s']/@for))]", value);
}
},
RADIO_BUTTON
{
@Override
public PlaywrightLocator createLocator(String value)
{
return createXpathLocator(".//input[@type='radio' and ((@* | text())='%1$s' or "
+ "@id=(//label[text() = '%1$s']/@for))]", value);
}
},
NAME
{
@Override
public PlaywrightLocator createLocator(String value)
{
return createXpathLocator(".//*[@*='%1$s' or text()='%1$s']", value);
}
};

public abstract PlaywrightLocator createLocator(String value);
Expand All @@ -65,4 +133,14 @@ private static PlaywrightLocator createCssLocator(String value)
{
return new PlaywrightLocator("css", value);
}

private static PlaywrightLocator createCssLocator(String locatorPattern, String value)
{
return createCssLocator(String.format(locatorPattern, value));
}

private static PlaywrightLocator createXpathLocator(String locatorPattern, Object... args)
{
return new PlaywrightLocator("xpath", String.format(locatorPattern, args));
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ void shouldCreateLocatorByClassName()
void shouldCreateLocatorByXpath()
{
var xpath = "//div";
assertEquals(new PlaywrightLocator("xpath", xpath), PlaywrightLocatorType.XPATH.createLocator(xpath));
assertEquals(createXpathLocator(xpath), PlaywrightLocatorType.XPATH.createLocator(xpath));
}

@Test
Expand All @@ -60,6 +60,75 @@ void shouldCreateLocatorByTagName()
assertEquals(createCssLocator(tagName), PlaywrightLocatorType.TAG_NAME.createLocator(tagName));
}

@Test
void shouldCreateLocatorByLinkText()
{
var expectedXpath = ".//a[text()='linkText' or @*='linkText' or *='linkText']";
assertEquals(createXpathLocator(expectedXpath), PlaywrightLocatorType.LINK_TEXT.createLocator("linkText"));
}

@Test
void shouldCreateLocatorByLinkUrl()
{
var linkUrl = "linkUrl";
assertEquals(createCssLocator("a[href='linkUrl']"), PlaywrightLocatorType.LINK_URL.createLocator(linkUrl));
}

@Test
void shouldCreateLocatorByLinkUrlPart()
{
var linkUrlPart = "linkUrlPart";
assertEquals(createCssLocator("a[href*='linkUrlPart']"),
PlaywrightLocatorType.LINK_URL_PART.createLocator(linkUrlPart));
}

@Test
void shouldCreateLocatorByImageSrc()
{
var imageSrc = "/image/src";
assertEquals(createCssLocator("img[src='/image/src']"),
PlaywrightLocatorType.IMAGE_SRC.createLocator(imageSrc));
}

@Test
void shouldCreateLocatorByImageSrcPart()
{
var imageSrcPart = "src";
assertEquals(createCssLocator("img[src*='src']"),
PlaywrightLocatorType.IMAGE_SRC_PART.createLocator(imageSrcPart));
}

@Test
void shouldCreateLocatorByElementName()
{
var elementName = "elementName";
assertEquals(createXpathLocator(".//*[@*='elementName' or text()='elementName']"),
PlaywrightLocatorType.NAME.createLocator(elementName));
}

@Test
void shouldCreateLocatorByFieldName()
{
var fieldName = "fieldName";
var expectedXpath = ".//*[(local-name() = 'input' or local-name() = 'textarea' or local-name()='body') and "
+ "((@* | text())='fieldName' or @id=(//label[text() = 'fieldName']/@for))]";
assertEquals(createXpathLocator(expectedXpath), PlaywrightLocatorType.FIELD_NAME.createLocator(fieldName));
}

@Test
void shouldCreateLocatorByRadioButton()
{
var radioButton = "radioButton";
var expectedXpath = ".//input[@type='radio' and ((@* | text())='radioButton' or "
+ "@id=(//label[text() = 'radioButton']/@for))]";
assertEquals(createXpathLocator(expectedXpath), PlaywrightLocatorType.RADIO_BUTTON.createLocator(radioButton));
}

private PlaywrightLocator createXpathLocator(String value)
{
return new PlaywrightLocator("xpath", value);
}

private PlaywrightLocator createCssLocator(String value)
{
return new PlaywrightLocator("css", value);
Expand Down
Loading