pytest-mysql 2.0.1

MySQL process and client fixtures for pytest

pytest-mysql

Package 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.

Warning

Only MySQL 5.7.6 and up are supported. For older versions, please use pytest-mysql 2.0.1 Although Pull Request to add back support for older MySQL versions are welcome.

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')

Note

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

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

• Bug tracker: https://github.com/ClearcodeHQ/pytest-mysql/issues

CHANGELOG

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