Skip to main content

Pyramid server fixture for py.test

Project description

# 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:

```bash
pip install pytest-pyramid
# or..
easy_install pytest-pyramid
```

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

```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:

```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:

```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:

```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.2.2 (2016-10-2r70)
* 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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pytest-pyramid-server-1.2.2.tar.gz (7.5 kB view details)

Uploaded Source

Built Distributions

pytest_pyramid_server-1.2.2-py2.7.egg (6.5 kB view details)

Uploaded Source

pytest_pyramid_server-1.2.2-py2-none-any.whl (10.1 kB view details)

Uploaded Python 2

File details

Details for the file pytest-pyramid-server-1.2.2.tar.gz.

File metadata

File hashes

Hashes for pytest-pyramid-server-1.2.2.tar.gz
Algorithm Hash digest
SHA256 0520c9884d03502bf1fe353fa0c52db26d63708ca1acf34fafb63a0e3aee2bef
MD5 415ac6425e60c15c49146949d722d991
BLAKE2b-256 c9ad3e241b34cf423ee62b766eeb3fb159d72e1e32a283fc8eb10130540b138d

See more details on using hashes here.

File details

Details for the file pytest_pyramid_server-1.2.2-py2.7.egg.

File metadata

File hashes

Hashes for pytest_pyramid_server-1.2.2-py2.7.egg
Algorithm Hash digest
SHA256 9a93996775060b022ad17df1902bdee269c17e8b4a5e095d88bdfa72ff444076
MD5 182dbdbad30290cab90b7818de758014
BLAKE2b-256 324f81d9ce9ea7fe71e73d24873589bbad23e821a398cc99e09d54611378362d

See more details on using hashes here.

File details

Details for the file pytest_pyramid_server-1.2.2-py2-none-any.whl.

File metadata

File hashes

Hashes for pytest_pyramid_server-1.2.2-py2-none-any.whl
Algorithm Hash digest
SHA256 8477f57b4b4a1b6615b4f95989353dd1e850f68b7671b9fad0f20c380b4d999a
MD5 ca94c77981d38f0231ffea90adeed96d
BLAKE2b-256 6c20054e75fe7a81ea67a706c3d2757416d6b8866e57382638059d9387af2e0e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page