summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorCole Robinson <crobinso@redhat.com>2020-07-17 13:56:43 -0400
committerCole Robinson <crobinso@redhat.com>2020-07-17 16:00:32 -0400
commitded69ee2ce4bf2925a6900ad6b66de36d4f8d010 (patch)
tree9897c2e21db94acb60fc036c4abea32ee6d4429a /CONTRIBUTING.md
parent92844eb2f8749f149782216d208a2234029c8075 (diff)
downloadvirt-manager-ded69ee2ce4bf2925a6900ad6b66de36d4f8d010.tar.gz
CONTRIBUTING: Point to new `pytest` test steps
Signed-off-by: Cole Robinson <crobinso@redhat.com>
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md15
1 files changed, 8 insertions, 7 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 5a88f2d9..6500ea35 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -24,11 +24,11 @@ report.
The following commands will be useful for anyone writing patches:
```sh
-./setup.py test # Run local unit test suite
+pytest # Run local unit test suite
./setup.py pylint # Run pylint/pycodestyle checking
```
-Any patches shouldn't change the output of 'test' or 'pylint'. Depending
+Any patches shouldn't change the output of 'pytest' or 'pylint'. Depending
on what version of libvirt or pylint is installed, you may see some
pre-existing errors from these commands. The important thing is that
any changes you make do not add additional errors.
@@ -39,7 +39,7 @@ If [`codespell`](https://github.com/codespell-project/codespell) is installed,
it will be invoked as well.
Patches to `virtinst/` code should ideally not regress code coverage
-testing. Run `./setup.py test --coverage` to see a coverage report
+testing. Run `pytest --cov` to see a coverage report
before and after your contribution, and ensure no new lines show up.
Maintainers can help you out if you aren't sure how to test your code.
@@ -108,9 +108,10 @@ Translations are handled through the Weblate instance hosted by the Fedora Proje
There's a few standalone specialty tests:
```sh
-./setup.py test_ui # dogtail UI test suite. This takes over your desktop
-./setup.py test_urls # Test fetching media from live distro URLs
-./setup.py test_initrd_inject # Test live virt-install --initrd-inject
+pytest --uitest # dogtail UI test suite. This takes over your desktop
+pytest tests/test_urls.py # Test fetching media from live distro URLs
+pytest tests/test_inject.py # Test live virt-install --initrd-inject
```
-All test 'test*' commands have a `--debug` option if you are hitting problems. For more options, see `./setup.py test --help`.
+To see full debug output from test runs, use
+`pytest --capture=no --log-level=debug ...`