Add alert modeling (#294)

Author: sbabcoc

src/main/java/com/nordstrom/automation/selenium/examples/ExamplePage.java

@@ -6,6 +6,7 @@
 import java.net.URL;
 import java.util.List;
 import java.util.Map;
+import java.util.Optional;
 import java.util.stream.Collectors;
 
 import org.openqa.selenium.By;
@@ -17,6 +18,8 @@
 import com.nordstrom.automation.selenium.annotations.PageUrl;
 import com.nordstrom.automation.selenium.core.ByType;
 import com.nordstrom.automation.selenium.core.JsUtility;
+import com.nordstrom.automation.selenium.interfaces.DetectsLoadCompletion;
+import com.nordstrom.automation.selenium.model.AlertHandler;
 import com.nordstrom.automation.selenium.model.Page;
 import com.nordstrom.automation.selenium.model.RobustWebElement;
 import com.nordstrom.automation.selenium.servlet.ExamplePageLauncher;
@@ -26,12 +29,13 @@
  * This class is the model for the 'Example' page used by Selenium Foundation unit tests.
  */
 @PageUrl("/grid/admin/ExamplePageServlet")
-public class ExamplePage extends Page {
+public class ExamplePage extends Page implements DetectsLoadCompletion {
 
     /** page title */
     public static final String TITLE = "Example Page";
     /** text content of example paragraphs collection */
-    public static final String[] PARAS = {"This is paragraph one.", "This is paragraph two.", "This is paragraph three."};
+    public static final String[] PARAS =
+        {"This is paragraph one.", "This is paragraph two.", "This is paragraph three.", /* hidden paragraph */ ""};
     /** text content of example table headers collection */
     public static final String[] HEADINGS = {"Firstname", "Lastname", "Age"};
     /** text content of example table rows collection */
@@ -58,6 +62,7 @@ public class ExamplePage extends Page {
      */
     public ExamplePage(WebDriver driver) {
         super(driver);
+        alertHandler = new ExampleAlertHandler(this);
     }
 
     private FrameComponent frameByLocator;
@@ -74,7 +79,9 @@ public ExamplePage(WebDriver driver) {
     private ShadowRootComponent shadowRootByElement;
     private List<ShadowRootComponent> shadowRootList;
     private Map<Object, ShadowRootComponent> shadowRootMap;
+    private final AlertHandler alertHandler;
     private int refreshCount;
+    private boolean isLoaded;
 
     /** identifier for frame 'A' */
     protected static final String FRAME_A_ID = "frame-a";
@@ -116,7 +123,15 @@ protected enum Using implements ByEnum {
         /** shadow root element 'B' */
         SHADOW_ROOT_B(By.cssSelector("div#shadow-root-b")),
         /** division element */
-        FORM_DIV(By.cssSelector("div#form-div"));
+        FORM_DIV(By.cssSelector("div#form-div")),
+        /** alert button */
+        ALERT(By.cssSelector("button#alert")),
+        /** confirm button */
+        CONFIRM(By.cssSelector("button#confirm")),
+        /** prompt button */
+        PROMPT(By.cssSelector("button#prompt")),
+        /** result paragraph */
+        RESULT(By.cssSelector("p#result"));
 
         private final By locator;
 
@@ -130,6 +145,39 @@ public By locator() {
         }
     }
 
+    /**
+     * This enumeration defined alert type constants. 
+     */
+    public enum ModalType {
+        /** 'alert' modal */
+        ALERT("I am a JS Alert"),
+        /** 'confirm' modal */
+        CONFIRM("I am a JS Confirm"),
+        /** 'prompt' modal */
+        PROMPT("I am a JS Prompt");
+        
+        private String text;
+
+        ModalType(String text) {
+            this.text = text;
+        }
+        
+        /**
+         * Convert the specified modal text to the corresponding constant.
+         * 
+         * @param text modal text
+         * @return modal type constant
+         * @throws IllegalArgumentException if specified text is unrecognized
+         */
+        public static ModalType fromString(String text) {
+            if (text == null) return null;
+            for (ModalType type : values()) {
+                if (type.text.equals(text)) return type;
+            }
+            throw new IllegalArgumentException("Unrecognized modal text: " + text);
+        }
+    }
+    
     /**
      * Get the automation component that models frame 'A' via the associated element locator.
      * 
@@ -436,7 +484,74 @@ public boolean hasXpathOptional() {
     public boolean hasBogusOptional() {
         return findOptional(By.tagName("BOGUS")).hasReference();
     }
+    
+    /**
+     * Get the type of the browser modal.
+     * 
+     * @return {@link ModalType} representing the current modal; {@code null} if modal is not shown
+     */
+    public ModalType getModalType() {
+        return ModalType.fromString(alertHandler.getText());
+    }
+    
+    /**
+     * Open the {@link ModalType#ALERT ALERT} modal.
+     */
+    public void openAlertModal() {
+        findElement(Using.ALERT).click();
+    }
 
+    /**
+     * Open the {@link ModalType#CONFIRM CONFIRM} modal.
+     */
+    public void openConfirmModal() {
+        findElement(Using.CONFIRM).click();
+    }
+
+    /**
+     * Open the {@link ModalType#PROMPT PROMPT} modal.
+     */
+    public void openPromptModal() {
+        findElement(Using.PROMPT).click();
+    }
+    
+    /**
+     * Accept the browser modal.
+     * 
+     * @return landing page object
+     */
+    public Page acceptModal() {
+        return alertHandler.accept();
+    }
+    
+    /**
+     * Send the specified keys to the browser modal and accept it.
+     * 
+     * @param keys keys to send
+     * @return landing page object
+     */
+    public Page sendKeysAndAccept(String keys) {
+        return alertHandler.sendKeysAndAccept(keys);
+    }
+    
+    /**
+     * Dismiss the browser modal.
+     * 
+     * @return landing page object
+     */
+    public Page dismissModal() {
+        return alertHandler.dismiss();
+    }
+    
+    /**
+     * Get the modal result text.
+     * 
+     * @return modal result text
+     */
+    public String getModalResult() {
+        return findElement(Using.RESULT).getText();
+    }
+    
     /**
      * Set the active Grid hub as the base URI for all relative loads of test pages.
      * 
@@ -464,5 +579,65 @@ public static URI setHubAsTarget() {
         }
         return targetUri;
     }
+
+    /**
+     * {@inheritDoc}
+     */
+    @Override
+    public boolean isLoadComplete() {
+        if (!isLoaded) {
+            isLoaded = true;
+            return false;
+        }
+        return true;
+    }
 
+    /**
+     * This class models the browser alerts of the example page.
+     */
+    private static class ExampleAlertHandler extends AlertHandler {
+        public ExampleAlertHandler(Page parentPage) {
+            super(parentPage);
+        }
+
+        /**
+         * {@inheritDoc}
+         */
+        @Override
+        public ExamplePage accept() {
+            return Optional.ofNullable(waitForAlert())
+                    .map(alert -> {
+                        alert.accept();
+                        return new ExamplePage(driver);
+                    })
+                    .orElse((ExamplePage) parentPage);
+        }
+
+        /**
+         * {@inheritDoc}
+         */
+        @Override
+        public ExamplePage sendKeysAndAccept(final String keys) {
+            return Optional.ofNullable(waitForAlert())
+                    .map(alert -> {
+                        alert.sendKeys(keys);
+                        alert.accept();
+                        return new ExamplePage(driver);
+                    })
+                    .orElse((ExamplePage) parentPage);
+        }
+
+        /**
+         * {@inheritDoc}
+         */
+        @Override
+        public ExamplePage dismiss() {
+            return Optional.ofNullable(waitForAlert())
+                    .map(alert -> {
+                        alert.dismiss();
+                        return new ExamplePage(driver);
+                    })
+                    .orElse((ExamplePage) parentPage);
+        }
+    }
 }

src/main/java/com/nordstrom/automation/selenium/model/AlertHandler.java

@@ -0,0 +1,143 @@
+package com.nordstrom.automation.selenium.model;
+
+import org.openqa.selenium.Alert;
+import org.openqa.selenium.NoAlertPresentException;
+import org.openqa.selenium.TimeoutException;
+import org.openqa.selenium.WebDriver;
+
+import java.time.Duration;
+import java.util.Optional;
+
+/**
+ * This class is a wrapper for the <b>Selenium</b> {@link Alert} class, providing an interface that treats browser
+ * modals as the application-level entities that they are instead of the pseudo-contexts presented by the standard
+ * API. 
+ */
+public abstract class AlertHandler {
+    /** driver for this handler */
+    protected final WebDriver driver;
+    /** alert handler parent page */
+    protected final Page parentPage;
+    /** alert handler wait timeout */
+    protected final Duration timeout;
+
+    /**
+     * Constructor for an alert handler with default timeout.
+     * 
+     * @param parentPage alert parent page
+     */
+    public AlertHandler(final Page parentPage) {
+        this(parentPage, Duration.ofSeconds(5));
+    }
+
+    /**
+     * Constructor for an alert handler with specified timeout.
+     * 
+     * @param parentPage alert parent page
+     * @param timeout maximum interval to wait for an alert to appear
+     */
+    public AlertHandler(final Page parentPage, final Duration timeout) {
+        this.driver = parentPage.getWrappedDriver();
+        this.parentPage = parentPage;
+        this.timeout = timeout;
+    }
+    
+    /**
+     * Wait for browser alert up to the timeout interval.
+     * 
+     * @return {@link Alert} object if alert appears; {@code null} if wait is interrupted
+     * @throws TimeoutException if alert is still absent when wait interval expires
+     */
+    protected Alert waitForAlert() {
+        long start = System.currentTimeMillis();
+        long end = start + timeout.toMillis();
+
+        while (System.currentTimeMillis() < end) {
+            try {
+                return driver.switchTo().alert();
+            } catch (NoAlertPresentException e) {
+                try {
+                    Thread.sleep(100);
+                } catch (InterruptedException ignored) {
+                    Thread.currentThread().interrupt();
+                    return null;
+                }
+            }
+        }
+        throw new TimeoutException("Alert not present after waiting " + timeout.getSeconds() + " seconds.");
+    }
+
+    /**
+     * Switch driver focus to browser alert if one is present.
+     * 
+     * @return {@link Alert} object; {@code null} if alert is absent
+     */
+    protected Alert switchIfAlertExists() {
+        try {
+            return driver.switchTo().alert();
+        } catch (NoAlertPresentException e) {
+            return null;
+        }
+    }
+    
+    /**
+     * Determine if browser alert is present.
+     * 
+     * @return {@code true} if alert exists; otherwise {@code false}
+     */
+    public boolean exists() {
+        return (null != switchIfAlertExists());
+    }
+
+    /**
+     * Get text of browser alert.
+     * 
+     * @return {@link Alert} text; {@code null} if alert is absent
+     */
+    public String getText() {
+        return Optional.ofNullable(switchIfAlertExists()).map(alert -> alert.getText()).orElse(null);
+    }
+
+    /**
+     * Wait for browser alert and accept it.
+     * 
+     * @return alert text; {code null} if wait is interrupted
+     * @throws TimeoutException if alert is still absent when wait interval expires
+     */
+    abstract public Page accept();
+
+    /**
+     * Wait for browser alert, then send the specified keys and accept the alert.
+     * 
+     * @param keys keys to send
+     * @return alert text; {code null} if wait is interrupted
+     * @throws TimeoutException if alert is still absent when wait interval expires
+     */
+    abstract public Page sendKeysAndAccept(String keys);
+    
+    /**
+     * Wait for browser alert and dismiss it.
+     * 
+     * @return alert text; {code null} if wait is interrupted
+     * @throws TimeoutException if alert is still absent when wait interval expires
+     */
+    abstract public Page dismiss();
+    
+    /**
+     * If browser alert is present, accept it.
+     * 
+     * @return if alert is present, landing page; otherwise parent page
+     */
+    public Page acceptIfPresent() {
+        return exists() ? accept() : parentPage;
+    }
+
+    /**
+     * If browser alert is present, dismiss it.
+     * 
+     * @return if alert is present, landing page; otherwise parent page
+     */
+    public Page dismissIfPresent() {
+        return exists() ? dismiss() : parentPage;
+    }
+}