pytest-dev / pytest-mimesis Goto Github PK

View Code? Open in Web Editor NEW

62.0 44.0 4.0 199 KB

Mimesis integration with the pytest test runner. This plugin provider useful fixtures based on providers from Mimesis.

Home Page: https://pypi.org/project/pytest-mimesis/

License: MIT License

Python 100.00%

pytest plugin fixtures pytest-mimesis mimesis faker fake-data pytest-plugin testing testing-tools

pytest-mimesis's Introduction

⛔️ DEPRECATED

This repository is now deprecated. We have integrated pytest-mimesis into mimesis itself, and there is no longer a need to use a separate package. Refer to the Integration with Pytest section for more details.

pytest-mimesis

pytest-mimesis is a pytest plugin that provides pytest fixtures for Mimesis providers. This allows you to quickly and easily use randomized, dummy data as part of your test suite.

Installation

pip install pytest-mimesis

Examples

Using the personal provider as part of a test.

# your_module/__init__.py

def validate_email(email):
    # code that validates an e-mail address
    return True

And your test file:

# tests/test_email.py

from your_module import validate_email

def test_validate_email(mimesis):
    assert validate_email(mimesis('email'))

You can also specify locales:

@pytest.mark.parameterize('mimesis_locale', ['de'])  # use German locale
def test_create_user(mimesis):
    assert create_user(name=mimesis('full_name'))


@pytest.mark.parameterize('mimesis_locale', ['de', 'en', 'jp'])  # test multiple locales
def test_add_phone(user, mimesis):
    assert user.add_phone_number(name=mimesis('full_name'))

Fixtures

We provide two public fixtures: mimesis_locale and mimesis. While mimesis_locale is just a string (like: en, ru), mimesis is an instance of mimesis.schema.Field.

We use caching of mimesis instances for different locales for the whole test session, so creating new instances is cheap.

Related projects

License

pytest-mimesis is licensed under the MIT License.

pytest-mimesis's People

Contributors

Stargazers

Watchers

Forkers

geyser nschlemm isabella232 ivan-paylnik

pytest-mimesis's Issues

python3.8 support

Specify classifiers in pyproject.toml

We are missing Trove Classifiers in pyproject.toml.
We need to add them.

Finish refactoring!

TODO:

Add Travis CI.
Update Readme
Update version of mimesis.

fast enough (not function scope), since adding providers might be kind of expensive
configurable, so different module could have different providers

Provide random seed

We should use pytest-randomly as our default seed.

There's an issue for this task lk-geimfari/mimesis#469
Currently, it is impossible to provide a seed for all providers in a single place.
See: https://github.com/pytest-dev/pytest-randomly/blob/master/pytest_randomly.py#L75

Version missmatch

Using version ^1.0 for pytest-mimesis

Updating dependencies
Resolving dependencies... (0.8s)
                                                                                      
[SolverProblemError]                                                   
Because no versions of pytest-mimesis match >1.0,<2.0                               
 and pytest-mimesis (1.0.0) depends on pytest (>=4.2), pytest-mimesis (>=1.0,<2.0)  
 requires pytest (>=4.2).                                                           
So, because rostelecom-svetochka depends on both pytest (^3.10.0) and pytest-mimes  
is (^1.0), version solving failed.                                                  
                                                                                      
add [-D|--dev] [--git GIT] [--path PATH] [-E|--extras EXTRAS] [--optional] [--python PYTHON] [--platform PLATFORM] [--allow-prereleases] [--dry-run] [--] <name> (<name>)...

@pytest.fixture(scope='function')
def gitlab_merge_request(mimesis):
    return {
        'user': {
            'username': mimesis('username'),
        },
        'object_attributes': {
            'id': mimesis('between', minimum=1),
            'state': 'opened'
        },
    }

What I want to achieve is something like:

import pytest

@pytest.mark.parametrize(
    'gitlab_merge_request__object_attributes__state', ['closed'],
)
def test_is_closed(gitlab_merge_request):
    assert gitlab_merge_request['object_attributes']['state'] == 'closed'

We can use https://docs.pytest.org/en/latest/fixture.html#override-a-fixture-with-direct-test-parametrization

Write all tests and update readme

We need to write test for all providers and update README.md

consider moving code into mimesis.pytest_plugin

then this project can be a thin shim that just registers the entry point:

[build-system]
requires = ["flit_core >=2,<4"]
build-backend = "flit_core.buildapi"

[tool.flit.metadata]
module = "pytest_mimesis"
dist-name = "pytest-mimesis"
author = "..."
author-email = "..."
home-page = "https://github.com/lk-geimfari/mimesis/tree/master/mimesis/pytest_plugin.py"
license = "..."
classifiers = ["..."]
requires = ["mimesis >= 4.2.0"]

[tool.flit.entrypoints.pytest11]
mimesis = "mimesis.pytest_plugin"

this is the approach used by pytest-celery: