Metadata-Version: 1.1
Name: pytest-splinter
Version: 1.2.1
Summary: Splinter plugin for pytest testing framework
Home-page: https://github.com/pytest-dev/pytest-splinter
Author: Paylogic developers
Author-email: developers@paylogic.com
License: MIT license
Description: Splinter plugin for the py.test runner
        ======================================
        
        .. image:: https://api.travis-ci.org/pytest-dev/pytest-splinter.png
            :target: https://travis-ci.org/pytest-dev/pytest-splinter
        .. image:: https://pypip.in/v/pytest-splinter/badge.png
            :target: https://crate.io/packages/pytest-splinter/
        .. image:: https://coveralls.io/repos/pytest-dev/pytest-splinter/badge.png?branch=master
            :target: https://coveralls.io/r/pytest-dev/pytest-splinter
        .. image:: https://readthedocs.org/projects/pytest-splinter/badge/?version=latest
            :target: https://readthedocs.org/projects/pytest-splinter/?badge=latest
            :alt: Documentation Status
        
        
        Install pytest-splinter
        -----------------------
        
        ::
        
            pip install pytest-splinter
        
        
        Features
        --------
        
        The plugin provides a set of fixtures to use `splinter <http://splinter.cobrateam.info>`_
        for browser testing with `pytest <http://pytest.org>`_
        
        
        Fixtures
        --------
        
        * browser
            Get the splinter's Browser. Fixture is underneath session scoped, so browser process is started
            once per test session.
        
        * browser_instance_getter
            Function to create an instance of the browser. This fixture is required only if you need to have
            multiple instances of the Browser in a single test at the same time. Example of usage:
        
        .. code-block:: python
        
            @pytest.fixture
            def admin_browser(browser_instance_getter):
                """Admin browser fixture."""
                # browser_instance_getter function receives single argument - parent fixture
                # in our case it's admin_browser
                return browser_instance_getter(admin_browser)
        
            def test_2_browsers(browser, admin_browser):
                """Test using 2 browsers at the same time."""
                browser.visit('http://google.com')
                admin_browser.visit('http://admin.example.com')
        
        * splinter_selenium_implicit_wait
            Implicit wait timeout to be passed to Selenium webdriver.
            Fixture gets the value from the command-line option splinter-implicit-wait (see below)
        
        * splinter_selenium_speed
            Speed for Selenium, if not 0 then it will sleep between each selenium command.
            Useful for debugging/demonstration.
            Fixture gets the value from the command-line option splinter-speed (see below)
        
        * splinter_selenium_socket_timeout
            Socket timeout for communication between the webdriver and the browser.
            Fixture gets the value from the command-line option splinter-socket-timeout (see below)
        
        * splinter_webdriver
            Splinter's webdriver name to use. Fixture gets the value from the command-line option
            splinter-webdriver (see below)
        
        * splinter_remote_url
            Splinter's webdriver remote url to use (optional). Fixture gets the value from the command-line option
            splinter-remote-url (see below). Will be used only if selected webdriver name is 'remote'.
        
        * splinter_session_scoped_browser
            pytest-splinter should use single browser instance per test session.
            Fixture gets the value from the command-line option splinter-session-scoped-browser (see below)
        
        * splinter_file_download_dir
            Directory, to which browser will automatically download the files it
            will experience during browsing. For example when you click on some download link.
            By default it's a temporary directory. Automatic downloading of files is only supported for firefox driver
            at the moment.
        
        * splinter_download_file_types
            Comma-separated list of content types to automatically download.
            By default it's the all known system mime types (via mimetypes standard library).
        
        * splinter_browser_load_condition
            Browser load condition, python function which should return True.
            If function returns False, it will be run several times, until timeout below reached.
        
        * splinter_browser_load_timeout
            Browser load condition timeout in seconds, after this timeout the exception
            WaitUntilTimeout will be raised.
        
        * splinter_firefox_profile_preferences
            Firefox profile preferences, a dictionary which is passed to selenium
            webdriver's profile_preferences
        
        * splinter_driver_kwargs
            Webdriver keyword arguments, a dictionary which is passed to selenium
            webdriver's constructor (after applying firefox preferences)
        
        * splinter_window_size
            Size of the browser window on browser initialization. Tuple in form (<width>, <height>). Default is (1366, 768)
        
        * splinter_screenshot_dir
            pytest-splinter browser screenshot directory.
            Fixture gets the value from the command-line option `splinter-screenshot-dir` (see below)
        
        * splinter_make_screenshot_on_failure
            Should pytest-splinter make browser screenshot on test failure.
            Fixture gets the value from the command-line option `splinter-make-screenshot-on-failure` (see below)
        
        
        Command-line options
        --------------------
        
        * `--splinter-implicit-wait`
            Selenium webdriver implicit wait. Seconds (default: 1).
        
        * `--splinter-speed`
            selenium webdriver speed (from command to command). Seconds (default: 0).
        
        * `--splinter-socket-timeout`
            Selenium webdriver socket timeout for for communication between the webdriver and the browser.
            Seconds (default: 120).
        
        * `--splinter-webdriver`
            Webdriver name to use. (default: firefox). Options:
        
            *  firefox
            *  remote
            *  chrome
            *  phantomjs
        
            For more details, refer to splinter and selenium documentation.
        
        * `--splinter-remote-url`
            Webdriver remote url to use. (default: None). Will be used only if selected webdriver name is 'remote'.
        
            For more details, refer to splinter and selenium documentation.
        
        * `--splinter-session-scoped-browser`
            pytest-splinter should use single browser instance per test session. Choise of 'true' or 'false'. (default: 'true').
        
        * `--splinter-make-screenshot-on-failure`
            pytest-splinter should make browser screenshot on test failure. Choise of 'true' or 'false'. (default: 'true').
        
        * `--splinter-screenshot-dir`
            pytest-splinter browser screenshot directory. By default it's current directory.
        
        
        Browser fixture
        ---------------
        
        As mentioned above, browser is a fixture made by creating splinter's Browser object, but with some overrides.
        
        *  visit
            Added possibility to wait for condition on each browser visit by having a fixture.
        
        *  wait_for_condition
            Method copying selenium's wait_for_condition, with difference that condition is in python,
            so there you can do whatever you want, and not only execute javascript via browser.evaluate_script.
        
        *  `status_code <http://splinter.cobrateam.info/docs/http-status-code-and-exception.html>`_
            This functionality is removed, so not available. Splinter implements this using additional request from python side,
            which is in general performance-wise not a good idea. Also normally when you interact with the browser as a user,
            you don't need the status code of the page.
        
        
        Several browsers for your test
        ------------------------------
        
        You can have several browsers in one test.
        
        .. code-block:: python
        
            import pytest
        
            @pytest.fixture
            def admin_browser(browser_instance_getter):
                return browser_instance_getter(admin_browser)
        
            def test_with_several_browsers(browser, admin_browser):
                browser.visit('http://example.com')
                admin_browser.visit('about:blank')
                assert browser.url == 'http://example.com'
        
        
        Automatic screenshots on test failure
        -------------------------------------
        
        When your functional test fails, it's important to know the reason.
        This becomes hard when tests are being run on the continuos integration server, where you cannot debug (use --pdb).
        To simplify things, special behaviour of the browser fixture was introduced, so when test failed, it makes a screenshot
        and puts it in the folder with the naming convention, to be compartible with this
        `jenkins plugin <https://wiki.jenkins-ci.org/display/JENKINS/JUnit+Attachments+Plugin>`_.
        
        Making screenshots is fully compartible with `pytest-xdist plugin <https://pypi.python.org/pypi/pytest-xdist>`_ and will
        transfer screenshots from the slave nodes through the communication channels automatically.
        
        So if your test which uses browser fixture will fail, you should get a screenshot file in such path:
        
        ::
        
            <pytest-screenshot-dir>/my.dotted.name.test.package/test_name-browser.png
        
        The `pytest-screenshot-dir` for storing the screenshot is deferred by a fixture and command line argument,
        as  described above at the configuration options section.
        Note that the making screenshots on the test failure is enabled by default. If you want to switch it off permanently,
        override `splinter_make_screenshot_on_failure` fixture to return `False`. For temporary disabling you can use
        command line argument:
        
        ::
        
            py.test tests/functional --splinter-make-screenshot-on-failure=false
        
        
        Python3 support
        ---------------
        
        Python3 is supported, check if you have recent version of splinter as it was added recently.
        
        
        Example
        -------
        
        test_your_test.py:
        
        .. code-block:: python
        
            def test_some_browser_stuff(browser):
                """Test using real browser."""
                url = "http://www.google.com"
                browser.visit(url)
                browser.fill('q', 'splinter - python acceptance testing for web applications')
                # Find and click the 'search' button
                button = browser.find_by_name('btnK')
                # Interact with elements
                button.click()
                assert browser.is_text_present('splinter.cobrateam.info'), 'splinter.cobrateam.info wasn't found... We need to'
                ' improve our SEO techniques'
        
        
        Contact
        -------
        
        If you have questions, bug reports, suggestions, etc. please create an issue on
        the `GitHub project page <http://github.com/paylogic/pytest-splinter>`_.
        
        
        License
        -------
        
        This software is licensed under the `MIT license <http://en.wikipedia.org/wiki/MIT_License>`_
        
        See `License <https://github.com/paylogic/pytest-splinter/blob/master/LICENSE.txt>`_
        
        
        © 2014 Paylogic International.
        
        Changelog
        =========
        
        1.2.1
        -----
        
        - improve exception handing when preparing the browser instance (bubenkoff)
        - require pytest (bubenkoff)
        
        
        1.2.0
        -----
        
        - automatic screenshot capture on test failure (bubenkoff)
        - improvements to the browser preparation procedure (bubenkoff)
        - boolean config options made more clear (bubenkoff)
        
        
        1.1.1
        -----
        
        - restore browser parameters on each test run instead of once for browser start (bubenkoff)
        
        
        1.1.0
        -----
        
        - added possibility to have multiple browser instances for single test (amakhnach, bubenkoff)
        
        
        1.0.4
        -----
        
        - Fixed browser fixture to support splinter_browser_load_condition and splinter_browser_load_timeout by default. (markon)
        
        
        1.0.3
        -----
        
        - unicode fixes to setup.py (bubenkoff,valberg)
        
        
        1.0.2
        -----
        
        - wait_for_condition now receives pytest_bdd.plugin.Browser object, not selenium webdriver one (bubenkoff)
        
        
        1.0.1
        -----
        
        - Refactoring and cleanup (bubenkoff)
        
        
        1.0.0
        -----
        
        - Initial public release
        
Platform: UNKNOWN
Classifier: Development Status :: 6 - Mature
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Topic :: Software Development :: Testing
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Utilities
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.0
Classifier: Programming Language :: Python :: 3.1
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
