${already_done} = False ${already_done} \${ClusterManagement__has_setup_run} False Returns variable value or ``default`` if the variable does not exist. ${ClusterManagement__has_setup_run} = True \${ClusterManagement__has_setup_run} True Makes a variable available everywhere within the scope of the current suite. ${cluster_size} = 1 ${cluster_size} \${NUM_ODL_SYSTEM} 1 Returns variable value or ``default`` if the variable does not exist. ${cluster_size} Converts the given item to an integer number. ${status} = PASS ${possibly_int_of_members} = 1 ${status} ${possibly_int_of_members} BuiltIn.Convert_To_Integer ${cluster_size} Runs the given keyword with the given arguments and ignores possible error. ${int_of_members} = 1 ${int_of_members} '${status}' != 'PASS' ${1} ${possibly_int_of_members} Sets variable based on the given condition. @{member_index_list} = [ ] @{member_index_list} Returns a list containing given items. @{session_list} = [ ] @{session_list} Returns a list containing given items. &{index_to_ip_mapping} = { } &{index_to_ip_mapping} Creates and returns a dictionary based on the given ``items``. ${member_index_list} ${index} Adds ``values`` to the end of ``list``. ${member_ip} = 10.30.171.175 ${member_ip} ${ODL_SYSTEM_${index}_IP} Returns the given values which can then be assigned to a variables. ${index_to_ip_mapping} ${index} ${member_ip} Adds the given ``key_value_pairs`` and/or ``items`` to the ``dictionary``. ${session} = ClusterManagement__session_1 ${session} ClusterManagement__session_${member_index} Returns the given values which can then be assigned to a variables. ${session} ${session_alias} = ClusterManagement__session_1 ${session_alias} member_index=${index} Return RequestsLibrary session alias pointing to node of given index. Creating Session using : alias=ClusterManagement__session_1, url=http://10.30.171.175:8181, headers={}, cookies={}, auth=<requests.auth.HTTPBasicAuth object at 0x7af8de758750>, timeout=5, proxies=None, verify=False, debug=0 ${session_alias} http://${member_ip}:${RESTCONFPORT} auth=${AUTH} timeout=${http_timeout} max_retries=${http_retries} Create Session: create a HTTP session to a server ${session_list} ${session_alias} Adds ``values`` to the end of ``list``. ${index} ${member_index_list} ${session_list} ${index_to_ip_mapping} http_timeout=${http_timeout} http_retries=${http_retries} Add a corresponding item based on index into the last three arguments. Create the Http session whose alias is added to list. 1 ${index} 1 ${int_of_members+1} ${ClusterManagement__member_index_list} = [1] \${ClusterManagement__member_index_list} ${member_index_list} Makes a variable available everywhere within the scope of the current suite. ${ClusterManagement__index_to_ip_mapping} = {1: '10.30.171.175'} \${ClusterManagement__index_to_ip_mapping} ${index_to_ip_mapping} Makes a variable available everywhere within the scope of the current suite. ${ClusterManagement__session_list} = ['ClusterManagement__session_1'] \${ClusterManagement__session_list} ${session_list} Makes a variable available everywhere within the scope of the current suite. int_of_members=${int_of_members} http_timeout=${http_timeout} http_retries=${http_retries} Construct index list, session list and IP mapping, publish them as suite variables. Detect repeated call, or detect number of members and initialize derived suite variables. Http sessions are created with parameters to not waste time when ODL is no accepting connections properly. ${already_done} = True ${already_done} \${ClusterManagement__has_setup_run} False Returns variable value or ``default`` if the variable does not exist. \${ClusterManagement__has_setup_run} True Makes a variable available everywhere within the scope of the current suite. ${cluster_size} \${NUM_ODL_SYSTEM} 1 Returns variable value or ``default`` if the variable does not exist. ${status} ${possibly_int_of_members} BuiltIn.Convert_To_Integer ${cluster_size} Runs the given keyword with the given arguments and ignores possible error. ${int_of_members} '${status}' != 'PASS' ${1} ${possibly_int_of_members} Sets variable based on the given condition. int_of_members=${int_of_members} http_timeout=${http_timeout} http_retries=${http_retries} Construct index list, session list and IP mapping, publish them as suite variables. http_timeout=${http_timeout} Detect repeated call, or detect number of members and initialize derived suite variables. Http sessions are created with parameters to not waste time when ODL is no accepting connections properly. Not A Karaf App ${return_list_reference} = [1] ${return_list_reference} """${given_list}""" != "" ${given_list} ${ClusterManagement__member_index_list} Sets variable based on the given condition. ${return_list_copy} = [1] ${return_list_copy} @{return_list_reference} Returns a list containing given items. ${return_list_copy} ${index_list} = [1] ${index_list} given_list=${member_index_list} Utility to allow ${EMPTY} as default argument value, as the internal list is computed at runtime. This keyword always returns a (shallow) copy of given or default list, so operations with the returned list should not affect other lists. Also note that this keyword does not consider empty list to be ${EMPTY}. ${member_ip} = 10.30.171.175 ${member_ip} dictionary=${ClusterManagement__index_to_ip_mapping} key=${member_index} Returns a value from the given ``dictionary`` based on the given ``key``. index=None host=None alias=None port=22 timeout=3 seconds newline= prompt=None term_type=vt100 width=80 height=24 path_separator=/ encoding=utf8 escape_ansi=False encoding_errors=strict ${current_connection} = index=None host=None alias=None port=22 timeout=3 seconds newline= prompt=None term_type=vt100 width=80 height=24 path_separator=/ encoding=utf8 escape_ansi=False encoding_errors=strict ${current_connection} Returns information about the connection. At least one of {return_stdout} or {return_stderr} args should be set to True Fails the test with the given message and optionally alters its tags. index=None host=None alias=None port=22 timeout=3 seconds newline= prompt=None term_type=vt100 width=80 height=24 path_separator=/ encoding=utf8 escape_ansi=False encoding_errors=strict ${current_ssh_connection} = index=None host=None alias=None port=22 timeout=3 seconds newline= prompt=None term_type=vt100 width=80 height=24 path_separator=/ encoding=utf8 escape_ansi=False encoding_errors=strict ${current_ssh_connection} Returns information about the connection. Attempting to execute command "iptables -I INPUT -p tcp --dport 8101 -j ACCEPT; iptables-save" on remote system "10.30.171.175" by user "jenkins" with keyfile pass "any" and prompt ">" and password "" Attempting to execute command "${cmd}" on remote system "${system}" by user "${user}" with keyfile pass "${keyfile_pass}" and prompt "${prompt}" and password "${password}" Logs the given message with the given level. ${conn_id} = 1 ${conn_id} ${system} prompt=${prompt} timeout=${prompt_timeout} Opens a new SSH connection to the given ``host`` and ``port``. Length is 0. ${pwd_length} = 0 ${pwd_length} ${password} Returns and logs the length of the given item as an integer. ${pwd_length} > 0 SSHLibrary.Login ${user} ${password} delay=${delay} Runs the specified keyword and returns from the enclosing user keyword. Logging into '10.30.171.175:22' as 'jenkins'. Read output: Welcome to Ubuntu 22.04.5 LTS (GNU/Linux 5.15.0-171-generic x86_64) * Documentation: https://help.ubuntu.com * Management: https://landscape.canonical.com * Support: https://ubuntu.com/pro System information as of Wed Apr 29 03:01:50 UTC 2026 System load: 0.36 Processes: 129 Usage of /: 11.1% of 77.35GB Users logged in: 0 Memory usage: 6% IPv4 address for ens3: 10.30.171.175 Swap usage: 0% Expanded Security Maintenance for Applications is not enabled. 0 updates can be applied immediately. 10 additional security updates can be applied with ESM Apps. Learn more about enabling ESM Apps service at https://ubuntu.com/esm The list of available updates is more than a week old. To check for new updates run: sudo apt update New release '24.04.4 LTS' available. Run 'do-release-upgrade' to upgrade to it. [?2004h[jenkins@releng-60024-213-0-builder-0 ~]> ${user} ${USER_HOME}/.ssh/${SSH_KEY} ${KEYFILE_PASS} delay=${delay} Logs into the SSH server using key-based authentication. Returning from the enclosing user keyword. SSHLibrary.Login With Public Key ${user} ${USER_HOME}/.ssh/${SSH_KEY} ${KEYFILE_PASS} delay=${delay} Runs the specified keyword and returns from the enclosing user keyword. ${user} ${password} On active SSH session: if given non-empty password, do Login, else do Login With Public Key. Executing command 'iptables -I INPUT -p tcp --dport 8101 -j ACCEPT; iptables-save'. Command exited with return code 4. ${stdout} = ${stderr} = iptables v1.8.7 (nf_tables): unknown option "--dport" Try `iptables -h' or 'iptables --help' for more information. iptables-save v1.8.7 (nf_tables): Could not fetch rule set generation id: Permission ... ${stdout} ${stderr} ${cmd} return_stderr=True Executes ``command`` on the remote machine and returns its outputs. Closes the current connection. iptables v1.8.7 (nf_tables): unknown option "--dport" Try `iptables -h' or 'iptables --help' for more information. iptables-save v1.8.7 (nf_tables): Could not fetch rule set generation id: Permission denied (you must be root) ${stderr} Logs the given message with the given level. ${stderr} ${stdout} ${stdout} ${stderr} ${connection_index} is not None SSHLibrary.Switch Connection ${connection_index} Runs the specified keyword and returns from the enclosing user keyword. 127.0.0.1 Opens a new SSH connection to the given ``host`` and ``port``. Closes the current connection. ${current_ssh_connection.index} Restore active SSH connection in SSHLibrary to given index. ${system} ${cmd} ${user} ${password} prompt=${prompt} Reduces the common work of running a command on a remote system to a single higher level robot keyword, taking care to log in with a public key and. The command given is written and the return value depends on the passed argument values of return_stdout (default: True) and return_stderr (default: False). At least one should be True, or the keyword will exit and FAIL. If both are True, the resulting return value will be a two element list containing both. Otherwise the resulting return value is a string. No test conditions are checked. Returning from the enclosing user keyword. Run Command On Remote System ${system} ${cmd} ${user} ${password} prompt=${prompt} Runs the specified keyword and returns from the enclosing user keyword. @{args} &{kwargs} Call Run Comand On Remote System, but with default values suitable for Controller machine. Returning from the enclosing user keyword. ${keyword_name} @{args} &{kwargs} Runs the specified keyword and returns from the enclosing user keyword. ${connection_index} is not None SSHLibrary.Switch Connection ${connection_index} Runs the specified keyword and returns from the enclosing user keyword. 127.0.0.1 Opens a new SSH connection to the given ``host`` and ``port``. Closes the current connection. ${current_connection.index} Restore active SSH connection in SSHLibrary to given index. ${output} = ${output} Utils.Run_Command_On_Controller ${member_ip} ${command} Store current connection index, run keyword returning its result, restore connection in teardown. Note that in order to avoid "got positional argument after named arguments", it is safer to use positional (not named) arguments on call. ${output} Logs the given message with the given level. ${output} command=${command} member_index=${index} Obtain IP, call Utils and return output. This keeps previous ssh session active. 1 ${index} @{index_list} iptables -I INPUT -p tcp --dport ${KARAF_SHELL_PORT} -j ACCEPT; iptables-save Cycle through indices (or all), run command on each. First connections to Karaf console may fail, so WUKS is used. TODO: Track as a Bug. Displays the given messages in the log file as keyword arguments. Not A Karaf App index=None host=None alias=None port=22 timeout=3 seconds newline= prompt=None term_type=vt100 width=80 height=24 path_separator=/ encoding=utf8 escape_ansi=False encoding_errors=strict ${current_ssh_connection_object} = index=None host=None alias=None port=22 timeout=3 seconds newline= prompt=None term_type=vt100 width=80 height=24 path_separator=/ encoding=utf8 escape_ansi=False encoding_errors=strict ${current_ssh_connection_object} Returns information about the connection. {} ${connection_index_dict} Logs the given message with the given level. 1 ${member_index} Logs the given message with the given level. Dictionary does not contain key '1'. ${connection_index_dict} ${member_index} Returns a value from the given ``dictionary`` based on the given ``key``. Dictionary does not contain key '1'. ${status} = FAIL ${old_connection_index} = Dictionary does not contain key '1'. ${status} ${old_connection_index} Get From Dictionary ${connection_index_dict} ${member_index} Runs the given keyword with the given arguments and ignores possible error. SSHLibrary.Switch_Connection ${old_connection_index} AND BuiltIn.Run_Keyword_And_Ignore_Error SSHLibrary.Write logout AND BuiltIn.Run_Keyword_And_Ignore_Error SSHLibrary.Close_Connection Executes all the given keywords in a sequence. ${ip_address} = 10.30.171.175 ${ip_address} dictionary=${ClusterManagement__index_to_ip_mapping} key=${member_index} Returns a value from the given ``dictionary`` based on the given ``key``. ${ip_address} ${odl_ip} = 10.30.171.175 ${odl_ip} ${member_index} Return node IP address of given index. ${odl_ip} port=${KARAF_SHELL_PORT} prompt=${KARAF_PROMPT_LOGIN} timeout=${timeout} Opens a new SSH connection to the given ``host`` and ``port``. index=4 host=10.30.171.175 alias=None port=8101 timeout=10 seconds newline= prompt=opendaylight-user term_type=vt100 width=80 height=24 path_separator=/ encoding=UTF-8 escape_ansi=False encoding_errors=strict ${karaf_connection_object} = index=4 host=10.30.171.175 alias=None port=8101 timeout=10 seconds newline= prompt=opendaylight-user term_type=vt100 width=80 height=24 path_separator=/ encoding=UTF-8 escape_ansi=False encoding_erro... ${karaf_connection_object} Returns information about the connection. ${connection_index_dict} ${member_index} ${karaf_connection_object.index} Adds the given ``key_value_pairs`` and/or ``items`` to the ``dictionary``. Logging into '10.30.171.175:8101' as 'karaf'. Read output: [33m [33m ________ ________ .__ .__ .__ __ [33m \_____ \ ______ ____ ____ \______ \ _____ ___.__.| | |__| ____ | |___/ |_ [33m / | \\____ \_/ __ \ / \ | | \\__ \< | || | | |/ ___\| | \ __\ [33m / | \ |_> > ___/| | \| ` \/ __ \\___ || |_| / /_/ > Y \ | [33m \_______ / __/ \___ >___| /_______ (____ / ____||____/__\___ /|___| /__| [33m \/|__| \/ \/ \/ \/\/ /_____/ \/ [33m Hit '[1m<tab>[0m' for a list of available commands and '[1m[cmd] --help[0m' for help on a specific command. Hit '[1m<ctrl-d>[0m' or type '[1msystem:shutdown[0m' or '[1mlogout[0m' to shutdown OpenDaylight. [?1h=[90m~[0m [?2004hopendaylight-user ${KARAF_USER} ${KARAF_PASSWORD} loglevel=${loglevel} Logs into the SSH server with the given ``username`` and ``password``. ${connection_index} is not None SSHLibrary.Switch Connection ${connection_index} Runs the specified keyword and returns from the enclosing user keyword. 127.0.0.1 Opens a new SSH connection to the given ``host`` and ``port``. Closes the current connection. ${current_ssh_connection_object.index} Restore active SSH connection in SSHLibrary to given index. '${IS_KARAF_APPL}' == 'True' SSHKeywords.Restore_Current_Ssh_Connection_From_Index ${current_ssh_connection_object.index} Runs the given keyword with the given arguments, if ``condition`` is true. member_index=${index} If there is a stored ssh connection index of connection to the controller's karaf console for ${member_index}, close the previous connection. In any case create a new connection to karaf console for ${member_index}, set correct prompt set and login to karaf console. Store connection index for ${member_index} and restore the previous active connection. 3s 1s Open_Controller_Karaf_Console_On_Background member_index=${index} Runs the specified keyword and retries if it fails. BuiltIn.Wait_Until_Keyword_Succeeds 3s 1s Open_Controller_Karaf_Console_On_Background member_index=${index} Runs the given keyword with the given arguments and ignores possible error. 1 ${index} @{ClusterManagement__member_index_list} Initialize ClusterManagement. Open ssh karaf connections to each ODL. Not A Karaf App ${karaf_connection_index} = 4 ${karaf_connection_index} ${connection_index_dict} ${member_index} Returns a value from the given ``dictionary`` based on the given ``key``. ${current_connection_index} = None ${current_connection_index} ${karaf_connection_index} Switches the active connection by index or alias. @root>log:set DEBUG org.opendaylight.jsonrpc ${command} Writes the given ``text`` on the remote machine and appends a newline. ${status_write} = PASS ${message_write} = @root>log:set DEBUG org.opendaylight.jsonrpc ${status_write} ${message_write} SSHLibrary.Write ${command} Runs the given keyword with the given arguments and ignores possible error. [?1l>[?2004l[?1h=[90m~[0m [?2004hopendaylight-user@root> ${KARAF_PROMPT} Consumes and returns the server output until a match to ``regexp`` is found. ${status_wait} = PASS ${message_wait} = [?1l>[?2004l[?1h=[90m~[0m [?2004hopendaylight-user@root> ${status_wait} ${message_wait} SSHLibrary.Read_Until_Regexp ${KARAF_PROMPT} Runs the given keyword with the given arguments and ignores possible error. Failed to send the command: ${command} Fails the test with the given message and optionally alters its tags. [?1l>[?2004l[?1h=[90m~[0m [?2004hopendaylight-user@root> ${message_wait} Logs the given message with the given level. Failed to see prompt after sending the command: ${command} Fails the test with the given message and optionally alters its tags. ${message_wait} ${connection_index} is not None SSHLibrary.Switch Connection ${connection_index} Runs the specified keyword and returns from the enclosing user keyword. 127.0.0.1 Opens a new SSH connection to the given ``host`` and ``port``. Closes the current connection. ${current_connection_index} Restore active SSH connection in SSHLibrary to given index. '${IS_KARAF_APPL}' == 'True' SSHKeywords.Restore_Current_Ssh_Connection_From_Index ${current_connection_index} Runs the given keyword with the given arguments, if ``condition`` is true. log:set DEBUG org.opendaylight.jsonrpc Send command to karaf without affecting current SSH connection. Read, log and return response. Getting file '<a href="file:///w/workspace/jsonrpc-csit-1node-basic-only-vanadium/test/csit/variables/jsonrpc/readservice_peer_payload.json">/w/workspace/jsonrpc-csit-1node-basic-only-vanadium/test/csit/variables/jsonrpc/readservice_peer_payload.json</a>'. ${JSON1} = { "configured-endpoints": [ { "name": "foo", "modules": [ "jsonrpc" ], "data-config-endpoints": [ { ... ${JSON1} ${file} Returns the contents of a specified file. { "configured-endpoints": [ { "name": "foo", "modules": [ "jsonrpc" ], "data-config-endpoints": [ { "path": "{}", "endpoint-uri": "zmq://127.0.0.1:4444" } ], "data-operational-endpoints": [ { "path": "{}", "endpoint-uri": "zmq://127.0.0.1:4444" } ] } ] } ${JSON1} Logs the given message with the given level. ${session} = ClusterManagement__session_1 ${session} ClusterManagement__session_${member_index} Returns the given values which can then be assigned to a variables. ${session} ${session} = ClusterManagement__session_1 ${session} member_index=${member_index} Return RequestsLibrary session alias pointing to node of given index. /rests/data/jsonrpc:config/configured-endpoints=foo ${uri} Logs the given message with the given level. { "configured-endpoints": [ { "name": "foo", "modules": [ "jsonrpc" ], "data-config-endpoints": [ { "path": "{}", "endpoint-uri": "zmq://127.0.0.1:4444" } ], "data-operational-endpoints": [ { "path": "{}", "endpoint-uri": "zmq://127.0.0.1:4444" } ] } ] } ${data} Logs the given message with the given level. {'Content-Type': 'application/json'} ${content_type} Logs the given message with the given level. {} ${accept} Logs the given message with the given level. ${accumulator} = {'Content-Type': 'application/json'} ${accumulator} ${first} Returns a copy of the given dictionary. ${items_to_add} = [] ${items_to_add} ${second} Returns items of the given ``dictionary`` as a list. ${accumulator} @{items_to_add} Adds the given ``key_value_pairs`` and/or ``items`` to the ``dictionary``. {'Content-Type': 'application/json'} ${accumulator} Logs the given message with the given level. ${accumulator} ${headers} = {'Content-Type': 'application/json'} ${headers} first=${content_type} second=${accept} Take two dicts, join them, return result. Second argument values take precedence. ReadTimeout: HTTPConnectionPool(host='10.30.171.175', port=8181): Read timed out. (read timeout=5.0) ${response} ${session} ${uri} data=${data} headers=${headers} Sends a PUT request on a previously created HTTP Session. ReadTimeout: HTTPConnectionPool(host='10.30.171.175', port=8181): Read timed out. (read timeout=5.0) ReadTimeout: HTTPConnectionPool(host='10.30.171.175', port=8181): Read timed out. (read timeout=5.0) ${response} ${session} ${uri} data=${data} headers=${headers} timeout=${http_timeout} Sends a PUT request on a previously created HTTP Session. ReadTimeout: HTTPConnectionPool(host='10.30.171.175', port=8181): Read timed out. (read timeout=5.0) ${response} Log response text, check status_code is one of allowed ones. In cases where this keyword is called in a WUKS it could end up logging tons of data and it may be desired to skip the logging by passing log_response=False, but by default it remains True. ${response.text} ${text_normalized} ${response.text} jmes_path=${jmes_path} Attempt to return sorted indented JSON string. ${text_normalized} ${response_text} uri=${uri} data=${data} accept=${ACCEPT_EMPTY} content_type=${HEADERS_YANG_JSON} session=${session} normalize_json=True http_timeout=${http_timeout} PUT data to given URI, check status code and return response text. ${content_type} and ${accept} are mandatory Python objects with headers to use. If ${normalize_json}, normalize text before returning. ReadTimeout: HTTPConnectionPool(host='10.30.171.175', port=8181): Read timed out. (read timeout=5.0) ${response_text} ${response_text} uri=${uri} data=${data} session=${session} Specify JSON headers and return Put_To_Uri normalized response text. Yang json content type is used as a workaround to RequestsLibrary json conversion eagerness. ReadTimeout: HTTPConnectionPool(host='10.30.171.175', port=8181): Read timed out. (read timeout=5.0) ${response_text} ${response_json} ${READ_SERVICE_PEER_URL}=${endpoint} ${JSON1} ${controller_index} Send a PUT with the supplied uri and data to member ${member_index}. ReadTimeout: HTTPConnectionPool(host='10.30.171.175', port=8181): Read timed out. (read timeout=5.0) ${response_json} Logs the given message with the given level. This keyword mounts an endpoint after starting service ReadTimeout: HTTPConnectionPool(host='10.30.171.175', port=8181): Read timed out. (read timeout=5.0) This keyword creates a new virtual environment, installs pyzmq & zmq and starts the read service on controller vm This keyword verifies if the data we get on the mount point is same as what we put Push data using python utility and verify using restconf basic data ReadTimeout: HTTPConnectionPool(host='10.30.171.175', port=8181): Read timed out. (read timeout=5.0) Deleting All Sessions Removes all the session objects Test suite for verifying basic variations of export API including checking statuses All Tests basic data jsonrpc-basic.txt