From: "Juraj Linkeš" <juraj.linkes@pantheon.tech>
To: thomas@monjalon.net, david.marchand@redhat.com,
Honnappa.Nagarahalli@arm.com, ohilyard@iol.unh.edu,
lijuan.tu@intel.com
Cc: dev@dpdk.org, "Juraj Linkeš" <juraj.linkes@pantheon.tech>
Subject: [RFC PATCH v1 18/24] dts: merge DTS doc/dts_gsg/usr_guide/intro.rst to DPDK
Date: Wed, 6 Apr 2022 15:11:00 +0000 [thread overview]
Message-ID: <20220406151106.2915304-19-juraj.linkes@pantheon.tech> (raw)
In-Reply-To: <20220406151106.2915304-1-juraj.linkes@pantheon.tech>
---
dts/doc/dts_gsg/usr_guide/intro.rst | 90 +++++++++++++++++++++++++++++
1 file changed, 90 insertions(+)
create mode 100644 dts/doc/dts_gsg/usr_guide/intro.rst
diff --git a/dts/doc/dts_gsg/usr_guide/intro.rst b/dts/doc/dts_gsg/usr_guide/intro.rst
new file mode 100644
index 0000000000..dc4c0bfa60
--- /dev/null
+++ b/dts/doc/dts_gsg/usr_guide/intro.rst
@@ -0,0 +1,90 @@
+Introduction
+============
+
+This document describes how to install and configure the Data Plane Development Kit Test Suite (DTS) in a Linux environment.
+DTS is an automation test tool for DPDK, wrote in `Python3`.
+DTS includes one set of test cases and DPDK generic test framework.
+DTS provides test example, references and framework for open source community.
+Based on DTS, everyone can develop their test plan, automation script and configuration for own features and platform.
+In addition, DTS provides a solution to allow that DPDK developers contribute their function test to certify their patch integration.
+It only requires limited effort to maintain test cases once merged into DPDK Test Suite.
+Everyone can utilize DTS to measure performance and functionality for features.
+
+As a generic test framework, DTS provides the following functions:
+
+* Communicate/manage DUT and Tester by SSH connection.
+* Able to work with DUT (Device Under Test), which installed Fedora, Ubuntu, CentOS, RHEL, etc.
+* Support virtualization hypervisor Qemu.
+* Support both software and hardware traffic generators, including Scapy, TRex and IXIA®.
+* Provide configure files to customize test suite and test cases to run under DUT.
+* Provide debug and log functionalities for tracking test cases execution process.
+* Support to output test result by excel, json, log text file, etc.
+
+DTS environment includes DUT (Device under Test), Tester and Traffic generator. DPDK are deployed on DUT and DTS can run on the Tester or DUT or the third machine.
+
+.. note::
+
+ * If run with functional testing, DTS uses `Scapy` as traffic generator, recommend installing DTS on Tester.
+ * If run with performance testing, DTS can use `TRex` or IXIA as traffic gengerator based on your deployment and configuration, recommend installing DTS on DUT.
+ * If use `TRex`, recommend deploying `TRex` and DUT on the same machine with different sockets.
+
+Please see a functional deployment example in the following figure:
+
+.. figure:: image/dts_func_deploy.png
+
+This architecture provides automatically mechanism to manage tester, DUT and packet generators, and remove dependency between test script and test environment/hardware.
+It defines one abstraction layer for DPDK Test Suite, and provides extensibility to add more test script.
+In the DPDK Test Suite Test Framework, it provides the following modules to help to manage device, platform, configure and test results.
+
+.. table::
+
+ +---------------------+------------------------------------------------------------------------------+
+ | File Name/Directory | Description |
+ +=====================+==============================================================================+
+ | dts | Main Application for DTS |
+ +---------------------+------------------------------------------------------------------------------+
+ | framework | Folder with dts framework modules |
+ +---------------------+------------------------------------------------------------------------------+
+ | nics | Folder with different network device modules |
+ +---------------------+------------------------------------------------------------------------------+
+ | conf | Folder with different config files |
+ +---------------------+------------------------------------------------------------------------------+
+ | execution.cfg | Default execution file |
+ +---------------------+------------------------------------------------------------------------------+
+ | executions | Folder with several execution file samples |
+ +---------------------+------------------------------------------------------------------------------+
+ | output | Folder which contain running log files and result files |
+ +---------------------+------------------------------------------------------------------------------+
+ | dep | Folder with dependence scripts |
+ +---------------------+------------------------------------------------------------------------------+
+ | test_plans | Folder with rst files which contain the description of test suites and cases |
+ +---------------------+------------------------------------------------------------------------------+
+ | tests | Folder with test scripts for test suites and cases |
+ +---------------------+------------------------------------------------------------------------------+
+ | doc | Folder with DTS related documents |
+ +---------------------+------------------------------------------------------------------------------+
+ | requirements.txt | DTS required Python packages |
+ +---------------------+------------------------------------------------------------------------------+
+
+These test script provides example and reference. Everyone can develop their test cases, verify their features functionality, and commit generic test report to maintainer.
+, user-defined test cases, test plans and scripts must follow DPDK Test Suite standard including code standard, naming conventions, configure format, rst test plan, API.
+
+Please see test cases, which are included in the DPDK compliance test suites:
+
+.. table::
+
+ +---------------------+----------------------------------------------------------------------------------------------------------------------------+
+ | Test Suite | Descriptions |
+ +=====================+============================================================================================================================+
+ | hello_world | Print a ``helloworld`` message on every enabled logic core. |
+ +---------------------+----------------------------------------------------------------------------------------------------------------------------+
+ | Timer | Shows how timer can be used in a RTE application. |
+ +---------------------+----------------------------------------------------------------------------------------------------------------------------+
+ | checksum_offload | Tests RX/TX L3/L4 Checksum offload features by Poll Mode Drivers |
+ +---------------------+----------------------------------------------------------------------------------------------------------------------------+
+ | jumbo_frame | Tests jumbo frames features by Poll Mode Drivers |
+ +---------------------+----------------------------------------------------------------------------------------------------------------------------+
+ | testpmd | Provides benchmark tests for the Intel Ethernet Controller (Niantic) Poll Mode Driver. |
+ +---------------------+----------------------------------------------------------------------------------------------------------------------------+
+ | L3fwd | Verifies Layer-3 Forwarding results using ``l3fwd`` application. |
+ +---------------------+----------------------------------------------------------------------------------------------------------------------------+
--
2.20.1
next prev parent reply other threads:[~2022-04-06 15:13 UTC|newest]
Thread overview: 25+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-04-06 15:10 [RFC PATCH v1 00/24] merge DTS documentation files " Juraj Linkeš
2022-04-06 15:10 ` [RFC PATCH v1 01/24] dts: merge DTS CONTRIBUTING.TXT " Juraj Linkeš
2022-04-06 15:10 ` [RFC PATCH v1 02/24] dts: merge DTS doc/dts_gsg/Makefile " Juraj Linkeš
2022-04-06 15:10 ` [RFC PATCH v1 03/24] dts: merge DTS doc/dts_gsg/conf.py " Juraj Linkeš
2022-04-06 15:10 ` [RFC PATCH v1 04/24] dts: merge DTS doc/dts_gsg/image/dts_network_arch.png " Juraj Linkeš
2022-04-06 15:10 ` [RFC PATCH v1 05/24] dts: merge DTS doc/dts_gsg/image/dts_result.png " Juraj Linkeš
2022-04-06 15:10 ` [RFC PATCH v1 06/24] dts: merge DTS doc/dts_gsg/image/dts_soft_arch.png " Juraj Linkeš
2022-04-06 15:10 ` [RFC PATCH v1 07/24] dts: merge DTS doc/dts_gsg/image/scene_pf_passthrough.svg " Juraj Linkeš
2022-04-06 15:10 ` [RFC PATCH v1 08/24] dts: merge DTS doc/dts_gsg/image/virt_flow.svg " Juraj Linkeš
2022-04-06 15:10 ` [RFC PATCH v1 09/24] dts: merge DTS doc/dts_gsg/index.rst " Juraj Linkeš
2022-04-06 15:10 ` [RFC PATCH v1 10/24] dts: merge DTS doc/dts_gsg/quick_start.rst " Juraj Linkeš
2022-04-06 15:10 ` [RFC PATCH v1 11/24] dts: merge DTS doc/dts_gsg/rel_notes/index.rst " Juraj Linkeš
2022-04-06 15:10 ` [RFC PATCH v1 12/24] dts: merge DTS doc/dts_gsg/rel_notes/release_21_11.rst " Juraj Linkeš
2022-04-06 15:10 ` [RFC PATCH v1 13/24] dts: merge DTS doc/dts_gsg/usr_guide/asan_test.rst " Juraj Linkeš
2022-04-06 15:10 ` [RFC PATCH v1 14/24] dts: merge DTS doc/dts_gsg/usr_guide/igb_uio.rst " Juraj Linkeš
2022-04-06 15:10 ` [RFC PATCH v1 15/24] dts: merge DTS doc/dts_gsg/usr_guide/image/dts_func_deploy.png " Juraj Linkeš
2022-04-06 15:10 ` [RFC PATCH v1 16/24] dts: merge DTS doc/dts_gsg/usr_guide/image/dts_result.png " Juraj Linkeš
2022-04-06 15:10 ` [RFC PATCH v1 17/24] dts: merge DTS doc/dts_gsg/usr_guide/index.rst " Juraj Linkeš
2022-04-06 15:11 ` Juraj Linkeš [this message]
2022-04-06 15:11 ` [RFC PATCH v1 19/24] dts: merge DTS doc/dts_gsg/usr_guide/ixia.rst " Juraj Linkeš
2022-04-06 15:11 ` [RFC PATCH v1 20/24] dts: merge DTS doc/dts_gsg/usr_guide/results.rst " Juraj Linkeš
2022-04-06 15:11 ` [RFC PATCH v1 21/24] dts: merge DTS doc/dts_gsg/usr_guide/setup_dut.rst " Juraj Linkeš
2022-04-06 15:11 ` [RFC PATCH v1 22/24] dts: merge DTS doc/dts_gsg/usr_guide/sys_reqs.rst " Juraj Linkeš
2022-04-06 15:11 ` [RFC PATCH v1 23/24] dts: merge DTS doc/dts_gsg/usr_guide/trex.rst " Juraj Linkeš
2022-04-06 15:11 ` [RFC PATCH v1 24/24] dts: merge DTS doc/dts_gsg/usr_guide/usage.rst " Juraj Linkeš
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20220406151106.2915304-19-juraj.linkes@pantheon.tech \
--to=juraj.linkes@pantheon.tech \
--cc=Honnappa.Nagarahalli@arm.com \
--cc=david.marchand@redhat.com \
--cc=dev@dpdk.org \
--cc=lijuan.tu@intel.com \
--cc=ohilyard@iol.unh.edu \
--cc=thomas@monjalon.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).