rls1801 report - static content edits - vpp performance.
[csit.git] / docs / report / csit_framework_documentation / csit_design.rst
1 .. _csit-design:
2
3 CSIT Design
4 ===========
5
6 FD.io CSIT system design needs to meet continuously expanding
7 requirements of FD.io projects including VPP, related sub-systems (e.g.
8 plugin applications, DPDK drivers) and FD.io applications (e.g. DPDK
9 applications), as well as growing number of compute platforms running
10 those applications. With CSIT project scope and charter including both
11 FD.io continuous testing AND performance trending/comparisons, those
12 evolving requirements further amplify the need for CSIT framework
13 modularity, flexibility and usability.
14
15 Design Hierarchy
16 ----------------
17
18 CSIT follows a hierarchical system design with SUTs and DUTs at the
19 bottom level of the hierarchy, presentation level at the top level and a
20 number of functional layers in-between. The current CSIT system design
21 including CSIT framework is depicted in the figure below.
22
23 .. only:: latex
24
25     .. raw:: latex
26
27        \begin{figure}[H]
28        \centering
29            \includesvg[width=0.90\textwidth]{../_tmp/src/csit_framework_documentation/csit_design_picture}
30            \label{fig:csit_design_picture}
31        \end{figure}
32
33 .. only:: html
34
35     .. figure:: csit_design_picture.svg
36         :alt: FD.io CSIT system design
37         :align: center
38
39    *FD.io CSIT system design*
40
41 A brief bottom-up description is provided here:
42
43 #. SUTs, DUTs, TGs
44
45    - SUTs - Systems Under Test;
46    - DUTs - Devices Under Test;
47    - TGs - Traffic Generators;
48
49 #. Level-1 libraries - Robot and Python
50
51    - Lowest level CSIT libraries abstracting underlying test environment, SUT,
52      DUT and TG specifics;
53    - Used commonly across multiple L2 KWs;
54    - Performance and functional tests:
55
56      - L1 KWs (KeyWords) are implemented as RF libraries and Python
57        libraries;
58
59    - Performance TG L1 KWs:
60
61      - All L1 KWs are implemented as Python libraries:
62
63        - Support for TRex only today;
64        - CSIT IXIA drivers in progress;
65
66    - Performance data plane traffic profiles:
67
68      - TG-specific stream profiles provide full control of:
69
70        - Packet definition – layers, MACs, IPs, ports, combinations thereof
71          e.g. IPs and UDP ports;
72        - Stream definitions - different streams can run together, delayed,
73          one after each other;
74        - Stream profiles are independent of CSIT framework and can be used
75          in any T-rex setup, can be sent anywhere to repeat tests with
76          exactly the same setup;
77        - Easily extensible – one can create a new stream profile that meets
78          tests requirements;
79        - Same stream profile can be used for different tests with the same
80          traffic needs;
81
82    - Functional data plane traffic scripts:
83
84      - Scapy specific traffic scripts;
85
86 #. Level-2 libraries - Robot resource files:
87
88    - Higher level CSIT libraries abstracting required functions for executing
89      tests;
90    - L2 KWs are classified into the following functional categories:
91
92      - Configuration, test, verification, state report;
93      - Suite setup, suite teardown;
94      - Test setup, test teardown;
95
96 #. Tests - Robot:
97
98    - Test suites with test cases;
99    - Functional tests using VIRL environment:
100
101      - VPP;
102      - Honeycomb;
103      - NSH_SFC;
104
105    - Performance tests using physical testbed environment:
106
107      - VPP;
108      - DPDK-Testpmd;
109      - DPDK-L3Fwd;
110      - Honeycomb;
111      - VPP Container K8s orchestrated topologies;
112
113    - Tools:
114
115      - Documentation generator;
116      - Report generator;
117      - Testbed environment setup ansible playbooks;
118      - Operational debugging scripts;
119
120 Test Lifecycle Abstraction
121 --------------------------
122
123 A well coded test must follow a disciplined abstraction of the test
124 lifecycles that includes setup, configuration, test and verification. In
125 addition to improve test execution efficiency, the commmon aspects of
126 test setup and configuration shared across multiple test cases should be
127 done only once. Translating these high-level guidelines into the Robot
128 Framework one arrives to definition of a well coded RF tests for FD.io
129 CSIT. Anatomy of Good Tests for CSIT:
130
131 #. Suite Setup - Suite startup Configuration common to all Test Cases in suite:
132    uses Configuration KWs, Verification KWs, StateReport KWs;
133 #. Test Setup - Test startup Configuration common to multiple Test Cases: uses
134    Configuration KWs, StateReport KWs;
135 #. Test Case - uses L2 KWs with RF Gherkin style:
136
137    - prefixed with {Given} - Verification of Test setup, reading state: uses
138      Configuration KWs, Verification KWs, StateReport KWs;
139    - prefixed with {When} - Test execution: Configuration KWs, Test KWs;
140    - prefixed with {Then} - Verification of Test execution, reading state: uses
141      Verification KWs, StateReport KWs;
142
143 #. Test Teardown - post Test teardown with Configuration cleanup and
144    Verification common to multiple Test Cases - uses: Configuration KWs,
145    Verification KWs, StateReport KWs;
146 #. Suite Teardown - Suite post-test Configuration cleanup: uses Configuration
147    KWs, Verification KWs, StateReport KWs;
148
149 RF Keywords Functional Classification
150 -------------------------------------
151
152 CSIT RF KWs are classified into the functional categories matching the test
153 lifecycle events described earlier. All CSIT RF L2 and L1 KWs have been grouped
154 into the following functional categories:
155
156 #. Configuration;
157 #. Test;
158 #. Verification;
159 #. StateReport;
160 #. SuiteSetup;
161 #. TestSetup;
162 #. SuiteTeardown;
163 #. TestTeardown;
164
165 RF Keywords Naming Guidelines
166 -----------------------------
167
168 Readability counts: "..code is read much more often than it is written."
169 Hence following a good and consistent grammar practice is important when
170 writing :abbr:`RF (Robot Framework)` KeyWords and Tests. All CSIT test cases
171 are coded using Gherkin style and include only L2 KWs references. L2 KWs are
172 coded using simple style and include L2 KWs, L1 KWs, and L1 python references.
173 To improve readability, the proposal is to use the same grammar for both
174 :abbr:`RF (Robot Framework)` KW styles, and to formalize the grammar of English
175 sentences used for naming the :abbr:`RF (Robot Framework)` KWs. :abbr:`RF (Robot
176 Framework)` KWs names are short sentences expressing functional description of
177 the command. They must follow English sentence grammar in one of the following
178 forms:
179
180 #. **Imperative** - verb-object(s): *"Do something"*, verb in base form.
181 #. **Declarative** - subject–verb–object(s): *"Subject does something"*, verb in
182    a third-person singular present tense form.
183 #. **Affirmative** - modal_verb-verb-object(s): *"Subject should be something"*,
184    *"Object should exist"*, verb in base form.
185 #. **Negative** - modal_verb-Not-verb-object(s): *"Subject should not be
186    something"*, *"Object should not exist"*, verb in base form.
187
188 Passive form MUST NOT be used. However a usage of past participle as an
189 adjective is okay. See usage examples provided in the Coding guidelines
190 section below. Following sections list applicability of the above
191 grammar forms to different :abbr:`RF (Robot Framework)` KW categories. Usage
192 examples are provided, both good and bad.
193
194 Coding guidelines
195 -----------------
196
197 Coding guidelines can be found on `Design optimizations wiki page
198 <https://wiki.fd.io/view/CSIT/Design_Optimizations>`_.

©2016 FD.io a Linux Foundation Collaborative Project. All Rights Reserved.
Linux Foundation is a registered trademark of The Linux Foundation. Linux is a registered trademark of Linus Torvalds.
Please see our privacy policy and terms of use.