Metadata-Version: 2.1
Name: pytest-pyramid-server
Version: 1.6.0
Summary: Pyramid server fixture for py.test
Home-page: https://github.com/manahl/pytest-plugins
Author: Edward Easton
Author-email: eeaston@gmail.com
License: MIT license
Platform: unix
Platform: linux
Classifier: License :: OSI Approved :: MIT License
Classifier: Development Status :: 5 - Production/Stable
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Testing
Classifier: Topic :: Utilities
Classifier: Intended Audience :: Developers
Classifier: Operating System :: POSIX
Classifier: Framework :: Pyramid
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Requires-Dist: pytest-server-fixtures
Requires-Dist: pytest (<4.0.0)
Requires-Dist: pyramid
Requires-Dist: waitress
Requires-Dist: six
Provides-Extra: tests
Requires-Dist: pyramid-debugtoolbar ; extra == 'tests'

Py.test Pyramid Server Fixture
==============================

Pyramid server fixture for py.test. The server is session-scoped by
default and run in a subprocess and temp dir, and as such is a 'real'
server that you can point a Selenium webdriver at.

Installation
------------

Install using your favourite package manager:

.. code:: bash

        pip install pytest-pyramid-server
        #  or..
        easy_install pytest-pyramid-server

Enable the fixture explicitly in your tests or conftest.py (not required
when using setuptools entry points):

.. code:: python

        pytest_plugins = ['pytest_pyramid_server']

Configuration
-------------

This fixture searches for its configuration in the current working
directory called 'testing.ini'. All .ini files in the cwd will be copied
to the tempdir so that paster-style config chaining still works. For
example:

::

    my-pyramid-app/
                  src/             # Project code is in here
                  setup.py         # Project setup.py
                  development.ini  # Development settings
                  production.ini   # Production settings
                  testing.ini      # Testing settings, will be used if tests 
                                   # are invoked using 'py.test' from this 
                                   # directory

Example
-------

Here's a noddy test case showing the main functionality:

.. code:: python

        def test_pyramid_server(pyramid_server):
            # This is the http://{host}:{port} of the running server. It will attempt to resolve
            # to externally accessable IPs so a web browser can access it.
            assert pyramid_server.uri.startswith('http')

            # GET a document from the server.
            assert pyramid_server.get('/orders/macbooks', as_json=True)  == {'id-1234': 'MPB-15inch'}

            # POST a document to the server.
            assert pyramid_server.post('/login', 'guest:password123').response_code == 200

            # ``path.py`` path object to the running config file
            assert pyramid_server.working_config.endswith('testing.ini')

``PyramidServer`` class
-----------------------

Using this with the default ``pyramid_server`` py.test fixture is good
enough for a lot of use-cases however you may wish to have more
fine-grained control about the server configuration. To do this you can
use the underlying server class directly - this is an implenentation of
the ``pytest-server-fixture`` framework and as such acts as a context
manager:

.. code:: python

        from pytest_pyramid import PyramidTestServer

        def test_custom_server():
            with PyramidTestServer(
                   # You can specify you own config directory and name
                   config_dir='/my/config',
                   config_fileme='my_testing.ini',

                  # You can set arbitrary config variables in the constructor
                  extra_config_vars={'my_config_section': {'my_dbname: 'foo',
                                                           'my_dbpass: 'bar'}}
               ) as server:
                   assert not server.dead
                   assert 'my_dbname = foo' in server.working_config.text()

            # Server should now be dead
            assert server.dead   

``pytest-webdriver`` and `PageObjects <https://page-objects.readthedocs.org/en/latest/>`__ integration
------------------------------------------------------------------------------------------------------

The ``pytest-webdriver`` plugin will detect when this plugin is active
and set its default base URL to the url of the running server. This is a
nice way of avoiding lots of string manipulation in your browser tests
when using Page Objects:

.. code:: python

        from page_objects import PageObject, PageElement

        class LoginPage(PageObject):
            username = PageElement(id_='username')
            password = PageElement(name='password')
            login = PageElement(css='input[type="submit"]')

        def test_login_page(webdriver, pyramid_server):
            page = LoginPage(webdriver)
            page.login.click()
            page.get('/foo/bar')
            assert webdriver.getCurrentUrl() == pyramid_server.uri + '/foo/bar'


Changelog
---------

1.6.0 (Unreleased)
~~~~~~~~~~~~~~~~~~

-  pytest-server-fixtures: added previously removed TestServerV2.kill()
   function
-  pytest-profiling: pin more-itertools==5.0.0 in integration tests, as
   that's a PY3 only release

1.5.1 (2019-01-24)
~~~~~~~~~~~~~~~~~~

-  pytest-verbose-parametrize: fixed unicode parameters when using
   ``@pytest.mark.parametrize``

1.5.0 (2019-01-23)
~~~~~~~~~~~~~~~~~~

-  pytest-server-fixtures: made postgres fixtures and its tests
   optional, like all other fixtures
-  pytest-server-fixtures: reverted a fix for pymongo deprecation
   warning, as this will break compatibility with pymongo 3.6.0
-  pytest-server-fixtures: dropped RHEL5 support in httpd

1.4.1 (2019-01-18)
~~~~~~~~~~~~~~~~~~

-  pytest-server-fixtures: server fixture binary path specified in ENV
   now only affect server class 'thread'

1.4.0 (2019-01-15)
~~~~~~~~~~~~~~~~~~

-  Fixing python 3 compatibility in Simple HTTP Server fixture
-  Fixed broken tests in pytest-profiling
-  Pinned pytest<4.0.0 until all deprecation warnings are fixed.
-  pytest-webdriver: replaced deprecated phantomjs with headless Google
   Chrome.
-  Add Vagrantfile to project to make test environment portable.
-  Add .editorconfig file to project.
-  pytest-server-fixtures: add TestServerV2 with Docker and Kubernetes
   support.
-  pytest-server-fixtures: fix for an issue where MinioServer is not
   cleaned up after use.
-  pytest-server-fixtures: fix deprecation warnings when calling
   pymongo.
-  pytest-server-fixtures: close pymongo client on MongoTestServer
   teardown.
-  pytest-server-fixtures: upgrade Mongo, Redis and RethinkDB to
   TestServerV2.
-  coveralls: fix broken coveralls

1.3.1 (2018-06-28)
~~~~~~~~~~~~~~~~~~

-  Use pymongo list\_database\_names() instead of the deprecated
   database\_names(), added pymongo>=3.6.0 dependency

1.3.0 (2017-11-17)
~~~~~~~~~~~~~~~~~~

-  Fixed workspace deletion when teardown is None
-  Fixed squash of root logger in pytest-listener
-  Added S3 Minio fixture (many thanks to Gavin Bisesi)
-  Added Postgres fixture (many thanks to Gavin Bisesi)
-  Use requests for server fixtures http gets as it handles redirects
   and proxies properly

1.2.12 (2017-8-1)
~~~~~~~~~~~~~~~~~

-  Fixed regression on cacheing ephemeral hostname, some clients were
   relying on this. This is now optional.

1.2.11 (2017-7-21)
~~~~~~~~~~~~~~~~~~

-  Fix for OSX binding to illegal local IP range (Thanks to Gavin
   Bisesi)
-  Setup and Py3k fixes for pytest-profiling (Thanks to xoviat)
-  We no longer try and bind port 5000 when reserving a local IP host,
   as someone could have bound it to 0.0.0.0
-  Fix for #46 sourcing gprof2dot when the local venv has not been
   activated

1.2.10 (2017-2-23)
~~~~~~~~~~~~~~~~~~

-  Handle custom Pytest test items in pytest-webdriver

1.2.9 (2017-2-23)
~~~~~~~~~~~~~~~~~

-  Add username into mongo server fixture tempdir path to stop
   collisions on shared multiuser filesystems

1.2.8 (2017-2-21)
~~~~~~~~~~~~~~~~~

-  Return function results in shutil.run.run\_as\_main

1.2.7 (2017-2-20)
~~~~~~~~~~~~~~~~~

-  More handling for older versions of path.py
-  Allow virtualenv argument passing in pytest-virtualenv

1.2.6 (2017-2-16 )
~~~~~~~~~~~~~~~~~~

-  Updated devpi server server setup for devpi-server >= 2.0
-  Improvements for random port picking
-  HTTPD server now binds to 0.0.0.0 by default to aid Selenium-style
   testing
-  Updated mongodb server args for mongodb >= 3.2
-  Corrections for mongodb fixture config and improve startup logic
-  Added module-scoped mongodb fixture
-  Handling for older versions of path.py
-  Fix for #40 where tests that chdir break pytest-profiling

1.2.5 (2016-12-09)
~~~~~~~~~~~~~~~~~~

-  Improvements for server runner host and port generation, now supports
   random local IPs
-  Bugfix for RethinkDB fixture config

1.2.4 (2016-11-14)
~~~~~~~~~~~~~~~~~~

-  Bugfix for pymongo extra dependency
-  Windows compatibility fix for pytest-virtualenv (Thanks to
   Jean-Christophe Fillion-Robin for PR)
-  Fix symlink handling for
   pytest-shutil.cmdline.get\_real\_python\_executable

1.2.3 (2016-11-7)
~~~~~~~~~~~~~~~~~

-  Improve resiliency of Mongo fixture startup checks

1.2.2 (2016-10-27)
~~~~~~~~~~~~~~~~~~

-  Python 3 compatibility across most of the modules
-  Fixed deprecated Path.py imports (Thanks to Bryan Moscon)
-  Fixed deprecated multicall in pytest-profiling (Thanks to Paul van
   der Linden for PR)
-  Added devpi-server fixture to create an index per test function
-  Added missing licence file
-  Split up httpd server fixture config so child classes can override
   loaded modules easier
-  Added 'preserve\_sys\_path' argument to TestServer base class which
   exports the current python sys.path to subprocesses.
-  Updated httpd, redis and jenkins runtime args and paths to current
   Ubuntu spec
-  Ignore errors when tearing down workspaces to avoid race conditions
   in 'shutil.rmtree' implementation

1.2.1 (2016-3-1)
~~~~~~~~~~~~~~~~

-  Fixed pytest-verbose-parametrize for latest version of py.test

1.2.0 (2016-2-19)
~~~~~~~~~~~~~~~~~

-  New plugin: git repository fixture

1.1.1 (2016-2-16)
~~~~~~~~~~~~~~~~~

-  pytest-profiling improvement: escape illegal characters in .prof
   files (Thanks to Aarni Koskela for the PR)

1.1.0 (2016-2-15)
~~~~~~~~~~~~~~~~~

-  New plugin: devpi server fixture
-  pytest-profiling improvement: overly-long .prof files are saved as
   the short hash of the test name (Thanks to Vladimir Lagunov for PR)
-  Changed default behavior of workspace.run() to not use a subshell for
   security reasons
-  Corrected virtualenv.run() method to handle arguments the same as the
   parent method workspace.run()
-  Removed deprecated '--distribute' from virtualenv args

1.0.1 (2015-12-23)
~~~~~~~~~~~~~~~~~~

-  Packaging bugfix

1.0.0 (2015-12-21)
~~~~~~~~~~~~~~~~~~

-  Initial public release



