proxmox-mirrors/mirror_frr
1
0
Fork 0
mirror of https://git.proxmox.com/git/mirror_frr synced 2025-07-27 10:04:18 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #17172 from opensourcerouting/fix/doc_unified_config

Browse Source 
doc: Require unified config for all new topotests
This commit is contained in:
Jafar Al-Gharaibeh 2024-10-21 13:40:48 -05:00 committed by GitHub
commit cf1da3e679
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
doc/developer/topotests.rst
View File

@ -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: