diff options
| author | Donatas Abraitis <donatas@opensourcerouting.org> | 2024-10-21 09:10:13 +0300 |
|---|---|---|
| committer | Donatas Abraitis <donatas@opensourcerouting.org> | 2024-10-21 09:10:13 +0300 |
| commit | d155d6278511f98ff292916917d8f15f94928fdc (patch) | |
| tree | 14be0d0f9ce12ef8ead6805ab6f47303a3e4637d /doc | |
| parent | 5d5da525b9d34044bbdf4da784132d6b5480b5da (diff) | |
doc: Require unified config for all new topotests
Signed-off-by: Donatas Abraitis <donatas@opensourcerouting.org>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/developer/topotests.rst | 15 |
1 files changed, 8 insertions, 7 deletions
diff --git a/doc/developer/topotests.rst b/doc/developer/topotests.rst index 6209749636..1ec516a1e1 100644 --- a/doc/developer/topotests.rst +++ b/doc/developer/topotests.rst @@ -1393,21 +1393,22 @@ or using unified config (specifying which daemons to run is optional): Requirements: - Directory name for a new topotest must not contain hyphen (``-``) characters. - To separate words, use underscores (``_``). For example, ``tests/topotests/bgp_new_example``. + To separate words, use underscores (``_``). For example, ``tests/topotests/bgp_new_example``; - Test code should always be declared inside functions that begin with the ``test_`` prefix. Functions beginning with different prefixes will not be run - by pytest. + by pytest; - Configuration files and long output commands should go into separated files - inside folders named after the equipment. + inside folders named after the equipment; - Tests must be able to run without any interaction. To make sure your test - conforms with this, run it without the :option:`-s` parameter. + conforms with this, run it without the :option:`-s` parameter; - Use `black <https://github.com/psf/black>`_ code formatter before creating - a pull request. This ensures we have a unified code style. + a pull request. This ensures we have a unified code style; - Mark test modules with pytest markers depending on the daemons used during the - tests (see :ref:`topotests-markers`) + tests (see :ref:`topotests-markers`); - Always use IPv4 :rfc:`5737` (``192.0.2.0/24``, ``198.51.100.0/24``, ``203.0.113.0/24``) and IPv6 :rfc:`3849` (``2001:db8::/32``) ranges reserved - for documentation. + for documentation; +- Use unified config (``frr.conf``) for all new [tests](#writing-tests). Tips: |