Update tests to use copier instead of cookiecutter

[sjvrijn]

Summary

Updates all tests to remove references to cookiecutter or the pytest-cookies plugin, and makes sure all tests work with copier instead. Note that the tests in test_values only tests for not erroring, and the 'directory name with spaces' test now expects an error since that validation is not (yet) implemented for copier.

Fixes #1 (?)

Instructions to review the pull request

Add my fork as a remote and switch to the 1-update-tests branch (or make a new clone, your choice), then install the required dependencies and run the tests.

Note: On my local WSL installation, the tox test hangs for some reason, although I suspect this may be a pyenv related issue. I'm assuming/hoping that this will not be a problem in the CI.

git remote add sjvrijn [email protected]:sjvrijn/copier-python-template.git
git fetch sjvrijn
git switch 1-update-tests
python -m venv venv
source venv/bin/activate
python -m pip install --upgrade pip setuptools
pip install ".[dev]"
pytest

[lyashevska]

I am not sure we need to test values now, because validators e.g. this force user to provide correct input. Lets discuss this.

[lyashevska]

I am not familiar with pyprojroot. I was originally thinking of replacing 'pytest-cookies' with 'pytest-copie'. See https://github.com/12rambau/pytest-copie

[sjvrijn]

pyprojroot is a simple but very helpful package to easily refer to paths relative to the project root. For the tests specifically, I used it to guarantee that the source refers to the root of the project, regardless of where the tests are called from (which can sometimes cause issues with these things.)

Using pytest-copie would be nice, but it doesn't a session-scoped fixture such as the one that pytest-cookies does. That means we end up with a whole bunch of ScopeMismatch errors if we do a 'naive' replacement:

ERROR tests/test_project.py::test_pytest - Failed: ScopeMismatch: You tried to access the function scoped fixture copie with a session scoped request object. Requesting fixture stack:
ERROR tests/test_project.py::test_coverage - Failed: ScopeMismatch: You tried to access the function scoped fixture copie with a session scoped request object. Requesting fixture stack:
ERROR tests/test_project.py::test_tox - Failed: ScopeMismatch: You tried to access the function scoped fixture copie with a session scoped request object. Requesting fixture stack:
ERROR tests/test_project.py::test_subpackage - Failed: ScopeMismatch: You tried to access the function scoped fixture copie with a session scoped request object. Requesting fixture stack:
ERROR tests/test_project.py::test_generate_api_docs - Failed: ScopeMismatch: You tried to access the function scoped fixture copie with a session scoped request object. Requesting fixture stack:
ERROR tests/test_project.py::test_coverage_api_docs - Failed: ScopeMismatch: You tried to access the function scoped fixture copie with a session scoped request object. Requesting fixture stack:
ERROR tests/test_project.py::test_doctest_api_docs - Failed: ScopeMismatch: You tried to access the function scoped fixture copie with a session scoped request object. Requesting fixture stack:
ERROR tests/test_project.py::test_ruff_check - Failed: ScopeMismatch: You tried to access the function scoped fixture copie with a session scoped request object. Requesting fixture stack:
ERROR tests/test_project.py::test_bumpversion - Failed: ScopeMismatch: You tried to access the function scoped fixture copie with a session scoped request object. Requesting fixture stack:

Looking at the pytest-cookies code, it seems like it should be an easy contribution to add a similar session scoped version. We should look into that!

[lyashevska]

Great work @sjvrijn! Thanks. I have left a few inline comments for us to discuss. I have tested it on my machine and one test has failed...
FAILED tests/test_project.py::test_coverage_api_docs - AssertionError: assert '| my_python_package | 100.00% | 0 |' in ['Undocumente... =1 failed, 13 passed, 2 warnings in 63.52s (0:01:03)

[lyashevska]

It looks great Sander! I will merge it now.