Feature/add js helper methods

it/src/test/java/io/github/giulong/spectrum/it/pages/LandingPage.java

@@ -9,9 +9,15 @@
 @SuppressWarnings("unused")
 public class LandingPage extends SpectrumPage<LandingPage, Void> {
 
+    @FindBy(id = "login")
+    private WebElement form;
+
     @FindBy(tagName = "h1")
     private WebElement title;
 
     @FindBy(linkText = "Checkboxes")
     private WebElement checkboxLink;
+
+    @FindBy(linkText = "Form Authentication")
+    private WebElement formLoginLink;
 }

it/src/test/java/io/github/giulong/spectrum/it/pages/LoginPage.java

@@ -29,6 +29,12 @@ public class LoginPage extends SpectrumPage<LoginPage, Void> {
     @FindBy(id = "login")
     private WebElement form;
 
+    @FindBy(id = "content")
+    private WebElement contentDiv;
+
+    @FindBy(className = "subheader")
+    private WebElement subHeader;
+
     @Override
     public LoginPage waitForPageLoading() {
         log.info("Wait for page loading: waiting for errorMessage to disappear");

it/src/test/java/io/github/giulong/spectrum/it/tests/JavascriptIT.java

@@ -1,10 +1,13 @@
 package io.github.giulong.spectrum.it.tests;
 
 import io.github.giulong.spectrum.SpectrumTest;
+import io.github.giulong.spectrum.enums.LocatorType;
 import io.github.giulong.spectrum.it.pages.CheckboxPage;
 import io.github.giulong.spectrum.it.pages.LandingPage;
+import io.github.giulong.spectrum.it.pages.LoginPage;
 import org.junit.jupiter.api.DisplayName;
 import org.junit.jupiter.api.Test;
+import org.openqa.selenium.NoSuchShadowRootException;
 import org.openqa.selenium.WebElement;
 
 import static org.junit.jupiter.api.Assertions.*;
@@ -13,8 +16,8 @@
 public class JavascriptIT extends SpectrumTest<Void> {
 
     private LandingPage landingPage;
-
     private CheckboxPage checkboxPage;
+    private LoginPage loginPage;
 
     @Test
     public void testWithNoDisplayName() {
@@ -27,13 +30,119 @@ public void testWithNoDisplayName() {
         final WebElement firstCheckbox = checkboxPage.getCheckboxes().getFirst();
         final WebElement secondCheckbox = checkboxPage.getCheckboxes().get(1);
 
-        assertFalse(firstCheckbox.isSelected());
-        assertTrue(secondCheckbox.isSelected());
+        assertFalse(js.isSelected(firstCheckbox));
+        assertTrue(js.isSelected(secondCheckbox));
+
+        assertTrue(js.isEnabled(firstCheckbox));
+        assertTrue(js.isDisplayed(firstCheckbox));
 
         js.click(firstCheckbox);
-        assertTrue(firstCheckbox.isSelected());
+        assertTrue(js.isSelected(firstCheckbox));
 
         // Take a screenshot with a custom message
         screenshotInfo("After checking the first checkbox");
     }
-}
+
+    @Test
+    public void testFindElementMethod() {
+        driver.get(configuration.getApplication().getBaseUrl());
+
+        assertEquals(landingPage.getFormLoginLink(), js.findElement(LocatorType.LINK_TEXT, "Form Authentication"));
+        assertEquals(landingPage.getFormLoginLink(), js.findElement(LocatorType.PARTIAL_LINK_TEXT, "Form Aut"));
+
+        js.click(landingPage.getFormLoginLink());
+        loginPage.waitForPageLoading();
+
+        final WebElement usernameField = loginPage.getUsername();
+        final WebElement subHeader = loginPage.getSubHeader();
+        final WebElement contentDiv = loginPage.getContentDiv();
+        final WebElement form = loginPage.getForm();
+
+        assertEquals(subHeader, js.findElement(contentDiv, LocatorType.CLASS_NAME, "subheader"));
+        assertEquals(form, js.findElement(contentDiv, LocatorType.TAG_NAME, "form"));
+        assertEquals(usernameField, js.findElement(LocatorType.NAME, "username"));
+        assertEquals(usernameField, js.findElement(LocatorType.CSS_SELECTOR, "input[id='username']"));
+        assertEquals(usernameField, js.findElement(LocatorType.XPATH, "//*[@id='username']"));
+
+        assertNotEquals(js.findElement(LocatorType.CLASS_NAME, "row"), js.findElement(contentDiv, LocatorType.CLASS_NAME, "row"));
+    }
+
+    @Test
+    public void testFindElementsMethod() {
+        driver.get(configuration.getApplication().getBaseUrl());
+
+        final WebElement mainContentDiv = js.findElement(LocatorType.ID, "content");
+
+        assertEquals(1, js.findElements(mainContentDiv, LocatorType.LINK_TEXT, "Dropdown").size());
+        assertEquals(1, js.findElements(LocatorType.LINK_TEXT, "Dropdown").size());
+        assertEquals(3, js.findElements(mainContentDiv, LocatorType.PARTIAL_LINK_TEXT, "File").size());
+        assertEquals(3, js.findElements(LocatorType.PARTIAL_LINK_TEXT, "File").size());
+
+        js.click(landingPage.getFormLoginLink());
+        loginPage.waitForPageLoading();
+
+        final WebElement form = loginPage.getForm();
+        final WebElement contentDiv = loginPage.getContentDiv();
+        final WebElement usernameField = loginPage.getUsername();
+
+        // Every test use two test cases, one with context=document (not passed) and other one with context passed
+        assertEquals(5, js.findElements(LocatorType.CLASS_NAME, "row").size());
+        assertEquals(2, js.findElements(form, LocatorType.CLASS_NAME, "row").size());
+        assertEquals(1, js.findElements(LocatorType.NAME, "login").size());
+        assertEquals(1, js.findElements(contentDiv, LocatorType.NAME, "login").size());
+        assertEquals(12, js.findElements(LocatorType.TAG_NAME, "div").size());
+        assertEquals(4, js.findElements(form, LocatorType.TAG_NAME, "div").size());
+        assertEquals(usernameField, js.findElements(LocatorType.CSS_SELECTOR, "input[id='username'").getFirst());
+        assertEquals(usernameField, js.findElements(form, LocatorType.CSS_SELECTOR, "input[id='username'").getFirst());
+        assertEquals(5, js.findElements(LocatorType.CSS_SELECTOR, "div[class='row'").size());
+        assertEquals(usernameField, js.findElements(LocatorType.XPATH, "//*[@id='username']").getFirst());
+    }
+
+    @Test
+    public void testWebElementGetMethods() {
+        driver.get(configuration.getApplication().getBaseUrl());
+
+        js.click(landingPage.getFormLoginLink());
+        loginPage.waitForPageLoading();
+
+        final WebElement form = loginPage.getForm();
+        final WebElement usernameField = loginPage.getUsername();
+        final WebElement contentDiv = loginPage.getContentDiv();
+
+        assertEquals(js.getTagName(usernameField), "input");
+
+        // Asserting that custom js methods return same value as selenium WebElement methods
+        assertEquals(js.getSize(usernameField), usernameField.getSize());
+        assertEquals(js.getRect(usernameField), usernameField.getRect());
+
+        assertEquals(js.getDomAttribute(usernameField, "name"), "username");
+        assertEquals(js.getAttribute(contentDiv, "class"), "large-12 columns");
+        assertEquals(js.getText(form), "Username\nPassword\n Login");
+
+        assertEquals(js.getCssValue(usernameField, "color"), "rgba(0, 0, 0, 0.75)");
+        assertEquals(js.getCssValue(usernameField, "background"), "rgb(255, 255, 255) none repeat scroll 0% 0% / auto padding-box border-box");
+
+        assertThrows(NoSuchShadowRootException.class, () -> js.getShadowRoot(usernameField));
+    }
+
+    @Test
+    public void testInputFieldActions() {
+        driver.get(configuration.getApplication().getBaseUrl());
+
+        js.click(landingPage.getFormLoginLink());
+        loginPage.waitForPageLoading();
+
+        final WebElement usernameField = loginPage.getUsername();
+        final WebElement passwordField = loginPage.getPassword();
+        final WebElement form = loginPage.getForm();
+
+        js.sendKeys(usernameField, "tomsmith");
+        js.clear(usernameField);
+        assertTrue(js.getDomProperty(usernameField, "value").isEmpty());
+        js.sendKeys(usernameField, "tomsmith");
+        js.sendKeys(passwordField, "SuperSecretPassword!");
+
+        js.submit(form);
+        assertEquals("https://the-internet.herokuapp.com/secure", driver.getCurrentUrl());
+    }
+}

spectrum/src/main/java/io/github/giulong/spectrum/enums/LocatorType.java

@@ -0,0 +1,52 @@
+package io.github.giulong.spectrum.enums;
+
+import io.github.giulong.spectrum.interfaces.WebElementFinder;
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+import lombok.extern.slf4j.Slf4j;
+import org.openqa.selenium.JavascriptExecutor;
+import org.openqa.selenium.WebElement;
+
+import java.util.List;
+
+@Slf4j
+@Getter
+@AllArgsConstructor
+public enum LocatorType implements WebElementFinder {
+
+    ID("return %s.getElementById('%s');", "return %s.querySelectorAll('#%s');"),
+    CLASS_NAME("return %s.getElementsByClassName('%s')[0];", "return %s.getElementsByClassName('%s');"),
+    CSS_SELECTOR("return %s.querySelector('%s');", "return %s.querySelectorAll('%s');"),
+    NAME("return %s.querySelector('[name=\"%s\"]');", "return %s.querySelectorAll('[name=\"%s\"]');"),
+    TAG_NAME("return %s.getElementsByTagName('%s')[0];", "return %s.getElementsByTagName('%s');"),
+
+    XPATH("return %s.evaluate('%s', document, null, XPathResult.FIRST_ORDERED_NODE_TYPE, null).singleNodeValue;",
+            "var webElements = %s.evaluate('%s', document, null, XPathResult.ORDERED_NODE_SNAPSHOT_TYPE, null);" +
+                    "return Array.from({length: webElements.snapshotLength}, (_, i) => webElements.snapshotItem(i));"),
+
+    LINK_TEXT("return %s.evaluate('//a[text()=\"%s\"]', " +
+            "document, null, XPathResult.FIRST_ORDERED_NODE_TYPE, null).singleNodeValue;",
+            "return Array.from(%s.querySelectorAll('a')).filter(link => link.textContent === '%s');"),
+
+    PARTIAL_LINK_TEXT("return %s.evaluate('//a[contains(text(), \"%s\")]', " +
+            "document, null, XPathResult.FIRST_ORDERED_NODE_TYPE, null).singleNodeValue;",
+            "return Array.from(%s.querySelectorAll('a')).filter(link => link.textContent.includes('%s'));");
+
+    private final String findElementScript;
+    private final String findElementsScript;
+
+    @Override
+    public WebElement findElement(JavascriptExecutor driver, WebElement context, String locatorValue) {
+        String jsCommand = String.format(findElementScript, context != null ? "arguments[0]" : "document", locatorValue);
+        log.debug("Executing js for finding web element. Script: {}", jsCommand);
+        return (WebElement) driver.executeScript(jsCommand, context);
+    }
+
+    @SuppressWarnings("unchecked")
+    @Override
+    public List<WebElement> findElements(JavascriptExecutor driver, WebElement context, String locatorValue) {
+        String jsCommand = String.format(findElementsScript, context != null ? "arguments[0]" : "document", locatorValue);
+        log.debug("Executing js for finding multiple web elements. Script: {}", jsCommand);
+        return (List<WebElement>) driver.executeScript(jsCommand, context);
+    }
+}

spectrum/src/main/java/io/github/giulong/spectrum/interfaces/WebElementFinder.java

@@ -0,0 +1,13 @@
+package io.github.giulong.spectrum.interfaces;
+
+import org.openqa.selenium.JavascriptExecutor;
+import org.openqa.selenium.WebElement;
+
+import java.util.List;
+
+public interface WebElementFinder {
+
+    WebElement findElement(JavascriptExecutor driver, WebElement context, String locatorValue);
+
+    List<WebElement> findElements(JavascriptExecutor driver, WebElement context, String locatorValue);
+}