Skip to main content

MySQL process and client fixtures for pytest

Project description

pytest-mysql

Latest PyPI version Wheel Status Supported Python Versions License

Package status

Tests Coverage Status Requirements Status

What is this?

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

How to use

Plugin contains two fixtures

  • mysql - it’s a client fixture that has functional scope. After each test drops test database from MySQL ensuring repeatability.

  • mysql_proc - session scoped fixture, that starts MySQL 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 mysql client and process fixtures if you’d need to:

from pytest_mysql import factories

mysql_my_proc = factories.mysql_proc(
    port=None, logsdir='/tmp')
mysql_my = factories.mysql('mysql_my_proc')

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

MySQL option

Fixture factory argument

Command line option

pytest.ini option

Default

Path to executable

executable

–mysql-exec

mysql_exec

/usr/bin/mysqld_safe

Path to Admin executable

admin_executable

–mysql-admin

mysql_admin

/usr/bin/mysqladmin

Path to Init executable

init_executable

–mysql-init

mysql_init

/usr/bin/mysql_install_db

host

host

–mysql-host

mysql_host

localhost

port

port

–mysql-port

mysql_port

random

MySQL user to work with

user

–mysql-user

mysql_user

root

User’s password

passwd

–mysql-passwd

mysql_passwd

Test database name

dbname

–mysql-dbname

mysqldbname

test

Starting parameters

params

–mysql-params

mysql_params

Log directory location

logsdir

–mysql-logsdir

mysql_logsdir

$TMPDIR

Example usage:

  • pass it as an argument in your own fixture

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

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

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

    [pytest]
    mysql_port = 8888

Package resources

CHANGELOG

1.1.0

  • [enhancement] change deprecated getfuncargvalaue to getfixturevalues, require at least pytest 3.0.0

1.0.0

  • [enhancements] create command line and pytest.ini configuration options for mysql’s log directory location

  • [enhancements] create command line and pytest.ini configuration options for mysql’s starting parametetrs

  • [enhancements] create command line and pytest.ini configuration options for mysql test database name

  • [enhancements] create command line and pytest.ini configuration options for mysql’s user password

  • [enhancements] create command line and pytest.ini configuration options for mysql user

  • [enhancements] create command line and pytest.ini configuration options for mysql host

  • [enhancements] create command line and pytest.ini configuration options for mysql port

  • [enhancements] create command line and pytest.ini configuration options for mysql’s init executable

  • [enhancements] create command line and pytest.ini configuration options for mysql’s admin executable

  • [enhancements] create command line and pytest.ini configuration options for mysql executable

  • [enhancements] create command line and pytest.ini configuration options for mysql logsdir

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-mysql-1.1.0.tar.gz (10.1 kB view details)

Uploaded Source

Built Distribution

pytest_mysql-1.1.0-py2.py3-none-any.whl (13.6 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file pytest-mysql-1.1.0.tar.gz.

File metadata

File hashes

Hashes for pytest-mysql-1.1.0.tar.gz
Algorithm Hash digest
SHA256 a560b305049e096d4de390fa1ae76e165283f6ae27710b033339780764887f90
MD5 31f797edac64d1db3bc34248a36d5be9
BLAKE2b-256 758d7bf23ed129e8351f2c238afd7a25205665c43270103ef1e671d89c91e46a

See more details on using hashes here.

File details

Details for the file pytest_mysql-1.1.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for pytest_mysql-1.1.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 fbd1115f14579cdaa5a857f328068a004a790ea4099989238b2c8ff34c5ae752
MD5 799f75cfbdd56835b985884f25a412bb
BLAKE2b-256 d0899d5274f9b61b10eea05cba848e1c3edd91e806a5fa7441e4eaa3a7ee8930

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