X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;ds=sidebyside;f=csit%2Flibraries%2FSxp.py;h=4aaf3b094f86c25a85ec6356351daf94163d699a;hb=0fb5ff3cd81cc5810c49ea2aeafb05a1e8cc1c8c;hp=5500c8fcf01067bd1d8a78e8b716478f67f6869e;hpb=153dbf27a8f0d9e6cdb283d1a50b869165f356d5;p=integration%2Ftest.git diff --git a/csit/libraries/Sxp.py b/csit/libraries/Sxp.py index 5500c8fcf0..4aaf3b094f 100644 --- a/csit/libraries/Sxp.py +++ b/csit/libraries/Sxp.py @@ -7,9 +7,9 @@ def get_active_controller_from_json(resp, service): """Gets index of active controller running specified service :param resp: JSON formatted response from EOS - :type resp: string + :type resp: str :param service: EOS Service to look for - :type service: string + :type service: str :return: Index of controller """ entities = json.loads(resp)['entity-owners']['entity-type'] @@ -25,9 +25,9 @@ def mod(num, base): """Gets modulo of number :param num: Number to be used - :type num: string + :type num: str :param base: Base used - :type base: string + :type base: str :returns: Int representing modulo of specified numbers. """ @@ -79,7 +79,7 @@ def get_ip_from_number_and_ip(n, ip_address): :param n: Number to be converted :type n: int :param ip_address: Base address - :type ip_address: string + :type ip_address: str :returns: String containing Ipv4. """ @@ -91,9 +91,9 @@ def lower_version(ver1, ver2): """Generate xml containing SGT mach data :param ver1: Version of SXP protocol for compare - :type ver1: string + :type ver1: str :param ver2: Version of SXP protocol for compare - :type ver2: string + :type ver2: str :returns: String containing lower from those two specified versions. """ @@ -109,23 +109,23 @@ def get_filter_entry(seq, entry_type, sgt="", esgt="", acl="", eacl="", pl="", e """Generate xml containing FilterEntry data :param seq: Sequence of entry - :type seq: string + :type seq: str :param entry_type: Type of entry (permit/deny) - :type entry_type: string + :type entry_type: str :param sgt: SGT matches to be added to entry - :type sgt: string + :type sgt: str :param esgt: SGT ranges match to be added to entry - :type esgt: string + :type esgt: str :param acl: ACL matches to be added to entry - :type acl: string + :type acl: str :param eacl: EACL matches to be added to entry - :type eacl: string + :type eacl: str :param pl: PrefixList matches to be added to entry - :type pl: string + :type pl: str :param epl: ExtendedPrefixList matches to be added to entry - :type epl: string + :type epl: str :param ps: PeerSequence matches to be added to entry - :type ps: string + :type ps: str :returns: String containing xml data for request """ @@ -199,7 +199,7 @@ def add_sgt_matches_xml(sgt_entries): """Generate xml containing SGT mach data :param sgt_entries: SGT matches - :type sgt_entries: string + :type sgt_entries: str :returns: String containing xml data for request """ @@ -215,9 +215,9 @@ def add_sgt_range_xml(start, end): """Generate xml containing SGT RangeMach data :param start: Start range of SGT - :type start: string + :type start: str :param end: End range of SGT - :type end: string + :type end: str :returns: String containing xml data for request """ @@ -232,11 +232,11 @@ def add_acl_entry_default_xml(seq, entry_type, acl_entries): """Generate xml containing AccessList data :param seq: Sequence of PrefixList entry - :type seq: string + :type seq: str :param entry_type: Entry type (permit/deny) - :type entry_type: string + :type entry_type: str :param acl_entries: XML data containing AccessList entries - :type acl_entries: string + :type acl_entries: str :returns: String containing xml data for request """ @@ -254,9 +254,9 @@ def add_acl_entry_xml(ip, mask): """Generate xml containing AccessList data :param ip: Ipv4/6 address - :type ip: string + :type ip: str :param mask: Ipv4/6 wildcard mask - :type mask: string + :type mask: str :returns: String containing xml data for request """ @@ -272,13 +272,13 @@ def add_eacl_entry_xml(ip, mask, amask, wmask): """Generate xml containing ExtendedAccessList data :param ip: Ipv4/6 address - :type ip: string + :type ip: str :param mask: Ipv4/6 wildcard mask - :type mask: string + :type mask: str :param amask: Ipv4/6 address mask - :type amask: string + :type amask: str :param wmask: Ipv4/6 address wildcard mask - :type wmask: string + :type wmask: str :returns: String containing xml data for request """ @@ -298,11 +298,11 @@ def add_ps_entry_default_xml(seq, entry_type, ps_entries): """Generate xml containing PeerSequence data :param seq: Sequence of PrefixList entry - :type seq: string + :type seq: str :param entry_type: Entry type (permit/deny) - :type entry_type: string + :type entry_type: str :param ps_entries: XML data containing PeerSequence entries - :type ps_entries: string + :type ps_entries: str :returns: String containing xml data for request """ @@ -318,11 +318,11 @@ def add_pl_entry_default_xml(seq, entry_type, pl_entries): """Generate xml containing PrefixList data :param seq: Sequence of PrefixList entry - :type seq: string + :type seq: str :param entry_type: Entry type (permit/deny) - :type entry_type: string + :type entry_type: str :param pl_entries: XML data containing PrefixList entries - :type pl_entries: string + :type pl_entries: str :returns: String containing xml data for request """ @@ -338,7 +338,7 @@ def add_pl_entry_xml(prefix): """Generate xml containing PrefixList data :param prefix: Ipv4/6 prefix - :type prefix: string + :type prefix: str :returns: String containing xml data for request """ @@ -353,11 +353,11 @@ def add_epl_entry_xml(prefix, op, mask): """Generate xml containing Extended PrefixList data :param prefix: Ipv4/6 prefix - :type prefix: string + :type prefix: str :param op: PrefixList option (ge/le/eq) - :type op: string + :type op: str :param mask: Ipv4/6 Mask - :type mask: string + :type mask: str :returns: String containing xml data for request """ @@ -376,9 +376,9 @@ def add_ps_entry_xml(op, length): """Generate xml containing Extended PrefixList data :param op: PrefixList option (ge/le/eq) - :type op: string + :type op: str :param length: PeerSequence length - :type length: string + :type length: str :returns: String containing xml data for request """ @@ -393,7 +393,7 @@ def parse_peer_groups(groups_json): """Parse JSON string into Array of PeerGroups :param groups_json: JSON containing PeerGroups - :type groups_json: string + :type groups_json: str :returns: Array containing PeerGroups. """ @@ -409,39 +409,41 @@ def parse_connections(connections_json): """Parse JSON string into Array of Connections :param connections_json: JSON containing Connections - :type connections_json: string + :type connections_json: str :returns: Array containing Connections. """ data = json.loads(connections_json) - connections = data['output']['connections'] - output = [] - for connection in connections.values(): - output += connection - return output + output = data['output'] + result = [] + if output: + connections = output['connections'] + for connection in connections.values(): + result += connection + return result def find_connection(connections_json, version, mode, ip, port, state): """Test if Connection with specified values is contained in JSON :param connections_json: JSON containing Connections - :type connections_json: string + :type connections_json: str :param version: Version of SXP protocol (version1/2/3/4) - :type version: string + :type version: str :param mode: Mode of SXP peer (speaker/listener/both) - :type mode: string + :type mode: str :param ip: Ipv4/6 address of remote peer - :type ip: string + :type ip: str :param port: Port on with remote peer listens - :type port: string + :type port: str :param state: State of connection (on/off/pendingOn/deleteHoldDown) - :type state: string + :type state: str :returns: True if Connection with specified params was found, otherwise False. """ for connection in parse_connections(connections_json): if (connection['peer-address'] == ip and connection['tcp-port'] == int(port) and ( - mode.strip() == 'any' or connection['mode'] == mode) and connection['version'] == version): + mode.strip() == 'any' or connection['mode'] == mode) and connection['version'] == version): if state == 'none': return True elif connection['state'] == state: @@ -453,7 +455,7 @@ def parse_bindings(bindings_json): """Parse JSON string into Array of Bindings :param bindings_json: JSON containing Bindings - :type bindings_json: string + :type bindings_json: str :returns: Array containing Bindings. """ @@ -469,11 +471,11 @@ def find_binding(bindings, sgt, prefix): """Test if Binding with specified values is contained in JSON :param bindings: JSON containing Bindings - :type bindings: string + :type bindings: str :param sgt: Source Group Tag - :type sgt: string + :type sgt: str :param prefix: Ipv4/6 prefix - :type prefix: string + :type prefix: str :returns: True if Binding with specified params was found, otherwise False. """ @@ -489,9 +491,9 @@ def parse_prefix_groups(prefix_groups_json, source_): """Parse JSON string into Array of PrefixGroups :param prefix_groups_json: JSON containing PrefixGroups - :type prefix_groups_json: string + :type prefix_groups_json: str :param source_: Source of PrefixGroups (sxp/local) - :type source_: string + :type source_: str :returns: Array containing PrefixGroups. """ @@ -510,15 +512,15 @@ def find_binding_legacy(prefix_groups_json, sgt, prefix, source_, action): """Test if Binding with specified values is contained in JSON :param prefix_groups_json: JSON containing Bindings and PrefixGroups - :type prefix_groups_json: string + :type prefix_groups_json: str :param sgt: Source Group Tag - :type sgt: string + :type sgt: str :param prefix: Ipv4/6 prefix - :type prefix: string + :type prefix: str :param source_: Source of binding (local/sxp) - :type source_: string + :type source_: str :param action: Action for binding (add/delete) - :type action: string + :type action: str :returns: True if Binding with specified params was found, otherwise False. """ @@ -531,47 +533,25 @@ def find_binding_legacy(prefix_groups_json, sgt, prefix, source_, action): return found -def add_entry_xml(sgt, prefix, ip, domain_name): - """Generate xml for Add Bindings request - - :param sgt: Source Group Tag - :type sgt: string - :param prefix: Ipv4/6 prefix - :type prefix: string - :param ip: Ipv4 address of node - :type ip: string - :param domain_name: Name of Domain - :type domain_name: string - :returns: String containing xml data for request - - """ - templ = Template(''' - $ip - $domain - $sgt - $prefix -''') - data = templ.substitute({'sgt': sgt, 'prefix': prefix, 'ip': ip, 'domain': get_domain_name(domain_name)}) - return data - - -def add_connection_xml(version, mode, ip, port, node, password_, domain_name, bindings_timeout=0): +def add_connection_xml(version, mode, ip, port, node, password_, domain_name, bindings_timeout=0, security_mode=''): """Generate xml for Add Connection request :param version: Version of SXP protocol (version1/2/3/4) - :type version: string + :type version: str :param mode: Mode of SXP peer (speaker/listener/both) - :type mode: string + :type mode: str :param ip: Ipv4/6 address of remote peer - :type ip: string + :type ip: str :param port: Port on with remote peer listens - :type port: string + :type port: str :param node: Ipv4 address of node - :type node: string + :type node: str :param password_: Password type (none/default) - :type password_: string + :type password_: str :param domain_name: Name of Domain - :type domain_name: string + :type domain_name: str + :param security_mode: Default/TSL security + :type security_mode: str :param bindings_timeout: Specifies DHD and Reconciliation timers :type bindings_timeout: int :returns: String containing xml data for request @@ -588,11 +568,15 @@ def add_connection_xml(version, mode, ip, port, node, password_, domain_name, bi $mode $version Connection to ISR-G2 + $security_type 45 30 $timeout $timeout + 90 + 180 + 90 @@ -600,7 +584,8 @@ def add_connection_xml(version, mode, ip, port, node, password_, domain_name, bi ''') data = templ.substitute( {'ip': ip, 'port': port, 'mode': mode, 'version': version, 'node': node, - 'password_': password_, 'domain': get_domain_name(domain_name), 'timeout': bindings_timeout}) + 'password_': password_, 'domain': get_domain_name(domain_name), 'timeout': bindings_timeout, + 'security_type': '' + security_mode + '' if security_mode else ''}) return data @@ -608,13 +593,13 @@ def delete_connections_xml(address, port, node, domain_name): """Generate xml for Delete Connection request :param address: Ipv4/6 address of remote peer - :type address: string + :type address: str :param port: Port on with remote peer listens - :type port: string + :type port: str :param node: Ipv4 address of node - :type node: string + :type node: str :param domain_name: Name of Domain - :type domain_name: string + :type domain_name: str :returns: String containing xml data for request """ @@ -628,75 +613,15 @@ def delete_connections_xml(address, port, node, domain_name): return data -def update_binding_xml(sgt0, prefix0, sgt1, prefix1, ip, domain_name): - """Generate xml for Update Binding request - - :param sgt0: Original Source Group Tag - :type sgt0: string - :param prefix0: Original Ipv4/6 prefix - :type prefix0: string - :param sgt1: New Source Group Tag - :type sgt1: string - :param prefix1: New Ipv4/6 prefix - :type prefix1: string - :param ip: Ipv4 address of node - :type ip: string - :param domain_name: Name of Domain - :type domain_name: string - :returns: String containing xml data for request - - """ - templ = Template(''' - $ip - $domain - - $sgt0 - $prefix0 - - - $sgt1 - $prefix1 - -''') - data = templ.substitute( - {'sgt0': sgt0, 'sgt1': sgt1, 'prefix0': prefix0, 'prefix1': prefix1, 'ip': ip, - 'domain': get_domain_name(domain_name)}) - return data - - -def delete_binding_xml(sgt, prefix, ip, domain_name): - """Generate xml for Delete Binding request - - :param sgt: Source Group Tag - :type sgt: string - :param prefix: Ipv4/6 prefix - :type prefix: string - :param ip: Ipv4 address of node - :type ip: string - :param domain_name: Name of Domain - :type domain_name: string - :returns: String containing xml data for request - - """ - templ = Template(''' - $ip - $sgt - $prefix - $domain -''') - data = templ.substitute({'sgt': sgt, 'prefix': prefix, 'ip': ip, 'domain': get_domain_name(domain_name)}) - return data - - def add_peer_group_xml(name, peers, ip): """Generate xml for Add PeerGroups request :param name: Name of PeerGroup - :type name: string + :type name: str :param peers: XML formatted peers that will be added to group - :type peers: string + :type peers: str :param ip: Ipv4 address of node - :type ip: string + :type ip: str :returns: String containing xml data for request """ @@ -715,9 +640,9 @@ def delete_peer_group_xml(name, ip): """Generate xml for Delete PeerGroup request :param name: Name of PeerGroup - :type name: string + :type name: str :param ip: Ipv4 address of node - :type ip: string + :type ip: str :returns: String containing xml data for request """ @@ -733,7 +658,7 @@ def get_peer_groups_from_node_xml(ip): """Generate xml for Get PeerGroups request :param ip: Ipv4 address of node - :type ip: string + :type ip: str :returns: String containing xml data for request """ @@ -748,15 +673,15 @@ def add_filter_xml(group, filter_type, entries, ip, policy=None): """Generate xml for Add Filter request :param group: Name of group containing filter - :type group: string + :type group: str :param filter_type: Type of filter - :type filter_type: string + :type filter_type: str :param entries: XML formatted entries that will be added in filter - :type entries: string + :type entries: str :param ip: Ipv4 address of node - :type ip: string + :type ip: str :param policy: Policy of filter update mechanism - :type policy: string + :type policy: str :returns: String containing xml data for request """ @@ -781,15 +706,15 @@ def add_domain_filter_xml(domain, domains, entries, ip, filter_name=None): """Generate xml for Add Domain Filter request :param domain: Name of Domain containing filter - :type domain: string + :type domain: str :param domains: Domains on which filter will be applied - :type domains: string + :type domains: str :param entries: XML formatted entries that will be added in filter - :type entries: string + :type entries: str :param ip: Ipv4 address of node - :type ip: string + :type ip: str :param filter_name: Name of filter - :type filter_name: string + :type filter_name: str :returns: String containing xml data for request """ @@ -813,11 +738,11 @@ def delete_filter_xml(group, filter_type, ip): """Generate xml for Delete Filter request :param group: Name of group containing filter - :type group: string + :type group: str :param filter_type: Type of filter - :type filter_type: string + :type filter_type: str :param ip: Ipv4 address of node - :type ip: string + :type ip: str :returns: String containing xml data for request """ @@ -835,11 +760,11 @@ def delete_domain_filter_xml(domain, ip, filter_name=None): """Generate xml for Delete Filter request :param domain: Name of Domain containing filter - :type domain: string + :type domain: str :param ip: Ipv4 address of node - :type ip: string + :type ip: str :param filter_name: Name of filter - :type filter_name: string + :type filter_name: str :returns: String containing xml data for request """ @@ -859,9 +784,9 @@ def get_connections_from_node_xml(ip, domain_name): """Generate xml for Get Connections request :param ip: Ipv4 address of node - :type ip: string + :type ip: str :param domain_name: Name of Domain - :type domain_name: string + :type domain_name: str :returns: String containing xml data for request """ @@ -877,11 +802,11 @@ def get_bindings_from_node_xml(ip, binding_range, domain_name): """Generate xml for Get Bindings request :param binding_range: All or only Local bindings - :type binding_range: string + :type binding_range: str :param ip: Ipv4 address of node - :type ip: string + :type ip: str :param domain_name: Name of Domain - :type domain_name: string + :type domain_name: str :returns: String containing xml data for request """ @@ -894,30 +819,54 @@ def get_bindings_from_node_xml(ip, binding_range, domain_name): return data -def add_node_xml(node_id, port, password, version, node_ip=None, expansion=0, bindings_timeout=0): +def add_node_xml(node_id, port, password, version, node_ip=None, expansion=0, bindings_timeout=0, keystores=None, + retry_open_timer=1): """Generate xml for Add Node request :param node_id: Ipv4 address formatted node id - :type node_id: string + :type node_id: str :param node_ip: Ipv4 address of node - :type node_ip: string + :type node_ip: strl :param port: Node port number :type port: int :param password: TCP-MD5 password - :type password: string + :type password: str :param version: Sxp device version - :type version: string + :type version: str :param expansion: Bindings expansion :type expansion: int :param bindings_timeout: Specifies DHD and Reconciliation timers :type bindings_timeout: int + :param keystores: SSL keystore and truststore specification + :type keystores: dict :returns: String containing xml data for request """ + tls = '' + if keystores: + tls = Template(''' + + + $keystore + JKS + PATH + $passwd + + + $truststore + JKS + PATH + $passwd + + $passwd + + ''').substitute( + {'keystore': keystores['keystore'], 'truststore': keystores['truststore'], 'passwd': keystores['password']}) + templ = Template(''' $id - 1 + $retry_open_timer 120 $timeout 90 @@ -928,17 +877,18 @@ def add_node_xml(node_id, port, password, version, node_ip=None, expansion=0, bi $expansion + $tls $password $port $version ODL SXP Controller $ip - ''') data = templ.substitute( - {'ip': node_id if not node_ip else node_ip, 'id': node_id, 'port': port, 'password': password, - 'version': version, 'expansion': expansion, 'timeout': bindings_timeout}) + {'ip': node_ip or node_id, 'id': node_id, 'port': port, 'password': password, + 'version': version, 'expansion': expansion, 'timeout': bindings_timeout, 'tls': tls, + 'retry_open_timer': retry_open_timer}) return data @@ -946,7 +896,7 @@ def delete_node_xml(node_id): """Generate xml for Delete node request :param node_id: Ipv4 address formatted node id - :type node_id: string + :type node_id: str :returns: String containing xml data for request """ @@ -957,21 +907,82 @@ def delete_node_xml(node_id): return data -def add_domain_xml(node_id, name): - """Generate xml for Add Domain request +def add_domain_xml_fluorine(node_id, name, sgt, prefixes, origin): + """Generate xml for Add Domain request (Fluorine version: bindings with origin) :param node_id: Id of node - :type node_id: string + :type node_id: str :param name: Name of Domain - :type name: string + :type name: str + :param sgt: Security group + :type sgt: int + :param prefixes: List of ip-prefixes + :type prefixes: str + :param origin: Origin of added bindings + :type origin: str :returns: String containing xml data for request """ - templ = Template(''' - $id - $name + master_database = '' + if prefixes != 'None': + xml_prefixes = '' + for prefix in prefixes.split(','): + xml_prefixes += '\n' + '' + prefix + '' + if xml_prefixes: + master_database += ''' + + $sgt + $xml_prefixes + + ''' + master_database = Template(master_database).substitute(({'sgt': sgt, 'xml_prefixes': xml_prefixes})) + + templ = Template(''' + $id + $name + $origin + $master_database ''') - data = templ.substitute({'name': name, 'id': node_id}) + + data = templ.substitute({'name': name, 'id': node_id, 'origin': origin, 'master_database': master_database}) + return data + + +def add_domain_xml_oxygen(node_id, name, sgt, prefixes): + """Generate xml for Add Domain request (Oxygen version: bindings without origin) + + :param node_id: Id of node + :type node_id: str + :param name: Name of Domain + :type name: str + :param sgt: Security group + :type sgt: int + :param prefixes: List of ip-prefixes + :type prefixes: str + :returns: String containing xml data for request + + """ + master_database = '' + if prefixes != 'None': + xml_prefixes = '' + for prefix in prefixes.split(','): + xml_prefixes += '\n' + '' + prefix + '' + if xml_prefixes: + master_database += ''' + + $sgt + $xml_prefixes + + ''' + master_database = Template(master_database).substitute(({'sgt': sgt, 'xml_prefixes': xml_prefixes})) + + templ = Template(''' + $id + $name + $master_database +''') + + data = templ.substitute({'name': name, 'id': node_id, 'master_database': master_database}) return data @@ -979,20 +990,26 @@ def delete_domain_xml(node_id, name): """Generate xml for Remove Domain request :param node_id: Id of node - :type node_id: string + :type node_id: str :param name: Name of Domain - :type name: string + :type name: str :returns: String containing xml data for request """ - return add_domain_xml(node_id, name) + templ = Template(''' + $node_id + $name +''') + + data = templ.substitute({'node_id': node_id, 'name': name}) + return data def get_domain_name(domain_name): """Generate xml for Get Bindings request :param domain_name: Name of Domain - :type domain_name: string + :type domain_name: str :returns: String containing xml data for request """ @@ -1002,32 +1019,66 @@ def get_domain_name(domain_name): return '' + domain_name + '' -def add_bindings_xml(node_id, domain, sgt, prefixes): - """Generate xml for Add Bindings request +def add_bindings_xml_fluorine(node_id, domain, sgt, prefixes, origin): + """Generate xml for Add Bindings request (Fluorine version with origin type) :param node_id: Id of node - :type node_id: string + :type node_id: str :param domain: Name of Domain - :type domain: string + :type domain: str :param sgt: Security group :type sgt: int :param prefixes: List of ip-prefixes - :type prefixes: string + :type prefixes: str + :param origin: Origin of added bindings + :type origin: str :returns: String containing xml data for request """ - bindings = '' + xml_prefixes = '' for prefix in prefixes.split(','): - bindings += '\n' + '' + prefix + '' - templ = Template(''' - $id - $name - - $sgt - $bindings - + xml_prefixes += '\n' + '' + prefix + '' + templ = Template(''' + $id + $name + $origin + + + $sgt + $xml_prefixes + + ''') - data = templ.substitute({'name': domain, 'id': node_id, 'sgt': sgt, 'bindings': bindings}) + data = templ.substitute({'name': domain, 'id': node_id, 'sgt': sgt, 'xml_prefixes': xml_prefixes, 'origin': origin}) + return data + + +def add_bindings_xml_oxygen(node_id, domain, sgt, prefixes): + """Generate xml for Add Bindings request (Oxygen version without origin type) + + :param node_id: Id of node + :type node_id: str + :param domain: Name of Domain + :type domain: str + :param sgt: Security group + :type sgt: int + :param prefixes: List of ip-prefixes + :type prefixes: str + :returns: String containing xml data for request + + """ + xml_prefixes = '' + for prefix in prefixes.split(','): + xml_prefixes += '\n' + '' + prefix + '' + templ = Template(''' + $id + $name + + $sgt + $xml_prefixes + +''') + data = templ.substitute({'name': domain, 'id': node_id, 'sgt': sgt, 'xml_prefixes': xml_prefixes}) return data @@ -1035,26 +1086,38 @@ def delete_bindings_xml(node_id, domain, sgt, prefixes): """Generate xml for Remove Bindings request :param node_id: Id of node - :type node_id: string + :type node_id: str :param domain: Name of Domain - :type domain: string + :type domain: str :param sgt: Security group :type sgt: int - :param prefixes: List of ip-prefixes - :type prefixes: string + :param prefixes: Comma separated list of ip-prefixes + :type prefixes: str :returns: String containing xml data for request """ - return add_bindings_xml(node_id, domain, sgt, prefixes) + xml_prefixes = '' + for prefix in prefixes.split(','): + xml_prefixes += '\n' + '' + prefix + '' + templ = Template(''' + $id + $name + + $sgt + $xml_prefixes + +''') + data = templ.substitute({'name': domain, 'id': node_id, 'sgt': sgt, 'xml_prefixes': xml_prefixes}) + return data def prefix_range(start, end): """Generate and concatenate ip-prefixes :param start: Start index - :type start: string + :type start: str :param end: End index - :type end: string + :type end: str :returns: String containing concatenated ip-prefixes """ @@ -1068,3 +1131,148 @@ def prefix_range(start, end): if index < end: prefixes += ',' return prefixes + + +def route_definition_xml(virtual_ip, net_mask, interface): + """Generate xml for Add Bindings request + + :param interface: Network interface name + :type interface: str + :param net_mask: NetMask of virtual ip + :type net_mask: str + :param virtual_ip: Virtual ip + :type virtual_ip: str + :returns: String containing xml data for request + + """ + templ = Template(''' + + $vip + $interface + $mask + + ''') + data = templ.substitute({'mask': net_mask, 'vip': virtual_ip, 'interface': interface}) + return data + + +def route_definitions_xml(routes, old_routes=None): + """Generate xml for Add Bindings request + + :param routes: XML formatted data containing RouteDefinitions + :type routes: str + :param old_routes: Routes add to request that needs to persist + :type old_routes: str + :returns: String containing xml data for request + + """ + if old_routes and "" in old_routes: + templ = Template(old_routes.replace("", "$routes")) + else: + templ = Template(''' + $routes + + ''') + data = templ.substitute({'routes': routes}) + return data + + +def add_binding_origin_xml(origin, priority): + """Generate xml for Add Binding Origin request + + :param origin: Origin type + :type origin: str + :param priority: Origin priority + :type priority: str + :returns: String containing xml data for request + + """ + templ = Template(''' + $origin + $priority +''') + data = templ.substitute({'origin': origin, 'priority': priority}) + return data + + +def update_binding_origin_xml(origin, priority): + """Generate xml for Update Binding Origin request + + :param origin: Origin type + :type origin: str + :param priority: Origin priority + :type priority: str + :returns: String containing xml data for request + + """ + templ = Template(''' + $origin + $priority +''') + data = templ.substitute({'origin': origin, 'priority': priority}) + return data + + +def delete_binding_origin_xml(origin): + """Generate xml for Delete Binding Origin request + + :param origin: Origin type + :type origin: str + :returns: String containing xml data for request + + """ + templ = Template(''' + $origin +''') + data = templ.substitute({'origin': origin}) + return data + + +def find_binding_origin(origins_json, origin): + """Test if Binding origin of specified value is contained in JSON + + :param origins_json: JSON containing Binding origins + :type origins_json: str + :param origin: Origin to be found + :type origin: str + :returns: True if Binding origin of specified origin type was found, otherwise False. + + """ + for json_origin in parse_binding_origins(origins_json): + if json_origin['origin'] == origin: + return True + return False + + +def find_binding_origin_with_priority(origins_json, origin, priority): + """Test if Binding origin of specified value and priority is contained in JSON + + :param origins_json: JSON containing Binding origins + :type origins_json: str + :param origin: Origin to be found + :type origin: str + :param priority: desired priority of origin + :type priority: str + :returns: True if Binding origin of specified origin type with desired priority was found, otherwise False. + + """ + for json_origin in parse_binding_origins(origins_json): + if json_origin['origin'] == origin: + if json_origin['priority'] == int(priority): + return True + return False + + +def parse_binding_origins(origins_json): + """Parse JSON string into Array of Binding origins + + :param origins_json: JSON containing Binding origins + :type origins_json: str + :returns: Array containing Binding origins. + + """ + output = [] + for origins in origins_json['binding-origins'].values(): + for origin in origins: + output.append(origin) + return output