Improve pc and vlan test Doc (#35)

* fix typo

Signed-off-by: zhoudongxu <[email protected]>

* remove some unnecessary comments

Signed-off-by: zhoudongxu <[email protected]>

Author: zhoudongxu

doc/sai-ptf/config_data/config_t0.md

@@ -6,7 +6,10 @@
     - [VLAN Interfaces](#vlan-interfaces)
     - [Json config data](#json-config-data)
   - [Route Configuration](#route-configuration)
-    - [rotue entries](#rotue-entries)
+    - [VLAN interfaces route entries](#vlan-interfaces-route-entries)
+    - [VLAN Neighbors](#vlan-neighbors)
+    - [LAG Route entry](#lag-route-entry)
+    - [LAG Neighbors](#lag-neighbors)
   - [LAG configuration](#lag-configuration)
     - [LAG and LAG members](#lag-and-lag-members)
   - [FDB Configuration](#fdb-configuration)
@@ -89,30 +92,29 @@ Below is the sample config data in config_db.json
 
 ## Route Configuration
 
-### rotue entries
 
-VLAN interfaces route entries
-|VLAN ID | VLAN Member | NH IP | NH MAC|
-|-|-|-|-|
-|1000| Ethernet4-32 | 192.168.10.11 ~ 192.168.10.18 | 10:00:11:11:11:11 - 10:00:88:88:88:88 |
-|2000| Ethernet36-72 | 192.168.20.21 ~ 192.168.20.28 | 20:00:11:11:11:11 - 20:00:88:88:88:88 |
+### VLAN interfaces route entries
+|VLAN ID | VLAN Member | NH IP | 
+|-|-|-|
+|1000| Ethernet4-32 | 192.168.10.11 ~ 192.168.10.18 | 
+|2000| Ethernet36-72 | 192.168.20.21 ~ 192.168.20.28 | 
 
-VLAN Neighbors
+### VLAN Neighbors
 |Name|IP|dest_mac|
 |-|-|-|
 |vlan1000_nb1-nb8| 192.168.10.11 ~ 192.168.10.18 | 10:00:11:11:11:11 - 10:00:88:88:88:88|
 |vlan2000_nb1-nb8|192.168.20.21 ~ 192.168.20.28 |20:00:11:11:11:11 - 20:00:88:88:88:88 |
 
 
-LAG Route entry
+### LAG Route entry
 
 |DestIp|Next Hop |Next Hop ip|
 |-|-|-|
 |192.168.0.11-192.168.0.18|lag1:port17-18|192.168.0.11-192.168.0.18|
 |192.168.0.19|lag2:port19-20|192.168.0.19|
 |192.168.0.20|lag3:port21-22|192.168.0.20|
 
-LAG Neighbors
+### LAG Neighbors
 
 |Name|IP|dest_mac|
 |-|-|-|
@@ -139,4 +141,4 @@ The MAC Table for VLAN L2 forwarding as below
 |mac0|mac0-00:00:00:00:00:11|Port0||Ethernet0|
 |mac1-8  |00:11:11:11:11:11 - 00:88:88:88:88:88|Port1-8|1000|Ethernet4-Ethernet32|
 |mac9-16 |00:99:99:99:99:99 - 01:00:00:00:00:00|Port9-16|2000|Ethernet36-Ethernet64|
-|mac17-mac31 |01:11:11:11:11:11 - 03:11:11:11:11:11|Port17-31||Ethernet68-Ethernet124|
+|mac17-mac31 |01:11:11:11:11:11 - 01:ff:ff:ff:ff:ff|Port17-31||Ethernet68-Ethernet124|

doc/sai-ptf/lag_test_plan.md

@@ -10,13 +10,10 @@
     - [Case3: Change source_ip](#case3-change-source_ip)
     - [Case4: Change destinstion_ip](#case4-change-destinstion_ip)
     - [Case5: Change protocol](#case5-change-protocol)
-    - [Testing Objective](#testing-objective)
   - [Test Group: Disable Egress/Ingress](#test-group-disable-egressingress)
     - [Case6: Disable_egress](#case6-disable_egress)
     - [Case7: Disable_ingress](#case7-disable_ingress)
-    - [Testing Objective](#testing-objective-1)
   - [Test Case: Remove lag member](#test-case-remove-lag-member)
-    - [Testing Objective](#testing-objective-2)
 # Overriew
 The purpose of this test plan is to test the LAG/PortChannel function from SAI.
 
@@ -81,7 +78,7 @@ These cases will cover five scenarios: src/dst ip, src/dst port , protocol. cons
 ### Case5: Change protocol
 
 
-### Testing Objective
+### Testing Objective <!-- omit in toc --> 
 For load balancing, expecting the ports in a lag should receive the packet equally. Traffic direction: from server side to T1 side. 
 ### Test steps: <!-- omit in toc --> 
 Test steps:
@@ -102,7 +99,7 @@ Test steps:
 ### Case6: Disable_egress
 ### Case7: Disable_ingress
 
-### Testing Objective
+### Testing Objective <!-- omit in toc --> 
 These cases will cover two scenarios: disable egress and ingress.  We can disable ingress or egress on a lag member, then we expect traffic drop on the disabled lag member.
 
 ### Test steps: <!-- omit in toc --> 
@@ -113,7 +110,7 @@ Test steps:
 - Check if Packet drop on port20
 
 ## Test Case: Remove lag member
-### Testing Objective
+### Testing Objective <!-- omit in toc --> 
 These cases will cover lag memeber removement.  We can remove a lag member, then expect traffic drop on the lag member.
 
 ### Test steps: <!-- omit in toc --> 

doc/sai-ptf/vlan_test_plan.md

@@ -63,8 +63,6 @@ In this VLAN test, most of test case will be tested with Tagged or Untagged pack
 ### Testing Objective <!-- omit in toc --> 
 This test verifies the VLAN function around untag and access ports.
 
-**This test will cover tagged and untagged mode respectivily.**
-
 *p.s. This test will not check function with the native VLAN scenario. Please make sure the native VLAN will not impact the result.*
 
 With an untagged packet, on the access port, when ingress and egress happen, the behavior as below
@@ -97,7 +95,6 @@ Test Steps:
 
 Drop packet when the destination port from MAC table search is the port which packet come into the switch.
 
-**This test will cover tagged and untagged mode respectivily.**
 
 ```
 Test example(Untag):                                
@@ -124,7 +121,6 @@ Flooding
                                                              | Port8|
 ```
 
-**This test will cover tagged and untagged mode respectivily.**
 
 ### Test Steps: <!-- omit in toc --> 
   - Create ``Untagged``/``Tagged VLAN1000`` packet, with ``mac1`` as source MAC and a un-existing ``MacX`` as dest MAC
@@ -142,7 +138,6 @@ For mac learning in VLAN scenario, after learning the mac address from the packe
   pkt(Untag:DMAC=MAC1)  -> Port2:Access:VLAN1000-> Port1:Access:VLAN1000 -> pkt(Untag:DMAC=MAC1)
 
 ```
-**This test will cover tagged and untagged mode respectivily.**
 ### Test Steps: <!-- omit in toc --> 
   - Create ``Untagged``/``Tagged VLAN1000`` packet, with a un-existing ``MacX`` as src MAC and ``mac2`` as dest MAC
   - Send packet on a VLAN source port1.
@@ -180,7 +175,6 @@ When add a VLAN member to a non-exist VLAN, it will fail.
 ### Testing Objective <!-- omit in toc --> 
 
 For VLAN-related counters, SAI should be able to get the counter and clear them.
-**This test will cover tagged and untagged mode respectivily.**
 
 ### Test Steps: <!-- omit in toc --> 
 Steps:
@@ -198,7 +192,6 @@ Steps:
 ### Testing Objective <!-- omit in toc --> 
 Test the function when disabling VLAN MAC learning.
 When disabled, no new MAC will be learned in the MAC table.
-**This test will cover tagged and untagged mode respectivily.**
 
 ### Additional config: <!-- omit in toc --> 
 - Do not config the MAC table
@@ -222,7 +215,7 @@ Server To Server
                                               |L3| <-> |Virtual Switch| 
   PC2 <- pkt(Untag) <- |DUT|Port9:Access:VLAN2000
 ```
-*All the layer 3 router tables are created as the basic config, not MAC and ARP learning in this test process.*
+
 The process is as below:
 1. PC1 sends a untag packet to port1, which is a VLAN1000 access port
 2. Based on packet dest IP, derive the route to the dest IP, Dest MAC and Port derived from L3 table. Then SRC MAC change to Switch MAC, Dest MAC change to PORT MAC, forwarding to PORT9