Merge pull request #16 from levi-rs/14-add-find-element

Add initial find_element function

Author: levi-rs

.coveragerc

@@ -0,0 +1,2 @@
+[run]
+omit = explicit/_version.py

.landscape.yml

@@ -0,0 +1,3 @@
+ignore-paths:
+  - versioneer.py
+  - explicit/_version.py

explicit/__init__.py

@@ -1,4 +1,3 @@
-
 from ._version import get_versions
 __version__ = get_versions()['version']
 del get_versions

explicit/waiter.py

@@ -0,0 +1,41 @@
+# -*- coding: utf-8 -*-
+"""explicit.waiter
+
+A collection of helper functions to make working with Selenium's
+explicit wait functionality easier.
+
+"""
+
+from selenium.webdriver.common.by import By
+from selenium.webdriver.support.ui import WebDriverWait
+from selenium.webdriver.support import expected_conditions as EC
+
+TIMEOUT = 30
+""" int: Default timeout value, in seconds"""
+
+CSS = By.CSS_SELECTOR
+""" By: Default Selenium search type (CSS Selector)"""
+
+
+def find_element(driver, elem_path, by=CSS, timeout=TIMEOUT, poll_frequency=0.5):
+    """ find and return an element once located
+
+    find_element locates an element on the page, waiting
+    for up to timeout seconds. The element, when located,
+    is 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:
+        element: Selenium element
+
+    Raises:
+        TimeoutException: Raised when target element isn't located
+    """
+    wait = WebDriverWait(driver, timeout, poll_frequency)
+    return wait.until(EC.presence_of_element_located((by, elem_path)))

setup.cfg

@@ -4,3 +4,19 @@ style = pep440
 versionfile_source = explicit/_version.py
 versionfile_build = explicit/_version.py
 tag_prefix =
+
+[flake8]
+count = True
+statistics = True
+max-complexity = 10
+max-line-length = 100
+output-file = {envdir}/flake8.txt
+exclude =
+    .git,
+    __pycache__,
+    docs/source/conf.py,
+    old,
+    build,
+    dist,
+    versioneer.py,
+    explicit/_version.py

setup.py

@@ -12,7 +12,7 @@
 with open(path.join(here, 'README.rst')) as f:
     long_description = f.read()
 
-install_requires = ['versioneer', ]
+install_requires = ['selenium']
 
 setup(
     name='explicit',

tests/conftest.py

@@ -0,0 +1,22 @@
+try:
+    import mock
+except ImportError:
+    from unittest import mock
+
+import pytest
+from selenium import webdriver
+from selenium.webdriver.remote.webelement import WebElement
+
+
+@pytest.fixture(scope="function")
+def driver():
+    ''' Returns a mock selenium driver object
+    '''
+    return mock.create_autospec(webdriver.Firefox)
+
+
+@pytest.fixture(scope="function")
+def element():
+    ''' Returns a mock selenium element object
+    '''
+    return mock.create_autospec(WebElement)

tests/test_placeholder.py

@@ -0,0 +1,13 @@
+from explicit import waiter
+
+
+def test_find_element(driver, element):
+    """ Verify the water can find and return an element
+    """
+    driver.find_element.side_effect = [None, element]
+
+    elem = waiter.find_element(driver, "div.mock-css-path")
+
+    assert driver.find_element.called
+    assert len(driver.mock_calls) == 2
+    assert elem is element

tests/test_waiter.py

@@ -1,19 +1,19 @@
 [tox]
 skipdist = True
-envlist = py{27,33,34,35,py,py3},lint
+envlist = py{26,27,33,34,35,py,py3},lint
 skip_missing_interpreters=True
 
 [testenv:lint]
 deps =
     flake8
 commands =
-    flake8 --max-complexity=10 --statistics --count --output-file={envdir}/flake8.txt setup.py explicit tests
+    flake8 --output-file={envdir}/flake8.txt setup.py explicit tests
 
 [testenv]
 deps =
-    py{27,py,py3}: mock
+    py{26,27,py,py3}: mock
     pytest
     pytest-cov
     pytest-sugar
 commands =
-    py.test -s --cov explicit --cov-report term-missing --cov-report xml --junitxml={envdir}/{envdir}.junit.xml tests []
+    py.test -s --cov-config .coveragerc --cov explicit --cov-report term-missing:skip-covered --cov-report xml --junitxml={envdir}/{envdir}.junit.xml tests []