Skip to main content

A Pytest plugin for your Cookiecutter templates

Project description

Join the chat at https://gitter.im/hackebrot/pytest-cookies PyPI Package 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.

https://raw.github.com/audreyr/cookiecutter/aa309b73bdc974788ba265d843a65bb94c2e608e/cookiecutter_medium.png

Installation

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

$ pip install pytest-cookies

It will automatically install pytest along with cookiecutter.

Usage

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.

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
  • 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 even 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', '==========']

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 codebase, 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

Project details


Release history Release notifications

History Node

0.3.0

History Node

0.2.0

This version
History Node

0.1.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
pytest_cookies-0.1.0-py2.py3-none-any.whl (7.3 kB) Copy SHA256 hash SHA256 Wheel 3.5 Oct 22, 2015
pytest-cookies-0.1.0.tar.gz (4.4 kB) Copy SHA256 hash SHA256 Source None Oct 22, 2015

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page