Metadata-Version: 2.4
Name: pytest-mysql
Version: 4.0.0
Summary: MySQL process and client fixtures for pytest
Author-email: Grzegorz Śliwiński <fizyk+pypi@fizyk.dev>
License:                    GNU LESSER GENERAL PUBLIC LICENSE
                               Version 3, 29 June 2007
        
         Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
         Everyone is permitted to copy and distribute verbatim copies
         of this license document, but changing it is not allowed.
        
        
          This version of the GNU Lesser General Public License incorporates
        the terms and conditions of version 3 of the GNU General Public
        License, supplemented by the additional permissions listed below.
        
          0. Additional Definitions.
        
          As used herein, "this License" refers to version 3 of the GNU Lesser
        General Public License, and the "GNU GPL" refers to version 3 of the GNU
        General Public License.
        
          "The Library" refers to a covered work governed by this License,
        other than an Application or a Combined Work as defined below.
        
          An "Application" is any work that makes use of an interface provided
        by the Library, but which is not otherwise based on the Library.
        Defining a subclass of a class defined by the Library is deemed a mode
        of using an interface provided by the Library.
        
          A "Combined Work" is a work produced by combining or linking an
        Application with the Library.  The particular version of the Library
        with which the Combined Work was made is also called the "Linked
        Version".
        
          The "Minimal Corresponding Source" for a Combined Work means the
        Corresponding Source for the Combined Work, excluding any source code
        for portions of the Combined Work that, considered in isolation, are
        based on the Application, and not on the Linked Version.
        
          The "Corresponding Application Code" for a Combined Work means the
        object code and/or source code for the Application, including any data
        and utility programs needed for reproducing the Combined Work from the
        Application, but excluding the System Libraries of the Combined Work.
        
          1. Exception to Section 3 of the GNU GPL.
        
          You may convey a covered work under sections 3 and 4 of this License
        without being bound by section 3 of the GNU GPL.
        
          2. Conveying Modified Versions.
        
          If you modify a copy of the Library, and, in your modifications, a
        facility refers to a function or data to be supplied by an Application
        that uses the facility (other than as an argument passed when the
        facility is invoked), then you may convey a copy of the modified
        version:
        
           a) under this License, provided that you make a good faith effort to
           ensure that, in the event an Application does not supply the
           function or data, the facility still operates, and performs
           whatever part of its purpose remains meaningful, or
        
           b) under the GNU GPL, with none of the additional permissions of
           this License applicable to that copy.
        
          3. Object Code Incorporating Material from Library Header Files.
        
          The object code form of an Application may incorporate material from
        a header file that is part of the Library.  You may convey such object
        code under terms of your choice, provided that, if the incorporated
        material is not limited to numerical parameters, data structure
        layouts and accessors, or small macros, inline functions and templates
        (ten or fewer lines in length), you do both of the following:
        
           a) Give prominent notice with each copy of the object code that the
           Library is used in it and that the Library and its use are
           covered by this License.
        
           b) Accompany the object code with a copy of the GNU GPL and this license
           document.
        
          4. Combined Works.
        
          You may convey a Combined Work under terms of your choice that,
        taken together, effectively do not restrict modification of the
        portions of the Library contained in the Combined Work and reverse
        engineering for debugging such modifications, if you also do each of
        the following:
        
           a) Give prominent notice with each copy of the Combined Work that
           the Library is used in it and that the Library and its use are
           covered by this License.
        
           b) Accompany the Combined Work with a copy of the GNU GPL and this license
           document.
        
           c) For a Combined Work that displays copyright notices during
           execution, include the copyright notice for the Library among
           these notices, as well as a reference directing the user to the
           copies of the GNU GPL and this license document.
        
           d) Do one of the following:
        
               0) Convey the Minimal Corresponding Source under the terms of this
               License, and the Corresponding Application Code in a form
               suitable for, and under terms that permit, the user to
               recombine or relink the Application with a modified version of
               the Linked Version to produce a modified Combined Work, in the
               manner specified by section 6 of the GNU GPL for conveying
               Corresponding Source.
        
               1) Use a suitable shared library mechanism for linking with the
               Library.  A suitable mechanism is one that (a) uses at run time
               a copy of the Library already present on the user's computer
               system, and (b) will operate properly with a modified version
               of the Library that is interface-compatible with the Linked
               Version.
        
           e) Provide Installation Information, but only if you would otherwise
           be required to provide such information under section 6 of the
           GNU GPL, and only to the extent that such information is
           necessary to install and execute a modified version of the
           Combined Work produced by recombining or relinking the
           Application with a modified version of the Linked Version. (If
           you use option 4d0, the Installation Information must accompany
           the Minimal Corresponding Source and Corresponding Application
           Code. If you use option 4d1, you must provide the Installation
           Information in the manner specified by section 6 of the GNU GPL
           for conveying Corresponding Source.)
        
          5. Combined Libraries.
        
          You may place library facilities that are a work based on the
        Library side by side in a single library together with other library
        facilities that are not Applications and are not covered by this
        License, and convey such a combined library under terms of your
        choice, if you do both of the following:
        
           a) Accompany the combined library with a copy of the same work based
           on the Library, uncombined with any other library facilities,
           conveyed under the terms of this License.
        
           b) Give prominent notice with the combined library that part of it
           is a work based on the Library, and explaining where to find the
           accompanying uncombined form of the same work.
        
          6. Revised Versions of the GNU Lesser General Public License.
        
          The Free Software Foundation may publish revised and/or new versions
        of the GNU Lesser General Public License from time to time. Such new
        versions will be similar in spirit to the present version, but may
        differ in detail to address new problems or concerns.
        
          Each version is given a distinguishing version number. If the
        Library as you received it specifies that a certain numbered version
        of the GNU Lesser General Public License "or any later version"
        applies to it, you have the option of following the terms and
        conditions either of that published version or of any later version
        published by the Free Software Foundation. If the Library as you
        received it does not specify a version number of the GNU Lesser
        General Public License, you may choose any version of the GNU Lesser
        General Public License ever published by the Free Software Foundation.
        
          If the Library as you received it specifies that a proxy can decide
        whether future versions of the GNU Lesser General Public License shall
        apply, that proxy's public statement of acceptance of any version is
        permanent authorization for you to choose that version for the
        Library.
        
Project-URL: Source, https://github.com/dbfixtures/pytest-mysql
Project-URL: Bug Tracker, https://github.com/dbfixtures/pytest-mysql/issues
Project-URL: Changelog, https://github.com/dbfixtures/pytest-mysql/blob/v4.0.0/CHANGES.rst
Keywords: tests,pytest,fixture,mysql
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Testing
Classifier: Framework :: Pytest
Requires-Python: >=3.10
Description-Content-Type: text/x-rst
License-File: COPYING
License-File: COPYING.lesser
License-File: AUTHORS.rst
Requires-Dist: pytest>=8.4
Requires-Dist: port-for>=0.7.3
Requires-Dist: mirakuru>=2.6.0
Requires-Dist: pymysql>=1.1.1
Requires-Dist: packaging>=23
Dynamic: license-file

.. image:: https://raw.githubusercontent.com/dbfixtures/pytest-mysql/master/logo.png
    :width: 100px
    :height: 100px

pytest-mysql
============

.. image:: https://img.shields.io/pypi/v/pytest-mysql.svg
    :target: https://pypi.python.org/pypi/pytest-mysql/
    :alt: Latest PyPI version

.. image:: https://img.shields.io/pypi/wheel/pytest-mysql.svg
    :target: https://pypi.python.org/pypi/pytest-mysql/
    :alt: Wheel Status

.. image:: https://img.shields.io/pypi/pyversions/pytest-mysql.svg
    :target: https://pypi.python.org/pypi/pytest-mysql/
    :alt: Supported Python Versions

.. image:: https://img.shields.io/pypi/l/pytest-mysql.svg
    :target: https://pypi.python.org/pypi/pytest-mysql/
    :alt: License

What is this?
=============

A pytest plugin for tests that rely on a running MySQL or MariaDB database.
It provides process and client fixtures.

.. warning::

    Tested with MySQL 8.0+ and MariaDB 10.11+.

.. image:: https://raw.githubusercontent.com/dbfixtures/pytest-mysql/main/docs/images/architecture.svg
    :alt: Project Architecture Diagram
    :align: center

How to use
==========

The plugin contains three fixtures:

* **mysql** - a function-scoped client fixture that drops the test database after each test to ensure repeatability.
* **mysql_proc** - a session-scoped process fixture that starts a local MySQL instance on first use and stops it at the end of the test session.
* **mysql_noproc** - a session-scoped fixture that connects to an already running MySQL instance.

Simply include one of these fixtures in your test fixture list.

You can also create additional MySQL client and process fixtures if you need to:


.. code-block:: python

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

.. note::

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

Prerequisites
-------------

Install MySQL or MariaDB on the machine where tests are executed.
This plugin relies on binaries provided by those installations (for example ``mysqld`` and ``mysqladmin``).

Use ``mysql_proc`` to start a local MySQL process from installed binaries.
Use ``mysql_noproc`` to connect to an already running MySQL/MariaDB server.

Quickstart: first test
----------------------

Install the plugin:

.. code-block:: shell

    pip install pytest-mysql

Create a minimal test that uses the built-in fixture:

.. code-block:: python

    def test_mysql_fixture_available(mysql):
        assert mysql is not None

Run your tests:

.. code-block:: shell

    pytest -q

Configuration
=============

You can define settings in three ways: fixture factory arguments, command-line options, and ``pytest.ini`` configuration options.
These settings are applied in the following order:

    * ``Fixture factory argument``
    * ``Command-line option``
    * ``Configuration option in your pytest.ini file``

.. list-table:: Configuration options
   :header-rows: 1

   * - MySQL/MariaDB option
     - Fixture factory argument
     - Command line option
     - pytest.ini option
     - Noproc 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
   * - Free port search count
     - port_search_count
     - --mysql-port-search-count
     - mysql_port_search_count
     - -
     - 5
   * - 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
     - mysql_dbname
     - -
     - test
   * - Starting parameters
     - params
     - --mysql-params
     - mysql_params
     - -
     -


Example usage:

* pass it as an argument in your own fixture

    .. code-block:: python

        mysql_proc = factories.mysql_proc(
            port=8888)

* use ``--mysql-port`` command line option when you run your tests

    .. code-block::

        pytest 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``:

    .. code-block:: ini

        [pytest]
        mysql_port = 8888

Examples
========

The examples below show advanced integration patterns after your first smoke test is passing.

Populating database for tests
-----------------------------

With SQLAlchemy
+++++++++++++++

This example shows how to populate the database and create an SQLAlchemy ORM connection:

The sample below is a simplified session fixture from
`pyramid_fullauth <https://github.com/fizyk/pyramid_fullauth/>`_ tests:

.. code-block:: python

    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
.. note::

    See the original code at `pyramid_fullauth's conftest file <https://github.com/fizyk/pyramid_fullauth/blob/2950e7f4a397b313aaf306d6d1a763ab7d8abf2b/tests/conftest.py#L35>`_.
    Depending on your needs, that in between code can fire alembic migrations in case of sqlalchemy stack or any other code

Connecting to MySQL/MariaDB (in a docker)
-----------------------------------------

To connect to MySQL or MariaDB running in Docker, use noproc fixtures.

.. code-block:: sh

    docker run --name some-db -e MYSQL_ALLOW_EMPTY_PASSWORD=yes -d mysql --expose 3306

.. code-block:: sh

    docker run --name some-db -e MARIADB_ALLOW_EMPTY_PASSWORD=yes -d mariadb --expose 3306

This starts MySQL/MariaDB in a Docker container, but using a locally installed MySQL or MariaDB instance is similar.

In tests, make sure your tests use the **mysql_noproc** fixture like this:

.. code-block:: python

    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:

.. code-block:: sh

    pytest --mysql-host=127.0.0.1



Running on Docker/as root
=========================

MySQL and MariaDB refuse to run as root by default, but we can force them by setting user=root in the configuration file.

However, the most common and secure approach is to change the user that runs tests in Docker:

.. code-block::

    USER nobody

This line should switch your Docker process to run as user ``nobody``. See `this comment for example <https://github.com/dbfixtures/pytest-mysql/issues/62#issuecomment-367975723>`_.

Package resources
-----------------

* Bug tracker: https://github.com/dbfixtures/pytest-mysql/issues

Release
=======

Install pipenv and ``--dev`` dependencies first, then run:

.. code-block::

    pipenv run tbump [NEW_VERSION]
