diff options
author | Tristan Maat <tristan.maat@codethink.co.uk> | 2018-03-15 15:24:08 +0000 |
---|---|---|
committer | Tristan Van Berkom <tristan.van.berkom@gmail.com> | 2018-04-11 06:49:22 +0000 |
commit | cb38665143e6a93f21a08416c869f996b528459f (patch) | |
tree | 1fc3a0ef5f10cb96902114e5d6f8a2629686f149 | |
parent | 37d9741401b6c59657c3745f21b468eea1122e62 (diff) | |
download | buildstream-cb38665143e6a93f21a08416c869f996b528459f.tar.gz |
HACKING.rst: Add integration and pytest notes
-rw-r--r-- | HACKING.rst | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/HACKING.rst b/HACKING.rst index 092d50368..9c2cb1264 100644 --- a/HACKING.rst +++ b/HACKING.rst @@ -321,6 +321,20 @@ the frontend tests you can do:: ./setup.py test --addopts '-k tests/frontend/' +We also have a set of slow integration tests that are disabled by +default - you will notice most of them marked with SKIP in the pytest +output. To run them, you can use:: + + ./setup.py test --addopts '--integration' + +By default, buildstream also runs pylint on all files. Should you want +to run just pylint (these checks are a lot faster), you can do so +with:: + + ./setup.py test --addopts '-m pylint' + +Alternatively, any IDE plugin that uses pytest should automatically +detect the ``.pylintrc`` in the project's root directory. Adding Tests ~~~~~~~~~~~~ @@ -342,6 +356,11 @@ to decorate your test case (again, examples exist in the existing tests for this), documentation on the datafiles extension can be found here: https://pypi.python.org/pypi/pytest-datafiles +Tests that run a sandbox should be decorated with:: + + @pytest.mark.integration + +and use the integration cli helper. Measuring BuildStream performance --------------------------------- |