Commit graph

57 commits

Author SHA1 Message Date
David Lamparter 444bc5e237 build: update packaging & docs for dir changes
`--sysconfdir` and `--localstatedir` now align with general autoconf
practices.

Signed-off-by: David Lamparter <equinox@opensourcerouting.org>
2024-01-27 19:01:19 +01:00
Donald Sharp db4bdf7a3a
Merge pull request #15023 from opensourcerouting/fix/drop_redundant_vrf_name
bgpd: Drop redundant VRF name printing for `show bgp summary`
2023-12-14 20:26:52 -05:00
Donatas Abraitis f68154184c doc: Update examples of show bgp summary
Signed-off-by: Donatas Abraitis <donatas@opensourcerouting.org>
2023-12-14 15:14:40 +02:00
Louis Scalbert 3dc8b2c1f5 doc: update for exabgp 4
Update the documentation to require exabgp 4

Signed-off-by: Louis Scalbert <louis.scalbert@6wind.com>
2023-12-14 11:39:24 +01:00
Christian Hopps 477b56106b tests: add support for running things under rr.
Signed-off-by: Christian Hopps <chopps@labn.net>
2023-12-01 11:44:22 -05:00
Christian Hopps c27b054efe tests: add ability to show all types of valgrind memleaks
Signed-off-by: Christian Hopps <chopps@labn.net>
2023-11-07 15:29:37 -05:00
Donald Sharp 30a51411a2
Merge pull request #14700 from mjstapp/fix_devdoc_bits
docs: clean up some developer doc warnings
2023-10-31 12:01:53 -04:00
Mark Stapp bb6d4cea60 docs: clean up some developer doc warnings
A few fixups to clean up some dev doc warnings, in the
northbound files especially.

Signed-off-by: Mark Stapp <mjs@labn.net>
2023-10-31 09:57:13 -04:00
Christian Hopps 62af972148 tests: add gdb integration with valgrind
Allows you to run daemons under valgrind integrated with gdb. When daemons are
run with the ``--gdb-daemons/--gdb-routers`` options they will be wired up to
valgrind using vgdb (valgrind tool) so gdb will stop when valgrind errors are
encountered.

Signed-off-by: Christian Hopps <chopps@labn.net>
2023-10-30 07:12:27 -04:00
Christian Hopps a921202a85 tests: add --gdb-use-emacs option
When specified `--gdb-use-emacs` will launch the daemon with gdb inside a
running emacs server using `emacsclient --eval` commands.

Signed-off-by: Christian Hopps <chopps@labn.net>
2023-10-23 05:11:32 -04:00
Quentin Young d2292c6bfe doc: fix whitespace, formatting errors
* Fix various whitespace and syntax errors
* Fix a couple tiny grammar mistakes

Signed-off-by: Quentin Young <qlyoung@qlyoung.net>
2023-09-27 19:55:35 -04:00
anlan_cs 4e8737b269 doc: Fix one syntax error for code block
The code block doesn't work due to special thing in front of it.
So, just make it work.

Signed-off-by: anlan_cs <vic.lan@pica8.com>
2023-06-27 13:51:40 +08:00
anlan_cs ee7457a1c0 doc: Fix one syntax error for code block
The code block doesn't work because blank line is missing.
So, just make it work.

Signed-off-by: anlan_cs <vic.lan@pica8.com>
2023-06-14 22:23:15 +08:00
Christian Hopps 17054f373e doc: update doc removing socat req + remove unused tests code
Signed-off-by: Christian Hopps <chopps@labn.net>
2023-06-08 11:03:18 -04:00
Christian Hopps 054d6bdc48 tests: selecting results by regexp and ragnes, add container support
- Allow selecting results using a regexp
- Allow selecting results using commasep range specs
- Add support for getting and saving results from a docker/podman
  container.
- update docs

Signed-off-by: Christian Hopps <chopps@labn.net>
2023-05-26 06:32:24 -04:00
Christian Hopps 9b18d3d6ac doc: document optionally required packages
- tshark and valgrind are required but only if you enable those
  features during test runs.

Signed-off-by: Christian Hopps <chopps@labn.net>
2023-05-17 13:52:41 -04:00
Lou Berger d4977708f0 topotest: add --memleaks topotest option
Signed-off-by: Lou Berger <lberger@labn.net>
2023-05-11 07:46:19 -04:00
Lou Berger 39869a3597 doc: update for ubuntu 22.04 and to run topotest with valgrind
Signed-off-by: Lou Berger <lberger@labn.net>
2023-05-11 07:13:20 -04:00
Christian Hopps a3e8e1aacb doc: document --perf and --perf-options, and a bit of cleanup
Signed-off-by: Christian Hopps <chopps@labn.net>
2023-04-23 21:56:38 -04:00
Christian Hopps c45ef001ab doc: document new pytest options and cli commands
Signed-off-by: Christian Hopps <chopps@labn.net>
2023-04-22 13:10:52 -04:00
Donatas Abraitis 8709aab554 doc: Use frrouting/frr-mibs repo downloading SNMP mibs
Use repo instead of pastebin.

Signed-off-by: Donatas Abraitis <donatas@opensourcerouting.org>
2023-03-19 22:56:13 +02:00
Kuldeep Kashyap c73d2974b2 doc: Update /doc/topotests.rst documentation
Updated /doc/topotests.rst with socat details,
which is needed to run PIMv6 tests. Socat tool
is used to send PIMv6 join and traffic.

Signed-off-by: Kuldeep Kashyap <kashyapk@vmware.com>
2022-07-28 21:57:51 -07:00
Christian Hopps e00241ad9f tests: new grpc topotest
Signed-off-by: Christian Hopps <chopps@labn.net>
2022-03-14 11:14:12 -04:00
Donatas Abraitis c2f24d8ee6 doc: Enforce using IPv4/IPv6 reserved ranges for documentation
Just to avoid publicly IPv4/IPv6 ranges in topotests/documentation.

Signed-off-by: Donatas Abraitis <donatas.abraitis@gmail.com>
2022-02-25 09:11:52 +02:00
Mark Stapp fd23ce2c01 docs: clarify topotest requirements
The developer docs weren't clear about some pre-reqs.

Signed-off-by: Mark Stapp <mstapp@nvidia.com>
2022-01-05 10:27:17 -05:00
David Lamparter e8713b62d1 doc/developer: fix warnings in topotests doc
Sphinx warns about a few nits here, just fix.  (Note :option:`-E` can't
be used without a "option:: -E" definition, it's intended as a cross
reference.)

Signed-off-by: David Lamparter <equinox@opensourcerouting.org>
2021-10-14 19:12:01 +02:00
Christian Hopps fe226e844a
doc: add sudo environment setup info for topotests
Signed-off-by: Christian Hopps <chopps@labn.net>
2021-09-26 19:14:49 -04:00
Christian Hopps 9b6f04c07c tests: update the test template and doc
- Update the template and documentation to use newer pytest fixutres for
setup and teardown, as well as skipping tests when the suite fails.

Signed-off-by: Christian Hopps <chopps@labn.net>
2021-09-08 13:09:41 -04:00
Hiroki Shirokura 1994c6bc05 doc: don't use abbreviate
Signed-off-by: Hiroki Shirokura <slank.dev@gmail.com>
2021-09-07 07:11:20 +00:00
Hiroki Shirokura e03862c34a topotests: to create pid file of topotest router
Create a pid file for the router created by topotest.
By executing nsenter directly against this pid, developers
can execute commands directly from outside the unet shell.
This allows the developer to use script, tab completion, etc.,
and improves efficiency.

Signed-off-by: Hiroki Shirokura <slank.dev@gmail.com>
2021-09-07 03:55:04 +00:00
Christian Hopps 77f3acb45e doc: minor update based on mininet removal
Signed-off-by: Christian Hopps <chopps@labn.net>
2021-09-04 09:04:46 -04:00
David Lamparter 2ee5fdba02 build: remove --enable-exampledir
This is no longer used with the recent config example removal.

Signed-off-by: David Lamparter <equinox@diac24.net>
2021-06-24 16:42:58 +02:00
Christian Hopps e58133a78e tests: add valgrind memleaks run options and detection
Signed-off-by: Christian Hopps <chopps@labn.net>
2021-06-16 02:56:15 -04:00
Donatas Abraitis 6ab47b0396 doc: Replace single tick with double tick under developer/topotests.rst
Signed-off-by: Donatas Abraitis <donatas.abraitis@gmail.com>
2021-06-02 08:48:25 +03:00
Donatas Abraitis f101a83b46 doc: Require topotests directory to be consistent with others
Just add a requirement to avoid hyphens in directory naming.

Signed-off-by: Donatas Abraitis <donatas.abraitis@gmail.com>
2021-05-11 14:14:26 +03:00
Donald Sharp 248e7b3af1 doc: Check for convergence, not sleep for convergence
Signed-off-by: Donald Sharp <sharpd@nvidia.com>
2021-04-09 12:24:22 -04:00
Donald Sharp ecf9b1bb50
Merge pull request #8167 from LabNConsulting/chopps/tests-add-gdb
tests: add option for auto-launching gdb
2021-03-25 10:27:50 -04:00
Pat Ruddy b69bc6fe0d doc: add libsnmp-dev install line
Do not assume libsnmp-dev is installed.

Signed-off-by: Pat Ruddy <pat@voltanet.io>
2021-03-23 10:18:16 +00:00
Christian Hopps 3f950192fe tests: add options for debugging topotest failures
Signed-off-by: Christian Hopps <chopps@labn.net>
2021-03-19 12:45:37 -04:00
Mark Stapp b43be6b8f6 doc: add more notes about new topotests
Add some extra notes to the dev doc section about writing new
topotests: check for OS/kernel support if necessary; avoid
volatile or unstable data like ifindices or link-locals.

Signed-off-by: Mark Stapp <mjs@voltanet.io>
2021-03-16 11:28:25 -04:00
Donald Sharp 6ddbc710cc
Merge pull request #7218 from kuldeepkash/multicast_pim_bsm
tests: Add multicast-pim-bsm-topo1 suite
2021-02-05 10:20:15 -05:00
kuldeepkash a91530499a doc: Updated topotest.rst doc with iperf
1. We are using iperf to send IGMP join and traffic for multicast suites. Iperf must be
   used to run all multicast suite

Signed-off-by: kuldeepkash <kashyapk@vmware.com>
2021-01-29 16:12:48 +00:00
David Schweizer 0f84d13839
doc: developer documentation for pytest markers
Signed-off-by: David Schweizer <dschweizer@opensourcerouting.org>
2021-01-21 16:22:39 +01:00
Kuldeep Kashyap bf17e2dffe doc: Updated topotest.rst doc with scapy details
1. Scapy, is a python tool, which would be used in multicast-pim-bsm-topo1
   suite automation. We have some BSM raw packets captured and saved in
   JSON file, these packets would be sent using scapy on tests demands.

Signed-off-by: Kuldeep Kashyap <kashyapk@vmware.com>
2021-01-18 18:17:13 +00:00
Pat Ruddy b638685c6c doc: add SNMP instructions for topotests
To run SNMP topotests some utilities and MIBs need to be
installed.

Signed-off-by: Pat Ruddy <pat@voltanet.io>
2021-01-12 20:00:06 +00:00
Mark Stapp e5f0ed147b tests: use .items instead of .iteritems in topotests
Avoid py2-only .iteritems() api.

Signed-off-by: Mark Stapp <mjs@voltanet.io>
2020-09-18 15:55:23 -04:00
Mark Stapp d9c43f8f19 doc: add note about generous BGP topotest timeouts
Add note blocks to the topotest and topotest-json dev docs to
emphasize the need for generous BGP retry/convergence timers.

Signed-off-by: Mark Stapp <mjs@voltanet.io>
2020-07-07 08:55:31 -04:00
Donatas Abraitis 9dd78258ff doc: Mention that we should use black code formatter for topotests
black - https://github.com/psf/black

Signed-off-by: Donatas Abraitis <donatas.abraitis@gmail.com>
2020-04-05 20:16:01 +03:00
Lou Berger dc935a5147 doc: recommend compiling with sharpd to enable scaling testing
Signed-off-by: Lou Berger <lberger@labn.net>
2020-01-21 06:27:43 -05:00
Rafael Zalamena 4260f16567 doc: update topotests doc for address sanitizer
Use the `--enable-address-sanitizer` option instead of the manual
version using environment flags.

This also avoids the problem of having to remember to skip clippy with
the custom flags:

```
make -C lib CFLAGS="-g -O2" LDFLAGS="-g" clippy
```

The snippet above is not needed with `--enable-address-sanitizer`!

Signed-off-by: Rafael Zalamena <rzalamena@opensourcerouting.org>
2019-10-08 21:35:06 -03:00