aligned and updated the Documentation part for some of the test cases

Change-Id: Ic1d8369cdbb4d416fbe0bde6e730dc77031edbf4
Signed-off-by: vidya sathyanarayanachar <s.vidya990@gmail.com>

diff --git a/csit/suites/genius/01_Interface_manager.robot b/csit/suites/genius/01_Interface_manager.robot
index 425e958edb85064118e728c4832713dbfa477d87..cb400ad4fca2caee2870e51600ed5a0f51a945e8 100644 (file)
--- a/csit/suites/genius/01_Interface_manager.robot
+++ b/csit/suites/genius/01_Interface_manager.robot
@@ -127,7 +127,7 @@ table entry
     should contain    ${result}    goto_table:50
 
 no table0 entry
-    [Documentation]    after Deleting trunk interface , checking for absence of table 0 in the flow dumps
+    [Documentation]    After Deleting trunk interface, checking for absence of table 0 in the flow dumps
     switch connection    ${conn_id_1}
     ${bridgename}    set variable    BR1
     ${ovs-check}    execute command    sudo ovs-ofctl -O OpenFlow13 dump-flows ${bridgename}
@@ -137,7 +137,7 @@ no table0 entry
 
 no goto_table entry
     [Arguments]    ${table-id}
-    [Documentation]    cchecks for absence of no goto_table afetr unbinding the service on the interface.
+    [Documentation]    Checks for absence of no goto_table after unbinding the service on the interface.
     switch connection    ${conn_id_1}
     ${ovs-check1}    execute command    sudo ovs-ofctl -O OpenFlow13 dump-flows ${bridgename}
     Log    ${ovs-check1}
@@ -145,7 +145,7 @@ no goto_table entry
 
 table0 entry
     [Arguments]    ${connection-id}    ${bridgename}
-    [Documentation]    after Deleting trunk interface , checking for absence of table 0 in the flow dumps
+    [Documentation]    After Creating the trunk interface , checking for  table 0 entry exist in the flow dumps
     switch connection    ${connection-id}
     log    switch connection
     ${ovs-check}    execute command    sudo ovs-ofctl -O OpenFlow13 dump-flows ${bridgename}
@@ -155,6 +155,7 @@ table0 entry
 
 ovs check for member interface creation
     [Arguments]    ${connection-id}    ${bridgename}
+    [Documentation]    This keyword verifies the member interface created on OVS by checking the table0 ,vlan and action=pop_vlan entries    
     switch connection    ${connection-id}
     ${ovs-check}    execute command    sudo ovs-ofctl -O OpenFlow13 dump-flows ${bridgename}
     log    ${ovs-check}
@@ -164,6 +165,7 @@ ovs check for member interface creation
 
 Create Interface
     [Arguments]    ${json_file}    ${interface_mode}
+    [Documentation]    Creates an trunk/transparent interface based on input provided to the json body                           
     ${body}    OperatingSystem.Get File    ${genius_config_dir}/${json_file}
     log    ${genius_config_dir}/${json_file}
     ${body}    replace string    ${body}    "l2vlan-mode":"trunk"    "l2vlan-mode":"${interface_mode}"

diff --git a/csit/suites/genius/02_ID_manager.robot b/csit/suites/genius/02_ID_manager.robot
index f7be69be1117bc2d8cffeb73b57f2edc74ce01a5..285e81b9380528d033595f0b3e7d005a9135fa7d 100644 (file)
--- a/csit/suites/genius/02_ID_manager.robot
+++ b/csit/suites/genius/02_ID_manager.robot
@@ -47,6 +47,7 @@ Neg_Allocate ids of size 10 from the same pool
     should be equal as strings    ${resp.status_code}    500
 
 Allocate IDs of size 3 from the pool
+    [Documentation]    This testcase allocates 3 Ids from the created pool in test case 1 
     ${body}    OperatingSystem.Get File    ${genius_config_dir}/${allocaterange_json}
     ${body}    replace string    ${body}    test-key    ${test_keys[2]}
     ${body}    replace string    ${body}    5    3
@@ -58,6 +59,7 @@ Allocate IDs of size 3 from the pool
     Should Be Equal As Strings    ${get_resp.status_code}    200
 
 Release a block of IDs allocated using releaseIds RPC
+    [Documentation]    This testcase Releases the block of Ids by using the key which is sent in json.
     ${body}    OperatingSystem.Get File    ${genius_config_dir}/releaseIds.json
     log    ${body}
     ${body}    replace string    ${body}    test-key    ${test_keys[2]}
@@ -74,6 +76,7 @@ Release a block of IDs allocated using releaseIds RPC
     log    ${released_ids}
 
 Delete the ID Pool using deleteIdPool RPC
+    [Documentation]    This testcase deletes the ID pool craeted in the 1st testcase.
     ${body}    OperatingSystem.Get File    ${genius_config_dir}/deleteIdPool.json
     ${body}    replace string    ${body}    poolname    ${pool-name}
     log    ${body}
@@ -82,6 +85,7 @@ Delete the ID Pool using deleteIdPool RPC
 
 *** Keywords ***
 get Id pool
+    [Documentation]    This keyword checks the created ID pool by doing GET.
     ${get_resp}    RequestsLibrary.Get Request    session    ${CONFIG_API}/id-manager:id-pools/id-pool/${pool-name}/available-ids-holder/    headers=${ACCEPT_XML}
     Log    ${get_resp.content}
     Should Contain    ${get_resp.content}    14

diff --git a/csit/suites/genius/03_Configure_ITM.robot b/csit/suites/genius/03_Configure_ITM.robot
index e1c2525d3697f9954d418aa08ae03a47e82ad9bb..4f837ce94325105d69dad932a08ea2d01ce013ab 100644 (file)
--- a/csit/suites/genius/03_Configure_ITM.robot
+++ b/csit/suites/genius/03_Configure_ITM.robot
@@ -189,7 +189,7 @@ Create VTEP - Vlan and Gateway
     Log    ${resp.content}
 
 Delete VTEP -Vlan and gateway
-    [Documentation]    This Delete testcase deletes the ITM tunnel created between 2 dpns.
+    [Documentation]    This testcase deletes the ITM tunnel created between 2 dpns.
     Remove All Elements At URI And Verify    ${CONFIG_API}/itm:transport-zones/transport-zone/${itm_created[0]}/
     Wait Until Keyword Succeeds    40    10    Verify Data Base after Delete    ${Dpn_id_1}    ${Dpn_id_2}    ${tunnel-5}
     ...    ${tunnel-6}
@@ -251,7 +251,7 @@ Validate interface state
 
 Check Table0 Entry for 2 Dpn
     [Arguments]    ${connection_id}    ${Bridgename}    ${port-num1}
-    [Documentation]    Checks the Table 0 entry in the OVS when flows are dumped in it.
+    [Documentation]    Checks the Table 0 entry in the OVS when flows are dumped.
     Switch Connection    ${connection_id}
     Log    ${connection_id}
     ${check}    Execute Command    sudo ovs-ofctl -O OpenFlow13 dump-flows ${Bridgename}
@@ -316,6 +316,7 @@ set json
 
 check-Tunnel-delete-on-ovs
     [Arguments]    ${connection-id}    ${tunnel}
+    [Documentation]    Verifies the Tunnel is deleted from OVS
     Log    ${tunnel}
     Switch Connection    ${connection-id}
     Log    ${connection-id}
@@ -326,6 +327,7 @@ check-Tunnel-delete-on-ovs
 
 check interface status
     [Arguments]    ${tunnel}    ${dpid}
+    [Documentation]    Verifies the operational state of the interface .
     ${resp}    RequestsLibrary.Get Request    session    ${OPERATIONAL_API}/ietf-interfaces:interfaces-state/interface/${tunnel}/    headers=${ACCEPT_XML}
     Log    ${OPERATIONAL_API}/ietf-interfaces:interfaces-state/interface/${tunnel}/
     Log    ${resp.content}
@@ -343,6 +345,7 @@ check interface status
 
 Verify Data Base after Delete
     [Arguments]    ${Dpn_id_1}    ${Dpn_id_2}    ${tunnel-1}    ${tunnel-2}
+    [Documentation]    Verifies the config database after the Tunnel deletion is done.
     ${type}    set variable    odl-interface:tunnel-type-vxlan
     No Content From URI    session    ${CONFIG_API}/itm-state:tunnel-list/internal-tunnel/${Dpn_id_1}/${Dpn_id_2}/${type}/    headers=${ACCEPT_XML}
     No Content From URI    session    ${CONFIG_API}/itm-state:tunnel-list/internal-tunnel/${Dpn_id_2}/${Dpn_id_1}/${type}/    headers=${ACCEPT_XML}