Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: Require unified config for all new topotests #17172

Merged
merged 1 commit into from
Oct 21, 2024
Merged

doc: Require unified config for all new topotests #17172

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions doc/developer/topotests.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
Loading