--- /dev/null
+*** Settings ***
+Documentation TCPMD5 user-facing feature system tests, using PCEP.
+...
+... 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
+...
+...
+... The original brief description of this suite is at
+... https://wiki.opendaylight.org/view/TCPMD5:Lithium_Feature_Tests#How_to_test
+Suite Setup Set_It_Up
+Suite Teardown Tear_It_Down
+Test Setup FailFast.Fail_This_Fast_On_Previous_Error
+Test Teardown FailFast.Start_Failing_Fast_If_This_Failed
+Library OperatingSystem
+Library RequestsLibrary
+Library SSHLibrary prompt=]>
+Library String
+Library ${CURDIR}/../../../libraries/HsfJson/hsf_json.py
+Resource ${CURDIR}/../../../libraries/ConfigViaRestconf.robot
+Resource ${CURDIR}/../../../libraries/FailFast.robot
+Resource ${CURDIR}/../../../libraries/NexusKeywords.robot
+Resource ${CURDIR}/../../../libraries/PcepOperations.robot
+Resource ${CURDIR}/../../../libraries/WaitForFailure.robot
+Variables ${CURDIR}/../../../variables/Variables.py
+Variables ${CURDIR}/../../../variables/pcepuser/variables.py ${TOOLS_SYSTEM_IP}
+
+*** Variables ***
+${directory_for_actual_responses} ${TEMPDIR}${/}actual
+${directory_for_expected_responses} ${TEMPDIR}${/}expected
+${directory_with_template_folders} ${CURDIR}/../../../variables/tcpmd5user/
+
+*** Test Cases ***
+Topology_Precondition
+ [Documentation] Compare current pcep-topology to empty one.
+ ... Timeout is long enough to see that pcep is ready, with no PCC is connected.
+ [Tags] critical
+ BuiltIn.Wait_Until_Keyword_Succeeds 300 1 Compare_Topology ${off_json} 010_Precondition.json
+
+Start_Secure_Pcc_Mock
+ [Documentation] Execute pcc-mock on Mininet with password set, fail if pcc-mock promptly exits. Keep pcc-mock running for next test cases.
+ ${command}= NexusKeywords.Compose_Full_Java_Command -jar ${filename} --password topsecret --reconnect 1 --local-address ${TOOLS_SYSTEM_IP} --remote-address ${ODL_SYSTEM_IP} 2>&1 | tee pccmock.log
+ BuiltIn.Log ${command}
+ SSHLibrary.Write ${command}
+ Read_And_Fail_If_Prompt_Is_Seen
+
+Topology_Unauthorized_1
+ [Documentation] Try to catch a glimpse of pcc-mock in pcep-topology. Pass if no change from Precondition is detected over 1 minute.
+ [Tags] critical
+ WaitForFailure.Verify_Keyword_Does_Not_Fail_Within_Timeout 10s 1s Compare_Topology ${off_json} 020_Unauthorized_1.json
+
+Enable_Tcpmd5_No_Password_Yet
+ [Documentation] Send series of restconf puts derived from https://wiki.opendaylight.org/view/BGP_LS_PCEP:TCP_MD5_Guide#RESTCONF_Configuration
+ ... Every put should return empty text with allwed status code.
+ # No ${mapping_as_string} is given, as there are no placeholders present in the following folders.
+ ConfigViaRestconf.Put_Xml_Template_Folder_Config_Via_Restconf ${directory_with_template_folders}${/}key_access_module
+ ConfigViaRestconf.Put_Xml_Template_Folder_Config_Via_Restconf ${directory_with_template_folders}${/}key_access_service
+ ConfigViaRestconf.Put_Xml_Template_Folder_Config_Via_Restconf ${directory_with_template_folders}${/}md5_client_channel_module
+ ConfigViaRestconf.Put_Xml_Template_Folder_Config_Via_Restconf ${directory_with_template_folders}${/}md5_client_channel_service
+ ConfigViaRestconf.Put_Xml_Template_Folder_Config_Via_Restconf ${directory_with_template_folders}${/}md5_server_channel_module
+ ConfigViaRestconf.Put_Xml_Template_Folder_Config_Via_Restconf ${directory_with_template_folders}${/}md5_server_channel_service
+ ConfigViaRestconf.Put_Xml_Template_Folder_Config_Via_Restconf ${directory_with_template_folders}${/}pcep_client_channel_module
+ ConfigViaRestconf.Put_Xml_Template_Folder_Config_Via_Restconf ${directory_with_template_folders}${/}pcep_server_channel_module
+ # TODO: Is it worth changing ConfigViaRestconf to read ${directory_with_template_folders} variable by default?
+
+Check_For_Bug_3753_Via_Bug_4267
+ [Documentation] Check state of disptcher configuration module, apply workaround if needed.
+ ... This test case should not be failing, failure indicates Bug 3753 was not fixed enough yet.
+ ... For more details, see https://bugs.opendaylight.org/show_bug.cgi?id=4267#c2
+ ... As dispatcher configuration differs between Lithium and Beryllium, two checks and two workarounds are needed.
+ ${success}= BuiltIn.Run_Keyword_And_Return_Status ConfigViaRestconf.Verify_Json_Template_Folder_Config_Via_Restconf ${directory_with_template_folders}${/}pcep_dispatcher_module
+ BuiltIn.Pass_Execution_If ${success} Bug 4267 not present, Beryllium data.
+ ${success}= BuiltIn.Run_Keyword_And_Return_Status ConfigViaRestconf.Verify_Json_Template_Folder_Config_Via_Restconf ${directory_with_template_folders}${/}lithium_pcep_dispatcher_module
+ BuiltIn.Pass_Execution_If ${success} Bug 4267 not present, Lithium data.
+ ${success}= BuiltIn.Run_Keyword_And_Return_Status ConfigViaRestconf.Put_Xml_Template_Folder_Config_Via_Restconf ${directory_with_template_folders}${/}pcep_dispatcher_module
+ BuiltIn.Run_Keyword_If ${success} BuiltIn.Fail Bug 4267 present, Beryllium workaround successful.
+ ${success}= BuiltIn.Run_Keyword_And_Return_Status ConfigViaRestconf.Put_Xml_Template_Folder_Config_Via_Restconf ${directory_with_template_folders}${/}lithium_pcep_dispatcher_module
+ BuiltIn.Run_Keyword_If ${success} BuiltIn.Fail Bug 4267 present, Lithium workaround successful.
+ BuiltIn.Fail Bug 4267 probably present. No workaround succeeded, so Bug 4491 is probably present too.
+ [Teardown] FailFast.Do_Not_Start_Failing_If_This_Failed
+
+Topology_Unauthorized_2
+ [Documentation] The same logic as Topology_Unauthorized_1 as no password was provided to ODL.
+ [Tags] critical
+ WaitForFailure.Verify_Keyword_Does_Not_Fail_Within_Timeout 10s 1s Compare_Topology ${off_json} 030_Unauthorized_2.json
+
+Set_Wrong_Password
+ [Documentation] Configure password in pcep dispatcher for client with Mininet IP address.
+ ... This password does not match what pcc-mock uses.
+ ${password_line}= Construct_Password_Element_Line_Using_Password changeme
+ BuiltIn.Log ${password_line}
+ Replace_Password_Xml_Element_In_Pcep_Client_Module ${password_line}
+
+Topology_Unauthorized_3
+ [Documentation] The same logic as Topology_Unauthorized_1 as incorrect password was provided to ODL.
+ [Tags] critical
+ WaitForFailure.Verify_Keyword_Does_Not_Fail_Within_Timeout 10s 1s Compare_Topology ${off_json} 040_Unauthorized_3.json
+
+Set_Correct_Password
+ [Documentation] Configure password in pcep dispatcher for client with Mininet IP address.
+ ... This password finally matches what pcc-mock uses.
+ ${password_line}= Construct_Password_Element_Line_Using_Password topsecret
+ BuiltIn.Log ${password_line}
+ Replace_Password_Xml_Element_In_Pcep_Client_Module ${password_line}
+
+Topology_Intercondition
+ [Documentation] Compare pcep-topology to filled one, which includes a tunnel from pcc-mock.
+ BuiltIn.Wait_Until_Keyword_Succeeds 10s 1s Compare_Topology ${default_json} 050_Intercondition.json
+
+Update_Delegated
+ [Documentation] Perform update-lsp on the mocked tunnel, check response is success.
+ ${text}= PcepOperations.Update_Xml_Lsp_Return_Json ${update_delegated_xml}
+ Pcep_Json_Is_Success ${text}
+
+Topology_Updated
+ [Documentation] Compare pcep-topology to default_json, which includes the updated tunnel.
+ [Tags] critical
+ BuiltIn.Wait_Until_Keyword_succeeds 5s 1s Compare_Topology ${updated_json} 060_Topology_Updated.json
+
+Unset_Password
+ [Documentation] De-configure password for pcep dispatcher for client with Mininet IP address.
+ [Setup] FailFast.Run_Even_When_Failing_Fast
+ Replace_Password_Xml_Element_In_Pcep_Client_Module ${EMPTY}
+ FailFast.Do_Not_Fail_Fast_From_Now_On
+ # NOTE: It is still possible to remain failing, if both previous and this test failed.
+ [Teardown] FailFast.Do_Not_Start_Failing_If_This_Failed
+
+Topology_Unauthorized_4
+ [Documentation] Wait for pcep-topology to become empty again.
+ [Tags] critical
+ BuiltIn.Wait_Until_Keyword_Succeeds 10s 1s Compare_Topology ${offjson} 070_Unauthorized_4.json
+
+Stop_Pcc_Mock
+ [Documentation] Send ctrl+c to pcc-mock, fails if no prompt is seen
+ ... after 3 seconds (the default for SSHLibrary)
+ [Setup] FailFast.Run_Even_When_Failing_Fast
+ # FIXME: Bgpcepuser has Write_Ctrl_C keyword. Re-use it.
+ ${command}= BuiltIn.Evaluate chr(int(3))
+ BuiltIn.Log ${command}
+ SSHLibrary.Write ${command}
+ SSHLibrary.Read_Until_Prompt
+ FailFast.Do_Not_Fail_Fast_From_Now_On
+ # NOTE: It is still possible to remain failing, if both previous and this test failed.
+ [Teardown] FailFast.Do_Not_Start_Failing_If_This_Failed
+
+Topology_Postcondition
+ [Documentation] Verify that pcep-topology stays empty.
+ [Tags] critical
+ WaitForFailure.Verify_Keyword_Does_Not_Fail_Within_Timeout 10 1 Compare_Topology ${offjson} 080_Postcondition.json
+ # FIXME: We should delete config changes to not affect next suite.
+
+*** Keywords ***
+Set_It_Up
+ [Documentation] Create SSH session to Mininet machine, prepare HTTP client session to Controller.
+ ... Figure out latest pcc-mock version and download it from Nexus to Mininet.
+ ... Also, delete and create directories for json diff handling.
+ NexusKeywords.Initialize_Artifact_Deployment_And_Usage
+ ${current_connection}= SSHLibrary.Get_Connection
+ ${current_prompt}= BuiltIn.Set_Variable ${current_connection.prompt}
+ BuiltIn.Log ${current_prompt}
+ BuiltIn.Set_Suite_Variable ${prompt} ${current_prompt}
+ RequestsLibrary.Create_Session ses http://${ODL_SYSTEM_IP}:${RESTCONFPORT}${OPERATIONAL_TOPO_API} auth=${AUTH}
+ ${name}= NexusKeywords.Deploy_Test_Tool bgpcep pcep-pcc-mock
+ BuiltIn.Set_Suite_Variable ${filename} ${name}
+ OperatingSystem.Remove_Directory ${directory_for_expected_responses} recursive=True
+ OperatingSystem.Remove_Directory ${directory_for_actual_responses} recursive=True
+ # The previous suite may have been using the same directories.
+ OperatingSystem.Create_Directory ${directory_for_expected_responses}
+ OperatingSystem.Create_Directory ${directory_for_actual_responses}
+ ConfigViaRestconf.Setup_Config_Via_Restconf
+ PcepOperations.Setup_Pcep_Operations
+ FailFast.Do_Not_Fail_Fast_From_Now_On
+
+Tear_It_Down
+ [Documentation] Download pccmock.log and Log its contents.
+ ... Compute and Log the diff between expected and actual normalized responses.
+ ... Close both HTTP client session and SSH connection to Mininet.
+ SSHLibrary.Get_File pccmock.log
+ ${pccmocklog}= OperatingSystem.Run cat pccmock.log
+ BuiltIn.Log ${pccmocklog}
+ ${diff}= OperatingSystem.Run diff -dur ${directory_for_expected_responses} ${directory_for_actual_responses}
+ BuiltIn.Log ${diff}
+ PcepOperations.Teardown_Pcep_Operations
+ ConfigViaRestconf.Teardown_Config_Via_Restconf
+ RequestsLibrary.Delete_All_Sessions
+ SSHLibrary.Close_All_Connections
+
+Read_And_Fail_If_Prompt_Is_Seen
+ [Documentation] Try to read SSH to see prompt, but expect to see no prompt within SSHLibrary's timeout.
+ BuiltIn.Run_Keyword_And_Expect_Error No match found for '${prompt}' in *. Read_Text_Before_Prompt
+
+Read_Text_Before_Prompt
+ [Documentation] Log text gathered by SSHLibrary.Read_Until_Prompt.
+ ... This needs to be a separate keyword just because how Read_And_Fail_If_Prompt_Is_Seen is implemented.
+ ${text}= SSHLibrary.Read_Until_Prompt
+ BuiltIn.Log ${text}
+
+Compare_Topology
+ [Arguments] ${expected} ${name}
+ [Documentation] Get current pcep-topology as json, normalize both expected and actual json.
+ ... Save normalized jsons to files for later processing.
+ ... Error codes and normalized jsons should match exactly.
+ # FIXME: See bgpuser to move handling of expected outside WUKS loop, as in bgpuser suite.
+ ${normexp}= hsf_json.Hsf_Json ${expected}
+ BuiltIn.Log ${normexp}
+ OperatingSystem.Create_File ${directory_for_expected_responses}${/}${name} ${normexp}
+ ${resp}= RequestsLibrary.Get_Request ses topology/pcep-topology
+ BuiltIn.Log ${resp}
+ BuiltIn.Log ${resp.text}
+ ${normresp}= hsf_json.Hsf_Json ${resp.text}
+ BuiltIn.Log ${normresp}
+ OperatingSystem.Create_File ${directory_for_actual_responses}${/}${name} ${normresp}
+ BuiltIn.Should_Be_Equal_As_Strings ${resp.status_code} 200
+ BuiltIn.Should_Be_Equal ${normresp} ${normexp}
+
+Construct_Password_Element_Line_Using_Password
+ [Arguments] ${password}
+ [Documentation] Return line with password XML element containing given password, whitespace is there so that data to send looks neat.
+ ${element}= String.Replace_String ${SPACE}${SPACE}<password>$PASSWORD</password>${\n} $PASSWORD ${password}
+ BuiltIn.Log ${element}
+ [Return] ${element}
+
+Replace_Password_Xml_Element_In_Pcep_Client_Module
+ [Arguments] ${password_element}
+ [Documentation] Send restconf PUT to replace the config module specifying PCEP password element (may me empty=missing).
+ ${mapping_as_string}= BuiltIn.Set_Variable {'IP': '${TOOLS_SYSTEM_IP}', 'PASSWD': '''${password_element}'''}
+ BuiltIn.Log ${mapping_as_string}
+ ConfigViaRestconf.Put_Xml_Template_Folder_Config_Via_Restconf ${directory_with_template_folders}${/}pcep_topology_client_module ${mapping_as_string}
[Tags] critical
WaitForFailure.Verify_Keyword_Does_Not_Fail_Within_Timeout 10s 1s Compare_Topology ${off_json} 020_Unauthorized_1.json
-Enable_Tcpmd5_No_Password_Yet
- [Documentation] Send series of restconf puts derived from https://wiki.opendaylight.org/view/BGP_LS_PCEP:TCP_MD5_Guide#RESTCONF_Configuration
- ... Every put should return empty text with allwed status code.
- # No ${mapping_as_string} is given, as there are no placeholders present in the following folders.
- ConfigViaRestconf.Put_Xml_Template_Folder_Config_Via_Restconf ${directory_with_template_folders}${/}key_access_module
- ConfigViaRestconf.Put_Xml_Template_Folder_Config_Via_Restconf ${directory_with_template_folders}${/}key_access_service
- ConfigViaRestconf.Put_Xml_Template_Folder_Config_Via_Restconf ${directory_with_template_folders}${/}md5_client_channel_module
- ConfigViaRestconf.Put_Xml_Template_Folder_Config_Via_Restconf ${directory_with_template_folders}${/}md5_client_channel_service
- ConfigViaRestconf.Put_Xml_Template_Folder_Config_Via_Restconf ${directory_with_template_folders}${/}md5_server_channel_module
- ConfigViaRestconf.Put_Xml_Template_Folder_Config_Via_Restconf ${directory_with_template_folders}${/}md5_server_channel_service
- ConfigViaRestconf.Put_Xml_Template_Folder_Config_Via_Restconf ${directory_with_template_folders}${/}pcep_client_channel_module
- ConfigViaRestconf.Put_Xml_Template_Folder_Config_Via_Restconf ${directory_with_template_folders}${/}pcep_server_channel_module
- # TODO: Is it worth changing ConfigViaRestconf to read ${directory_with_template_folders} variable by default?
-
-Check_For_Bug_3753_Via_Bug_4267
- [Documentation] Check state of disptcher configuration module, apply workaround if needed.
- ... This test case should not be failing, failure indicates Bug 3753 was not fixed enough yet.
- ... For more details, see https://bugs.opendaylight.org/show_bug.cgi?id=4267#c2
- ... As dispatcher configuration differs between Lithium and Beryllium, two checks and two workarounds are needed.
- ${success}= BuiltIn.Run_Keyword_And_Return_Status ConfigViaRestconf.Verify_Json_Template_Folder_Config_Via_Restconf ${directory_with_template_folders}${/}pcep_dispatcher_module
- BuiltIn.Pass_Execution_If ${success} Bug 4267 not present, Beryllium data.
- ${success}= BuiltIn.Run_Keyword_And_Return_Status ConfigViaRestconf.Verify_Json_Template_Folder_Config_Via_Restconf ${directory_with_template_folders}${/}lithium_pcep_dispatcher_module
- BuiltIn.Pass_Execution_If ${success} Bug 4267 not present, Lithium data.
- ${success}= BuiltIn.Run_Keyword_And_Return_Status ConfigViaRestconf.Put_Xml_Template_Folder_Config_Via_Restconf ${directory_with_template_folders}${/}pcep_dispatcher_module
- BuiltIn.Run_Keyword_If ${success} BuiltIn.Fail Bug 4267 present, Beryllium workaround successful.
- ${success}= BuiltIn.Run_Keyword_And_Return_Status ConfigViaRestconf.Put_Xml_Template_Folder_Config_Via_Restconf ${directory_with_template_folders}${/}lithium_pcep_dispatcher_module
- BuiltIn.Run_Keyword_If ${success} BuiltIn.Fail Bug 4267 present, Lithium workaround successful.
- BuiltIn.Fail Bug 4267 probably present. No workaround succeeded, so Bug 4491 is probably present too.
- [Teardown] FailFast.Do_Not_Start_Failing_If_This_Failed
-
Topology_Unauthorized_2
[Documentation] The same logic as Topology_Unauthorized_1 as no password was provided to ODL.
[Tags] critical
Code Review / integration / test.git / commitdiff