Skip to main content
https://raw.githubusercontent.com/ClearcodeHQ/pytest-mysql/master/logo.png

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

mysqld_exec

–mysql-mysqld

mysql_mysqld

mysqld

Path to safe executable

mysqld_safe

–mysql-mysqld-safe

mysql_mysqld_safe

/usr/bin/mysqld_safe

Path to mysql_install_db for legacy installations

install_db

–mysql-install-db

mysql_install_db

/usr/bin/mysql_install_db

Path to Admin executable

admin_executable

–mysql-admin

mysql_admin

/usr/bin/mysqladmin

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

Running on Docker/as root

Unfortunately, running MySQL as root (thus by default on docker) is not possible. MySQL (and MariaDB as well) will not allow it.

USER nobody

This line should switch your docker process to run on user nobody. See this comment for example

Package resources

CHANGELOG

2.0.2

  • [enhancement] Preemptively read data after each test in mysql client fixture. This will make test run if the test itself forgot to fetch queried data.

  • [enhnacement] Require at least mirakuru 2.3.0 - forced by changed stop method parameters change

2.0.1

  • [fix] Improved mysql version detection on osx

  • [build] extracted xdist into separate stage on travis

  • [build] have deployemt as separate stage on travis

2.0.0

  • [Enhancements] Add support for MySQL 5.7.6 and up with new configuration options. Legacy configuration supports older MySQL and MariaDB databases.

  • [breaking] mysql_exec ini option replaced with mysql_mysqld_safe

  • [breaking] –mysql-exec cmd option replaced with –mysql-mysqld-safe

  • [breaking] replaced mysql_init ini option with mysql_install_db

  • [breaking] replaced –mysql-init cmd option with –mysql-install-db

  • [breaking] added mysql_mysqld option and –mysql-mysqld cmd option

1.1.1

  • [enhancements] removed path.py dependency

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

Metadata

Release files for pytest-mysql 2.0.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pytest-mysql 2.0.2
File Size Uploaded
pytest-mysql-2.0.2.tar.gz 14.3 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for pytest-mysql 2.0.2
File Interpreter ABI Platform
pytest_mysql-2.0.2-py3-none-any.whl Python 3 none any Details

Total release size: 43.0 kB

Release files / pytest-mysql-2.0.2.tar.gz

Download URL pytest-mysql-2.0.2.tar.gz
Size 14.3 kB
Tags Source
SHA-256 checksum
How to use checksums
047802b7226c9fe098fb8a1166a8365345eeb181b3da7ffe133684ca0802b997
BLAKE2b-256 checksum
How to use checksums
496b7ad410d9821fb91e2e62f03f3db7944005475ad64cf3270d8aae39f20f3d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.8.0

Release files / pytest_mysql-2.0.2-py3-none-any.whl

Download URL pytest_mysql-2.0.2-py3-none-any.whl
Size 28.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
713911310b752b7e9d5c9b133868a12b0b1ea122981b4761b738fc6759ad8aff
BLAKE2b-256 checksum
How to use checksums
861fd52dd219b7a5110327ac396826f3aedb9b05b36f5d85bd40aaa331b47b30
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.8.0

Release history Release notifications | RSS feed

5.0.1

2 release files

5.0.0

2 release files

4.0.0

2 release files

3.1.0

2 release files

3.0.0

2 release files

2.5.0

2 release files

2.4.2

2 release files

2.4.1

2 release files

2.4.0

2 release files

2.3.1

2 release files

2.3.0

2 release files

2.2.0

2 release files

2.1.0

2 release files

2.0.3

2 release files

This release

2.0.2 This release

2 release files

2.0.1

2 release files

2.0.0

2 release files

1.1.1

2 release files

1.1.0

2 release files

1.0.0

2 release files

0.0.0

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page