auto_pytest_mg (Automatic pytest Mock Generator)

• GitHub: https://github.com/rozelie/auto_pytest_mg
• GitHub Releases: https://github.com/rozelie/auto_pytest_mg/releases
• PyPi: https://pypi.org/project/auto-pytest-mg/

auto_pytest_mg parses the AST of an input python file to generate a new test file with fixtures and boilerplate test functions. Rendered tests include the mocker and mg fixtures which are available via the pytest-mock and pytest-mocker-generator packages, respectively.

Note that this packages is a static analysis tool and will not execute any of your code.

Usage

# install the package
pip install auto_pytest_mg

# go to project's source root
cd my_project

# pass the file to generate tests for
auto_pytest_mg my_project/my_file.py

Example

Source file located at my_project/my_file.py

# my_project/my_file.py
import requests

class MyClass:

    def __init__(self, a: int):
        self.a = a

    def method(self) -> int:
        return self.a


def get(url: str) -> requests.Response:
    return requests.get(url)

Running auto_pytest_mg my_project/my_file.py will then output to stdout the generated test file:

import pytest

from my_project.my_file import get, MyClass


MODULE_PATH = "my_project.my_file"


@pytest.fixture
def mock_requests(mocker):
    return mocker.patch(f"{MODULE_PATH}.requests")



@pytest.fixture
def my_class(mocker):
    a = mocker.MagicMock()
    return MyClass(a=a)


class TestMyClass:
    def test__init__(self, mocker):
        a = mocker.MagicMock()

        my_class_ = MyClass(a=a)

    def test_method(self, mocker, mg, my_class):
        mg.generate_uut_mocks_with_asserts(my_class.method)

        result = my_class.method()


      
def test_get(mocker, mg):
    url = mocker.MagicMock()
    mg.generate_uut_mocks_with_asserts(get)

    result = get(url=url)

Similar packages

• pyguin
  • Runs given code and uses a genetic algorithm to produce test cases
  • Can output to unittest/pytest test styles
• pythoscope
  • Last updated in 2016
  • Performs static analysis, does not run your code.

Development

See DEVELOPMENT.md

License

This project is licensed under the terms of the MIT license. See LICENSE for more details.

Credits

This project was generated with python-package-template