pytest-cookies 0.3.0

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()