com.twosigma.webtau.browser.page.path.GenericPageElement Maven / Gradle / Ivy
/*
* Copyright 2018 TWO SIGMA OPEN SOURCE, LLC
*
* 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.
*/
package com.twosigma.webtau.browser.page.path;
import com.twosigma.webtau.browser.InjectedJavaScript;
import com.twosigma.webtau.browser.page.*;
import com.twosigma.webtau.browser.page.path.filter.ByNumberElementsFilter;
import com.twosigma.webtau.browser.page.path.filter.ByRegexpElementsFilter;
import com.twosigma.webtau.browser.page.path.filter.ByTextElementsFilter;
import com.twosigma.webtau.browser.page.path.finder.ByCssFinder;
import com.twosigma.webtau.browser.page.value.ElementValue;
import com.twosigma.webtau.browser.page.value.handlers.PageElementGetSetValueHandlers;
import com.twosigma.webtau.reporter.TokenizedMessage;
import org.openqa.selenium.JavascriptExecutor;
import org.openqa.selenium.StaleElementReferenceException;
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.WebElement;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.function.Supplier;
import java.util.regex.Pattern;
import static com.twosigma.webtau.cfg.WebTauConfig.getCfg;
import static com.twosigma.webtau.reporter.IntegrationTestsMessageBuilder.TO;
import static com.twosigma.webtau.reporter.IntegrationTestsMessageBuilder.action;
import static com.twosigma.webtau.reporter.IntegrationTestsMessageBuilder.stringValue;
import static com.twosigma.webtau.reporter.TestStep.createAndExecuteStep;
import static com.twosigma.webtau.reporter.TokenizedMessage.tokenizedMessage;
public class GenericPageElement implements PageElement {
private WebDriver driver;
private final InjectedJavaScript injectedJavaScript;
private ElementPath path;
private final TokenizedMessage pathDescription;
private ElementValue elementValue;
private ElementValue countValue;
public GenericPageElement(WebDriver driver, InjectedJavaScript injectedJavaScript, ElementPath path) {
this.driver = driver;
this.injectedJavaScript = injectedJavaScript;
this.path = path;
this.pathDescription = path.describe();
this.elementValue = new ElementValue<>(this, "value", this::getUnderlyingValue);
this.countValue = new ElementValue<>(this, "count", this::getNumberOfElements);
}
@Override
public ElementValue getCount() {
return countValue;
}
@Override
public TokenizedMessage describe() {
return pathDescription;
}
@Override
public void highlight() {
injectedJavaScript.flashWebElements(findElements());
}
public void click() {
execute(tokenizedMessage(action("clicking")).add(pathDescription),
() -> tokenizedMessage(action("clicked")).add(pathDescription),
() -> findElement().click());
}
public WebElement findElement() {
List webElements = findElements();
return webElements.get(0);
}
@Override
public List findElements() {
List webElements = path.find(driver);
return webElements.isEmpty() ?
Collections.singletonList(createNullElement()) :
webElements;
}
@Override
public ElementValue elementValue() {
return elementValue;
}
@Override
public ElementValue, PageElement> elementValues() {
return new ElementValue<>(this, "all values", this::extractValues);
}
@Override
public void setValue(Object value) {
execute(tokenizedMessage(action("setting value"), stringValue(value), TO).add(pathDescription),
() -> tokenizedMessage(action("set value"), stringValue(value), TO).add(pathDescription),
() -> setValueBasedOnType(value));
}
@Override
public void sendKeys(String keys) {
execute(tokenizedMessage(action("sending keys"), stringValue(keys), TO).add(pathDescription),
() -> tokenizedMessage(action("sent keys"), stringValue(keys), TO).add(pathDescription),
() -> findElement().sendKeys(keys));
}
@Override
public void clear() {
execute(tokenizedMessage(action("clearing")).add(pathDescription),
() -> tokenizedMessage(action("cleared")).add(pathDescription),
() -> findElement().clear());
}
@Override
public PageElement find(String css) {
return find(new ByCssFinder(css));
}
@Override
public PageElement find(ElementsFinder finder) {
return withFinder(finder);
}
@Override
public PageElement get(String text) {
return withFilter(new ByTextElementsFilter(injectedJavaScript, text));
}
@Override
public PageElement get(int number) {
return withFilter(new ByNumberElementsFilter(number));
}
@Override
public PageElement get(Pattern regexp) {
return withFilter(new ByRegexpElementsFilter(injectedJavaScript, regexp));
}
@Override
public boolean isVisible() {
return handleStaleElement(() -> findElement().isDisplayed(), false);
}
@Override
public boolean isEnabled() {
return handleStaleElement(() -> findElement().isEnabled(), false);
}
@Override
public boolean isSelected() {
return findElement().isSelected();
}
@Override
public String toString() {
return path.toString();
}
@Override
public String getText() {
return findElement().getText();
}
@Override
public String getUnderlyingValue() {
List values = extractValues();
return values.isEmpty() ? null : values.get(0);
}
@Override
public void scrollIntoView() {
execute(tokenizedMessage(action("scrolling into view ")).add(pathDescription),
() -> tokenizedMessage(action("scrolled into view")).add(pathDescription),
() -> ((JavascriptExecutor)driver).executeScript(
"arguments[0].scrollIntoView(true);", findElement())
);
}
private String getTagName() {
return findElement().getTagName();
}
private String getAttribute(String name) {
return findElement().getAttribute(name);
}
private List extractValues() {
List elements = path.find(driver);
List> elementsMeta = handleStaleElement(() -> injectedJavaScript.extractElementsMeta(elements),
Collections.emptyList());
if (elementsMeta.isEmpty()) {
return Collections.emptyList();
}
List result = new ArrayList<>();
for (int idx = 0; idx < elements.size(); idx++) {
HtmlNode htmlNode = new HtmlNode(elementsMeta.get(idx));
PageElement pageElementByIdx = get(idx + 1);
result.add(handleStaleElement(() ->
PageElementGetSetValueHandlers.getValue(
htmlNode,
pageElementByIdx), null));
}
return result;
}
private Integer getNumberOfElements() {
List webElements = path.find(driver);
return webElements.size();
}
private void setValueBasedOnType(Object value) {
HtmlNode htmlNode = findHtmlNode();
PageElementGetSetValueHandlers.setValue(this::execute, pathDescription,
htmlNode,
this,
value);
}
private void execute(TokenizedMessage inProgressMessage,
Supplier completionMessageSupplier,
Runnable action) {
createAndExecuteStep(this, inProgressMessage, completionMessageSupplier,
() -> repeatForStaleElement(action));
}
private PageElement withFilter(ElementsFilter filter) {
ElementPath newPath = path.copy();
newPath.addFilter(filter);
return new GenericPageElement(driver, injectedJavaScript, newPath);
}
private PageElement withFinder(ElementsFinder finder) {
ElementPath newPath = path.copy();
newPath.addFinder(finder);
return new GenericPageElement(driver, injectedJavaScript, newPath);
}
private HtmlNode findHtmlNode() {
List elements = path.find(driver);
List> elementsMeta = elements.isEmpty() ?
Collections.emptyList():
injectedJavaScript.extractElementsMeta(elements);
return elementsMeta.isEmpty() ? HtmlNode.NULL : new HtmlNode(elementsMeta.get(0));
}
private NullWebElement createNullElement() {
return new NullWebElement(path.toString());
}
static private R handleStaleElement(Supplier code, R valueInCaseOfStale) {
try {
return code.get();
} catch (StaleElementReferenceException e) {
return valueInCaseOfStale;
}
}
static private void repeatForStaleElement(Runnable code) {
int numberOfAttemptsLeft = getCfg().getStaleElementRetry();
for (; numberOfAttemptsLeft >= 1; numberOfAttemptsLeft--) {
try {
code.run();
break;
} catch (StaleElementReferenceException e) {
if (numberOfAttemptsLeft == 1) {
throw new RuntimeException("element is stale, " +
"consider using waitTo beVisible matcher to make sure component fully appeared");
}
sleep(getCfg().getStaleElementRetryWait());
}
}
}
static private void sleep(int millis) {
try {
Thread.sleep(millis);
} catch (InterruptedException e) {
throw new RuntimeException(e);
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy