From d9c43f8f19cfa7ec389824630947379307b7d515 Mon Sep 17 00:00:00 2001 From: Mark Stapp Date: Tue, 7 Jul 2020 08:55:31 -0400 Subject: [PATCH] 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 --- doc/developer/topotests-jsontopo.rst | 6 ++++++ doc/developer/topotests.rst | 6 ++++++ 2 files changed, 12 insertions(+) diff --git a/doc/developer/topotests-jsontopo.rst b/doc/developer/topotests-jsontopo.rst index bbae80f11d..1c77cd7be1 100644 --- a/doc/developer/topotests-jsontopo.rst +++ b/doc/developer/topotests-jsontopo.rst @@ -55,8 +55,14 @@ This is the recommended test writing routine: * Create topology from json * Create configuration from json * Write the tests +* Format the new code using `black `_ * Create a Pull Request +.. Note:: + + BGP tests MUST use generous convergence timeouts - you must ensure + that any test involving BGP uses a convergence timeout of at least + 130 seconds. File Hierarchy ^^^^^^^^^^^^^^ diff --git a/doc/developer/topotests.rst b/doc/developer/topotests.rst index 7e627781e0..b32f2bbf49 100644 --- a/doc/developer/topotests.rst +++ b/doc/developer/topotests.rst @@ -363,6 +363,12 @@ This is the recommended test writing routine: - Format the new code using `black `_ - Create a Pull Request +.. Note:: + + BGP tests MUST use generous convergence timeouts - you must ensure + that any test involving BGP uses a convergence timeout of at least + 130 seconds. + Topotest File Hierarchy """"""""""""""""""""""" -- 2.39.5