csit/libraries/Sxp.py

   1 import json
   2 from netaddr import IPAddress
   3 from string import Template
   4
   5
   6 def get_active_controller_from_json(resp, service):
   7     """Gets index of active controller running specified service
   8
   9     :param resp: JSON formatted response from EOS
  10     :type resp: str
  11     :param service: EOS Service to look for
  12     :type service: str
  13     :return: Index of controller
  14     """
  15     entities = json.loads(resp)['entity-owners']['entity-type']
  16     for entity in entities:
  17         if entity['type'] == "org.opendaylight.mdsal.ServiceEntityType":
  18             for instance in entity['entity']:
  19                 if service in instance['id']:
  20                     return int(instance['owner'][-1:])
  21     return 0
  22
  23
  24 def mod(num, base):
  25     """Gets modulo of number
  26
  27     :param num: Number to be used
  28     :type num: str
  29     :param base: Base used
  30     :type base: str
  31     :returns: Int representing modulo of specified numbers.
  32
  33     """
  34     return int(num) % int(base)
  35
  36
  37 def get_average_of_items(items):
  38     """Gets average of items in provided list
  39
  40     :param items: To be proceed
  41     :return: Average value
  42
  43     """
  44     return sum(items) / len(items)
  45
  46
  47 def get_opposing_mode(mode):
  48     """Generate string representing opposing SXP peer mode
  49
  50         :param mode: SXP peer mode
  51         :type mode: str
  52         :returns: String with opposing SXP peer mode.
  53
  54         """
  55     if 'speaker' == mode:
  56         return 'listener'
  57     elif 'listener' == mode:
  58         return 'speaker'
  59     return 'both'
  60
  61
  62 def get_ip_from_number(n, base=2130706432):
  63     """Generate string representing Ipv4 from specified number plus base value
  64
  65     :param n: Number to be converted
  66     :type n: int
  67     :param base: Starting index
  68     :type base: int
  69     :returns: String containing Ipv4.
  70
  71     """
  72     ip = IPAddress(int(base) + n)
  73     return str(ip)
  74
  75
  76 def get_ip_from_number_and_ip(n, ip_address):
  77     """Generate string representing Ipv4 from specified number and IPAddress
  78
  79     :param n: Number to be converted
  80     :type n: int
  81     :param ip_address: Base address
  82     :type ip_address: str
  83     :returns: String containing Ipv4.
  84
  85     """
  86     ip = IPAddress(int(IPAddress(ip_address)) + n)
  87     return str(ip)
  88
  89
  90 def lower_version(ver1, ver2):
  91     """Generate xml containing SGT mach data
  92
  93     :param ver1: Version of SXP protocol for compare
  94     :type ver1: str
  95     :param ver2: Version of SXP protocol for compare
  96     :type ver2: str
  97     :returns: String containing lower from those two specified versions.
  98
  99     """
 100     v1 = int(ver1[-1:])
 101     v2 = int(ver2[-1:])
 102     if v1 <= v2:
 103         return ver1
 104     else:
 105         return ver2
 106
 107
 108 def get_filter_entry(seq, entry_type, sgt="", esgt="", acl="", eacl="", pl="", epl="", ps=""):
 109     """Generate xml containing FilterEntry data
 110
 111     :param seq: Sequence of entry
 112     :type seq: str
 113     :param entry_type: Type of entry (permit/deny)
 114     :type entry_type: str
 115     :param sgt: SGT matches to be added to entry
 116     :type sgt: str
 117     :param esgt: SGT ranges match to be added to entry
 118     :type esgt: str
 119     :param acl: ACL matches to be added to entry
 120     :type acl: str
 121     :param eacl: EACL matches to be added to entry
 122     :type eacl: str
 123     :param pl: PrefixList matches to be added to entry
 124     :type pl: str
 125     :param epl: ExtendedPrefixList matches to be added to entry
 126     :type epl: str
 127     :param ps: PeerSequence matches to be added to entry
 128     :type ps: str
 129     :returns: String containing xml data for request
 130
 131     """
 132     entries = ""
 133     # Generate XML request containing combination of Matches of different types
 134     if sgt:
 135         args = sgt.split(',')
 136         entries += add_sgt_matches_xml(args)
 137     elif esgt:
 138         args = esgt.split(',')
 139         entries += add_sgt_range_xml(args[0], args[1])
 140     if pl:
 141         entries += add_pl_entry_xml(pl)
 142     elif epl:
 143         args = epl.split(',')
 144         entries += add_epl_entry_xml(args[0], args[1], args[2])
 145     if acl:
 146         args = acl.split(',')
 147         entries += add_acl_entry_xml(args[0], args[1])
 148     elif eacl:
 149         args = eacl.split(',')
 150         entries += add_eacl_entry_xml(args[0], args[1], args[2], args[3])
 151     if ps:
 152         args = ps.split(',')
 153         entries += add_ps_entry_xml(args[0], args[1])
 154     # Wrap entries in ACL/PrefixList according to specified values
 155     if pl or epl:
 156         return add_pl_entry_default_xml(seq, entry_type, entries)
 157     elif ps:
 158         return add_ps_entry_default_xml(seq, entry_type, entries)
 159     return add_acl_entry_default_xml(seq, entry_type, entries)
 160
 161
 162 def add_peers(*args):
 163     """Generate xml containing Peer mach data
 164
 165     :param args: Peers data
 166     :type args: dict
 167     :returns: String containing xml data for request
 168
 169     """
 170     templ = Template('''
 171         <sxp-peer>
 172             <peer-address>$ip</peer-address>
 173         </sxp-peer>''')
 174     peers = ""
 175     for count, value in enumerate(args):
 176         peers += templ.substitute({'ip': value})
 177     return peers
 178
 179
 180 def add_domains(*args):
 181     """Generate xml containing Domain mach data
 182
 183     :param args: Domain data
 184     :type args: dict
 185     :returns: String containing xml data for request
 186
 187     """
 188     templ = Template('''
 189         <domain>
 190             <name>$name</name>
 191         </domain>''')
 192     peers = ""
 193     for count, value in enumerate(args):
 194         peers += templ.substitute({'name': value})
 195     return peers
 196
 197
 198 def add_sgt_matches_xml(sgt_entries):
 199     """Generate xml containing SGT mach data
 200
 201     :param sgt_entries: SGT matches
 202     :type sgt_entries: str
 203     :returns: String containing xml data for request
 204
 205     """
 206     templ = Template('''
 207         <matches>$sgt</matches>''')
 208     matches = ""
 209     for sgt in sgt_entries:
 210         matches += templ.substitute({'sgt': sgt})
 211     return matches
 212
 213
 214 def add_sgt_range_xml(start, end):
 215     """Generate xml containing SGT RangeMach data
 216
 217     :param start: Start range of SGT
 218     :type start: str
 219     :param end: End range of SGT
 220     :type end: str
 221     :returns: String containing xml data for request
 222
 223     """
 224     templ = Template('''
 225         <sgt-start>$start</sgt-start>
 226         <sgt-end>$end</sgt-end>''')
 227     match = templ.substitute({'start': start, 'end': end})
 228     return match
 229
 230
 231 def add_acl_entry_default_xml(seq, entry_type, acl_entries):
 232     """Generate xml containing AccessList data
 233
 234     :param seq: Sequence of PrefixList entry
 235     :type seq: str
 236     :param entry_type: Entry type (permit/deny)
 237     :type entry_type: str
 238     :param acl_entries: XML data containing AccessList entries
 239     :type acl_entries: str
 240     :returns: String containing xml data for request
 241
 242     """
 243     templ = Template('''
 244         <acl-entry>
 245             <entry-type>$entry_type</entry-type>
 246             <entry-seq>$seq</entry-seq>$acl_entries
 247         </acl-entry>''')
 248     matches = templ.substitute(
 249         {'seq': seq, 'entry_type': entry_type, 'acl_entries': acl_entries})
 250     return matches
 251
 252
 253 def add_acl_entry_xml(ip, mask):
 254     """Generate xml containing AccessList data
 255
 256     :param ip: Ipv4/6 address
 257     :type ip: str
 258     :param mask: Ipv4/6 wildcard mask
 259     :type mask: str
 260     :returns: String containing xml data for request
 261
 262     """
 263     templ = Template('''
 264         <acl-match>
 265             <ip-address>$ip</ip-address>
 266             <wildcard-mask>$mask</wildcard-mask>
 267         </acl-match>''')
 268     return templ.substitute({'ip': ip, 'mask': mask})
 269
 270
 271 def add_eacl_entry_xml(ip, mask, amask, wmask):
 272     """Generate xml containing ExtendedAccessList data
 273
 274     :param ip: Ipv4/6 address
 275     :type ip: str
 276     :param mask: Ipv4/6 wildcard mask
 277     :type mask: str
 278     :param amask: Ipv4/6 address mask
 279     :type amask: str
 280     :param wmask: Ipv4/6 address wildcard mask
 281     :type wmask: str
 282     :returns: String containing xml data for request
 283
 284     """
 285     templ = Template('''
 286         <acl-match>
 287             <ip-address>$ip</ip-address>
 288             <wildcard-mask>$mask</wildcard-mask>
 289             <mask>
 290               <address-mask>$amask</address-mask>
 291               <wildcard-mask>$wmask</wildcard-mask>
 292             </mask>
 293         </acl-match>''')
 294     return templ.substitute({'ip': ip, 'mask': mask, 'amask': amask, 'wmask': wmask})
 295
 296
 297 def add_ps_entry_default_xml(seq, entry_type, ps_entries):
 298     """Generate xml containing PeerSequence data
 299
 300     :param seq: Sequence of PrefixList entry
 301     :type seq: str
 302     :param entry_type: Entry type (permit/deny)
 303     :type entry_type: str
 304     :param ps_entries: XML data containing PeerSequence entries
 305     :type ps_entries: str
 306     :returns: String containing xml data for request
 307
 308     """
 309     templ = Template('''
 310     <peer-sequence-entry xmlns="urn:opendaylight:sxp:controller">
 311           <entry-type>$entry_type</entry-type>
 312           <entry-seq>$seq</entry-seq>$ps_entries
 313     </peer-sequence-entry>''')
 314     return templ.substitute({'seq': seq, 'entry_type': entry_type, 'ps_entries': ps_entries})
 315
 316
 317 def add_pl_entry_default_xml(seq, entry_type, pl_entries):
 318     """Generate xml containing PrefixList data
 319
 320     :param seq: Sequence of PrefixList entry
 321     :type seq: str
 322     :param entry_type: Entry type (permit/deny)
 323     :type entry_type: str
 324     :param pl_entries: XML data containing PrefixList entries
 325     :type pl_entries: str
 326     :returns: String containing xml data for request
 327
 328     """
 329     templ = Template('''
 330     <prefix-list-entry xmlns="urn:opendaylight:sxp:controller">
 331           <entry-type>$entry_type</entry-type>
 332           <entry-seq>$seq</entry-seq>$pl_entries
 333     </prefix-list-entry>''')
 334     return templ.substitute({'seq': seq, 'entry_type': entry_type, 'pl_entries': pl_entries})
 335
 336
 337 def add_pl_entry_xml(prefix):
 338     """Generate xml containing PrefixList data
 339
 340     :param prefix: Ipv4/6 prefix
 341     :type prefix: str
 342     :returns: String containing xml data for request
 343
 344     """
 345     templ = Template('''
 346         <prefix-list-match>
 347             <ip-prefix>$prefix</ip-prefix>
 348         </prefix-list-match>''')
 349     return templ.substitute({'prefix': prefix})
 350
 351
 352 def add_epl_entry_xml(prefix, op, mask):
 353     """Generate xml containing Extended PrefixList data
 354
 355     :param prefix: Ipv4/6 prefix
 356     :type prefix: str
 357     :param op: PrefixList option (ge/le/eq)
 358     :type op: str
 359     :param mask: Ipv4/6 Mask
 360     :type mask: str
 361     :returns: String containing xml data for request
 362
 363     """
 364     templ = Template('''
 365         <prefix-list-match>
 366             <ip-prefix>$prefix</ip-prefix>
 367             <mask>
 368                 <mask-range>$op</mask-range>
 369                 <mask-value>$mask</mask-value>
 370             </mask>
 371         </prefix-list-match>''')
 372     return templ.substitute({'prefix': prefix, 'mask': mask, 'op': op})
 373
 374
 375 def add_ps_entry_xml(op, length):
 376     """Generate xml containing Extended PrefixList data
 377
 378     :param op: PrefixList option (ge/le/eq)
 379     :type op: str
 380     :param length: PeerSequence length
 381     :type length: str
 382     :returns: String containing xml data for request
 383
 384     """
 385     templ = Template('''
 386         <peer-sequence-length>$length</peer-sequence-length>
 387         <peer-sequence-range>$op</peer-sequence-range>
 388         ''')
 389     return templ.substitute({'length': length, 'op': op})
 390
 391
 392 def parse_peer_groups(groups_json):
 393     """Parse JSON string into Array of PeerGroups
 394
 395     :param groups_json: JSON containing PeerGroups
 396     :type groups_json: str
 397     :returns: Array containing PeerGroups.
 398
 399     """
 400     data = json.loads(groups_json)
 401     groups = data['output']
 402     output = []
 403     for group in groups.values():
 404         output += group
 405     return output
 406
 407
 408 def parse_connections(connections_json):
 409     """Parse JSON string into Array of Connections
 410
 411     :param connections_json: JSON containing Connections
 412     :type connections_json: str
 413     :returns: Array containing Connections.
 414
 415     """
 416     data = json.loads(connections_json)
 417     connections = data['output']['connections']
 418     output = []
 419     for connection in connections.values():
 420         output += connection
 421     return output
 422
 423
 424 def find_connection(connections_json, version, mode, ip, port, state):
 425     """Test if Connection with specified values is contained in JSON
 426
 427     :param connections_json: JSON containing Connections
 428     :type connections_json: str
 429     :param version: Version of SXP protocol (version1/2/3/4)
 430     :type version: str
 431     :param mode: Mode of SXP peer (speaker/listener/both)
 432     :type mode: str
 433     :param ip: Ipv4/6 address of remote peer
 434     :type ip: str
 435     :param port: Port on with remote peer listens
 436     :type port: str
 437     :param state: State of connection (on/off/pendingOn/deleteHoldDown)
 438     :type state: str
 439     :returns: True if Connection with specified params was found, otherwise False.
 440
 441     """
 442     for connection in parse_connections(connections_json):
 443         if (connection['peer-address'] == ip and connection['tcp-port'] == int(port) and (
 444                 mode.strip() == 'any' or connection['mode'] == mode) and connection['version'] == version):
 445             if state == 'none':
 446                 return True
 447             elif connection['state'] == state:
 448                 return True
 449     return False
 450
 451
 452 def parse_bindings(bindings_json):
 453     """Parse JSON string into Array of Bindings
 454
 455     :param bindings_json: JSON containing Bindings
 456     :type bindings_json: str
 457     :returns: Array containing Bindings.
 458
 459     """
 460     data = json.loads(bindings_json)
 461     output = []
 462     for bindings_json in data['output'].values():
 463         for binding in bindings_json:
 464             output.append(binding)
 465     return output
 466
 467
 468 def find_binding(bindings, sgt, prefix):
 469     """Test if Binding with specified values is contained in JSON
 470
 471     :param bindings: JSON containing Bindings
 472     :type bindings: str
 473     :param sgt: Source Group Tag
 474     :type sgt: str
 475     :param prefix: Ipv4/6 prefix
 476     :type prefix: str
 477     :returns: True if Binding with specified params was found, otherwise False.
 478
 479     """
 480     for binding in parse_bindings(bindings):
 481         if binding['sgt'] == int(sgt):
 482             for ip_prefix in binding['ip-prefix']:
 483                 if ip_prefix == prefix:
 484                     return True
 485     return False
 486
 487
 488 def parse_prefix_groups(prefix_groups_json, source_):
 489     """Parse JSON string into Array of PrefixGroups
 490
 491     :param prefix_groups_json: JSON containing PrefixGroups
 492     :type prefix_groups_json: str
 493     :param source_: Source of PrefixGroups (sxp/local)
 494     :type source_: str
 495     :returns: Array containing PrefixGroups.
 496
 497     """
 498     data = json.loads(prefix_groups_json)
 499     bindings = data['sxp-node:master-database']
 500     output = []
 501     for binding in bindings.values():
 502         for binding_source in binding:
 503             if source_ == "any" or binding_source['binding-source'] == source_:
 504                 for prefix_group in binding_source['prefix-group']:
 505                     output.append(prefix_group)
 506     return output
 507
 508
 509 def find_binding_legacy(prefix_groups_json, sgt, prefix, source_, action):
 510     """Test if Binding with specified values is contained in JSON
 511
 512     :param prefix_groups_json: JSON containing Bindings and PrefixGroups
 513     :type prefix_groups_json: str
 514     :param sgt: Source Group Tag
 515     :type sgt: str
 516     :param prefix: Ipv4/6 prefix
 517     :type prefix: str
 518     :param source_: Source of binding (local/sxp)
 519     :type source_: str
 520     :param action: Action for binding (add/delete)
 521     :type action: str
 522     :returns: True if Binding with specified params was found, otherwise False.
 523
 524     """
 525     found = False
 526     for prefixgroup in parse_prefix_groups(prefix_groups_json, source_):
 527         if prefixgroup['sgt'] == int(sgt):
 528             for binding in prefixgroup['binding']:
 529                 if binding['ip-prefix'] == prefix and binding['action'] == action:
 530                     found = True
 531     return found
 532
 533
 534 def add_connection_xml(version, mode, ip, port, node, password_, domain_name, bindings_timeout=0, security_mode=''):
 535     """Generate xml for Add Connection request
 536
 537     :param version: Version of SXP protocol (version1/2/3/4)
 538     :type version: str
 539     :param mode: Mode of SXP peer (speaker/listener/both)
 540     :type mode: str
 541     :param ip: Ipv4/6 address of remote peer
 542     :type ip: str
 543     :param port: Port on with remote peer listens
 544     :type port: str
 545     :param node: Ipv4 address of node
 546     :type node: str
 547     :param password_: Password type (none/default)
 548     :type password_: str
 549     :param domain_name: Name of Domain
 550     :type domain_name: str
 551     :param security_mode: Default/TSL security
 552     :type security_mode: str
 553     :param bindings_timeout: Specifies DHD and Reconciliation timers
 554     :type bindings_timeout: int
 555     :returns: String containing xml data for request
 556
 557     """
 558     templ = Template('''<input>
 559    <requested-node xmlns="urn:opendaylight:sxp:controller">$node</requested-node>
 560    $domain
 561    <connections xmlns="urn:opendaylight:sxp:controller">
 562       <connection>
 563          <peer-address>$ip</peer-address>
 564          <tcp-port>$port</tcp-port>
 565          <password>$password_</password>
 566          <mode>$mode</mode>
 567          <version>$version</version>
 568          <description>Connection to ISR-G2</description>
 569          $security_type
 570          <connection-timers>
 571             <hold-time-min-acceptable>45</hold-time-min-acceptable>
 572             <keep-alive-time>30</keep-alive-time>
 573             <reconciliation-time>$timeout</reconciliation-time>
 574             <delete-hold-down-time>$timeout</delete-hold-down-time>
 575          </connection-timers>
 576       </connection>
 577    </connections>
 578 </input>
 579 ''')
 580     data = templ.substitute(
 581         {'ip': ip, 'port': port, 'mode': mode, 'version': version, 'node': node,
 582          'password_': password_, 'domain': get_domain_name(domain_name), 'timeout': bindings_timeout,
 583          'security_type': '<security-type>' + security_mode + '</security-type>' if security_mode else ''})
 584     return data
 585
 586
 587 def delete_connections_xml(address, port, node, domain_name):
 588     """Generate xml for Delete Connection request
 589
 590     :param address: Ipv4/6 address of remote peer
 591     :type address: str
 592     :param port: Port on with remote peer listens
 593     :type port: str
 594     :param node: Ipv4 address of node
 595     :type node: str
 596     :param domain_name: Name of Domain
 597     :type domain_name: str
 598     :returns: String containing xml data for request
 599
 600     """
 601     templ = Template('''<input>
 602    <requested-node xmlns="urn:opendaylight:sxp:controller">$node</requested-node>
 603    $domain
 604    <peer-address xmlns="urn:opendaylight:sxp:controller">$address</peer-address>
 605    <tcp-port xmlns="urn:opendaylight:sxp:controller">$port</tcp-port>
 606 </input>''')
 607     data = templ.substitute({'address': address, 'port': port, 'node': node, 'domain': get_domain_name(domain_name)})
 608     return data
 609
 610
 611 def add_peer_group_xml(name, peers, ip):
 612     """Generate xml for Add PeerGroups request
 613
 614     :param name: Name of PeerGroup
 615     :type name: str
 616     :param peers: XML formatted peers that will be added to group
 617     :type peers: str
 618     :param ip: Ipv4 address of node
 619     :type ip: str
 620     :returns: String containing xml data for request
 621
 622     """
 623     templ = Template('''<input>
 624   <requested-node xmlns="urn:opendaylight:sxp:controller">$ip</requested-node>
 625   <sxp-peer-group xmlns="urn:opendaylight:sxp:controller">
 626     <name xmlns="urn:opendaylight:sxp:controller">$name</name>
 627     <sxp-peers xmlns="urn:opendaylight:sxp:controller">$peers</sxp-peers>
 628     </sxp-peer-group>
 629 </input>''')
 630     data = templ.substitute({'name': name, 'peers': peers, 'ip': ip})
 631     return data
 632
 633
 634 def delete_peer_group_xml(name, ip):
 635     """Generate xml for Delete PeerGroup request
 636
 637     :param name: Name of PeerGroup
 638     :type name: str
 639     :param ip: Ipv4 address of node
 640     :type ip: str
 641     :returns: String containing xml data for request
 642
 643     """
 644     templ = Template('''<input>
 645   <requested-node xmlns="urn:opendaylight:sxp:controller">$ip</requested-node>
 646   <peer-group-name xmlns="urn:opendaylight:sxp:controller">$name</peer-group-name>
 647 </input>''')
 648     data = templ.substitute({'name': name, 'ip': ip})
 649     return data
 650
 651
 652 def get_peer_groups_from_node_xml(ip):
 653     """Generate xml for Get PeerGroups request
 654
 655     :param ip: Ipv4 address of node
 656     :type ip: str
 657     :returns: String containing xml data for request
 658
 659     """
 660     templ = Template('''<input>
 661    <requested-node xmlns="urn:opendaylight:sxp:controller">$ip</requested-node>
 662 </input>''')
 663     data = templ.substitute({'ip': ip})
 664     return data
 665
 666
 667 def add_filter_xml(group, filter_type, entries, ip, policy=None):
 668     """Generate xml for Add Filter request
 669
 670     :param group: Name of group containing filter
 671     :type group: str
 672     :param filter_type: Type of filter
 673     :type filter_type: str
 674     :param entries: XML formatted entries that will be added in filter
 675     :type entries: str
 676     :param ip: Ipv4 address of node
 677     :type ip: str
 678     :param policy: Policy of filter update mechanism
 679     :type policy: str
 680     :returns: String containing xml data for request
 681
 682     """
 683     if policy:
 684         policy = "<filter-policy>" + policy + "</filter-policy>"
 685     else:
 686         policy = ""
 687     templ = Template('''<input>
 688   <requested-node xmlns="urn:opendaylight:sxp:controller">$ip</requested-node>
 689   <peer-group-name xmlns="urn:opendaylight:sxp:controller">$group</peer-group-name>
 690   <sxp-filter xmlns="urn:opendaylight:sxp:controller">
 691     $filter_policy
 692     <filter-type>$filter_type</filter-type>$entries
 693   </sxp-filter>
 694 </input>''')
 695     data = templ.substitute(
 696         {'group': group, 'filter_type': filter_type, 'ip': ip, 'entries': entries, 'filter_policy': policy})
 697     return data
 698
 699
 700 def add_domain_filter_xml(domain, domains, entries, ip, filter_name=None):
 701     """Generate xml for Add Domain Filter request
 702
 703     :param domain: Name of Domain containing filter
 704     :type domain: str
 705     :param domains: Domains on which filter will be applied
 706     :type domains: str
 707     :param entries: XML formatted entries that will be added in filter
 708     :type entries: str
 709     :param ip: Ipv4 address of node
 710     :type ip: str
 711     :param filter_name: Name of filter
 712     :type filter_name: str
 713     :returns: String containing xml data for request
 714
 715     """
 716     if filter_name:
 717         filter_name = "<filter-name>" + filter_name + "</filter-name>"
 718     templ = Template('''<input>
 719   <requested-node xmlns="urn:opendaylight:sxp:controller">$ip</requested-node>
 720   <domain-name xmlns="urn:opendaylight:sxp:controller">$domain</domain-name>
 721   <sxp-domain-filter xmlns="urn:opendaylight:sxp:controller">
 722     $filter_name
 723     <domains>$domains</domains>
 724     $entries
 725   </sxp-domain-filter>
 726 </input>''')
 727     data = templ.substitute(
 728         {'domain': domain, 'domains': domains, 'ip': ip, 'entries': entries, 'filter_name': filter_name})
 729     return data
 730
 731
 732 def delete_filter_xml(group, filter_type, ip):
 733     """Generate xml for Delete Filter request
 734
 735     :param group: Name of group containing filter
 736     :type group: str
 737     :param filter_type: Type of filter
 738     :type filter_type: str
 739     :param ip: Ipv4 address of node
 740     :type ip: str
 741     :returns: String containing xml data for request
 742
 743     """
 744     templ = Template('''<input>
 745   <requested-node xmlns="urn:opendaylight:sxp:controller">$ip</requested-node>
 746   <peer-group-name xmlns="urn:opendaylight:sxp:controller">$group</peer-group-name>
 747   <filter-type xmlns="urn:opendaylight:sxp:controller">$filter_type</filter-type>
 748 </input>''')
 749     data = templ.substitute(
 750         {'group': group, 'filter_type': filter_type, 'ip': ip})
 751     return data
 752
 753
 754 def delete_domain_filter_xml(domain, ip, filter_name=None):
 755     """Generate xml for Delete Filter request
 756
 757     :param domain: Name of Domain containing filter
 758     :type domain: str
 759     :param ip: Ipv4 address of node
 760     :type ip: str
 761     :param filter_name: Name of filter
 762     :type filter_name: str
 763     :returns: String containing xml data for request
 764
 765     """
 766     if filter_name:
 767         filter_name = '<filter-name xmlns="urn:opendaylight:sxp:controller">' + filter_name + "</filter-name>"
 768     templ = Template('''<input>
 769   <requested-node xmlns="urn:opendaylight:sxp:controller">$ip</requested-node>
 770   <domain-name xmlns="urn:opendaylight:sxp:controller">$domain</domain-name>
 771   $filter_name
 772 </input>''')
 773     data = templ.substitute(
 774         {'domain': domain, 'ip': ip, 'filter_name': filter_name})
 775     return data
 776
 777
 778 def get_connections_from_node_xml(ip, domain_name):
 779     """Generate xml for Get Connections request
 780
 781     :param ip: Ipv4 address of node
 782     :type ip: str
 783     :param domain_name: Name of Domain
 784     :type domain_name: str
 785     :returns: String containing xml data for request
 786
 787     """
 788     templ = Template('''<input>
 789    <requested-node xmlns="urn:opendaylight:sxp:controller">$ip</requested-node>
 790    $domain
 791 </input>''')
 792     data = templ.substitute({'ip': ip, 'domain': get_domain_name(domain_name)})
 793     return data
 794
 795
 796 def get_bindings_from_node_xml(ip, binding_range, domain_name):
 797     """Generate xml for Get Bindings request
 798
 799     :param binding_range: All or only Local bindings
 800     :type binding_range: str
 801     :param ip: Ipv4 address of node
 802     :type ip: str
 803     :param domain_name: Name of Domain
 804     :type domain_name: str
 805     :returns: String containing xml data for request
 806
 807     """
 808     templ = Template('''<input>
 809   <requested-node xmlns="urn:opendaylight:sxp:controller">$ip</requested-node>
 810   <bindings-range xmlns="urn:opendaylight:sxp:controller">$range</bindings-range>
 811   $domain
 812 </input>''')
 813     data = templ.substitute({'ip': ip, 'range': binding_range, 'domain': get_domain_name(domain_name)})
 814     return data
 815
 816
 817 def add_node_xml(node_id, port, password, version, node_ip=None, expansion=0, bindings_timeout=0, keystores=None,
 818                  retry_open_timer=1):
 819     """Generate xml for Add Node request
 820
 821     :param node_id: Ipv4 address formatted node id
 822     :type node_id: str
 823     :param node_ip: Ipv4 address of node
 824     :type node_ip: strl
 825     :param port: Node port number
 826     :type port: int
 827     :param password: TCP-MD5 password
 828     :type password: str
 829     :param version: Sxp device version
 830     :type version: str
 831     :param expansion: Bindings expansion
 832     :type expansion: int
 833     :param bindings_timeout: Specifies DHD and Reconciliation timers
 834     :type bindings_timeout: int
 835     :param keystores: SSL keystore and truststore specification
 836     :type keystores: dict
 837     :returns: String containing xml data for request
 838
 839     """
 840     tls = ''
 841     if keystores:
 842         tls = Template('''
 843         <tls>
 844             <keystore>
 845               <location>$keystore</location>
 846               <type>JKS</type>
 847               <path-type>PATH</path-type>
 848               <password>$passwd</password>
 849             </keystore>
 850             <truststore>
 851               <location>$truststore</location>
 852               <type>JKS</type>
 853               <path-type>PATH</path-type>
 854               <password>$passwd</password>
 855             </truststore>
 856             <certificate-password>$passwd</certificate-password>
 857         </tls>
 858     ''').substitute(
 859             {'keystore': keystores['keystore'], 'truststore': keystores['truststore'], 'passwd': keystores['password']})
 860
 861     templ = Template('''<input xmlns="urn:opendaylight:sxp:controller">
 862     <node-id>$id</node-id>
 863     <timers>
 864         <retry-open-time>$retry_open_timer</retry-open-time>
 865         <hold-time-min-acceptable>120</hold-time-min-acceptable>
 866         <delete-hold-down-time>$timeout</delete-hold-down-time>
 867         <hold-time-min>90</hold-time-min>
 868         <reconciliation-time>$timeout</reconciliation-time>
 869         <hold-time>90</hold-time>
 870         <hold-time-max>180</hold-time-max>
 871         <keep-alive-time>30</keep-alive-time>
 872     </timers>
 873     <mapping-expanded>$expansion</mapping-expanded>
 874     <security>
 875         $tls
 876         <password>$password</password>
 877     </security>
 878     <tcp-port>$port</tcp-port>
 879     <version>$version</version>
 880     <description>ODL SXP Controller</description>
 881     <source-ip>$ip</source-ip>
 882 </input>''')
 883     data = templ.substitute(
 884         {'ip': node_ip or node_id, 'id': node_id, 'port': port, 'password': password,
 885          'version': version, 'expansion': expansion, 'timeout': bindings_timeout, 'tls': tls,
 886          'retry_open_timer': retry_open_timer})
 887     return data
 888
 889
 890 def delete_node_xml(node_id):
 891     """Generate xml for Delete node request
 892
 893     :param node_id: Ipv4 address formatted node id
 894     :type node_id: str
 895     :returns: String containing xml data for request
 896
 897     """
 898     templ = Template('''<input xmlns="urn:opendaylight:sxp:controller">
 899   <node-id>$id</node-id>
 900 </input>''')
 901     data = templ.substitute({'id': node_id})
 902     return data
 903
 904
 905 def add_domain_xml_fluorine(node_id, name, sgt, prefixes, origin):
 906     """Generate xml for Add Domain request (Fluorine version: bindings with origin)
 907
 908     :param node_id: Id of node
 909     :type node_id: str
 910     :param name: Name of Domain
 911     :type name: str
 912     :param sgt: Security group
 913     :type sgt: int
 914     :param prefixes: List of ip-prefixes
 915     :type prefixes: str
 916     :param origin: Origin of added bindings
 917     :type origin: str
 918     :returns: String containing xml data for request
 919
 920     """
 921     master_database = ''
 922     if prefixes != 'None':
 923         xml_prefixes = ''
 924         for prefix in prefixes.split(','):
 925             xml_prefixes += '\n' + '<ip-prefix>' + prefix + '</ip-prefix>'
 926         if xml_prefixes:
 927             master_database += '''<master-database>
 928             <binding>
 929                 <sgt>$sgt</sgt>
 930                 $xml_prefixes
 931             </binding>
 932         </master-database>'''
 933             master_database = Template(master_database).substitute(({'sgt': sgt, 'xml_prefixes': xml_prefixes}))
 934
 935     templ = Template('''<input xmlns="urn:opendaylight:sxp:controller">
 936     <node-id>$id</node-id>
 937     <domain-name>$name</domain-name>
 938     <origin>$origin</origin>
 939     $master_database
 940 </input>''')
 941
 942     data = templ.substitute({'name': name, 'id': node_id, 'origin': origin, 'master_database': master_database})
 943     return data
 944
 945
 946 def add_domain_xml_oxygen(node_id, name, sgt, prefixes):
 947     """Generate xml for Add Domain request (Oxygen version: bindings without origin)
 948
 949     :param node_id: Id of node
 950     :type node_id: str
 951     :param name: Name of Domain
 952     :type name: str
 953     :param sgt: Security group
 954     :type sgt: int
 955     :param prefixes: List of ip-prefixes
 956     :type prefixes: str
 957     :returns: String containing xml data for request
 958
 959     """
 960     master_database = ''
 961     if prefixes != 'None':
 962         xml_prefixes = ''
 963         for prefix in prefixes.split(','):
 964             xml_prefixes += '\n' + '<ip-prefix>' + prefix + '</ip-prefix>'
 965         if xml_prefixes:
 966             master_database += '''<master-database>
 967             <binding>
 968                 <sgt>$sgt</sgt>
 969                 $xml_prefixes
 970             </binding>
 971         </master-database>'''
 972             master_database = Template(master_database).substitute(({'sgt': sgt, 'xml_prefixes': xml_prefixes}))
 973
 974     templ = Template('''<input xmlns="urn:opendaylight:sxp:controller">
 975     <node-id>$id</node-id>
 976     <domain-name>$name</domain-name>
 977     $master_database
 978 </input>''')
 979
 980     data = templ.substitute({'name': name, 'id': node_id, 'master_database': master_database})
 981     return data
 982
 983
 984 def delete_domain_xml(node_id, name):
 985     """Generate xml for Remove Domain request
 986
 987     :param node_id: Id of node
 988     :type node_id: str
 989     :param name: Name of Domain
 990     :type name: str
 991     :returns: String containing xml data for request
 992
 993     """
 994     return add_domain_xml(node_id, name)
 995
 996
 997 def get_domain_name(domain_name):
 998     """Generate xml for Get Bindings request
 999
1000     :param domain_name: Name of Domain
1001     :type domain_name: str
1002     :returns: String containing xml data for request
1003
1004     """
1005     if domain_name == 'global':
1006         return ''
1007     else:
1008         return '<domain-name xmlns="urn:opendaylight:sxp:controller">' + domain_name + '</domain-name>'
1009
1010
1011 def add_bindings_xml_fluorine(node_id, domain, sgt, prefixes, origin):
1012     """Generate xml for Add Bindings request (Fluorine version with origin type)
1013
1014     :param node_id: Id of node
1015     :type node_id: str
1016     :param domain: Name of Domain
1017     :type domain: str
1018     :param sgt: Security group
1019     :type sgt: int
1020     :param prefixes: List of ip-prefixes
1021     :type prefixes: str
1022     :param origin: Origin of added bindings
1023     :type origin: str
1024     :returns: String containing xml data for request
1025
1026     """
1027     xml_prefixes = ''
1028     for prefix in prefixes.split(','):
1029         xml_prefixes += '\n' + '<ip-prefix>' + prefix + '</ip-prefix>'
1030     templ = Template('''<input xmlns="urn:opendaylight:sxp:controller">
1031     <node-id>$id</node-id>
1032     <domain-name>$name</domain-name>
1033     <origin>$origin</origin>
1034     <master-database>
1035         <binding>
1036             <sgt>$sgt</sgt>
1037             $xml_prefixes
1038         </binding>
1039     </master-database>
1040 </input>''')
1041     data = templ.substitute({'name': domain, 'id': node_id, 'sgt': sgt, 'xml_prefixes': xml_prefixes, 'origin': origin})
1042     return data
1043
1044
1045 def add_bindings_xml_oxygen(node_id, domain, sgt, prefixes):
1046     """Generate xml for Add Bindings request (Oxygen version without origin type)
1047
1048     :param node_id: Id of node
1049     :type node_id: str
1050     :param domain: Name of Domain
1051     :type domain: str
1052     :param sgt: Security group
1053     :type sgt: int
1054     :param prefixes: List of ip-prefixes
1055     :type prefixes: str
1056     :returns: String containing xml data for request
1057
1058     """
1059     xml_prefixes = ''
1060     for prefix in prefixes.split(','):
1061         xml_prefixes += '\n' + '<ip-prefix>' + prefix + '</ip-prefix>'
1062     templ = Template('''<input xmlns="urn:opendaylight:sxp:controller">
1063     <node-id>$id</node-id>
1064     <domain-name>$name</domain-name>
1065         <binding>
1066             <sgt>$sgt</sgt>
1067             $xml_prefixes
1068         </binding>
1069 </input>''')
1070     data = templ.substitute({'name': domain, 'id': node_id, 'sgt': sgt, 'xml_prefixes': xml_prefixes})
1071     return data
1072
1073
1074 def delete_bindings_xml(node_id, domain, sgt, prefixes):
1075     """Generate xml for Remove Bindings request
1076
1077     :param node_id: Id of node
1078     :type node_id: str
1079     :param domain: Name of Domain
1080     :type domain: str
1081     :param sgt: Security group
1082     :type sgt: int
1083     :param prefixes: Comma separated list of ip-prefixes
1084     :type prefixes: str
1085     :returns: String containing xml data for request
1086
1087     """
1088     xml_prefixes = ''
1089     for prefix in prefixes.split(','):
1090         xml_prefixes += '\n' + '<ip-prefix>' + prefix + '</ip-prefix>'
1091     templ = Template('''<input xmlns="urn:opendaylight:sxp:controller">
1092     <node-id>$id</node-id>
1093     <domain-name>$name</domain-name>
1094     <binding>
1095         <sgt>$sgt</sgt>
1096         $xml_prefixes
1097     </binding>
1098 </input>''')
1099     data = templ.substitute({'name': domain, 'id': node_id, 'sgt': sgt, 'xml_prefixes': xml_prefixes})
1100     return data
1101
1102
1103 def prefix_range(start, end):
1104     """Generate and concatenate ip-prefixes
1105
1106     :param start: Start index
1107     :type start: str
1108     :param end: End index
1109     :type end: str
1110     :returns: String containing concatenated ip-prefixes
1111
1112     """
1113     start = int(start)
1114     end = int(end)
1115     index = 0
1116     prefixes = ''
1117     while index < end:
1118         prefixes += get_ip_from_number(index + start) + '/32'
1119         index += 1
1120         if index < end:
1121             prefixes += ','
1122     return prefixes
1123
1124
1125 def route_definition_xml(virtual_ip, net_mask, interface):
1126     """Generate xml for Add Bindings request
1127
1128     :param interface: Network interface name
1129     :type interface: str
1130     :param net_mask: NetMask of virtual ip
1131     :type net_mask: str
1132     :param virtual_ip: Virtual ip
1133     :type virtual_ip: str
1134     :returns: String containing xml data for request
1135
1136     """
1137     templ = Template('''
1138     <routing-definition>
1139         <ip-address>$vip</ip-address>
1140         <interface>$interface</interface>
1141         <netmask>$mask</netmask>
1142     </routing-definition>
1143     ''')
1144     data = templ.substitute({'mask': net_mask, 'vip': virtual_ip, 'interface': interface})
1145     return data
1146
1147
1148 def route_definitions_xml(routes, old_routes=None):
1149     """Generate xml for Add Bindings request
1150
1151     :param routes: XML formatted data containing RouteDefinitions
1152     :type routes: str
1153     :param old_routes: Routes add to request that needs to persist
1154     :type old_routes: str
1155     :returns: String containing xml data for request
1156
1157     """
1158     if old_routes and "</sxp-cluster-route>" in old_routes:
1159         templ = Template(old_routes.replace("</sxp-cluster-route>", "$routes</sxp-cluster-route>"))
1160     else:
1161         templ = Template('''<sxp-cluster-route xmlns="urn:opendaylight:sxp:cluster:route">
1162     $routes
1163 </sxp-cluster-route>
1164     ''')
1165     data = templ.substitute({'routes': routes})
1166     return data
1167
1168
1169 def add_binding_origin_xml(origin, priority):
1170     """Generate xml for Add Binding Origin request
1171
1172     :param origin: Origin type
1173     :type origin: str
1174     :param priority: Origin priority
1175     :type priority: str
1176     :returns: String containing xml data for request
1177
1178     """
1179     templ = Template('''<input xmlns="urn:opendaylight:sxp:config:controller">
1180     <origin>$origin</origin>
1181     <priority>$priority</priority>
1182 </input>''')
1183     data = templ.substitute({'origin': origin, 'priority': priority})
1184     return data
1185
1186
1187 def update_binding_origin_xml(origin, priority):
1188     """Generate xml for Update Binding Origin request
1189
1190     :param origin: Origin type
1191     :type origin: str
1192     :param priority: Origin priority
1193     :type priority: str
1194     :returns: String containing xml data for request
1195
1196     """
1197     templ = Template('''<input xmlns="urn:opendaylight:sxp:config:controller">
1198     <origin>$origin</origin>
1199     <priority>$priority</priority>
1200 </input>''')
1201     data = templ.substitute({'origin': origin, 'priority': priority})
1202     return data
1203
1204
1205 def delete_binding_origin_xml(origin):
1206     """Generate xml for Delete Binding Origin request
1207
1208     :param origin: Origin type
1209     :type origin: str
1210     :returns: String containing xml data for request
1211
1212     """
1213     templ = Template('''<input xmlns="urn:opendaylight:sxp:config:controller">
1214     <origin>$origin</origin>
1215 </input>''')
1216     data = templ.substitute({'origin': origin})
1217     return data
1218
1219
1220 def find_binding_origin(origins_json, origin):
1221     """Test if Binding origin of specified value is contained in JSON
1222
1223     :param origins_json: JSON containing Binding origins
1224     :type origins_json: str
1225     :param origin: Origin to be found
1226     :type origin: str
1227     :returns: True if Binding origin of specified origin type was found, otherwise False.
1228
1229     """
1230     for json_origin in parse_binding_origins(origins_json):
1231         if json_origin['origin'] == origin:
1232             return True
1233     return False
1234
1235
1236 def find_binding_origin_with_priority(origins_json, origin, priority):
1237     """Test if Binding origin of specified value and priority is contained in JSON
1238
1239     :param origins_json: JSON containing Binding origins
1240     :type origins_json: str
1241     :param origin: Origin to be found
1242     :type origin: str
1243     :param priority: desired priority of origin
1244     :type priority: str
1245     :returns: True if Binding origin of specified origin type with desired priority was found, otherwise False.
1246
1247     """
1248     for json_origin in parse_binding_origins(origins_json):
1249         if json_origin['origin'] == origin:
1250             if json_origin['priority'] == int(priority):
1251                 return True
1252     return False
1253
1254
1255 def parse_binding_origins(origins_json):
1256     """Parse JSON string into Array of Binding origins
1257
1258     :param origins_json: JSON containing Binding origins
1259     :type origins_json: str
1260     :returns: Array containing Binding origins.
1261
1262     """
1263     output = []
1264     for origins in origins_json['binding-origins'].values():
1265         for origin in origins:
1266             output.append(origin)
1267     return output