Merge pull request #23 from levi-rs/add-find-write

Add find_elements to waiter

Author: levi-rs

explicit/waiter.py

@@ -42,6 +42,30 @@ def find_element(driver, elem_path, by=CSS, timeout=TIMEOUT, poll_frequency=0.5)
     return wait.until(EC.presence_of_element_located((by, elem_path)))
 
 
+def find_elements(driver, elem_path, by=CSS, timeout=TIMEOUT, poll_frequency=0.5):
+    """ Find and return all elements once located
+
+    find_elements locates all elements on the page, waiting
+    for up to timeout seconds. The elements, when located,
+    are returned. If not located, a TimeoutException is raised.
+
+    Args:
+        driver (selenium webdriver or element): A driver or element
+        elem_path (str): String used to located the element
+        by (selenium By): Selenium By reference
+        timeout (int): Selenium Wait timeout, in seconds
+        poll_frequency (float): Selenium Wait polling frequency, in seconds
+
+    Returns:
+        list of elements: Selenium element
+
+    Raises:
+        TimeoutException: Raised when target element isn't located
+    """
+    wait = WebDriverWait(driver, timeout, poll_frequency)
+    return wait.until(EC.presence_of_all_elements_located((by, elem_path)))
+
+
 def find_write(driver, elem_path, write_str, clear_first=True, send_enter=False,
                by=CSS, timeout=TIMEOUT, poll_frequency=0.5):
     """ Find a writable element and write to it

tests/test_waiter.py

@@ -44,6 +44,41 @@ def test_find_element_with_non_defaults(driver, element):
                                                   mock.call(By.XPATH, mock_xpath_path)]
 
 
+def test_find_elements_with_defaults(driver, element):
+    """ Verify the waiter can find and return all elements
+    """
+    mock_css_path = "div.mock-css-path"
+
+    driver.find_elements.side_effect = [None, [element, element]]
+
+    elem_list = waiter.find_elements(driver, mock_css_path)
+
+    assert driver.find_elements.called
+    assert isinstance(elem_list, list)
+    assert all(map(lambda x: x is element, elem_list))
+    assert len(driver.mock_calls) == 2
+    assert driver.find_elements.call_args_list == [mock.call(CSS, mock_css_path),
+                                                   mock.call(CSS, mock_css_path)]
+
+
+def test_find_elements_with_non_defaults(driver, element):
+    """ Verify the waiter can find and return all elements when using
+        non-default kwargs
+    """
+    mock_xpath_path = "div[@id=mock-id]"
+
+    driver.find_elements.side_effect = [None, [element, element]]
+
+    elem_list = waiter.find_elements(driver, mock_xpath_path, by=By.XPATH)
+
+    assert driver.find_elements.called
+    assert isinstance(elem_list, list)
+    assert all(map(lambda x: x is element, elem_list))
+    assert len(driver.mock_calls) == 2
+    assert driver.find_elements.call_args_list == [mock.call(By.XPATH, mock_xpath_path),
+                                                   mock.call(By.XPATH, mock_xpath_path)]
+
+
 def test_find_write_with_defaults(driver, element):
     """ Verify the waiter can find and write to an element, using
         default kwargs