Merge pull request #63 from spyoungtech/release/0.2.0

Release/0.2.0

Author: spyoungtech

.travis.yml

@@ -1,39 +1,63 @@
-sudo: false
+dist: xenial
 language: python
+
+
 python:
   - "2.7"
-  - "3.5"
   - "3.6"
-  - "nightly"
+
+env:
+  global:
+    - BEHAVE_WEBDRIVER_HEADLESS=1
+  matrix:
+    - BEHAVE_WEBDRIVER=Chrome
+    - BEHAVE_WEBDRIVER=Firefox
 
 addons:
   chrome: stable
+  firefox: latest
+
+matrix:
+  include:
+    - os: osx
+      language: generic
+      python:
+      env:
+        - BEHAVE_WEBDRIVER=Safari
+    - python: "3.5"
+      env:
+       - BEHAVE_WEBDRIVER=Chrome
+    - python: "3.7"
+      env:
+        - BEHAVE_WEBDRIVER=Chrome
+
+
+  fast_finish: true
+  allow_failures:
+    - os: osx
+
 install:
-  - wget -N http://chromedriver.storage.googleapis.com/2.35/chromedriver_linux64.zip -P ./
-  - unzip ./chromedriver_linux64.zip -d ./
-  - rm ./chromedriver_linux64.zip
-  - chmod +x ./chromedriver
-  - pip install -r ./requirements.txt
-  - pip install coveralls pytest mock
+  - ./ci/install.sh
 
 script:
   - cd tests/demo-app
   - python ./runserver.py > /dev/null 2>&1 &
   - cd ../..
+  - export ENV_BASE_URL=http://127.0.0.1:8000/
   - coverage run -m behave tests/features
   - coverage run -a -m pytest tests/unittests
 
-
 after_success:
   - coveralls
 
-
 deploy:
   provider: pypi
+  distributions: "sdist bdist_wheel"
   user: "spyoungtech"
   password:
     secure: "oj3Yvv150E+ExDCxYkeXdwH3+jXmrQbJFK9ic+DHwFBmN8wb0IbjcjtBTu+VOotiEfHZjUuK8Ok44bYvsLIka0Zzt8pY52KREFXEwLh63IYottccerE9VmzQUvC87GWCsiLkmVR5O4ATM31byOFk9MmxIrWy3qhoNNJvQSTcW/HMDIweJUnqHQ10KS/7IkxHZiW1Efe3KKIr9cjOWiXAX/xjmSD7DzEVpENT4BvvwrBnDO2JY+CROHmsO8X2FqjriNn2BCLZK1rd3FXS/hcb698V4nZdTNd63f8twmuPk/owr2dQiexiAhZPQKHj8KBZ6fyn80uOuHHc/44U4rWf+699Q4nq2vYDCaLA2drl3PAPZg65HjWumVQKKYCddY1by52iumJ0fFdPqB7dERqWIvHzCERkwJvsZtzxQ8QV7CUENyS5v398/wUdaOqhRD+MMHG6ZS4Zuhr/wurrJrcX3KjAffY3dVN6uEzTq57JoYX9zrMysKQRyUsGUiNC7e008vRm8rSIEoX4Kc/NqqY+em+wKLuhvxGyDZ9Sd731BgtCQPNj+DFBvk55taXKw78NlCwl03pFCRXKTWoy1nZKYoStQmizy9d44dqua12NV2EOYHzK6+WddM6xJnuVFaWxqcV/vesL/6ekJw8wZI3Q0ud3d0Ws1zSxfyjJt4OchZQ="
   on:
     tags: true
     python: 3.6
+    env: BEHAVE_WEBDRIVER=Chrome
 

MANIFEST.in

@@ -0,0 +1,2 @@
+include LICENSE
+include README.rst

README.rst

@@ -84,8 +84,23 @@ options to run headless. This is useful, for example in headless testing environ
    def before_all(context):
        context.behave_driver = behave_webdriver.Chrome.headless()
 
-In the future, behave-webdriver will provide `fixtures`_ for the setup and teardown of webdrivers.
-See the behave tutorial for more information about `environment controls`_ .
+
+Using a fixture
+^^^^^^^^^^^^^^^
+
+*New in 0.1.1*
+
+You may also find it convenient to use a fixture to setup your driver as well. For example, to use our fixture with Firefox
+
+.. code-block:: python
+
+    from behave_webdriver.fixtures import fixture_browser
+    def before_all(context):
+        use_fixture(fixture_browser, webdriver='Firefox')
+
+This will also ensure that the browser is torn down at the corresponding `cleanup point`_.
+
+.. _cleanup point: http://behave.readthedocs.io/en/stable/fixtures.html#fixture-cleanup-points
 
 Writing the feature file
 ------------------------
@@ -337,24 +352,24 @@ Then Steps ✔️
 Acknowledgements ❤️
 ===================
 
-Special thanks to the authors of the `webdriverio/cucumber-boilerplate`_ project
+Special thanks to the authors and contributors of the `webdriverio/cucumber-boilerplate`_ project
 
-Special thanks to the authors of `behave`_
+Special thanks to the authors and contributors of `behave`_
 
 
 
 
 .. _selenium-requests: https://github.com/cryzed/Selenium-Requests
 
-.. _environment controls: http://behave.readthedocs.io/en/latest/tutorial.html#environmental-controls
+.. _environment controls: http://behave.readthedocs.io/en/stable/tutorial.html#environmental-controls
 
-.. _fixtures: http://behave.readthedocs.io/en/latest/fixtures.html
+.. _fixtures: http://behave.readthedocs.io/en/stable/fixtures.html
 
-.. _step implementations: http://behave.readthedocs.io/en/latest/tutorial.html#python-step-implementations
+.. _step implementations: http://behave.readthedocs.io/en/stable/tutorial.html#python-step-implementations
 
 .. _driver installation notes: http://selenium-python.readthedocs.io/installation.html#drivers
 
-.. _behave-webdriver documentation: http://behave-webdriver.readthedocs.io/en/latest/
+.. _behave-webdriver documentation: http://behave-webdriver.readthedocs.io/en/stable/
 
 .. _selenium: https://github.com/SeleniumHQ/selenium
 
@@ -364,8 +379,8 @@ Special thanks to the authors of `behave`_
 
 
 
-.. |docs| image:: https://readthedocs.org/projects/behave-webdriver/badge/?version=latest
-    :target: http://behave-webdriver.readthedocs.io/en/latest/
+.. |docs| image:: https://readthedocs.org/projects/behave-webdriver/badge/?version=stable
+    :target: http://behave-webdriver.readthedocs.io/en/stable/
 
 .. |status| image:: https://travis-ci.org/spyoungtech/behave-webdriver.svg?branch=master
     :target: https://travis-ci.org/spyoungtech/behave-webdriver

appveyor.yml

@@ -0,0 +1,26 @@
+version: 1.0.{build}
+
+environment:
+  BEHAVE_WEBDRIVER: IE
+
+matrix:
+  allow_failures:
+    - BEHAVE_WEBDRIVER: IE
+
+services:
+  - iis
+
+install:
+  - regedit /s .\ci\bfcache.reg
+  - cmd: .\ci\install.bat
+
+build: off
+
+test_script:
+  - cmd: .\ci\runtests.bat
+  - ps: |
+       $wc = New-Object 'System.Net.WebClient';
+       Get-ChildItem .\reports |
+       Foreach-Object {
+           $wc.UploadFile("https://ci.appveyor.com/api/testresults/junit/$($env:APPVEYOR_JOB_ID)", (Resolve-Path $_.FullName))
+       }

behave_webdriver/__init__.py

@@ -11,10 +11,6 @@
     'Remote',
     'from_env',
     'from_string',
-    'fixture_browser',
-    'before_all_factory',
-    'before_feature_factory',
-    'before_scenario_factory',
 ]
 from behave_webdriver.driver import (Chrome,
                                      Firefox,
@@ -32,3 +28,6 @@
                                        before_all_factory,
                                        before_feature_factory,
                                        before_scenario_factory)
+from behave_webdriver.fixtures import use_fixture_tag
+from behave_webdriver import transformers
+

behave_webdriver/driver.py

@@ -5,6 +5,7 @@
 
 from selenium import webdriver
 from selenium.webdriver.chrome.options import Options as ChromeOptions
+from selenium.webdriver.firefox.options import Options as FirefoxOptions
 from selenium.common.exceptions import NoSuchElementException, TimeoutException, WebDriverException
 from selenium.webdriver.support.ui import WebDriverWait
 from selenium.webdriver.common.by import By
@@ -63,11 +64,18 @@ class BehaveDriverMixin(object):
 
 
     """
+    _driver_name = ''
     def __init__(self, *args, **kwargs):
         default_wait = kwargs.pop('default_wait', 1.5)
         super(BehaveDriverMixin, self).__init__(*args, **kwargs)
         self.default_wait = default_wait
 
+
+    def wait(self, wait_time=None):
+        if wait_time is None:
+            wait_time = self.default_wait
+        return WebDriverWait(self, wait_time)
+
     @property
     def alert(self):
         """
@@ -604,6 +612,7 @@ class Chrome(BehaveDriverMixin, webdriver.Chrome):
     """
     Chrome driver class. Alternate constructors and browser-specific logic is implemented here.
     """
+    _driver_name = 'chromedriver'
     @classmethod
     def headless(cls, *args, **kwargs):
         chrome_options = kwargs.pop('chrome_options', None)
@@ -626,55 +635,92 @@ class Firefox(BehaveDriverMixin, webdriver.Firefox):
     """
     Firefox driver class. Alternate constructors and browser-specific logic is implemented here.
     """
+    _driver_name = 'geckodriver'
+    @classmethod
+    def headless(cls, *args, **kwargs):
+        firefox_options = kwargs.pop('firefox_options', None)
+        if firefox_options is None:
+            firefox_options = FirefoxOptions()
+        firefox_options.add_argument('--headless')
+        kwargs['firefox_options'] = firefox_options
+        return cls(*args, **kwargs)
 
-    pass
+    @property
+    def secondary_handles(self):
+        self.switch_to.window(self.current_window_handle)
+        try:
+            # FIXME: there must be a better way
+            self.wait(1).until(EC.new_window_is_opened(self.window_handles))
+            self.switch_to.window(self.current_window_handle)
+        except TimeoutException:
+            pass
+        return super(Firefox, self).secondary_handles
+
+    @property
+    def last_opened_handle(self):
+        self.switch_to.window(self.current_window_handle)
+        return super(Firefox, self).last_opened_handle
+
+    def click_element(self, element):
+        self.scroll_to_element(element)
+        super(Firefox, self).click_element(element)
+
+    def doubleclick_element(self, element):
+        """
+        Overrides the doubleclick method to first scroll to element, and adds JS shim for doubleclick
+        """
+        self.scroll_to_element(element)
+        elem = self.get_element(element)
+        script = ("var evObj = new MouseEvent('dblclick', {bubbles: true, cancelable: true, view: window}); "
+                  " arguments[0].dispatchEvent(evObj);")
+        self.execute_script(script, elem)
+
+    def move_to_element(self, element, offset=None):
+        self.scroll_to_bottom()
+        self.scroll_to_element(element)
+        super(Firefox, self).move_to_element(element, offset=offset)
 
 
 class Ie(BehaveDriverMixin, webdriver.Ie):
     """
     Ie driver class. Alternate constructors and browser-specific logic is implemented here.
     """
-    pass
+    _driver_name = 'IEDriverServer'
 
 
 class Edge(BehaveDriverMixin, webdriver.Edge):
     """
     Edge driver class. Alternate constructors and browser-specific logic is implemented here.
     """
-    pass
 
 
 class Opera(BehaveDriverMixin, webdriver.Opera):
     """
     Opera driver class. Alternate constructors and browser-specific logic is implemented here.
     """
-    pass
 
 
 class Safari(BehaveDriverMixin, webdriver.Safari):
     """
     Safari driver class. Alternate constructors and browser-specific logic is implemented here.
     """
-    pass
+    _driver_name = 'safaridriver'
 
 
 class BlackBerry(BehaveDriverMixin, webdriver.BlackBerry):
     """
     BlackBerry driver class. Alternate constructors and browser-specific logic is implemented here.
     """
-    pass
 
 
 class Android(BehaveDriverMixin, webdriver.Android):
     """
     Android driver class. Alternate constructors and browser-specific logic is implemented here.
     """
-    pass
 
 
 class Remote(BehaveDriverMixin, webdriver.Remote):
     """
     Remote driver class. Alternate constructors and browser-specific logic is implemented here.
     """
-    pass