Update Robot Framework format - step 1

[integration/test.git] / csit / libraries / PcepOperations.robot

diff --git a/csit/libraries/PcepOperations.robot b/csit/libraries/PcepOperations.robot
index 43f3a73ed24b3cea4e4f6dde5666f667d381880e..5b324bbfbcf488aa08b7a2105392718719ac1d10 100644 (file)
--- a/csit/libraries/PcepOperations.robot
+++ b/csit/libraries/PcepOperations.robot
@@ -1,27 +1,34 @@
 *** Settings ***
-Documentation     Robot keyword library (Resource) for performing PCEP operations via restconf calls.
+Documentation       Robot keyword library (Resource) for performing PCEP operations via restconf calls.
 ...
-...               Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
+...                 Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
 ...
-...               This program and the accompanying materials are made available under the
-...               terms of the Eclipse Public License v1.0 which accompanies this distribution,
-...               and is available at http://www.eclipse.org/legal/epl-v10.html
+...                 This program and the accompanying materials are made available under the
+...                 terms of the Eclipse Public License v1.0 which accompanies this distribution,
+...                 and is available at http://www.eclipse.org/legal/epl-v10.html
 ...
-...               TODO: Remove all old keywords, update pcepuser.robot accordingly
-...               TODO: Add new KWs, update all pcep tests to use them.
-Library           RequestsLibrary
-Library           norm_json.py
-Resource          ../variables/Variables.robot
-Resource          TemplatedRequests.robot
+...                 TODO: Remove all old keywords, update pcepuser.robot accordingly
+...                 TODO: Add new KWs, update all pcep tests to use them.
+
+Library             RequestsLibrary
+Library             norm_json.py
+Resource            ../variables/Variables.robot
+Resource            TemplatedRequests.robot
+
 
 *** Variables ***
-${PCEP_VAR_FOLDER}    ${CURDIR}/../variables/tcpmd5user
+${PCEP_VAR_FOLDER}      ${CURDIR}/../variables/tcpmd5user
+
 
 *** Keywords ***
 Setup_Pcep_Operations
     [Documentation]    Creates Requests session to be used by subsequent keywords.
     # Do not append slash at the end uf URL, Requests would add another, resulting in error.
-    Create_Session    pcep_session    http://${ODL_SYSTEM_IP}:${RESTCONFPORT}/rests/operations    headers=${HEADERS_XML}    auth=${AUTH}
+    Create_Session
+    ...    pcep_session
+    ...    http://${ODL_SYSTEM_IP}:${RESTCONFPORT}/rests/operations
+    ...    headers=${HEADERS_XML}
+    ...    auth=${AUTH}
 
 Teardown_Pcep_Operations
     [Documentation]    Teardown to pair with Setup (otherwise no-op).
@@ -29,43 +36,44 @@ Teardown_Pcep_Operations
     # Delete_Session    pcep_session
 
 Add_Xml_Lsp_Return_Json
-    [Arguments]    ${xml_data}
     [Documentation]    Instantiate LSP according to XML data and return response (json) text.
+    [Arguments]    ${xml_data}
     # Also no slash here
     ${response}=    Operate_Xml_Lsp_Return_Json    network-topology-pcep:add-lsp    ${xml_data}
-    [Return]    ${response}
+    RETURN    ${response}
 
 Update_Xml_Lsp_Return_Json
-    [Arguments]    ${xml_data}
     [Documentation]    Update LSP according to XML data and return response (json) text.
+    [Arguments]    ${xml_data}
     # Also no slash here
     ${response}=    Operate_Xml_Lsp_Return_Json    network-topology-pcep:update-lsp    ${xml_data}
-    [Return]    ${response}
+    RETURN    ${response}
 
 Remove_Xml_Lsp_Return_Json
-    [Arguments]    ${xml_data}
     [Documentation]    Remove LSP according to XML data and return response (json) text.
+    [Arguments]    ${xml_data}
     # Also no slash here
     ${response}=    Operate_Xml_Lsp_Return_Json    network-topology-pcep:remove-lsp    ${xml_data}
-    [Return]    ${response}
+    RETURN    ${response}
 
 Operate_Xml_Lsp_Return_Json
-    [Arguments]    ${uri_part}    ${xml_data}
     [Documentation]    Post XML data to given pcep-operations URI, check status_code is 200 and return response text (JSON).
+    [Arguments]    ${uri_part}    ${xml_data}
     ${response}=    RequestsLibrary.Post Request    pcep_session    ${uri_part}    data=${xml_data}
     Log    ${xml_data}
     Should Contain    ${ALLOWED_STATUS_CODES}    ${response.status_code}
-    [Return]    ${response.text}
+    RETURN    ${response.text}
 
 Pcep_Json_Is_Success
-    [Arguments]    ${text}
     [Documentation]    Given text should be equal to successfull json response.
+    [Arguments]    ${text}
     Should_Be_Equal_As_Strings    ${text}    {"output":{}}
 
 Pcep_Json_Is_Refused
-    [Arguments]    ${actual_raw}
     [Documentation]    Given text should be equal to json response when device refuses tunnel removal.
-    ${expected_raw}=    BuiltIn.Set_Variable    {"network-topology-pcep:output":{"error":[{"error-object":{"ignore":false,"processing-rule":false,"type":19,"value":9}}],"failure":"failed"}}
+    [Arguments]    ${actual_raw}
+    ${expected_raw}=    BuiltIn.Set_Variable
+    ...    {"network-topology-pcep:output":{"error":[{"error-object":{"ignore":false,"processing-rule":false,"type":19,"value":9}}],"failure":"failed"}}
     # TODO: Is that JSON worth referencing pcepuser variables from this library?
     ${expected_normalized}=    norm_json.normalize_json_text    ${expected_raw}
     ${actual_normalized}=    norm_json.normalize_json_text    ${actual_raw}
@@ -73,7 +81,13 @@ Pcep_Json_Is_Refused
     # TODO: Would the diff approach be more useful?
 
 Pcep_Topology_Precondition
-    [Arguments]    ${session}
     [Documentation]    Compare current pcep-topology to empty one.
     ...    Timeout is long enough to see that pcep is ready.
-    BuiltIn.Wait_Until_Keyword_Succeeds    300s    1s    TemplatedRequests.Get_As_Json_Templated    ${PCEP_VAR_FOLDER}/default_off    session=${session}    verify=True
+    [Arguments]    ${session}
+    BuiltIn.Wait_Until_Keyword_Succeeds
+    ...    300s
+    ...    1s
+    ...    TemplatedRequests.Get_As_Json_Templated
+    ...    ${PCEP_VAR_FOLDER}/default_off
+    ...    session=${session}
+    ...    verify=True