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.
pytest-cookies is available for download from PyPI via pip:
$ pip install pytest-cookies
It will automatically install pytest along with cookiecutter.
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.
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 terminationexception
: is the exception that happened if one didproject
: 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', '==========']
If you encounter any problems, please file an issue along with a detailed description.
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.
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.
Distributed under the terms of the MIT license, Pytest-Cookies is free and open source software