... terms of the Eclipse Public License v1.0 which accompanies this distribution,
... and is available at http://www.eclipse.org/legal/epl-v10.html
...
+... Test suite performs basic pcep md5 password authorization test cases:
+... (Run entire basic PCEP suite without passwords.)
+... Start pcc-mock (reconnecting mode): 1 pcc, 1 lsp, password set, check pcep-topology stays empty.
+... Use restconf to change PCEP configuration to use a wrong password, check pcep-topology stays empty.
+... Change ODL PCEP configuration to use the correct password, check pcep-topology shows the lsp.
+... Stop pcc-mock, check pcep-topology stays empty.
+... Start pcc-mock with new password, check pcep-topology stays empty.
+... Change ODL PCEP configuration to use the correct password, check pcep-topology shows the lsp.
+... Update the lsp, check a change in pcep-topology.
+... Change ODL PCEP configuration to not use password, pcep-topology empties, kill pcep-pcc-mock.
...
-... The original brief description of this suite is at
-... https://wiki.opendaylight.org/view/TCPMD5:Lithium_Feature_Tests#How_to_test
+... Test cases no longer need netconf-connector-ssh, and they include comparison of
+... pcep-session-state.
Suite Setup Set_It_Up
Suite Teardown Tear_It_Down
Test Setup FailFast.Fail_This_Fast_On_Previous_Error
Library OperatingSystem
Library RequestsLibrary
Library SSHLibrary prompt=]>
-Library String
-Library ${CURDIR}/../../../libraries/norm_json.py
-Resource ${CURDIR}/../../../libraries/FailFast.robot
-Resource ${CURDIR}/../../../libraries/KarafKeywords.robot
-Resource ${CURDIR}/../../../libraries/NexusKeywords.robot
-Resource ${CURDIR}/../../../libraries/PcepOperations.robot
-Resource ${CURDIR}/../../../libraries/TemplatedRequests.robot
-Resource ${CURDIR}/../../../libraries/WaitForFailure.robot
-Variables ${CURDIR}/../../../variables/Variables.py
-Variables ${CURDIR}/../../../variables/pcepuser/variables.py ${TOOLS_SYSTEM_IP}
+Resource ../../../libraries/CompareStream.robot
+Resource ../../../libraries/FailFast.robot
+Resource ../../../libraries/KarafKeywords.robot
+Resource ../../../libraries/NexusKeywords.robot
+Resource ../../../libraries/TemplatedRequests.robot
+Resource ../../../libraries/RemoteBash.robot
+Resource ../../../libraries/WaitForFailure.robot
+Resource ../../../variables/Variables.robot
*** Variables ***
-${directory_for_actual_responses} ${TEMPDIR}${/}actual
-${directory_for_expected_responses} ${TEMPDIR}${/}expected
-${directory_with_template_folders} ${CURDIR}/../../../variables/tcpmd5user/
-${CONNECTOR_FEATURE} odl-netconf-connector-all
+${DIR_WITH_TEMPLATES} ${CURDIR}/../../../variables/tcpmd5user/
+${CONFIG_SESSION} session
+${OLD_ERROR_ARGS} \n"last-received-error": {},\n"last-sent-error": {},
+${NEW_ERROR_ARGS} ${EMPTY}
*** 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.
+ ... Timeout is long enough to see that pcep is ready, with no PCC connected.
[Tags] critical
- BuiltIn.Wait_Until_Keyword_Succeeds 300 1 Compare_Topology ${off_json} 010_Precondition.json
+ BuiltIn.Wait_Until_Keyword_Succeeds 300s 1s TemplatedRequests.Get_As_Json_Templated ${DIR_WITH_TEMPLATES}${/}default_off session=${CONFIG_SESSION} verify=True
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
+ Start_Pcc_Mock_Tool_With_Password password=topsecret
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.
+ [Documentation] Try to catch a glimpse of pcc-mock in pcep-topology. Pass if no change from Precondition is detected over 10 seconds.
[Tags] critical
- WaitForFailure.Verify_Keyword_Does_Not_Fail_Within_Timeout 10s 1s Compare_Topology ${off_json} 020_Unauthorized_1.json
+ WaitForFailure.Verify_Keyword_Does_Not_Fail_Within_Timeout 10s 1s Test_Unauthorized
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}
+ Replace_Password_On_Pcep_Node password=changeme
Topology_Unauthorized_2
[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
+ WaitForFailure.Verify_Keyword_Does_Not_Fail_Within_Timeout 10s 1s Test_Unauthorized
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}
+ Replace_Password_On_Pcep_Node password=topsecret
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
+ [Documentation] Compare pcep-topology/path-computation-client to filled one, which includes a tunnel from pcc-mock.
+ &{mapping} BuiltIn.Create_Dictionary IP=${TOOLS_SYSTEM_IP} CODE=${pcc_name_code} NAME=${pcc_name} IP_ODL=${ODL_SYSTEM_IP} ERRORS=${ERROR_ARGS}
+ BuiltIn.Wait_Until_Keyword_Succeeds 30s 1s TemplatedRequests.Get_As_Json_Templated ${DIR_WITH_TEMPLATES}${/}default_on_state ${mapping} ${CONFIG_SESSION}
+ ... verify=True
+
+Stop_Pcc_Mock_1
+ [Documentation] Stops First instance of pcc-mock.
+ [Setup] FailFast.Run_Even_When_Failing_Fast
+ Stop_Pcc_Mock_Tool
+ 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_3
+ [Documentation] The same logic as Topology_Unauthorized_1, with no pcc-mock running.
+ [Tags] critical
+ BuiltIn.Wait_Until_Keyword_Succeeds 10s 1s Test_Unauthorized
+
+Start_Secure_Pcc_Mock_2
+ [Documentation] Execute pcc-mock on Mininet with new password set, fail if pcc-mock promptly exits. Keep pcc-mock running for next test cases.
+ Start_Pcc_Mock_Tool_With_Password password=newtopsecret
+
+Topology_Unauthorized_4
+ [Documentation] The same logic as Topology_Unauthorized_1, but ODL password became incorrect with new pcc-mock running.
+ [Tags] critical
+ WaitForFailure.Verify_Keyword_Does_Not_Fail_Within_Timeout 10s 1s Test_Unauthorized
+
+Set_Correct_Password_2
+ [Documentation] Configure password in pcep dispatcher for client with Mininet IP address.
+ ... This password again matches what second pcc-mock instance uses.
+ Replace_Password_On_Pcep_Node password=newtopsecret
+
+Topology_Intercondition_2
+ [Documentation] Compare pcep-topology/path-computation-client to filled one, which includes a tunnel from pcc-mock.
+ &{mapping} BuiltIn.Create_Dictionary IP=${TOOLS_SYSTEM_IP} CODE=${pcc_name_code} NAME=${pcc_name} IP_ODL=${ODL_SYSTEM_IP} ERRORS=${ERROR_ARGS}
+ BuiltIn.Wait_Until_Keyword_Succeeds 30s 1s TemplatedRequests.Get_As_Json_Templated ${DIR_WITH_TEMPLATES}${/}default_on_state ${mapping} ${CONFIG_SESSION}
+ ... verify=True
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}
+ &{mapping} BuiltIn.Create_Dictionary IP=${TOOLS_SYSTEM_IP} NAME=${pcc_name}
+ ${response}= TemplatedRequests.Post_As_Xml_Templated ${DIR_WITH_TEMPLATES}${/}update_delegated ${mapping} ${CONFIG_SESSION} verify=True
+ Log ${response}
Topology_Updated
- [Documentation] Compare pcep-topology to default_json, which includes the updated tunnel.
+ [Documentation] Compare pcep-topology/path-computation-client to default_on_updated, which includes the updated tunnel.
[Tags] critical
- BuiltIn.Wait_Until_Keyword_succeeds 5s 1s Compare_Topology ${updated_json} 060_Topology_Updated.json
+ &{mapping} BuiltIn.Create_Dictionary IP=${TOOLS_SYSTEM_IP} CODE=${pcc_name_code} NAME=${pcc_name} IP_ODL=${ODL_SYSTEM_IP} ERRORS=${ERROR_ARGS}
+ BuiltIn.Wait_Until_Keyword_Succeeds 30s 1s TemplatedRequests.Get_As_Json_Templated ${DIR_WITH_TEMPLATES}${/}default_on_updated_state ${mapping} ${CONFIG_SESSION}
+ ... verify=True
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}
+ Unset_Password_On_Pcep_Node
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_3
+Topology_Unauthorized_5
[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
+ BuiltIn.Wait_Until_Keyword_Succeeds 10s 1s Test_Unauthorized
-Stop_Pcc_Mock
- [Documentation] Send ctrl+c to pcc-mock, fails if no prompt is seen
- ... after 3 seconds (the default for SSHLibrary)
+Stop_Pcc_Mock_2
+ [Documentation] Stops second instance of pcc-mock
[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
+ Stop_Pcc_Mock_Tool
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.
+ WaitForFailure.Verify_Keyword_Does_Not_Fail_Within_Timeout 10s 1s Test_Unauthorized
+
+Delete_Pcep_Client_Module
+ [Documentation] Delete Pcep client module.
+ &{mapping} BuiltIn.Create_Dictionary IP=${TOOLS_SYSTEM_IP}
+ TemplatedRequests.Delete_Templated ${DIR_WITH_TEMPLATES}${/}pcep_topology_node ${mapping}
*** Keywords ***
Set_It_Up
... Also, delete and create directories for json diff handling.
KarafKeywords.Setup_Karaf_Keywords
TemplatedRequests.Create_Default_Session
- BuiltIn.Run_Keyword_If """${USE_NETCONF_CONNECTOR}""" == """False""" Install_Netconf_Connector
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}
+ RequestsLibrary.Create_Session ${CONFIG_SESSION} http://${ODL_SYSTEM_IP}:${RESTCONFPORT} 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}
- PcepOperations.Setup_Pcep_Operations
+ #Setting Pcc Name and its code for mapping for templates
+ BuiltIn.Set_Suite_Variable ${pcc_name} pcc_${TOOLS_SYSTEM_IP}_tunnel_1
+ ${code}= Evaluate binascii.b2a_base64('${pcc_name}')[:-1] modules=binascii
+ BuiltIn.Set_Suite_Variable ${pcc_name_code} ${code}
FailFast.Do_Not_Fail_Fast_From_Now_On
+ ${ERROR_ARGS} = CompareStream.Set_Variable_If_At_Least_Neon ${NEW_ERROR_ARGS} ${OLD_ERROR_ARGS}
+ BuiltIn.Set_Suite_Variable ${ERROR_ARGS}
Tear_It_Down
[Documentation] Download pccmock.log and Log its contents.
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
- BuiltIn.Run_Keyword_If """${USE_NETCONF_CONNECTOR}""" == """False""" Uninstall_Netconf_Connector
RequestsLibrary.Delete_All_Sessions
SSHLibrary.Close_All_Connections
-Install_Netconf_Connector
- [Documentation] Installs ${CONNECTOR_FEATURE} feature.
- # During the netconf connector installation the karaf's ssh is restarted and connection to karaf console is droped. This is causing an error
- # which is ignored, because the feature should be installed anyway.
- ${status} ${results} = BuiltIn.Run_Keyword_And_Ignore_Error KarafKeywords.Install_A_Feature ${CONNECTOR_FEATURE}
- BuiltIn.Log ${results}
- BuiltIn.Wait_Until_Keyword_Succeeds 240 3 Check_Netconf_Up_And_Running
-
-Check_Netconf_Up_And_Running
- [Documentation] Make a request to netconf connector's mounted pcep module and expect it is mounted.
- TemplatedRequests.Get_From_Uri restconf/config/network-topology:network-topology/topology/topology-netconf/node/controller-config/yang-ext:mount/config:modules/module/odl-pcep-topology-provider-cfg:pcep-topology-provider/pcep-topology
-
-Uninstall_Netconf_Connector
- [Documentation] Uninstalls ${CONNECTOR_FEATURE} feature.
- ${status} ${results} = BuiltIn.Run_Keyword_And_Ignore_Error KarafKeywords.Uninstall_A_Feature ${CONNECTOR_FEATURE}
- BuiltIn.Log ${results}
-
-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
+Test_Unauthorized
+ [Documentation] Try to access pcep topology with wrong password, should get empty topology
+ TemplatedRequests.Get_As_Json_Templated ${DIR_WITH_TEMPLATES}${/}default_off session=${CONFIG_SESSION} verify=True
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
+ ${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}= norm_json.normalize_json_text ${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}= norm_json.normalize_json_text ${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
+Replace_Password_On_Pcep_Node
[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} BuiltIn.Create_Dictionary IP=${TOOLS_SYSTEM_IP} PASSWD=${password_element}
- TemplatedRequests.Put_As_Xml_Templated ${directory_with_template_folders}${/}pcep_topology_client_module mapping=${mapping}
+ [Documentation] Send restconf PUT to replace the config module specifying PCEP password element.
+ &{mapping} BuiltIn.Create_Dictionary IP=${TOOLS_SYSTEM_IP} PASSWD=${password}
+ TemplatedRequests.Put_As_Xml_Templated ${DIR_WITH_TEMPLATES}${/}pcep_topology_node mapping=${mapping}
+
+Unset_Password_On_Pcep_Node
+ [Documentation] Send restconf PUT to unset the config module.
+ &{mapping} BuiltIn.Create_Dictionary IP=${TOOLS_SYSTEM_IP}
+ TemplatedRequests.Put_As_Xml_Templated ${DIR_WITH_TEMPLATES}${/}pcep_topology_node_empty mapping=${mapping}
+
+Stop_Pcc_Mock_Tool
+ [Documentation] Send ctrl+c to pcc-mock, fails if no prompt is seen
+ ... after 3 seconds (the default for SSHLibrary)
+ RemoteBash.Write_Bare_Ctrl_C
+ ${output}= SSHLibrary.Read_Until_Prompt
+ BuiltIn.Log ${output}
+
+Start_Pcc_Mock_Tool_With_Password
+ [Arguments] ${password}
+ [Documentation] Starts pcc-mock with password argument.
+ ${command}= NexusKeywords.Compose_Full_Java_Command -jar ${filename} --password ${password} --reconnect 1 --local-address ${TOOLS_SYSTEM_IP} --remote-address ${ODL_SYSTEM_IP} 2>&1 | tee pccmock.log
+ BuiltIn.Log ${command}
+ SSHLibrary.Write ${command}