From 248e7b3af10144d1a9487a021e7249221a33a0b2 Mon Sep 17 00:00:00 2001 From: Donald Sharp Date: Fri, 9 Apr 2021 12:06:55 -0400 Subject: [PATCH] doc: Check for convergence, not sleep for convergence Signed-off-by: Donald Sharp --- doc/developer/topotests.rst | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/doc/developer/topotests.rst b/doc/developer/topotests.rst index 2a6d2dda34..a86566dbb0 100644 --- a/doc/developer/topotests.rst +++ b/doc/developer/topotests.rst @@ -480,6 +480,15 @@ Some things to keep in mind: - Avoid including unstable data in your test: don't rely on link-local addresses or ifindex values, for example, because these can change from run to run. +- Using sleep is almost never appropriate to wait for some convergence + event as the sole item done. As an example: if the test resets the peers + in BGP, the test should look for the peers reconverging instead of just + sleeping an arbitrary amount of time and continuing on. It is ok to + use sleep in a tight loop with appropriate show commands to ensure that + the protocol reaches the desired state. This should be bounded by + appropriate timeouts for the protocol in question though. See + verify_bgp_convergence as a good example of this. If you are having + troubles figuring out what to look for, please do not be afraid to ask. Topotest File Hierarchy -- 2.39.5