From: Filip Tehlar <ftehlar@cisco.com>
Date: Wed, 24 Jan 2024 14:11:27 +0000 (+0100)
Subject: hs-test: update docs on debugging
X-Git-Tag: v24.10-rc0~280
X-Git-Url: https://gerrit.fd.io/r/gitweb?a=commitdiff_plain;h=f34b6800de78d99192dc5757a4845e2668749c40;p=vpp.git

hs-test: update docs on debugging

Type: docs

Change-Id: I3bd89feb53a35532c79283bcdac2c87635c60920
Signed-off-by: Filip Tehlar <ftehlar@cisco.com>
---

diff --git a/extras/hs-test/README.rst b/extras/hs-test/README.rst
index 2caa65d7a83..6db832b7fbe 100644
--- a/extras/hs-test/README.rst
+++ b/extras/hs-test/README.rst
@@ -195,6 +195,21 @@ test run time it is not advisable to use aforementioned skip methods and instead
     func (s *MySuite) SkipTest(){
 
 
+**Debugging a test**
+
+It is possible to debug VPP by attaching ``gdb`` before test execution by adding ``DEBUG=true`` like follows:
+
+::
+
+    $ make test TEST=TestVeths/TestLDPreloadIperfVpp DEBUG=true
+    ...
+    run following command in different terminal:
+    docker exec -it server-vpp gdb -ex "attach $(docker exec server-vpp pidof vpp)"
+    Afterwards press CTRL+C to continue
+
+If a test consists of more VPP instances then this is done for each of them.
+
+
 **Eternal dependencies**
 
 * Linux tools ``ip``, ``brctl``