From c208b954564e8fffdd4c86cc3c497e0c3df1aeec Mon Sep 17 00:00:00 2001 From: Charles Cooper Date: Tue, 14 Jan 2025 12:09:31 -0500 Subject: [PATCH] chore[docs]: update readme about testing (#4448) - add comments to `quicktest.sh` explaining usage. - remove `tests_require` from `setup.py` as that has been deprecated - remove `pytest-runner` from `setup.py` - update readme to reference quicktest.sh --- README.md | 2 +- quicktest.sh | 11 ++++++++++- setup.py | 3 +-- 3 files changed, 12 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 84c2948ceb..827d40d549 100644 --- a/README.md +++ b/README.md @@ -50,7 +50,7 @@ be a bit behind the latest version found in the master branch of this repository ```bash make dev-init -python setup.py test +./quicktest.sh -m "not fuzzing" ``` ## Developing (working on the compiler) diff --git a/quicktest.sh b/quicktest.sh index cd3aad1f15..af928f5d7c 100755 --- a/quicktest.sh +++ b/quicktest.sh @@ -2,8 +2,17 @@ # examples: # ./quicktest.sh +# ./quicktest.sh -m "not fuzzing" +# ./quicktest.sh -m "not fuzzing" -n (this is the most useful) +# ./quicktest.sh -m "not fuzzing" -n0 # ./quicktest.sh tests/.../mytest.py # run pytest but bail out on first error -# useful for dev workflow +# useful for dev workflow. + pytest -q -s --instafail -x --disable-warnings "$@" + +# useful options include: +# -n0 (uses only one core but faster startup) +# -nauto (uses only one core but faster startup) +# -m "not fuzzing" - skip slow/fuzzing tests diff --git a/setup.py b/setup.py index 5b1ae1b81a..e6d4c5763d 100644 --- a/setup.py +++ b/setup.py @@ -98,8 +98,7 @@ def _global_version(version): "importlib-metadata", "wheel", ], - setup_requires=["pytest-runner", "setuptools_scm>=7.1.0,<8.0.0"], - tests_require=extras_require["test"], + setup_requires=["setuptools_scm>=7.1.0,<8.0.0"], extras_require=extras_require, entry_points={ "console_scripts": [