Merge pull request #21 from slu-it/SendKeyError

Added method for pressing the ENTER key on text fields and a warning on problematic methods

Author: benhamidene

webtester-core/src/main/java/info/novatec/testit/webtester/pageobjects/TextField.java

@@ -3,6 +3,7 @@
 import java.util.Set;
 
 import org.apache.commons.lang.StringUtils;
+import org.openqa.selenium.Keys;
 import org.openqa.selenium.WebElement;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -12,6 +13,7 @@
 import info.novatec.testit.webtester.api.callbacks.PageObjectCallback;
 import info.novatec.testit.webtester.api.exceptions.PageObjectIsDisabledException;
 import info.novatec.testit.webtester.api.exceptions.PageObjectIsInvisibleException;
+import info.novatec.testit.webtester.api.exceptions.StaleElementRecoveryException;
 import info.novatec.testit.webtester.api.pageobjects.traits.HasText;
 import info.novatec.testit.webtester.eventsystem.events.pageobject.TextAppendedEvent;
 import info.novatec.testit.webtester.eventsystem.events.pageobject.TextClearedEvent;
@@ -88,6 +90,11 @@ protected void executeAfterAction(TextField textField, String oldText, String ne
     /**
      * Sets the given text by replacing whatever text is currently set for the
      * {@link TextField text field}.
+     * <p>
+     * <b>Note:</b> is is not advised to try and send {@link Keys} via this method!
+     * Doing so may in some cases lead to unintended side effects. I.e. sending ENTER
+     * to a search field will cause a {@link StaleElementRecoveryException} if this action
+     * navigates to another page.
      *
      * @param textToSet the text to set
      * @return the same instance for fluent API use
@@ -117,6 +124,11 @@ protected void executeAfterAction(TextField textField, String oldText, String ne
     /**
      * Appends the given text to whatever text is currently set for the
      * {@link TextField text field}.
+     * <p>
+     * <b>Note:</b> is is not advised to try and send {@link Keys} via this method!
+     * Doing so may in some cases lead to unintended side effects. I.e. sending ENTER
+     * to a search field will cause a {@link StaleElementRecoveryException} if this action
+     * navigates to another page.
      *
      * @param textToAppend the text to append
      * @return the same instance for fluent API use
@@ -142,6 +154,26 @@ protected void executeAfterAction(TextField textField, String oldText, String ne
         return this;
     }
 
+    /**
+     * Presses enter on this text field. This can be for example be used to send a form where the text
+     * field is included.
+     * <p>
+     * This method does <u>not</u> return this instance for fluent API because pressing ENTER is usually done in
+     * order to send a form or otherwise execute a potentially terminal action.
+     *
+     * @since 1.1.0
+     */
+    public void pressEnter() {
+        executeAction(new PageObjectCallback() {
+
+            @Override
+            public void execute(PageObject pageObject) {
+                pageObject.getWebElement().sendKeys(Keys.ENTER);
+            }
+
+        });
+    }
+
     @Override
     protected boolean isCorrectClassForWebElement(WebElement webElement) {
 

webtester-core/src/test/java/info/novatec/testit/webtester/pageobjects/TextFieldTest.java

@@ -8,6 +8,7 @@
 import static org.mockito.Mockito.inOrder;
 import static org.mockito.Mockito.never;
 import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.verifyNoMoreInteractions;
 import static org.mockito.Mockito.when;
 
 import org.apache.commons.lang.StringUtils;
@@ -16,6 +17,7 @@
 import org.mockito.Captor;
 import org.mockito.InOrder;
 import org.mockito.InjectMocks;
+import org.openqa.selenium.Keys;
 
 import info.novatec.testit.webtester.AbstractPageObjectTest;
 import info.novatec.testit.webtester.api.exceptions.PageObjectIsDisabledException;
@@ -203,6 +205,15 @@ public void testThatAppendingTextOnDisabledFieldThrowsException() {
         cut.appendText("foo");
     }
 
+    /* pressing ENTER */
+
+    @Test
+    public void testThatPressingEnterSendsCorrectKey() {
+        cut.pressEnter();
+        verify(webElement).sendKeys(Keys.ENTER);
+        verifyNoMoreInteractions(webElement);
+    }
+
     /* correctness of class */
 
     @Test