appium#846: listeners

Author: TikhomirovSergey

src/main/java/io/appium/java_client/events/DefaultAspect.java

@@ -83,6 +83,8 @@ class DefaultAspect {
  + ".rotate(..))";
  private static final String EXECUTION_CONTEXT = "execution(* org.openqa.selenium.ContextAware."
  + "context(..))";
+ private static final String EXECUTION_SWITCH_TO_WINDOW = "execution(* org.openqa.selenium.WebDriver.TargetLocator"
+ + ".window(..))";
  private static final String AROUND = "execution(* org.openqa.selenium.WebDriver.*(..)) || "
  + "execution(* org.openqa.selenium.WebElement.*(..)) || "
  + "execution(* org.openqa.selenium.WebDriver.Navigation.*(..)) || "
@@ -463,6 +465,24 @@ public void afterMaximization(JoinPoint joinPoint) throws Throwable {
  }
  }
 
+ @Before(EXECUTION_SWITCH_TO_WINDOW)
+ public void beforeSwitchToWindow(JoinPoint joinPoint) throws Throwable {
+ try {
+ listener.beforeSwitchToWindow(castArgument(joinPoint, 0), driver);
+ } catch (Throwable t) {
+ throw getRootCause(t);
+ }
+ }
+
+ @After(EXECUTION_SWITCH_TO_WINDOW)
+ public void afterSwitchToWindow(JoinPoint joinPoint) throws Throwable {
+ try {
+ listener.afterSwitchToWindow(castArgument(joinPoint, 0), driver);
+ } catch (Throwable t) {
+ throw getRootCause(t);
+ }
+ }
+
  @Before(EXECUTION_ROTATE)
  public void beforeRotation(JoinPoint joinPoint) throws Throwable {
  try {

src/main/java/io/appium/java_client/events/DefaultListener.java

@@ -209,6 +209,16 @@ public void afterWindowIsMoved(WebDriver driver, WebDriver.Window window, Point
  ((WindowEventListener) dispatcher).afterWindowIsMaximized(driver, window);
  }
 
+ @Override
+ public void beforeSwitchToWindow(String windowName, WebDriver driver) {
+ ((WebDriverEventListener) dispatcher).beforeSwitchToWindow(windowName, driver);
+ }
+
+ @Override
+ public void afterSwitchToWindow(String windowName, WebDriver driver) {
+ ((WebDriverEventListener) dispatcher).afterSwitchToWindow(windowName, driver);
+ }
+
  @Override public void beforeSwitchingToContext(WebDriver driver, String context) {
  ((ContextEventListener) dispatcher).beforeSwitchingToContext(driver, context);
  }

src/main/java/io/appium/java_client/events/api/general/WindowEventListener.java

@@ -78,4 +78,20 @@ void afterWindowIsMoved(WebDriver driver, WebDriver.Window window,
  * @param window is the window which has been maximized
  */
  void afterWindowIsMaximized(WebDriver driver, WebDriver.Window window);
+
+ /**
+ * This action will be performed each time before
+ * {@link org.openqa.selenium.WebDriver.TargetLocator#window(java.lang.String)}.
+ *
+ * @param driver WebDriver
+ */
+ void beforeSwitchToWindow(String windowName, WebDriver driver);
+
+ /**
+ * This action will be performed each time after
+ * {@link org.openqa.selenium.WebDriver.TargetLocator#window(java.lang.String)}.
+ *
+ * @param driver WebDriver
+ */
+ void afterSwitchToWindow(String windowName, WebDriver driver);
 }

src/test/java/io/appium/java_client/events/BaseListenerTest.java

@@ -270,6 +270,8 @@ protected boolean assertThatWindowListenerWorks(EmptyWebDriver driver, TestListe
 
  window.maximize();
 
+ driver.switchTo().window("Test window");
+
  assertThat(listener.messages,
  contains(prefix + "Attempt to change size of the window. The height is " + d.getHeight()
  + " the width is " + d.getWidth(),
@@ -280,7 +282,9 @@ protected boolean assertThatWindowListenerWorks(EmptyWebDriver driver, TestListe
  prefix + "The position the window has been changed. The X is " + p.getX()
  + " the Y is " + p.getY(),
  prefix + "Attempt to maximize the window.",
- prefix + "The window has been maximized"));
+ prefix + "The window has been maximized",
+ prefix + "Attempt to switch to window Test window",
+ prefix + "driver is switched to window Test window"));
  return true;
  } finally {
  listener.messages.clear();

src/test/java/io/appium/java_client/events/WebDriverEventListenerCompatibilityTest.java

@@ -1,16 +1,21 @@
 package io.appium.java_client.events;
 
+import static org.hamcrest.Matchers.contains;
 import static org.hamcrest.core.Is.is;
 import static org.hamcrest.core.IsCollectionContaining.hasItems;
 import static org.junit.Assert.assertThat;
 
 import io.appium.java_client.events.listeners.AppiumListener;
 import io.appium.java_client.events.listeners.SingleListeners;
+import io.appium.java_client.events.listeners.TestListener;
 import org.junit.BeforeClass;
 import org.junit.FixMethodOrder;
 import org.junit.Test;
 import org.junit.runners.MethodSorters;
 import org.openqa.selenium.Alert;
+import org.openqa.selenium.Dimension;
+import org.openqa.selenium.Point;
+import org.openqa.selenium.WebDriver;
 
 @FixMethodOrder(MethodSorters.NAME_ASCENDING)
 public class WebDriverEventListenerCompatibilityTest extends BaseListenerTest {
@@ -71,7 +76,6 @@ public void alertEventTest() {
  WEBDRIVER_EVENT_LISTENER + "The alert was accepted",
  WEBDRIVER_EVENT_LISTENER + "Attempt to dismiss alert",
  WEBDRIVER_EVENT_LISTENER + "The alert was dismissed"));
- assertThat(listener.messages.size(), is(4));
  } finally {
  listener.messages.clear();
  }
@@ -82,4 +86,17 @@ public void exceptionEventTest() {
  assertThat(super.assertThatExceptionListenerWorks(driver, listener, WEBDRIVER_EVENT_LISTENER),
  is(true));
  }
+
+ @Test
+ public void windowListenerTest() {
+ try {
+ driver.switchTo().window("Test window");
+ assertThat(listener.messages,
+ hasItems(WEBDRIVER_EVENT_LISTENER + "Attempt to switch to window Test window",
+ WEBDRIVER_EVENT_LISTENER + "driver is switched to window Test window"));
+ } finally {
+ listener.messages.clear();
+ }
+
+ }
 }

src/test/java/io/appium/java_client/events/listeners/AppiumListener.java

@@ -1,5 +1,7 @@
 package io.appium.java_client.events.listeners;
 
+import static java.lang.String.format;
+
 import io.appium.java_client.events.api.general.AppiumWebDriverEventListener;
 import org.openqa.selenium.By;
 import org.openqa.selenium.WebDriver;
@@ -112,4 +114,14 @@ public void beforeAlertDismiss(WebDriver driver) {
  @Override public void onException(Throwable throwable, WebDriver driver) {
  messages.add("WebDriverEventListener: The exception was thrown: " + throwable.getClass());
  }
+
+ @Override
+ public void beforeSwitchToWindow(String windowName, WebDriver driver) {
+ messages.add(format("WebDriverEventListener: Attempt to switch to window %s", windowName));
+ }
+
+ @Override
+ public void afterSwitchToWindow(String windowName, WebDriver driver) {
+ messages.add(format("WebDriverEventListener: driver is switched to window %s", windowName));
+ }
 }

src/test/java/io/appium/java_client/events/listeners/WindowListener.java

@@ -1,5 +1,7 @@
 package io.appium.java_client.events.listeners;
 
+import static java.lang.String.format;
+
 import io.appium.java_client.events.api.general.WindowEventListener;
 import org.openqa.selenium.Dimension;
 import org.openqa.selenium.Point;
@@ -42,4 +44,14 @@ public void afterWindowIsMoved(WebDriver driver, WebDriver.Window window, Point
  @Override public void afterWindowIsMaximized(WebDriver driver, WebDriver.Window window) {
  messages.add("The window has been maximized");
  }
+
+ @Override
+ public void beforeSwitchToWindow(String windowName, WebDriver driver) {
+ messages.add(format("Attempt to switch to window %s", windowName));
+ }
+
+ @Override
+ public void afterSwitchToWindow(String windowName, WebDriver driver) {
+ messages.add(format("driver is switched to window %s", windowName));
+ }
 }

src/test/java/io/appium/java_client/events/listeners/WindowListener2.java

@@ -1,5 +1,7 @@
 package io.appium.java_client.events.listeners;
 
+import static java.lang.String.format;
+
 import io.appium.java_client.events.api.general.WindowEventListener;
 import org.openqa.selenium.Dimension;
 import org.openqa.selenium.Point;
@@ -46,4 +48,14 @@ public void afterWindowIsMoved(WebDriver driver, WebDriver.Window window, Point
  @Override public void afterWindowIsMaximized(WebDriver driver, WebDriver.Window window) {
  messages.add("Externally defined listener: The window has been maximized");
  }
+
+ @Override
+ public void beforeSwitchToWindow(String windowName, WebDriver driver) {
+ messages.add(format("Externally defined listener: Attempt to switch to window %s", windowName));
+ }
+
+ @Override
+ public void afterSwitchToWindow(String windowName, WebDriver driver) {
+ messages.add(format("Externally defined listener: driver is switched to window %s", windowName));
+ }
 }