Add a section to the dts rst under How to Write a Test Suite
which provides an example for how to write a test case
docstring, including a steps and verify section.
Signed-off-by: Dean Marx <dm...@iol.unh.edu>
---
doc/guides/tools/dts.rst | 16 ++++++++++++++++
1 file changed, 16 insertions(+)
diff --git a/doc/guides/tools/dts.rst b/doc/guides/tools/dts.rst
index 78761dc49e..7f21b45281 100644
--- a/doc/guides/tools/dts.rst
+++ b/doc/guides/tools/dts.rst
@@ -414,6 +414,22 @@ Test Cases
A test suite may include any number of functional and/or performance test
cases.
Each suite should focus on testing a single feature (one feature = one test
suite).
+ Test case docstrings must include a Steps and Verify section. For example:
+
+ Example::
+
+ @func_test
+ def test_basic_link(self):
+ """Tests basic link status.
+
+ Steps:
+ Launch testpmd.
+ Check port info.
+
+ Verify:
+ Port info shows link status is up.
+ "
+
Setup and Teardown Hooks
Setup and teardown methods can be defined at both the suite and test case
levels.
--
2.50.1
