Skip to main content

Postgresql fixtures and fixture factories for Pytest.

Project description

https://raw.githubusercontent.com/ClearcodeHQ/pytest-postgresql/master/logo.png

pytest-postgresql

Latest PyPI version Wheel Status Supported Python Versions License

Package status

Tests Coverage Status

What is this?

This is a pytest plugin, that enables you to test your code that relies on a running PostgreSQL Database. It allows you to specify fixtures for PostgreSQL process and client.

How to use

Warning

Tested on PostgreSQL versions > 9.x. See tests for more details.

Install with:

pip install pytest-postgresql

You will also need to install psycopg2, or one of its alternative packagings such as psycopg2-binary (pre-compiled wheels) or psycopg2cffi (CFFI based, useful on PyPy).

Plugin contains two fixtures:

  • postgresql - it’s a client fixture that has functional scope. After each test it ends all leftover connections, and drops test database from PostgreSQL ensuring repeatability.
  • postgresql_proc - session scoped fixture, that starts PostgreSQL instance at it’s first use and stops at the end of the tests.

Simply include one of these fixtures into your tests fixture list.

You can also create additional postgresql client and process fixtures if you’d need to:

from pytest_postgresql import factories

postgresql_my_proc = factories.postgresql_proc(
    port=None, unixsocketdir='/var/run')
postgresql_my = factories.postgresql('postgresql_my_proc')

Note

Each PostgreSQL process fixture can be configured in a different way than the others through the fixture factory arguments.

Connecting to already existing postgresql database

Some projects are using already running postgresql servers (ie on docker instances). In order to connect to them, one would be using the postgresql_nooproc fixture.

postgresql_external = factories.postgresql('postgresql_nooproc')

By default the postgresql_nooproc fixture would connect to postgresql instance using 5432 port. Standard configuration options apply to it.

These are the configuration options that are working on all levels with the postgresql_nooproc fixture:

Configuration

You can define your settings in three ways, it’s fixture factory argument, command line option and pytest.ini configuration option. You can pick which you prefer, but remember that these settings are handled in the following order:

  • Fixture factory argument
  • Command line option
  • Configuration option in your pytest.ini file
Configuration options
PostgreSQL option Fixture factory argument Command line option pytest.ini option Noop process fixrture Default
Path to executable executable –postgresql-exec postgresql_exec
/usr/lib/postgresql/9.1/bin/pg_ctl
host host –postgresql-host postgresql_host yes 127.0.0.1
port port –postgresql-port postgresql_port yes (5436) random
postgresql user user –postgresql-user postgresql_user yes postgres
Starting parameters startparams –postgresql-startparams postgresql_startparams
-w
Log filename’s prefix logsprefix –postgresql-logsprefix postgresql_logsprefix
 
Location for unixsockets unixsocket –postgresql-unixsocketdir postgresql_unixsocketdir
$TMPDIR
Database name db_name –postgresql-dbname postgresql_dbname
test
PostgreSQL connection options options –postgresql-options postgresql_options yes  

Example usage:

  • pass it as an argument in your own fixture

    postgresql_proc = factories.postgresql_proc(
        port=8888)
    
  • use --postgresql-port command line option when you run your tests

    py.test tests --postgresql-port=8888
    
  • specify your port as postgresql_port in your pytest.ini file.

    To do so, put a line like the following under the [pytest] section of your pytest.ini:

    [pytest]
    postgresql_port = 8888
    

Maintaining database state outside of the fixtures

It is possible and appears it’s used in other libraries for tests, to maintain database state with the use of the pytest-postgresql database managing functionality:

For this import DatabaseJanitor and use it’s init and drop methods:

from pytest_postgresql.factories import DatabaseJanitor

# variable definition

janitor = DatabaseJanitor(user, host, port, db_name, version)
janitor.init()
# your code, or yield
janitor.drop()
# at this moment you'll have clean database step

or use it as a context manager:

from pytest_postgresql.factories import DatabaseJanitor

# variable definition

with DatabaseJanitor(user, host, port, db_name, version):
    # do something here

CHANGELOG

2.2.0

  • [feature] ability to properly connect to already existing postgresql server using postgresql_noproc fixture.

2.1.0

  • [enhancement] Gather helper functions maintaining postgresql database in DatabaseJanitor class.
  • [deprecate] Deprecate init_postgresql_database in favour of DatabaseJanitor.init
  • [deprecate] Deprecate drop_postgresql_database in favour of DatabaseJanitor.drop

2.0.0

  • [feature] Drop support for python 2.7. From now on, only support python 3.5 and up
  • [feature] Ability to configure database name through plugin options
  • [enhancement] Use tmpdir_factory. Drop logsdir parameter
  • [ehnancement] Support only Postgresql 9.0 and up
  • [bugfix] Always start postgresql with LC_ALL, LC_TYPE and LANG set to C.UTF-8. It makes postgresql start in english.

1.4.1

  • [bugfix] Allow creating test databse with hyphens

1.4.0

  • [enhancements] Ability to configure additional options for postgresql process and connection
  • [bugfix] - removed hard dependency on psycopg2, allowing any of its alternative packages, like psycopg2-binary, to be used.
  • [maintenance] Drop support for python 3.4 and use 3.7 instead

1.3.4

  • [bugfix] properly detect if executor running and clean after executor is being stopped

    Note

    Previously if a test failed, there was a possibility of the executor being removed when python was closing, causing it to print ignored errors on already unloaded modules.

1.3.3

  • [enhancement] use executor’s context manager to start/stop postrgesql server in a fixture

1.3.2

  • [bugfix] version regexp to correctly catch postgresql 10

1.3.1

  • [enhancement] explicitly turn off logging_collector

1.3.0

  • [feature] pypy compatibility

1.2.0

  • [bugfix] - disallow connection to database before it gets dropped.

    Note

    Otherwise it caused random test subprocess to connect again and this the drop was unsucessfull which resulted in many more test failes on setup.

  • [cleanup] - removed path.py dependency

1.1.1

  • [bugfix] - Fixing the default pg_ctl path creation

1.1.0

  • [feature] - migrate usage of getfuncargvalue to getfixturevalue. require at least pytest 3.0.0

1.0.0

  • create command line and pytest.ini configuration options for postgresql starting parameters
  • create command line and pytest.ini configuration options for postgresql username
  • make the port random by default
  • create command line and pytest.ini configuration options for executable
  • create command line and pytest.ini configuration options for host
  • create command line and pytest.ini configuration options for port
  • Extracted code from pytest-dbfixtures

Project details


Download files

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

Files for pytest-postgresql, version 2.2.0
Filename, size File type Python version Upload date Hashes
Filename, size pytest_postgresql-2.2.0-py3-none-any.whl (31.2 kB) File type Wheel Python version py3 Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page