🍪 The pytest plugin for your Cookiecutters
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
tests
.gitignore
.travis.yml
CONTRIBUTING.md
CONTRIBUTORS.rst
LICENSE
MANIFEST.in
Makefile
README.rst
appveyor.yml
mkdocs.yml
pytest_cookies.py
setup.cfg
setup.py
tox.ini

README.rst

Pytest-Cookies

Join the chat at https://gitter.im/hackebrot/pytest-cookies PyPI Package PyPI Python Versions PyPI Package License Documentation Status See Build Status on Travis CI See Build Status on AppVeyor

pytest is a mature full-featured Python testing tool that provides easy, no boilerplate testing. Its hook-based customization system supports integration of external plugins such as pytest-cookies.

This plugin 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.

Cookiecutter

Installation

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

$ pip install pytest-cookies

It will automatically install pytest along with cookiecutter.

Features

cookies.bake() returns a result instance with a bunch of fields that hold useful information:

  • exit_code: is the exit code of cookiecutter, 0 means successful termination
  • exception: is the exception that happened (if one did, None otherwise)
  • project: a py.path.local object pointing to the rendered project

The returned LocalPath instance provides you with a powerful interface to filesystem related information, that comes in handy for validating the generated project layout and file contents:

def test_readme(cookies):
    result = cookies.bake()

    readme_file = result.project.join('README.rst')
    readme_lines = readme_file.readlines(cr=False)

    assert readme_lines == [
        'helloworld',
        '==========',
    ]

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.basename == 'helloworld'
    assert result.project.isdir()

It accepts the extra_context keyword argument that will be passed to cookiecutter. The given dictionary will override the default values of the template context, allowing you to test arbitrary user input data.

Please see the Injecting Extra Context section of the official cookiecutter documentation.

Specify 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

To customize the cookiecutter template directory in a test, cookies.bake() can also accept an optional template parameter:

@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.basename == 'example-project'
    assert result.project.isdir()

Keep Output Directories for Debugging

By default, the cookies fixture will remove all baked projects. However, you can pass the flag keep-baked-projects if you'd like to keep them (it won't clutter, pytest will remove entries older than 3 temporary directories):

$ pytest --keep-baked-projects

Issues

If you encounter any problems, please file an issue along with a detailed description.

Contributing

Contributions are very welcome! Tests can be run with tox, please make sure all of the tests are green before you submit a pull request.

Code of Conduct

Everyone interacting in the pytest-cookies project's codebases, issue trackers, chat rooms, and mailing lists is expected to follow the PyPA Code of Conduct.

License

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

OSI certified