Skip to content

Commit

Permalink
Update new reactor contribution instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
altendky committed Mar 30, 2019
1 parent d1c02e2 commit 55576a0
Showing 1 changed file with 14 additions and 3 deletions.
17 changes: 14 additions & 3 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,26 @@ What it takes to add a new reactor:

* In ``testing/test_basic.py``

* Add ``test_blockon_in_hook_with_foo()`` decorated by ``@skip_if_reactor_not('foo')``
* Add ``test_wrong_reactor_with_foo()`` decorated by ``@skip_if_reactor_not('foo')``
* Add ``test_blockon_in_hook_with_foo()`` with ``skip_if_reactor_not('foo')`` as the first line
* Add ``test_wrong_reactor_with_foo()`` with ``skip_if_reactor_not('foo')`` as the first line

* In ``tox.ini``

* Adjust ``envlist`` to include the ``fooreactor`` factor for the appropriate versions of Python
* Add conditional ``deps`` for the new reactor such as ``foo: foobar`` to the appropriate test environments
* Add the conditional assignment ``foo: reactor_option=foo`` to ``setenv`` in the appropriate test environments
* Add ``fooreactor: pytest --reactor=foo`` to the commands list

* In ``.travis.yml``

* Consider any extra system packages which may be required

* In ``appveyor.yml``

* Add the new reactor environment to the ``TOXENV`` for each relevant Python

Reference reactor additions:
* `asyncio`_
* `qt5reactor`_

.. _`asyncio`: https://github.com/pytest-dev/pytest-twisted/pull/63
.. _`qt5reactor`: https://github.com/pytest-dev/pytest-twisted/pull/16

0 comments on commit 55576a0

Please sign in to comment.