Remove spend_time_in_reactor from functional tests

- Issue #456
- Protect mail list click click against staleness exceptions
  Mail list is manipulated while accessing first mail so page
  often is stale. Repeat function if that happens

1 files changed, 20 insertions, 26 deletions

diff --git a/service/test/functional/features/steps/common.py b/service/test/functional/features/steps/common.py
index b53359dc..9a547375 100644
--- a/service/test/functional/features/steps/common.py
+++ b/service/test/functional/features/steps/common.py
@@ -13,15 +13,11 @@
 #
 # You should have received a copy of the GNU Affero General Public License
 # along with Pixelated. If not, see <http://www.gnu.org/licenses/>.
-from crochet import wait_for
-
 from selenium.webdriver.common.by import By
 from selenium.webdriver.support import expected_conditions as EC
 from selenium.webdriver.support.wait import WebDriverWait
-from selenium.common.exceptions import TimeoutException
-from twisted.internet import reactor
-from twisted.internet import defer
-
+from selenium.common.exceptions import TimeoutException, StaleElementReferenceException
+import time
 from test.support.integration import MailBuilder
 
 LOADING = 'loading'
@@ -49,7 +45,6 @@ def wait_until_element_is_invisible_by_locator(context, locator_tuple, timeout=T
 
 
 def wait_until_element_is_deleted(context, locator_tuple, timeout=TIMEOUT_IN_S):
-    spend_time_in_reactor()
     wait = WebDriverWait(context.browser, timeout)
     wait.until(lambda s: len(s.find_elements(locator_tuple[0], locator_tuple[1])) == 0)
 
@@ -63,33 +58,35 @@ def wait_for_user_alert_to_disapear(context, timeout=TIMEOUT_IN_S):
 
 
 def wait_until_elements_are_visible_by_locator(context, locator_tuple, timeout=TIMEOUT_IN_S):
-    spend_time_in_reactor()
     wait = WebDriverWait(context.browser, timeout)
     wait.until(EC.presence_of_all_elements_located(locator_tuple))
     return context.browser.find_elements(locator_tuple[0], locator_tuple[1])
 
 
 def wait_until_elements_are_visible_by_xpath(context, locator_tuple, timeout=TIMEOUT_IN_S):
-    spend_time_in_reactor()
     wait = WebDriverWait(context.browser, timeout)
     wait.until(EC.presence_of_all_elements_located(locator_tuple))
     return context.browser.find_elements(locator_tuple[0], locator_tuple[1])
 
 
 def wait_until_element_is_visible_by_locator(context, locator_tuple, timeout=TIMEOUT_IN_S):
-    spend_time_in_reactor()
     wait = WebDriverWait(context.browser, timeout)
     wait.until(EC.visibility_of_element_located(locator_tuple))
     return context.browser.find_element(locator_tuple[0], locator_tuple[1])
 
 
+def wait_for_condition(context, predicate_func, timeout=TIMEOUT_IN_S, poll_frequency=0.1):
+    wait = WebDriverWait(context.browser, timeout, poll_frequency=poll_frequency)
+    wait.until(predicate_func)
+
+
 def fill_by_xpath(context, xpath, text):
     field = context.browser.find_element_by_xpath(xpath)
     field.send_keys(text)
 
 
 def fill_by_css_selector(context, css_selector, text):
-    field = context.browser.find_element_by_css_selector(css_selector)
+    field = find_element_by_css_selector(context, css_selector)
     field.send_keys(text)
 
 
@@ -126,8 +123,8 @@ def find_element_by_class_name(context, class_name):
     return wait_until_element_is_visible_by_locator(context, (By.CLASS_NAME, class_name))
 
 
-def find_elements_by_css_selector(context, css_selector):
-    return wait_until_elements_are_visible_by_locator(context, (By.CSS_SELECTOR, css_selector))
+def find_elements_by_css_selector(context, css_selector, timeout=TIMEOUT_IN_S):
+    return wait_until_elements_are_visible_by_locator(context, (By.CSS_SELECTOR, css_selector), timeout=timeout)
 
 
 def find_elements_by_xpath(context, xpath):
@@ -144,12 +141,21 @@ def element_should_have_content(context, css_selector, content):
 
 
 def wait_until_button_is_visible(context, title, timeout=TIMEOUT_IN_S):
-    spend_time_in_reactor()
     wait = WebDriverWait(context.browser, timeout)
     locator_tuple = (By.XPATH, ("//%s[contains(.,'%s')]" % ('button', title)))
     wait.until(EC.visibility_of_element_located(locator_tuple))
 
 
+def execute_ignoring_staleness(func, timeout=TIMEOUT_IN_S):
+    end_time = time.time() + timeout
+    while time.time() <= end_time:
+        try:
+            return func()
+        except StaleElementReferenceException:
+            pass
+    raise TimeoutException('did not solve stale state until timeout %f' % timeout)
+
+
 def click_button(context, title, element='button'):
     button = find_element_containing_text(context, title, element_type=element)
     button.click()
@@ -180,15 +186,3 @@ def get_console_log(context):
 def create_email(context):
     input_mail = MailBuilder().build_input_mail()
     context.client.add_mail_to_inbox(input_mail)
-
-
-@wait_for(timeout=5.0)
-def spend_time_in_reactor(reactor_time=1.0):
-    d = defer.Deferred()
-
-    def done_waiting():
-        d.callback(None)
-
-    reactor.callLater(reactor_time, done_waiting)
-
-    return d