MySQL process and client fixtures for pytest
Project description
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.
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=8888specify 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 nobodyThis 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.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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file pytest-mysql-2.0.0.tar.gz.
File metadata
- Download URL: pytest-mysql-2.0.0.tar.gz
- Upload date:
- Size: 13.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 6f8e9b103b017ff955d90ca182d6d68d1a69b53528c1c17cf418255168953077 |
|
| MD5 | 81edfef2cb2bf9f7acea5d95571c9c43 |
|
| BLAKE2b-256 | c7c5e622ecc6c5f25516018124964bcf9c9a9cc55e6582990cbaa22fce479370 |
File details
Details for the file pytest_mysql-2.0.0-py2.py3-none-any.whl.
File metadata
- Download URL: pytest_mysql-2.0.0-py2.py3-none-any.whl
- Upload date:
- Size: 12.8 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 2782cf68479843b1d3975366516403897455d005aaf87a50083badd5b8498cf7 |
|
| MD5 | c75195aa40c5b77f4bd2064add653a07 |
|
| BLAKE2b-256 | 81585928a1ad95bb4e844d4155f1451a63592825f29df2f08bf8834ed7e925d1 |
