Feature/15 element

src/main/java/aquality/selenium/core/elements/Element.java

@@ -0,0 +1,145 @@
+package aquality.selenium.core.elements;
+
+import aquality.selenium.core.applications.IApplication;
+import aquality.selenium.core.configurations.IElementCacheConfiguration;
+import aquality.selenium.core.elements.interfaces.*;
+import aquality.selenium.core.localization.ILocalizedLogger;
+import aquality.selenium.core.logging.Logger;
+import aquality.selenium.core.utilities.IElementActionRetrier;
+import aquality.selenium.core.waitings.IConditionalWait;
+import org.openqa.selenium.By;
+import org.openqa.selenium.NoSuchElementException;
+import org.openqa.selenium.WebDriverException;
+import org.openqa.selenium.remote.RemoteWebElement;
+
+import java.util.function.Supplier;
+
+public abstract class Element implements IElement {
+
+    private final String name;
+    private final ElementState elementState;
+    private final By locator;
+    private IElementCacheHandler elementCacheHandler;
+
+    protected Element(final By loc, final String name, final ElementState state) {
+        locator = loc;
+        this.name = name;
+        elementState = state;
+    }
+
+    protected abstract IApplication getApplication();
+
+    protected abstract IElementFactory getElementFactory();
+
+    protected abstract IElementFinder getElementFinder();
+
+    protected abstract IElementCacheConfiguration getElementCacheConfiguration();
+
+    protected abstract IElementActionRetrier getElementActionRetrier();
+
+    protected abstract ILocalizedLogger getLocalizedLogger();
+
+    protected abstract IConditionalWait getConditionalWait();
+
+    protected abstract String getElementType();
+
+    protected IElementCacheHandler getCache() {
+        if (elementCacheHandler == null) {
+            elementCacheHandler = new ElementCacheHandler(locator, elementState, getElementFinder());
+        }
+
+        return elementCacheHandler;
+    }
+
+    protected Logger getLogger() {
+        return Logger.getInstance();
+    }
+
+    @Override
+    public By getLocator() {
+        return locator;
+    }
+
+    @Override
+    public String getName() {
+        return name;
+    }
+
+    @Override
+    public IElementStateProvider state() {
+        return getElementCacheConfiguration().isEnabled()
+                ? new CachedElementStateProvider(locator, getConditionalWait(), getCache(), getLocalizedLogger())
+                : new DefaultElementStateProvider(locator, getConditionalWait(), getElementFinder());
+    }
+
+    @Override
+    public RemoteWebElement getElement(Long timeout) {
+        try {
+            return getElementCacheConfiguration().isEnabled()
+                    ? getCache().getElement(timeout)
+                    : (RemoteWebElement) getElementFinder().findElement(locator, elementState, timeout);
+        } catch (NoSuchElementException e) {
+            logPageSource(e);
+            throw e;
+        }
+    }
+
+    protected void logPageSource(WebDriverException exception) {
+        try {
+            getLogger().debug("Page source:".concat(System.lineSeparator()).concat(getApplication().getDriver().getPageSource()), exception);
+        } catch (WebDriverException e) {
+            getLogger().error(exception.getMessage());
+            getLocalizedLogger().fatal("loc.get.page.source.failed", e);
+        }
+    }
+
+    @Override
+    public String getText() {
+        logElementAction("loc.get.text");
+        return doWithRetry(() -> getElement().getText());
+    }
+
+    @Override
+    public String getAttribute(String attr) {
+        logElementAction("loc.el.getattr", attr);
+        return doWithRetry(() -> getElement().getAttribute(attr));
+    }
+
+    @Override
+    public void sendKeys(String keys) {
+        logElementAction("loc.text.sending.keys", keys);
+        doWithRetry(() -> getElement().sendKeys(keys));
+    }
+
+    @Override
+    public void click() {
+        logElementAction("loc.clicking");
+        doWithRetry(() -> getElement().click());
+    }
+
+    @Override
+    public <T extends IElement> T findChildElement(By childLoc, String name, Class<T> clazz, ElementState state) {
+        return getElementFactory().findChildElement(this, childLoc, name, clazz, state);
+    }
+
+    @Override
+    public <T extends IElement> T findChildElement(By childLoc, String name, IElementSupplier<T> supplier, ElementState state) {
+        return getElementFactory().findChildElement(this, childLoc, name, supplier, state);
+    }
+
+    protected <T> T doWithRetry(Supplier<T> action) {
+        return getElementActionRetrier().doWithRetry(action);
+    }
+
+    protected void doWithRetry(Runnable action) {
+        getElementActionRetrier().doWithRetry(action);
+    }
+
+    protected void logElementAction(String messageKey, Object... args) {
+        getLocalizedLogger().infoElementAction(getElementType(), name, messageKey, args);
+    }
+
+    protected ElementState getElementState() {
+        return elementState;
+    }
+}

src/main/java/aquality/selenium/core/elements/interfaces/IElement.java

@@ -3,36 +3,75 @@
 import org.openqa.selenium.By;
 import org.openqa.selenium.remote.RemoteWebElement;
 
+/**
+ * Describes behavior of any UI element.
+ */
 public interface IElement extends IParent {
+    /**
+     * Gets unique locator of element.
+     *
+     * @return Element locator
+     */
+    By getLocator();
+
+    /**
+     * Gets unique name of element
+     *
+     * @return name
+     */
+    String getName();
+
+    /**
+     * Provides ability to define of element's state (whether it is displayed, exists or not) and respective waiting functions
+     *
+     * @return provider to define element's state
+     */
+    IElementStateProvider state();
 
     /**
-     * Gets clear WebElement.
+     * Gets current element by specified {@link #getLocator()}
+     * Default timeout is provided in {@link aquality.selenium.core.configurations.ITimeoutConfiguration}/>
+     * {@link org.openqa.selenium.NoSuchElementException} throws if element not found
      *
-     * @return WebElement
+     * @return instance of {@link RemoteWebElement} if found.
      */
     default RemoteWebElement getElement() {
         return getElement(null);
     }
 
     /**
-     * Gets clear WebElement.
+     * Gets current element by specified {@link #getLocator()}
+     * {@link org.openqa.selenium.NoSuchElementException} throws if element not found
      *
      * @param timeout Timeout for waiting
-     * @return WebElement
+     * @return instance of {@link RemoteWebElement} if found.
      */
     RemoteWebElement getElement(Long timeout);
 
     /**
-     * Gets element name.
+     * Gets the item text (inner text).
      *
-     * @return name
+     * @return text of element
      */
-    String getName();
+    String getText();
 
     /**
-     * Gets element locator.
+     * Gets attribute value of the element.
      *
-     * @return locator
+     * @param attr Attribute name
+     * @return Attribute value
      */
-    By getLocator();
+    String getAttribute(String attr);
+
+    /**
+     * Sends keys
+     *
+     * @param keys keys for sending
+     */
+    void sendKeys(String keys);
+
+    /**
+     * Clicks on the item.
+     */
+    void click();
 }

src/main/java/aquality/selenium/core/elements/interfaces/IParent.java

@@ -8,31 +8,100 @@ public interface IParent {
     /**
      * Find an element in the parent element
      *
-     * @param childLoc Child element locator
-     * @param clazz class or interface of the element to be obtained
+     * @param childLoc child element locator
+     * @param name     output name in logs
+     * @param clazz    class or interface of the element to be obtained
+     * @param state    visibility state of target element
+     * @param <T>      the type of the element to be obtained
      * @return found child element
      */
-    default <T extends IElement> T findChildElement(By childLoc, Class<? extends IElement> clazz){
-        return findChildElement(childLoc, clazz, ElementState.DISPLAYED);
+    <T extends IElement> T findChildElement(By childLoc, String name, Class<T> clazz, ElementState state);
+
+    /**
+     * Find an element in the parent element with DISPLAYED state
+     *
+     * @param childLoc child element locator
+     * @param name     output name in logs
+     * @param clazz    class or interface of the element to be obtained
+     * @param <T>      the type of the element to be obtained
+     * @return found child element
+     */
+    default <T extends IElement> T findChildElement(By childLoc, String name, Class<T> clazz) {
+        return findChildElement(childLoc, name, clazz, ElementState.DISPLAYED);
     }
 
     /**
      * Find an element in the parent element
      *
-     * @param childLoc Child element locator
-     * @param clazz class or interface of the element to be obtained
-     * @param state visibility state of target element
+     * @param childLoc child element locator
+     * @param clazz    class or interface of the element to be obtained
+     * @param state    visibility state of target element
+     * @param <T>      the type of the element to be obtained
      * @return found child element
      */
-    <T extends IElement> T findChildElement(By childLoc, Class<? extends IElement> clazz, ElementState state);
+    default <T extends IElement> T findChildElement(By childLoc, Class<T> clazz, ElementState state) {
+        return findChildElement(childLoc, null, clazz, state);
+    }
 
     /**
-     * Find an element in the parent element
+     * Find an element in the parent element with DISPLAYED state
+     *
+     * @param childLoc child element locator
+     * @param clazz    class or interface of the element to be obtained
+     * @param <T>      the type of the element to be obtained
+     * @return found child element
+     */
+    default <T extends IElement> T findChildElement(By childLoc, Class<T> clazz) {
+        return findChildElement(childLoc, null, clazz, ElementState.DISPLAYED);
+    }
+
+    /**
+     * Finds an element in the parent element
      *
      * @param childLoc Child element locator
+     * @param name     output name in logs
+     * @param supplier required element's supplier
+     * @param state    visibility state of target element
+     * @param <T>      the type of the element to be obtained
+     * @return found child element
+     */
+    <T extends IElement> T findChildElement(By childLoc, String name, IElementSupplier<T> supplier, ElementState state);
+
+    /**
+     * Find an element in the parent element with DISPLAYED state
+     *
+     * @param childLoc child element locator
+     * @param name     output name in logs
+     * @param supplier required element's supplier
+     * @param <T>      the type of the element to be obtained
+     * @return found child element
+     */
+    default <T extends IElement> T findChildElement(By childLoc, String name, IElementSupplier<T> supplier) {
+        return findChildElement(childLoc, name, supplier, ElementState.DISPLAYED);
+    }
+
+    /**
+     * Finds an element in the parent element
+     *
+     * @param childLoc child element locator
      * @param supplier required element's supplier
-     * @param state visibility state of target element
+     * @param state    visibility state of target element
+     * @param <T>      the type of the element to be obtained
      * @return found child element
      */
-    <T extends IElement> T findChildElement(By childLoc, IElementSupplier<T> supplier, ElementState state);
+    default <T extends IElement> T findChildElement(By childLoc, IElementSupplier<T> supplier, ElementState state) {
+        return findChildElement(childLoc, null, supplier, state);
+    }
+
+    /**
+     * Find an element in the parent element with DISPLAYED state
+     *
+     * @param childLoc child element locator
+     * @param supplier required element's supplier
+     * @param <T>      the type of the element to be obtained
+     * @return found child element
+     */
+    default <T extends IElement> T findChildElement(By childLoc, IElementSupplier<T> supplier) {
+        return findChildElement(childLoc, null, supplier, ElementState.DISPLAYED);
+    }
 }

src/main/resources/localization/be.json

@@ -8,5 +8,6 @@
   "loc.elements.were.found.but.not.in.state": "Знайшлі элементы па лакатару '%1$s', але яны не ў жаданым стане %2$s",
   "loc.elements.found.but.should.not": "Не павінна быць знойдзена элементаў па лакатару '%1$s' у %2$s стане",
   "loc.search.of.elements.failed": "Пошук элемента па лакатару '%1$s' прайшоў няўдала",
-  "loc.element.not.in.state": "Элемент %1$s ня стаў %2$s пасля таймаўта %3$s"
+  "loc.element.not.in.state": "Элемент %1$s не стаў %2$s пасля таймаўта %3$s",
+  "loc.get.page.source.failed": "Адбылася памылка ў час атрымання разметкі старонкі"
 }

src/main/resources/localization/en.json

@@ -8,5 +8,6 @@
   "loc.elements.were.found.but.not.in.state": "Elements were found by locator '%1$s' but not in desired state %2$s",
   "loc.elements.found.but.should.not": "No elements should be found by locator '%1$s' in %2$s state",
   "loc.search.of.elements.failed": "Search of element by locator '%1$s' failed",
-  "loc.element.not.in.state": "Element %1$s has not become %2$s after timeout %3$s"
+  "loc.element.not.in.state": "Element %1$s has not become %2$s after timeout %3$s",
+  "loc.get.page.source.failed": "An exception occurred while tried to save the page source"
 }

src/main/resources/localization/ru.json

@@ -8,5 +8,6 @@
   "loc.elements.were.found.but.not.in.state": "Удалось найти элементы по локатору '%1$s', но они не в желаемом состоянии %2$s",
   "loc.elements.found.but.should.not": "Не должно быть найдено элементов по локатору '%1$s' в %2$s состоянии",
   "loc.search.of.elements.failed":  "Поиск элемента по локатору '%1$s' прошел неудачно",
-  "loc.element.not.in.state": "Элемент %1$s не стал %2$s после таймаута %3$s"
+  "loc.element.not.in.state": "Элемент %1$s не стал %2$s после таймаута %3$s",
+  "loc.get.page.source.failed": "Произошла ошибка во время получения разметки страницы"
 }