forked from sonic-net/sonic-buildimage
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request sonic-net#210 from BRCM-SONIC/testplan_debugsh_son…
…ic_cli Sonic 4.0.0 Klish debugsh cli TestPlan
- Loading branch information
Showing
2 changed files
with
126 additions
and
0 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
126 changes: 126 additions & 0 deletions
126
TestPlans/system/Klish_debugsh_cli/SONIC_4_0_0_Klish_debugsh_cli_Testplan.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,126 @@ | ||
| # SQA Test Plan | ||
| # Klish debugsh cli | ||
| # SONiC 4.0.0 Release | ||
|
|
||
| ## Test Plan Revision History | ||
|
|
||
| | Rev | Date | Author | Change Description | | ||
| | ---- | ---------- | --------------- | ------------------ | | ||
| | 0.1 | 5/31/2021 | Kesava Swamy K | Initial Version | | ||
| | 0.2 | 6/3/2021 | Kesava Swamy K | Corrected the directory path and made changes as per update in HLD | | ||
|
|
||
| ## List of Reviewers | ||
|
|
||
| | Function | Name | | ||
| | :------: | :--: | | ||
| | QA | Chandra Bhushan Singh | | ||
| | DEV | Arun Barboza | | ||
|
|
||
| ## List of Approvers | ||
|
|
||
| | Function | Name | Date Approved | | ||
| | :------: | :--: | :-----------: | | ||
| | | | | | ||
|
|
||
| ## Definition/Abbreviation | ||
|
|
||
| | **Term** | **Meaning** | | ||
| | -------- | -------------------------- | | ||
| | | | | ||
|
|
||
| ## Feature Overview | ||
|
|
||
| This feature provides the framework to execute debugsh CLI commands from sonic-cli/Klish Cli. | ||
|
|
||
| ## 1 Test Focus Areas | ||
| - 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. | ||
| - Test Script compares the output of the command form sonic-cli to that from Linux prompt/debugsh shell and reports the test result. <BR /> | ||
| sonic-cli# debug shell <BR /> | ||
| sonic-cli(debugsh)# show system internal <tab> <BR /> | ||
| sonic-cli(debugsh)# <BR /> | ||
| sonic-cli(debugsh)# show system internal vxlanmgr global <BR /> | ||
| <BR /> | ||
| VxlanHwCapability Enable <BR /> | ||
| Feature Capability: Vxlan(Enable) Vlan_Vni_Num(4096) <BR /> | ||
| <BR /> | ||
| ============== Pending Request Count=============== <BR /> | ||
| tunnel_map:0 nvo:0 tunnel:0 vnet:0 <BR /> | ||
| sonic-cli(debugsh)# <BR /> | ||
| sonic-cli(debugsh)# debug system internal logger aclsvcd level info <BR /> | ||
| sonic-cli(debugsh)# <BR /> | ||
| sonic-cli(debugsh)# clear system internal vlan ifp <BR /> | ||
| sonic-cli(debugsh)# <BR /> | ||
| sonic-cli(debugsh)# timeout 2 <BR /> | ||
| sonic-cli(debugsh)# <BR /> | ||
|
|
||
| ## 2 Topologies | ||
|
|
||
| <span style="color:red"> </span> | ||
|
|
||
| #### Topology 1 | ||
|
|
||
| ## 3 Test Case and objectives | ||
|
|
||
| ### 3.1 Functional Test Cases | ||
|
|
||
| #### 3.1.1 Verification of command execution "show system internal <>" in debugsh shell in Klish CLI. | ||
|
|
||
| | **Test ID** | **debugsh_sonic_001** | | ||
| | -------------- | :----------------------------------------------------------- | | ||
| | **Test Name** | **Verification of command execution "show system internal <>" in debugsh shell in Klish CLI.** | | ||
| | **Test Setup** | **Topology 1** | | ||
| | **Type** | **Functional** | | ||
| | **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.| | ||
|
|
||
| #### 3.1.2 Verification of command execution "debug system internal <>" in debugsh shell in sonic-cli/Klish Cli. | ||
|
|
||
| | **Test ID** | **debugsh_sonic_002** | | ||
| | -------------- | :----------------------------------------------------------- | | ||
| | **Test Name** | **Verification of command execution "debug system internal <>" in debugsh shell in Klish CLI.** | | ||
| | **Test Setup** | **Topology 1** | | ||
| | **Type** | **Functional** | | ||
| | **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.| | ||
|
|
||
| #### 3.1.3 Verification of command execution "clear system internal <>" in debughsh shell in Klish CLI. | ||
|
|
||
| | **Test ID** | **debugsh_sonic_003** | | ||
| | -------------- | :----------------------------------------------------------- | | ||
| | **Test Name** | **Verification of command execution "clear system internal <>" in debughsh shell in Klish CLI.** | | ||
| | **Test Setup** | **Topology 1** | | ||
| | **Type** | **Functional** | | ||
| | **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.| | ||
|
|
||
| #### 3.1.4 Verification of command execution "show system internal debugsh backend cmdtree <>" in debugsh shell in Klish CLI. | ||
|
|
||
| | **Test ID** | **debugsh_sonic_004** | | ||
| | -------------- | :----------------------------------------------------------- | | ||
| | **Test Name** | **Verification of command execution "show system internal debugsh backend cmdtree <>" in debugsh shell in Klish CLI.** | | ||
| | **Test Setup** | **Topology 1** | | ||
| | **Type** | **Functional** | | ||
| | **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.| | ||
|
|
||
| #### 3.1.5 Verification of command execution "timeout <1-180>" in debugsh shell in Klish CLI. | ||
|
|
||
| | **Test ID** | **debugsh_sonic_005** | | ||
| | -------------- | :----------------------------------------------------------- | | ||
| | **Test Name** | **Verification of command execution "timeout <1-180>" in debugsh shell in Klish CLI.** | | ||
| | **Test Setup** | **Topology 1** | | ||
| | **Type** | **Functional** | | ||
| | **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.| | ||
|
|
||
| ### 3.4 Management | ||
|
|
||
| #### 3.4.1 REST | ||
|
|
||
| ##### 3.4.1.1 Verify the debugsh supported commands via REST. | ||
|
|
||
| | **Test ID** | **debugsh_sonic_006** | | ||
| | -------------- | ------------------------------------------------------------ | | ||
| | **Test Name** | **Verify the debugsh supported commands via REST.** | | ||
| | **Test Setup** | **Topology 1** | | ||
| | **Type** | **Functional** | | ||
| | **Steps** | This test case will be covered implicitly in REST run.| | ||
|
|
||
| ## Reference Links | ||
| HLD - https://github.com/BRCM-SONIC/sonic_doc_private/pull/205/files/a54e8812c2bdf59836ceaa44b0fbb510c88c79b4#diff-21787d9be61858381372a0833ded648ae10d5b79b4f54d88eeaf1c22e93e163d | ||
|
|