pytest-cookies

pytest-cookies

pytest is a mature testing framework for Python that is developed by a thriving and ever-growing community of volunteers. It uses plain assert statements and regular Python comparisons. At the core of the pytest test framework is a powerful hook-based plugin system.

pytest-cookies is a pytest plugin that comes with a cookies fixture which is a wrapper for the cookiecutter API for generating projects. It helps you verify that your template is working as expected and takes care of cleaning up after running the tests. 🍪

Installation

pytest-cookies is available for download from PyPI via pip:

pip install pytest-cookies

This will automatically install pytest and cookiecutter.

Usage

Generate a new project

The cookies.bake() method generates a new project from your template based on the default values specified in cookiecutter.json:

def test_bake_project(cookies):
    result = cookies.bake(extra_context={"repo_name": "helloworld"})

    assert result.exit_code == 0
    assert result.exception is None

    assert result.project_path.name == "helloworld"
    assert result.project_path.is_dir()

    # The `project` attribute is deprecated
    assert result.project.basename == "helloworld"
    assert result.project.isdir()

Please note that the project attribute of the returned Result class is deprecated and will be removed in a future release, please use project_path instead.

The cookies.bake() method also accepts the extra_context keyword argument that will be passed to cookiecutter. The given dictionary will override the default values of the template context, effectively allowing you to test arbitrary user input data.

For more information on injecting extra context, please check out the cookiecutter documentation.

Specify the template directory

By default cookies.bake() looks for a cookiecutter template in the current directory. This can be overridden on the command line by passing a --template parameter to pytest:

pytest --template TEMPLATE

You can customize the cookiecutter template directory from a test by passing in the optional template paramter:

@pytest.fixture
def custom_template(tmpdir):
    template = tmpdir.ensure("cookiecutter-template", dir=True)
    template.join("cookiecutter.json").write('{"repo_name": "example-project"}')

    repo_dir = template.ensure("{{cookiecutter.repo_name}}", dir=True)
    repo_dir.join("README.rst").write("{{cookiecutter.repo_name}}")

    return template


def test_bake_custom_project(cookies, custom_template):
    """Test for 'cookiecutter-template'."""
    result = cookies.bake(template=str(custom_template))

    assert result.exit_code == 0
    assert result.exception is None

    assert result.project_path.name == "example-project"
    assert result.project_path.is_dir()

Keep output directories for debugging

By default cookies removes baked projects.

However, you can pass the keep-baked-projects flag if you'd like to keep them (it won't clutter as pytest only keeps the three newest temporary directories):

pytest --keep-baked-projects

Community

Contributions are very welcome! If you encounter any problems, please file an issue along with a detailed description. Tests can be run with tox. Please make sure all of the tests are green before you submit a pull request.

You can also support the development of this project by volunteering to become a maintainer, which means you will be able to triage issues, merge pull-requests, and publish new releases. If you're interested, please submit a pull-request to add yourself to the list of maintainers and we'll get you started! 🍪

Please note that pytest-cookies is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

License

Distributed under the terms of the MIT license, pytest-cookies is free and open source software.