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.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.0.0.tar.gz (10.0 kB view details)

Uploaded Source

Built Distribution

pytest_mysql-1.0.0-py2.py3-none-any.whl (13.5 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for pytest-mysql-1.0.0.tar.gz
Algorithm Hash digest
SHA256 504b4ee023cee5921291db531246a6db231a8401e649bd1cf6755e5a34cda3a8
MD5 0ce45d8dc242c677b7d4388619e699ac
BLAKE2b-256 87ff47ec9b31e2644182e0973606f0f209cde9d54aae4f9c6d664ceac681a626

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for pytest_mysql-1.0.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 00d781a3acfdf971ed3e3c1e3b4e36c3b3ac66f2cea08fc1b9fc181c543b6c1e
MD5 6974b06b6400c17021d47c40eb48f899
BLAKE2b-256 7eef7ecfc2a65e2f9798d3bf3938483c9a8fea3901bedaf3d22e7d44bef5ed8e

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