simplify test setup and remove tox from template

Author: mariushelf

.github/workflows/cicd.yaml

@@ -29,6 +29,4 @@ jobs:
         curl -sSL https://install.python-poetry.org | python3 -
         export PATH=$PATH:$HOME/.local/bin
     - name: Run tests
-      env:
-        TOX_ENV: ${{ matrix.python-version }}
       run: ./tests/test.sh

.gitignore

@@ -54,5 +54,5 @@ notebooks/
 .idea
 
 # project artefacts
-test_project
+test_project*
 .python-version

Makefile

@@ -2,3 +2,6 @@
 
 test:
 	./tests/test.sh
+
+test-all:
+	tox p

tests/test.sh

@@ -9,11 +9,12 @@
 set -xe
 
 CURRENT_DIR=$(pwd)
+PROJECT_DIR="test_project${TOX_ENV_NAME}"
 
-rm -rf test_project
+rm -rf $PROJECT_DIR
 
 cookiecutter --no-input --default-config \
-  -o test_project \
+  -o $PROJECT_DIR \
    . \
   author_name="Joe Doe" \
     author_email="joe@example.com" \
@@ -24,7 +25,7 @@ cookiecutter --no-input --default-config \
     license="MIT"
 echo "✅ Cookiecutter executes successfully."
 
-cd test_project/my_project
+cd $PROJECT_DIR/my_project
 
 poetry install
 
@@ -41,16 +42,10 @@ make docs
 echo "✅ Documentation builds."
 
 # check that the tests pass (apart from the test_reminder which always fails)
-TOX_ARGS="-k 'not test_reminder'" make test
-
-# check that the test_reminder fails
-if TOX_ARGS="-k test_reminder" make test ; then
-    echo 'test_reminder test does not fail.' >&2
-    exit 1
-fi
-echo "✅ test_reminder test failed as expected."
+make test
+echo "✅ The tests pass."
 
 cd "${CURRENT_DIR}"
-#rm -rf test_project
+rm -rf $PROJECT_DIR
 
 echo "✅ Cookiecutter project tested successfully. All good 🤩"

tox.toml

@@ -0,0 +1,10 @@
+requires = ["tox>=4"]
+env_list = ["3.13", "3.12", "3.11", "3.10", "pypy3.10"]
+
+[env_run_base]
+description = "Test that the cookiecutter builds."
+deps = [
+    "cookiecutter"
+]
+allowlist_externals = ["make"]
+commands = [["make", { replace = "posargs", default = ["test"], extend = true }]]

{{ cookiecutter.project_slug }}/.github/workflows/cicd.yaml

@@ -61,10 +61,6 @@ jobs:
         with:
           fail_ci_if_error: true
   #        token: ${{ secrets.CODECOV_TOKEN }} # not required for public repos
-      - name: Install tox, tox-gh
-        run: python -m pip install tox tox-gh
-      - name: Setup test suite
-        run: python -mtox r --notest
       - name: Run test suite
         run: python -mtox r --skip-pkg-install
         env:

{{ cookiecutter.project_slug }}/Makefile

@@ -1,7 +1,6 @@
 SHELL := /bin/bash
 
 .PHONY: docs
-TOX_ARGS?=
 
 install:
 	poetry install
@@ -13,16 +12,11 @@ clean_docs:
 	cd docs && make clean
 
 test: install
-	poetry run tox -r run-parallel -- -- $(TOX_ARGS)
+	poetry run pytest tests
 
 docs:
 	cd docs && poetry run make html
 	echo You can now browse the documentation at ./docs/build/index.html
 
 build: docs
 	poetry build
-
-# deactivated by default to prevent accidental uploads
-publish: test clean build
-	echo "NOT uploading to PyPI. You need to uncomment the command in the Makefile."
-#	poetry run python -mtwine upload dist/* --verbose

{{ cookiecutter.project_slug }}/tests/test_{{ cookiecutter.project_slug }}.py

@@ -2,15 +2,6 @@
 
 import {{ cookiecutter.project_slug }}
 
-# TODO: implement your tests here!
-
-
-def test_reminder():
-    """Reminder to write tests."""
-    assert False, (
-        "If this test runs it probably means that you have not written your own tests yet 😱 Do it now!"
-    )
-
 
 def test_version_is_semver_string():
     """Test that the version in pyproject.toml is a proper semantic version."""