Fix shadow DOM 'findElements'; add unit tests (#205)

sbabcoc · May 2, 2022 · d7cff50 · d7cff50
1 parent e3adadb
commit d7cff50
Show file tree

Hide file tree

Showing 14 changed files with 137 additions and 47 deletions.
diff --git a/build.gradle b/build.gradle
@@ -210,7 +210,7 @@ dependencies {
   constraints {
     api 'com.nordstrom.tools:java-utils:2.1.0'
     api 'com.nordstrom.tools:settings:2.3.10'
-    api 'com.nordstrom.tools:junit-foundation:15.3.4'
+    api 'com.nordstrom.tools:junit-foundation:16.0.1'
     api 'com.github.sbabcoc:logback-testng:1.3.4'
     api 'org.hamcrest:hamcrest-core:2.2'
     api 'org.yaml:snakeyaml:1.28'

diff --git a/pom.xml b/pom.xml
@@ -44,7 +44,7 @@
     <source-plugin.version>3.2.1</source-plugin.version>
     <javadoc-plugin.version>3.3.0</javadoc-plugin.version>
     <settings.version>2.3.10</settings.version>
-    <junit-foundation.version>15.3.4</junit-foundation.version>
+    <junit-foundation.version>16.0.1</junit-foundation.version>
     <logback-testng.version>1.3.4</logback-testng.version>
     <sonar.language>java</sonar.language>
     <jacoco.version>0.8.7</jacoco.version>
@@ -325,7 +325,7 @@
         <guava.version>30.1.1-jre</guava.version>
         <httpcomponents.version>4.5.13</httpcomponents.version>
         <jsoup.version>1.14.2</jsoup.version>
-        <htmlunit.version>2.59.0</htmlunit.version>
+        <htmlunit.version>2.61.0</htmlunit.version>
         <jcommander.version>1.78</jcommander.version>
         <mockito.version>3.1.0</mockito.version>
         <!-- managed to resolve identified threat -->

diff --git a/selenium2Deps.gradle b/selenium2Deps.gradle
@@ -24,7 +24,7 @@ sourceSets {
 
 dependencies {
   constraints {
-    api 'com.nordstrom.tools:testng-foundation:3.0.6-j7'
+    api 'com.nordstrom.tools:testng-foundation:3.0.9-j7'
     api 'commons-io:commons-io:2.4'
     api 'org.seleniumhq.selenium:selenium-server:2.53.1'
     api 'org.seleniumhq.selenium:selenium-support:2.53.1'

diff --git a/selenium3Deps.gradle b/selenium3Deps.gradle
@@ -24,7 +24,7 @@ sourceSets {
 
 dependencies {
   constraints {
-    api 'com.nordstrom.tools:testng-foundation:3.0.6-j8'
+    api 'com.nordstrom.tools:testng-foundation:3.0.9-j8'
     api 'org.seleniumhq.selenium:selenium-server:3.141.59'
     api 'org.seleniumhq.selenium:selenium-support:3.141.59'
     api 'org.apache.httpcomponents:httpclient:4.5.13'
@@ -35,7 +35,7 @@ dependencies {
     api 'com.squareup.okhttp3:okhttp:4.9.1'
     api 'com.squareup.okio:okio:2.10.0'
     api 'org.eclipse.jetty.websocket:websocket-client:9.4.43.v20210629'
-    testImplementation 'org.seleniumhq.selenium:htmlunit-driver:2.59.0'
+    testImplementation 'org.seleniumhq.selenium:htmlunit-driver:2.61.0'
     testImplementation 'org.mockito:mockito-core:3.1.0'
   }
   api 'com.nordstrom.tools:testng-foundation'

diff --git a/src/main/java/com/nordstrom/automation/selenium/core/JsUtility.java b/src/main/java/com/nordstrom/automation/selenium/core/JsUtility.java
@@ -75,6 +75,7 @@ public final class JsUtility {
     private static final String MESSAGE_KEY = "message";
 
     private static final String DOCUMENT_READY = getScriptResource("documentReady.js");
+    private static final String CREATE_SCRIPT_NODE = getScriptResource("createScriptNode.js");
 
     private static final List<String> JS_EXCEPTIONS = Arrays.asList(
                     "org.openqa.selenium.WebDriverException",
@@ -198,7 +199,7 @@ public TimeoutException differentiateTimeout(TimeoutException e) {
     public static void injectGlueLib(final WebDriver driver) {
         JavascriptExecutor executor = WebDriverUtils.getExecutor(driver);
         if ((boolean) executor.executeScript("return (typeof isObject != 'function');")) {
-            executor.executeScript(getScriptResource(JsUtility.JAVA_GLUE_LIB));
+            executor.executeScript(CREATE_SCRIPT_NODE, getScriptResource(JAVA_GLUE_LIB));
         }
     }
 

diff --git a/src/main/java/com/nordstrom/automation/selenium/examples/ShadowRootComponent.java b/src/main/java/com/nordstrom/automation/selenium/examples/ShadowRootComponent.java
@@ -1,7 +1,11 @@
 package com.nordstrom.automation.selenium.examples;
 
+import java.util.Arrays;
+import java.util.List;
+
 import org.openqa.selenium.By;
 import org.openqa.selenium.SearchContext;
+import org.openqa.selenium.WebElement;
 
 import com.nordstrom.automation.selenium.model.ComponentContainer;
 import com.nordstrom.automation.selenium.model.RobustWebElement;
@@ -22,7 +26,8 @@ public ShadowRootComponent(final RobustWebElement element, final ComponentContai
     }
 
     private enum Using implements ByEnum {
-        HEADING(By.cssSelector("h1"));
+        HEADING(By.cssSelector("h1")),
+        PARA(By.cssSelector("p[id^='para-']"));
 
         private By locator;
 
@@ -36,10 +41,15 @@ public By locator() {
         }
     }
 
-    public String getContent() {
+    public String getHeading() {
         return findElement(Using.HEADING).getText();
     }
-
+
+    public List<String> getParagraphs() {
+        List<WebElement> paraList = findElements(Using.PARA);
+        return Arrays.asList(paraList.get(0).getText(), paraList.get(1).getText(), paraList.get(2).getText());
+    }
+
     public static Object getKey(final SearchContext context) {
         return getShadowRoot(context).findElement(Using.HEADING.locator).getText();
     }

diff --git a/src/main/java/com/nordstrom/automation/selenium/model/FirefoxShadowRoot.java b/src/main/java/com/nordstrom/automation/selenium/model/FirefoxShadowRoot.java
@@ -42,7 +42,7 @@ public List<WebElement> findElements(final By by) {
     @Override
     public WebElement findElement(final By by) {
         String script = SearchContextUtils.buildScriptToLocateElement(ContextType.SHADOW, by, 0);
-        return JsUtility.runAndReturn(driver, script, context);
+        return RobustElementFactory.makeRobustElement(null, (RobustWebElement) context, script);
     }
 
     /**

diff --git a/src/main/java/com/nordstrom/automation/selenium/model/RobustElementWrapper.java b/src/main/java/com/nordstrom/automation/selenium/model/RobustElementWrapper.java
@@ -52,12 +52,12 @@ private enum Strategy { LOCATOR, SCRIPT }
 
     private final WebDriver driver;
     private final WrapsContext context;
-    private WebElement wrapped;
-    private By locator;
-    private int index;
+    private final String script;
+    private final By locator;
+    private final int index;
+    private final Strategy strategy;
 
-    private String script;
-    private Strategy strategy = Strategy.LOCATOR;
+    private WebElement wrapped;
 
     private long acquiredAt;
 
@@ -77,30 +77,40 @@ public RobustElementWrapper(
         // if specified element is already robust
         if (element instanceof RobustWebElement) {
             RobustElementWrapper wrapper = ((InterceptionAccessor) element).getInterceptor();
-            this.acquiredAt = wrapper.acquiredAt;
 
-            this.wrapped = wrapper.wrapped;
+            this.driver = wrapper.driver;
             this.context = wrapper.context;
+
+            this.script = wrapper.script;
             this.locator = wrapper.locator;
             this.index = wrapper.index;
+            this.strategy = wrapper.strategy;
+
+            this.wrapped = wrapper.wrapped;
+            this.acquiredAt = wrapper.acquiredAt;
         } else {
             Objects.requireNonNull(context, "[context] must be non-null");
             Objects.requireNonNull(locator, "[locator] must be non-null");
             if (index < OPTIONAL) {
                 throw new IndexOutOfBoundsException("Specified index is invalid");
             }
 
-            this.wrapped = element;
+            this.driver = WebDriverUtils.getDriver(context.getWrappedContext());
             this.context = context;
-            this.locator = locator;
-            this.index = index;
-        }
-
-        driver = WebDriverUtils.getDriver(this.context.getWrappedContext());
-
-        if ((this.index == OPTIONAL) || (this.index > 0)) {
-            script = SearchContextUtils.buildScriptToLocateElement(this.context, this.locator, this.index);
-            strategy = Strategy.SCRIPT;
+
+            if ((index == OPTIONAL) || (index > 0)) {
+                this.script = SearchContextUtils.buildScriptToLocateElement(context, locator, index);
+                this.locator = null;
+                this.index = (index == OPTIONAL) ? OPTIONAL : CARDINAL;
+                this.strategy = Strategy.SCRIPT;
+            } else {
+                this.script = null;
+                this.locator = locator;
+                this.index = index;
+                this.strategy = Strategy.LOCATOR;
+            }
+
+            this.wrapped = element;
         }
 
         if (this.wrapped == null) {
@@ -124,21 +134,18 @@ public RobustElementWrapper(
     public RobustElementWrapper(
             final WebElement element, final WrapsContext context, final String script) {
 
-        this.wrapped = element;
+        this.driver = WebDriverUtils.getDriver(context.getWrappedContext());
         this.context = context;
-        this.index = CARDINAL;
-
-        driver = WebDriverUtils.getDriver(this.context.getWrappedContext());
 
         this.script = script;
-        strategy = Strategy.SCRIPT;
+        this.locator = null;
+        this.index = CARDINAL;
+        this.strategy = Strategy.SCRIPT;
+
+        this.wrapped = element;
 
         if (this.wrapped == null) {
-            if (this.index == OPTIONAL) {
-                acquireReference(this);
-            } else {
-                refreshReference(null);
-            }
+            refreshReference(null);
         } else if (acquiredAt == 0) {
             acquiredAt = System.currentTimeMillis();
         }

diff --git a/src/main/java/com/nordstrom/automation/selenium/utility/SearchContextUtils.java b/src/main/java/com/nordstrom/automation/selenium/utility/SearchContextUtils.java
@@ -66,16 +66,17 @@ public static String buildScriptToLocateElements(final WrapsContext context, fin
      */
     public static String buildScriptToLocateElements(final ContextType type, final By locator) {
         String format;
+        String shadow = (type == ContextType.SHADOW) ? CHECK_SHADOW_HOST : "";
 
-        String selector = ByType.cssLocatorFor(locator);
+        String selector = quoteSelector(ByType.cssLocatorFor(locator));
         if (selector != null) {
             format = LOCATE_EVERY_BY_CSS;
         } else {
-            selector = ByType.xpathLocatorFor(locator);
+            selector = quoteSelector(ByType.xpathLocatorFor(locator));
             format = LOCATE_EVERY_BY_XPATH;
         }
 
-        return String.format(format, type.name, selector);
+        return String.format(shadow + format, type.name, selector);
     }
 
     /**

diff --git a/src/main/resources/ExamplePage.html b/src/main/resources/ExamplePage.html
@@ -32,12 +32,38 @@
           var rootA = elemA.attachShadow({mode: 'open'});
           var h1_a = document.createElement('h1');
           h1_a.textContent = 'Shadow DOM A';
+          h1_a.id = 'shadow-heading-a';
+          var para_1_a = document.createElement('p');
+          para_1_a.textContent = '[A] This is paragraph one.';
+          para_1_a.id = 'para-1-a';
+          var para_2_a = document.createElement('p');
+          para_2_a.textContent = '[A] This is paragraph two.';
+          para_2_a.id = 'para-2-a';
+          var para_3_a = document.createElement('p');
+          para_3_a.textContent = '[A] This is paragraph three.';
+          para_3_a.id = 'para-3-a';
           rootA.appendChild(h1_a);
+          rootA.appendChild(para_1_a);
+          rootA.appendChild(para_2_a);
+          rootA.appendChild(para_3_a);
 
           var rootB = elemB.attachShadow({mode: 'open'});
           var h1_b = document.createElement('h1');
           h1_b.textContent = 'Shadow DOM B';
+          h1_b.id = 'shadow-heading-b';
+          var para_1_b = document.createElement('p');
+          para_1_b.textContent = '[B] This is paragraph one.';
+          para_1_b.id = 'para-1-b';
+          var para_2_b = document.createElement('p');
+          para_2_b.textContent = '[B] This is paragraph two.';
+          para_2_b.id = 'para-2-b';
+          var para_3_b = document.createElement('p');
+          para_3_b.textContent = '[B] This is paragraph three.';
+          para_3_b.id = 'para-3-b';
           rootB.appendChild(h1_b);
+          rootB.appendChild(para_1_b);
+          rootB.appendChild(para_2_b);
+          rootB.appendChild(para_3_b);
         }
       }
     </script>

diff --git a/src/main/resources/createScriptNode.js b/src/main/resources/createScriptNode.js
@@ -0,0 +1,4 @@
+var head = document.getElementsByTagName('head')[0];
+var script = document.createElement('script');
+script.textContent = arguments[0];
+head.appendChild(script);
diff --git a/src/test/java/com/nordstrom/automation/selenium/core/ModelTestCore.java b/src/test/java/com/nordstrom/automation/selenium/core/ModelTestCore.java
@@ -114,7 +114,7 @@ public static Runnable testShadowRootByLocator(final TestBase instance) {
             @Override
             public void run() {
                 ShadowRootComponent shadowRoot = page.getShadowRootByLocator();
-                assertEquals(shadowRoot.getContent(), SHADOW_DOM_A);
+                assertEquals(shadowRoot.getHeading(), SHADOW_DOM_A);
             }
         };
     }
@@ -126,7 +126,7 @@ public static Runnable testShadowRootByElement(final TestBase instance) {
             @Override
             public void run() {
                 ShadowRootComponent shadowRoot = page.getShadowRootByElement();
-                assertEquals(shadowRoot.getContent(), SHADOW_DOM_B);
+                assertEquals(shadowRoot.getHeading(), SHADOW_DOM_B);
             }
         };
     }
@@ -139,8 +139,8 @@ public static Runnable testShadowRootList(final TestBase instance) {
             public void run() {
                 List<ShadowRootComponent> shadowRootList = page.getShadowRootList();
                 assertEquals(shadowRootList.size(), 2);
-                assertEquals(shadowRootList.get(0).getContent(), SHADOW_DOM_A);
-                assertEquals(shadowRootList.get(1).getContent(), SHADOW_DOM_B);
+                assertEquals(shadowRootList.get(0).getHeading(), SHADOW_DOM_A);
+                assertEquals(shadowRootList.get(1).getHeading(), SHADOW_DOM_B);
             }
         };
     }
@@ -153,8 +153,8 @@ public static Runnable testShadowRootMap(final TestBase instance) {
             public void run() {
                 Map<Object, ShadowRootComponent> shadowRootMap = page.getShadowRootMap();
                 assertEquals(shadowRootMap.size(), 2);
-                assertEquals(shadowRootMap.get(SHADOW_DOM_A).getContent(), SHADOW_DOM_A);
-                assertEquals(shadowRootMap.get(SHADOW_DOM_B).getContent(), SHADOW_DOM_B);
+                assertEquals(shadowRootMap.get(SHADOW_DOM_A).getHeading(), SHADOW_DOM_A);
+                assertEquals(shadowRootMap.get(SHADOW_DOM_B).getHeading(), SHADOW_DOM_B);
             }
         };
     }
@@ -235,4 +235,25 @@ public static void testBogusOptional(TestBase instance) {
         assertFalse(page.hasBogusOptional());
     }
 
+    public static Runnable testShadowParagraphs(final TestBase instance) {
+        return new Runnable() {
+            final ExamplePage page = instance.getInitialPage();
+
+            @Override
+            public void run() {
+                ShadowRootComponent shadowRoot = page.getShadowRootByLocator();
+                List<String> paraList = shadowRoot.getParagraphs();
+                assertEquals(paraList.size(), 3);
+
+                String[] expect = new String[3];
+                String heading = shadowRoot.getHeading();
+                String marker = String.format("[%s] ", heading.substring(11));
+                for (int i = 0; i < 3; i++) {
+                    expect[i] = marker + PARAS[i];
+                }
+                assertArrayEquals(paraList.toArray(), expect);
+            }
+        };
+    }
+
 }
diff --git a/src/test/java/com/nordstrom/automation/selenium/junit/JUnitModelTest.java b/src/test/java/com/nordstrom/automation/selenium/junit/JUnitModelTest.java
@@ -4,6 +4,7 @@
 
 import org.junit.Ignore;
 import org.junit.Test;
+
 import com.nordstrom.automation.selenium.annotations.InitialPage;
 import com.nordstrom.automation.selenium.core.ModelTestCore;
 import com.nordstrom.automation.selenium.examples.ExamplePage;
@@ -146,4 +147,14 @@ public void testBogusOptional() {
     	ModelTestCore.testBogusOptional(this);
     }
 
+    @Test
+    @Ignore
+    public void testShadowParagraphs() {
+        try {
+            ModelTestCore.testShadowParagraphs(this).run();
+        } catch (ShadowRootContextException e) {
+            assumeNoException(e);
+        }
+    }
+
 }
diff --git a/src/test/java/com/nordstrom/automation/selenium/model/ModelTest.java b/src/test/java/com/nordstrom/automation/selenium/model/ModelTest.java
@@ -127,4 +127,13 @@ public void testBogusOptional() {
     	ModelTestCore.testBogusOptional(this);
     }
 
+    @Test
+    public void testShadowParagraphs() {
+        try {
+            ModelTestCore.testShadowParagraphs(this).run();
+        } catch (ShadowRootContextException e) {
+            throw new SkipException(e.getMessage(), e);
+        }
+    }
+
 }