MySQL process and client fixtures for pytest
Project description
pytest-mysql
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.
mysql_noproc - session scoped fixtures, that allows to connect to already existing MySQL instance, and cleans the database 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
from getpass import getuser()
mysql_my_proc = factories.mysql_proc(
port=None, user=getuser())
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/MariaDB option |
Fixture factory argument |
Command line option |
pytest.ini option |
Noop process fixture |
Default |
---|---|---|---|---|---|
Path to executable |
mysqld_exec |
–mysql-mysqld |
mysql_mysqld |
mysqld |
|
Path to safe executable |
mysqld_safe |
–mysql-mysqld-safe |
mysql_mysqld_safe |
mysqld_safe |
|
Path to mysql_install_db for legacy installations |
install_db |
–mysql-install-db |
mysql_install_db |
mysql_install_db |
|
Path to Admin executable |
admin_executable |
–mysql-admin |
mysql_admin |
mysqladmin |
|
Database hostname |
host |
–mysql-host |
mysql_host |
yes |
localhost |
Database port |
port |
–mysql-port |
mysql_port |
yes (3306) |
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 [DEPRECATED] |
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
Examples
Populating database for tests
With SQLAlchemy
This example shows how to populate database and create an SQLAlchemy’s ORM connection:
Sample below is simplified session fixture from pyramid_fullauth tests:
from sqlalchemy import create_engine
from sqlalchemy.orm import scoped_session, sessionmaker
from sqlalchemy.pool import NullPool
from zope.sqlalchemy import register
@pytest.fixture
def db_session(mysql):
"""Session for SQLAlchemy."""
from pyramid_fullauth.models import Base # pylint:disable=import-outside-toplevel
# assumes setting, these can be obtained from pytest-mysql config or mysql_proc
connection = f'mysql+mysqldb://root:@127.0.0.1:3307/tests?charset=utf8'
engine = create_engine(connection, echo=False, poolclass=NullPool)
pyramid_basemodel.Session = scoped_session(sessionmaker(extension=ZopeTransactionExtension()))
pyramid_basemodel.bind_engine(
engine, pyramid_basemodel.Session, should_create=True, should_drop=True)
yield pyramid_basemodel.Session
transaction.commit()
Base.metadata.drop_all(engine)
@pytest.fixture
def user(db_session):
"""Test user fixture."""
from pyramid_fullauth.models import User
from tests.tools import DEFAULT_USER
new_user = User(**DEFAULT_USER)
db_session.add(new_user)
transaction.commit()
return new_user
def test_remove_last_admin(db_session, user):
"""
Sample test checks internal login, but shows usage in tests with SQLAlchemy
"""
user = db_session.merge(user)
user.is_admin = True
transaction.commit()
user = db_session.merge(user)
with pytest.raises(AttributeError):
user.is_admin = False
Connecting to MySQL/MariaDB (in a docker)
To connect to a docker run postgresql and run test on it, use noproc fixtures.
docker run --name some-db -e MYSQL_ALLOW_EMPTY_PASSWORD=yes -d mysql --expose 3306
docker run --name some-db -e MARIADB_ALLOW_EMPTY_PASSWORD=yes -d mariadb --expose 3306
This will start postgresql in a docker container, however using a postgresql installed locally is not much different.
In tests, make sure that all your tests are using mysql_noproc fixture like that:
mysql_in_docker = factories.mysql_noproc()
mysql = factories.mysql("mysql_in_docker")
def test_mysql_docker(mysql):
"""Run test."""
cur = mysql.cursor()
cur.query("CREATE TABLE pet (name VARCHAR(20), owner VARCHAR(20), species VARCHAR(20), sex CHAR(1), birth DATE, death DATE);")
mysql.commit()
cur.close()
And run tests:
pytest --mysql-host=127.0.0.1
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.3.1
Bugs
Now will accept correctly database names with hyphen
2.3.0
Features
Import FixtureRequest from pytest, not private _pytest. Require at least pytest 6.2
Replace tmpdir_factory with tmp_path_factory
Docs
List mysql_noproc in README’s fixtures list
Fixes
Database cleanup code will attempt to reconnect to mysql if test accidentally would close the connection
2.2.0
Feature
add user option to setup and tear down mysql process as non-privileged
Misc
Add Python 3.10 to CI
2.1.0
Feature
mysql_noproc fixture to connect to already running mysql server
raise more meaningful error when the test database already exists
Misc
rely on get_port functionality delivered by port_for
Deprecation
Deprecated mysql_logsdir ini configuration and –mysql-logsdir command option
Deprecated logs_prefix process fixture factory setting
Misc
Require minimum python 3.7
Migrate CI to Github Actions
2.0.3
[enhancement] Do not assume that mysql executables are in /usr/bin
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
Project details
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.3.1.tar.gz
.
File metadata
- Download URL: pytest-mysql-2.3.1.tar.gz
- Upload date:
- Size: 32.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.11.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.10
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | c66f5e76fcf17d189086d310b5febf3a8057bdc0106d18b2fd59a361ce64d42f |
|
MD5 | 06ebe22d0026495c2e2fe7fceacabc0a |
|
BLAKE2b-256 | a978942118aa82d131b3ebaff613eeb8553a22e6e0160ceba9317545c51131a7 |
File details
Details for the file pytest_mysql-2.3.1-py3-none-any.whl
.
File metadata
- Download URL: pytest_mysql-2.3.1-py3-none-any.whl
- Upload date:
- Size: 31.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.11.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.10
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | a62bfd317d34f7ac21c1f28decb6c3f1dbb8aa445622316b2317378baa90249f |
|
MD5 | 432a0f186ed00a3b9085e536a31e8acb |
|
BLAKE2b-256 | 3944498c566a761a650fcf55af566ca5efd058d169170353d823615e7a4602b0 |