Skip to content

Commit e2c0004

Browse files
KeshavKaKeshavKa
authored
Merge pull request sonic-net#210 from BRCM-SONIC/testplan_debugsh_sonic_cli
Sonic 4.0.0 Klish debugsh cli TestPlan
2 parents b8e0495 + 4cbe4ba commit e2c0004

2 files changed

Lines changed: 126 additions & 0 deletions

File tree

‎TestPlans/system/Klish_debugsh_cli/Klishdebugshcli.png‎

3.26 KB
Loading

‎TestPlans/system/Klish_debugsh_cli/SONIC_4_0_0_Klish_debugsh_cli_Testplan.md‎

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
# SQA Test Plan
2+
# Klish debugsh cli
3+
# SONiC 4.0.0 Release
4+
5+
## Test Plan Revision History
6+
7+
| Rev | Date | Author | Change Description |
8+
| ---- | ---------- | --------------- | ------------------ |
9+
| 0.1 | 5/31/2021 | Kesava Swamy K | Initial Version |
10+
| 0.2 | 6/3/2021 | Kesava Swamy K | Corrected the directory path and made changes as per update in HLD |
11+
12+
## List of Reviewers
13+
14+
| Function | Name |
15+
| :------: | :--: |
16+
| QA | Chandra Bhushan Singh |
17+
| DEV | Arun Barboza |
18+
19+
## List of Approvers
20+
21+
| Function | Name | Date Approved |
22+
| :------: | :--: | :-----------: |
23+
| | | |
24+
25+
## Definition/Abbreviation
26+
27+
| **Term** | **Meaning** |
28+
| -------- | -------------------------- |
29+
| | |
30+
31+
## Feature Overview
32+
33+
This feature provides the framework to execute debugsh CLI commands from sonic-cli/Klish Cli.
34+
35+
## 1 Test Focus Areas
36+
- This test plan covers the verification of execution of below debugsh CLI commands(mentioned in HLD) from sonic-cli. Under each command's help there may be multiple options and corresponding sub options. We cover the execution of each command with that main option and one or two sub options to that main option.
37+
- Test Script compares the output of the command form sonic-cli to that from Linux prompt/debugsh shell and reports the test result. <BR />
38+
sonic-cli# debug shell <BR />
39+
sonic-cli(debugsh)# show system internal <tab> <BR />
40+
sonic-cli(debugsh)# <BR />
41+
sonic-cli(debugsh)# show system internal vxlanmgr global <BR />
42+
<BR />
43+
VxlanHwCapability Enable <BR />
44+
Feature Capability: Vxlan(Enable) Vlan_Vni_Num(4096) <BR />
45+
<BR />
46+
============== Pending Request Count=============== <BR />
47+
tunnel_map:0 nvo:0 tunnel:0 vnet:0 <BR />
48+
sonic-cli(debugsh)# <BR />
49+
sonic-cli(debugsh)# debug system internal logger aclsvcd level info <BR />
50+
sonic-cli(debugsh)# <BR />
51+
sonic-cli(debugsh)# clear system internal vlan ifp <BR />
52+
sonic-cli(debugsh)# <BR />
53+
sonic-cli(debugsh)# timeout 2 <BR />
54+
sonic-cli(debugsh)# <BR />
55+
56+
## 2 Topologies
57+
58+
<span style="color:red"> </span>![Topology](Klishdebugshcli.png "Figure: Topology 1")
59+
60+
#### Topology 1
61+
62+
## 3 Test Case and objectives
63+
64+
### 3.1 Functional Test Cases
65+
66+
#### 3.1.1 Verification of command execution "show system internal <>" in debugsh shell in Klish CLI.
67+
68+
| **Test ID** | **debugsh_sonic_001** |
69+
| -------------- | :----------------------------------------------------------- |
70+
| **Test Name** | **Verification of command execution "show system internal <>" in debugsh shell in Klish CLI.** |
71+
| **Test Setup** | **Topology 1** |
72+
| **Type** | **Functional** |
73+
| **Steps** | 1. In Klish CLI, enter into "debugsh" shell and execute the command "show system internal <>" with each possible option and sub options. <BR /> 2. Check that command is executed successfully. <BR />3. Capture the output of each command. <BR />4. Execute the same commands in Linux CLI in debugsh mode and capture the output. <BR />5. Verify that outputs of each command is same in both Klish CLI and Linux CLI. <BR />6. Execute the command with invalid options and verify that command execution is rejected.|
74+
75+
#### 3.1.2 Verification of command execution "debug system internal <>" in debugsh shell in sonic-cli/Klish Cli.
76+
77+
| **Test ID** | **debugsh_sonic_002** |
78+
| -------------- | :----------------------------------------------------------- |
79+
| **Test Name** | **Verification of command execution "debug system internal <>" in debugsh shell in Klish CLI.** |
80+
| **Test Setup** | **Topology 1** |
81+
| **Type** | **Functional** |
82+
| **Steps** | 1. In Klish CLI, enter into "debugsh" shell and execute the command "debug system internal <>" with each possible option and sub options. <BR /> 2. Check that command is executed successfully. <BR />3. Capture the output of each command. <BR />4. Execute the same commands in Linux CLI in debugsh mode and capture the output. <BR />5. Verify that outputs of each command is same in both Klish CLI and Linux CLI. <BR />6. Execute the command with invalid options and verify that command execution is rejected.|
83+
84+
#### 3.1.3 Verification of command execution "clear system internal <>" in debughsh shell in Klish CLI.
85+
86+
| **Test ID** | **debugsh_sonic_003** |
87+
| -------------- | :----------------------------------------------------------- |
88+
| **Test Name** | **Verification of command execution "clear system internal <>" in debughsh shell in Klish CLI.** |
89+
| **Test Setup** | **Topology 1** |
90+
| **Type** | **Functional** |
91+
| **Steps** | 1. In Klish CLI, enter into "debugsh" shell and execute the command "clear system internal" with each possible option and sub options. <BR /> 2. Check that command is executed successfully. <BR />3. Capture the output of each command. <BR />5. Execute the same commands in Linux CLI in debugsh mode and capture the output. <BR />4. Verify that outputs of each command is same in both Klish CLI and Linux CLI. <BR />6. Execute the command with invalid options and verify that command execution is rejected.|
92+
93+
#### 3.1.4 Verification of command execution "show system internal debugsh backend cmdtree <>" in debugsh shell in Klish CLI.
94+
95+
| **Test ID** | **debugsh_sonic_004** |
96+
| -------------- | :----------------------------------------------------------- |
97+
| **Test Name** | **Verification of command execution "show system internal debugsh backend cmdtree <>" in debugsh shell in Klish CLI.** |
98+
| **Test Setup** | **Topology 1** |
99+
| **Type** | **Functional** |
100+
| **Steps** | 1. In Klish CLI, enter into "debugsh" shell and execute the command "show system internal debugsh backend cmdtree" with each possible option and sub options. <BR /> 2. Check that command is executed successfully. <BR />3. Capture the output of each command. <BR />4. Execute the same commands in Linux CLI in debugsh mode and capture the output. <BR />5. Verify that outputs of each command is same in both Klish CLI and Linux CLI. <BR />6. Execute the command with invalid options and verify that command execution is rejected.|
101+
102+
#### 3.1.5 Verification of command execution "timeout <1-180>" in debugsh shell in Klish CLI.
103+
104+
| **Test ID** | **debugsh_sonic_005** |
105+
| -------------- | :----------------------------------------------------------- |
106+
| **Test Name** | **Verification of command execution "timeout <1-180>" in debugsh shell in Klish CLI.** |
107+
| **Test Setup** | **Topology 1** |
108+
| **Type** | **Functional** |
109+
| **Steps** | 1. In Klish CLI, enter into "debugsh" shell and execute the command "timeout <1-180>" with each possible option and sub options. <BR /> 2. Check that command is executed successfully. <BR />3. Capture the output of each command. <BR />4. Execute the same commands in Linux CLI in debugsh mode and capture the output. <BR />5. Verify that outputs of each command is same in both Klish CLI and Linux CLI. <BR />6. Execute the command with invalid options and verify that command execution is rejected.|
110+
111+
### 3.4 Management
112+
113+
#### 3.4.1 REST
114+
115+
##### 3.4.1.1 Verify the debugsh supported commands via REST.
116+
117+
| **Test ID** | **debugsh_sonic_006** |
118+
| -------------- | ------------------------------------------------------------ |
119+
| **Test Name** | **Verify the debugsh supported commands via REST.** |
120+
| **Test Setup** | **Topology 1** |
121+
| **Type** | **Functional** |
122+
| **Steps** | This test case will be covered implicitly in REST run.|
123+
124+
## Reference Links
125+
HLD - https://github.com/BRCM-SONIC/sonic_doc_private/pull/205/files/a54e8812c2bdf59836ceaa44b0fbb510c88c79b4#diff-21787d9be61858381372a0833ded648ae10d5b79b4f54d88eeaf1c22e93e163d
126+

0 commit comments

Comments
 (0)