Package: pytest-splinter4
Apytestplugin forsplinter.pytest-splinter4 is a fork ofpytest-splinterwith added features and fixes to support newer versions ofpytest,pytest-xdist,splinter >= 0.17.0, andselenium >= 4.0.Installationpython-mpipinstallpytest-splinter4FeaturesSensible DefaultsDriver executable_path argumentWhen using chrome, firefox, or edge, theexecutable_pathdriver argument has
a default value set to also search for chrome/gecko/edgedriver in the current working directory.Browser FixturesThe following fixtures provide instances ofsplinter.Browser()browserA new instance of splinter’s Browser. Fixture is session scoped, so browser process is started
once per test session, but the state of the browser will be clean (current page isblank, cookies clean).session_browserThe same asbrowserexcept the lifetime. This fixture is session-scoped so will only be finalized at the
end of the whole test session. Useful if you want to speedup your test suite paying with reduced test isolation.browser_instance_getterFunction 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:@pytest.fixturedefadmin_browser(request,browser_instance_getter):"""Admin browser fixture."""# browser_instance_getter function receives parent fixture -- our admin_browserreturnbrowser_instance_getter(request,admin_browser)deftest_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')Selenium FixturesThe following fixtures provide support for selenium parameters.
They are only used when Selenium based drivers are used.splinter_selenium_implicit_waitImplicit wait timeout to be passed to Selenium webdriver.
Fixture gets the value from the command-line option splinter-implicit-wait (see below)splinter_selenium_speedSpeed 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_timeoutSocket timeout for communication between the webdriver and the browser.
Fixture gets the value from the command-line option splinter-socket-timeout (see below)Splinter FixturesThe following fixtures provide support for splinter parameters.splinter_wait_timeExplicit wait timeout (for waiting for explicit condition viawait_for_condition).
Default value is from the command-line option splinter-wait-time (see below)splinter_webdriverSplinter’s webdriver name to use. Default value is from the command-line option
splinter-webdriver (see below).To make pytest-splinter always use certain webdriver, override a fixture
in yourconftest.pyfile. Example:importpytest@pytest.fixture(scope='session')defsplinter_webdriver():"""Override splinter webdriver name."""return'chrome'splinter_remote_urlWebdriver remote url to use. Default value is from the command-line option
splinter-remote-url (see below).This will only be used if the selected webdriver name is ‘remote’.splinter_remote_nameName of the browser to use when running Remote Webdriver.This will be used only if the selected webdriver name is ‘remote’.splinter_session_scoped_browserUse a single browser instance per test session.
Default value is from the command-line option splinter-session-scoped-browser (see below)splinter_file_download_dirDirectory, 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_typesComma-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_conditionBrowser load condition, a python function which should return True.
If function returns False, it will be run several times, until timeout below reached.splinter_browser_load_timeoutBrowser load condition timeout in seconds, after this timeout the exception
WaitUntilTimeout will be raised.splinter_wait_timeBrowser explicit wait timeout in seconds, after this timeout the exception
WaitUntilTimeout will be raised.splinter_driver_kwargsWebdriver keyword arguments, a dictionary which is passed to selenium
webdriver’s constructor (after applying firefox preferences)importpytestfrompathlibimportPath@pytest.fixturedefsplinter_driver_kwargs():"""
    Webdriver kwargs for Firefox.
    https://selenium-python.readthedocs.io/api.html#module-selenium.webdriver.firefox.webdriver
    """return{"service_log_path":Path("/log/directory/geckodriver.log")}splinter_window_sizeSize of the browser window on browser initialization. Tuple in form (<width>, <height>). Default is (1366, 768)splinter_logs_dirDriver logs directory. Default is ‘logs’.splinter_screenshot_dirBrowser screenshot directory. Default is ‘logs/{test_function_name}’.This fixture gets the value from the command-line optionsplinter-screenshot-dir(see below).splinter_make_screenshot_on_failureShould pytest-splinter take browser screenshots on test failure?
This fixture gets the value from the command-line optionsplinter-make-screenshot-on-failure(see below).splinter_screenshot_encodingEncoding of thehtmlscreenshoton test failure. UTF-8 by default.splinter_browser_classClass to use for browser instance.
Defaults topytest_splinter.plugin.Browser.splinter_clean_cookies_urlsList of additional urls to clean cookies on. By default, during the preparation of the browser for the test,
pytest-splinter only cleans cookies for the last visited url from previous test, as it’s not possible to clean
all cookies from all domains at once via webdriver protocol, by design. This limitation can be worked around if
you know the list of urls, the domains for which you need to clean cookies (for examplehttps://facebook.com).
If so, you can override this fixture and put those urls there, and pytest-splinter will visit each of them and will
clean the cookies for each domain.splinter_headlessRun Chrome in headless mode. Defaults to false.http://splinter.readthedocs.io/en/latest/drivers/chrome.html#using-headless-option-for-chromeFirefox Onlysplinter_firefox_profile_preferencesFirefox profile preferences, a dictionary which is passed to selenium
webdriver’s profile_preferencessplinter_firefox_profile_directoryFirefox profile directory to use as template for firefox profile created by selenium.
By default, it’s an empty directly inside pytest_splinter/profiles/firefoxCommand-line options–splinter-implicit-waitSelenium webdriver implicit wait. Seconds (default: 5).–splinter-speedselenium webdriver speed (from command to command). Seconds (default: 0).–splinter-socket-timeoutSelenium webdriver socket timeout for for communication between the webdriver and the browser.
Seconds (default: 120).–splinter-webdriverWebdriver name to use. (default: firefox). Options:firefoxremotechromeFor more details refer to the documentation for splinter and selenium.–splinter-remote-urlWebdriver remote url to use. (default: None). Will be used only if selected webdriver name is ‘remote’.For more details refer to the documentation for splinter and selenium.–splinter-remote-nameName of the browser to use when running Remote Webdriver.–splinter-session-scoped-browserpytest-splinter should use a single browser instance per test session.
Choices are ‘true’ or ‘false’ (default: ‘true’).–splinter-make-screenshot-on-failurepytest-splinter should take browser screenshots on test failure.
Choices are ‘true’ or ‘false’ (default: ‘true’).–splinter-screenshot-dirpytest-splinter browser screenshot directory. Defaults to the current
directory.–splinter-headlessOverridesplinter_headlessfixture. Choices are ‘true’ or ‘false’, default: ‘true’.http://splinter.readthedocs.io/en/latest/drivers/chrome.html#using-headless-option-for-chromehttps://splinter.readthedocs.io/en/latest/drivers/firefox.html#using-headless-option-for-firefoxBrowser fixtureAs mentioned above, thebrowserfixture is an instance of splinter’s Browser object,
but with some overrides.visitAdded possibility to wait for condition on each browser visit by having a fixture.wait_for_conditionMethod 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.Automatic screenshots on test failureWhen a test fails, it’s important to know the reason.
This becomes hard when tests are being run on the continuous integration server,
where you cannot debug (using –pdb).
To simplify things, a special behaviour of the browser fixture is available,
which takes a screenshot on test failure and puts it in a folder with the a
naming convention compatible to thejenkins plugin.
The html content of the browser page is also stored, this can be useful for debugging the html source.Creating screenshots is fully compatible withpytest-xdist pluginand will transfer the screenshots
from the worker nodes through the communication channel automatically.If a test (using the browser fixture) fails, you should get a screenshot files
in the following path:<splinter-screenshot-dir>/my.dotted.name.test.package/test_name-browser.png
<splinter-screenshot-dir>/my.dotted.name.test.package/test_name-browser.htmlThesplinter-screenshot-dirfor storing the screenshot is generated by a
fixture and can be provided through a command line argument, as described above
at the configuration options section.Taking screenshots on test failure is enabled by default. It can be controlled
through thesplinter_make_screenshot_on_failurefixture, where returnFalseskips it. You can also disable it via a command line argument:pytest tests/functional --splinter-make-screenshot-on-failure=falseIn case taking a screenshot fails, a pytest warning will be issued, which
can be viewed using the-rwargument forpytest.Exampledeftest_using_a_browser(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' buttonbutton=browser.find_by_name('btnK')# Interact with elementsbutton.click()assertbrowser.is_text_present('splinter.cobrateam.info'),"splinter.cobrateam.info wasn't found... We need to"' improve our SEO techniques'ContactIf you have questions, bug reports, suggestions, etc. please create an issue on
theGitHub project page.LicenseThis software is licensed under theMIT licenseSeeLicense file