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             <hold-time>90</hold-time>
 576             <hold-time-max>180</hold-time-max>
 577             <hold-time-min>90</hold-time-min>
 578          </connection-timers>
 579       </connection>
 580    </connections>
 581 </input>
 582 ''')
 583     data = templ.substitute(
 584         {'ip': ip, 'port': port, 'mode': mode, 'version': version, 'node': node,
 585          'password_': password_, 'domain': get_domain_name(domain_name), 'timeout': bindings_timeout,
 586          'security_type': '<security-type>' + security_mode + '</security-type>' if security_mode else ''})
 587     return data
 588
 589
 590 def delete_connections_xml(address, port, node, domain_name):
 591     """Generate xml for Delete Connection request
 592
 593     :param address: Ipv4/6 address of remote peer
 594     :type address: str
 595     :param port: Port on with remote peer listens
 596     :type port: str
 597     :param node: Ipv4 address of node
 598     :type node: str
 599     :param domain_name: Name of Domain
 600     :type domain_name: str
 601     :returns: String containing xml data for request
 602
 603     """
 604     templ = Template('''<input>
 605    <requested-node xmlns="urn:opendaylight:sxp:controller">$node</requested-node>
 606    $domain
 607    <peer-address xmlns="urn:opendaylight:sxp:controller">$address</peer-address>
 608    <tcp-port xmlns="urn:opendaylight:sxp:controller">$port</tcp-port>
 609 </input>''')
 610     data = templ.substitute({'address': address, 'port': port, 'node': node, 'domain': get_domain_name(domain_name)})
 611     return data
 612
 613
 614 def add_peer_group_xml(name, peers, ip):
 615     """Generate xml for Add PeerGroups request
 616
 617     :param name: Name of PeerGroup
 618     :type name: str
 619     :param peers: XML formatted peers that will be added to group
 620     :type peers: str
 621     :param ip: Ipv4 address of node
 622     :type ip: str
 623     :returns: String containing xml data for request
 624
 625     """
 626     templ = Template('''<input>
 627   <requested-node xmlns="urn:opendaylight:sxp:controller">$ip</requested-node>
 628   <sxp-peer-group xmlns="urn:opendaylight:sxp:controller">
 629     <name xmlns="urn:opendaylight:sxp:controller">$name</name>
 630     <sxp-peers xmlns="urn:opendaylight:sxp:controller">$peers</sxp-peers>
 631     </sxp-peer-group>
 632 </input>''')
 633     data = templ.substitute({'name': name, 'peers': peers, 'ip': ip})
 634     return data
 635
 636
 637 def delete_peer_group_xml(name, ip):
 638     """Generate xml for Delete PeerGroup request
 639
 640     :param name: Name of PeerGroup
 641     :type name: str
 642     :param ip: Ipv4 address of node
 643     :type ip: str
 644     :returns: String containing xml data for request
 645
 646     """
 647     templ = Template('''<input>
 648   <requested-node xmlns="urn:opendaylight:sxp:controller">$ip</requested-node>
 649   <peer-group-name xmlns="urn:opendaylight:sxp:controller">$name</peer-group-name>
 650 </input>''')
 651     data = templ.substitute({'name': name, 'ip': ip})
 652     return data
 653
 654
 655 def get_peer_groups_from_node_xml(ip):
 656     """Generate xml for Get PeerGroups request
 657
 658     :param ip: Ipv4 address of node
 659     :type ip: str
 660     :returns: String containing xml data for request
 661
 662     """
 663     templ = Template('''<input>
 664    <requested-node xmlns="urn:opendaylight:sxp:controller">$ip</requested-node>
 665 </input>''')
 666     data = templ.substitute({'ip': ip})
 667     return data
 668
 669
 670 def add_filter_xml(group, filter_type, entries, ip, policy=None):
 671     """Generate xml for Add Filter request
 672
 673     :param group: Name of group containing filter
 674     :type group: str
 675     :param filter_type: Type of filter
 676     :type filter_type: str
 677     :param entries: XML formatted entries that will be added in filter
 678     :type entries: str
 679     :param ip: Ipv4 address of node
 680     :type ip: str
 681     :param policy: Policy of filter update mechanism
 682     :type policy: str
 683     :returns: String containing xml data for request
 684
 685     """
 686     if policy:
 687         policy = "<filter-policy>" + policy + "</filter-policy>"
 688     else:
 689         policy = ""
 690     templ = Template('''<input>
 691   <requested-node xmlns="urn:opendaylight:sxp:controller">$ip</requested-node>
 692   <peer-group-name xmlns="urn:opendaylight:sxp:controller">$group</peer-group-name>
 693   <sxp-filter xmlns="urn:opendaylight:sxp:controller">
 694     $filter_policy
 695     <filter-type>$filter_type</filter-type>$entries
 696   </sxp-filter>
 697 </input>''')
 698     data = templ.substitute(
 699         {'group': group, 'filter_type': filter_type, 'ip': ip, 'entries': entries, 'filter_policy': policy})
 700     return data
 701
 702
 703 def add_domain_filter_xml(domain, domains, entries, ip, filter_name=None):
 704     """Generate xml for Add Domain Filter request
 705
 706     :param domain: Name of Domain containing filter
 707     :type domain: str
 708     :param domains: Domains on which filter will be applied
 709     :type domains: str
 710     :param entries: XML formatted entries that will be added in filter
 711     :type entries: str
 712     :param ip: Ipv4 address of node
 713     :type ip: str
 714     :param filter_name: Name of filter
 715     :type filter_name: str
 716     :returns: String containing xml data for request
 717
 718     """
 719     if filter_name:
 720         filter_name = "<filter-name>" + filter_name + "</filter-name>"
 721     templ = Template('''<input>
 722   <requested-node xmlns="urn:opendaylight:sxp:controller">$ip</requested-node>
 723   <domain-name xmlns="urn:opendaylight:sxp:controller">$domain</domain-name>
 724   <sxp-domain-filter xmlns="urn:opendaylight:sxp:controller">
 725     $filter_name
 726     <domains>$domains</domains>
 727     $entries
 728   </sxp-domain-filter>
 729 </input>''')
 730     data = templ.substitute(
 731         {'domain': domain, 'domains': domains, 'ip': ip, 'entries': entries, 'filter_name': filter_name})
 732     return data
 733
 734
 735 def delete_filter_xml(group, filter_type, ip):
 736     """Generate xml for Delete Filter request
 737
 738     :param group: Name of group containing filter
 739     :type group: str
 740     :param filter_type: Type of filter
 741     :type filter_type: str
 742     :param ip: Ipv4 address of node
 743     :type ip: str
 744     :returns: String containing xml data for request
 745
 746     """
 747     templ = Template('''<input>
 748   <requested-node xmlns="urn:opendaylight:sxp:controller">$ip</requested-node>
 749   <peer-group-name xmlns="urn:opendaylight:sxp:controller">$group</peer-group-name>
 750   <filter-type xmlns="urn:opendaylight:sxp:controller">$filter_type</filter-type>
 751 </input>''')
 752     data = templ.substitute(
 753         {'group': group, 'filter_type': filter_type, 'ip': ip})
 754     return data
 755
 756
 757 def delete_domain_filter_xml(domain, ip, filter_name=None):
 758     """Generate xml for Delete Filter request
 759
 760     :param domain: Name of Domain containing filter
 761     :type domain: str
 762     :param ip: Ipv4 address of node
 763     :type ip: str
 764     :param filter_name: Name of filter
 765     :type filter_name: str
 766     :returns: String containing xml data for request
 767
 768     """
 769     if filter_name:
 770         filter_name = '<filter-name xmlns="urn:opendaylight:sxp:controller">' + filter_name + "</filter-name>"
 771     templ = Template('''<input>
 772   <requested-node xmlns="urn:opendaylight:sxp:controller">$ip</requested-node>
 773   <domain-name xmlns="urn:opendaylight:sxp:controller">$domain</domain-name>
 774   $filter_name
 775 </input>''')
 776     data = templ.substitute(
 777         {'domain': domain, 'ip': ip, 'filter_name': filter_name})
 778     return data
 779
 780
 781 def get_connections_from_node_xml(ip, domain_name):
 782     """Generate xml for Get Connections request
 783
 784     :param ip: Ipv4 address of node
 785     :type ip: str
 786     :param domain_name: Name of Domain
 787     :type domain_name: str
 788     :returns: String containing xml data for request
 789
 790     """
 791     templ = Template('''<input>
 792    <requested-node xmlns="urn:opendaylight:sxp:controller">$ip</requested-node>
 793    $domain
 794 </input>''')
 795     data = templ.substitute({'ip': ip, 'domain': get_domain_name(domain_name)})
 796     return data
 797
 798
 799 def get_bindings_from_node_xml(ip, binding_range, domain_name):
 800     """Generate xml for Get Bindings request
 801
 802     :param binding_range: All or only Local bindings
 803     :type binding_range: str
 804     :param ip: Ipv4 address of node
 805     :type ip: str
 806     :param domain_name: Name of Domain
 807     :type domain_name: str
 808     :returns: String containing xml data for request
 809
 810     """
 811     templ = Template('''<input>
 812   <requested-node xmlns="urn:opendaylight:sxp:controller">$ip</requested-node>
 813   <bindings-range xmlns="urn:opendaylight:sxp:controller">$range</bindings-range>
 814   $domain
 815 </input>''')
 816     data = templ.substitute({'ip': ip, 'range': binding_range, 'domain': get_domain_name(domain_name)})
 817     return data
 818
 819
 820 def add_node_xml(node_id, port, password, version, node_ip=None, expansion=0, bindings_timeout=0, keystores=None,
 821                  retry_open_timer=1):
 822     """Generate xml for Add Node request
 823
 824     :param node_id: Ipv4 address formatted node id
 825     :type node_id: str
 826     :param node_ip: Ipv4 address of node
 827     :type node_ip: strl
 828     :param port: Node port number
 829     :type port: int
 830     :param password: TCP-MD5 password
 831     :type password: str
 832     :param version: Sxp device version
 833     :type version: str
 834     :param expansion: Bindings expansion
 835     :type expansion: int
 836     :param bindings_timeout: Specifies DHD and Reconciliation timers
 837     :type bindings_timeout: int
 838     :param keystores: SSL keystore and truststore specification
 839     :type keystores: dict
 840     :returns: String containing xml data for request
 841
 842     """
 843     tls = ''
 844     if keystores:
 845         tls = Template('''
 846         <tls>
 847             <keystore>
 848               <location>$keystore</location>
 849               <type>JKS</type>
 850               <path-type>PATH</path-type>
 851               <password>$passwd</password>
 852             </keystore>
 853             <truststore>
 854               <location>$truststore</location>
 855               <type>JKS</type>
 856               <path-type>PATH</path-type>
 857               <password>$passwd</password>
 858             </truststore>
 859             <certificate-password>$passwd</certificate-password>
 860         </tls>
 861     ''').substitute(
 862             {'keystore': keystores['keystore'], 'truststore': keystores['truststore'], 'passwd': keystores['password']})
 863
 864     templ = Template('''<input xmlns="urn:opendaylight:sxp:controller">
 865     <node-id>$id</node-id>
 866     <timers>
 867         <retry-open-time>$retry_open_timer</retry-open-time>
 868         <hold-time-min-acceptable>120</hold-time-min-acceptable>
 869         <delete-hold-down-time>$timeout</delete-hold-down-time>
 870         <hold-time-min>90</hold-time-min>
 871         <reconciliation-time>$timeout</reconciliation-time>
 872         <hold-time>90</hold-time>
 873         <hold-time-max>180</hold-time-max>
 874         <keep-alive-time>30</keep-alive-time>
 875     </timers>
 876     <mapping-expanded>$expansion</mapping-expanded>
 877     <security>
 878         $tls
 879         <password>$password</password>
 880     </security>
 881     <tcp-port>$port</tcp-port>
 882     <version>$version</version>
 883     <description>ODL SXP Controller</description>
 884     <source-ip>$ip</source-ip>
 885 </input>''')
 886     data = templ.substitute(
 887         {'ip': node_ip or node_id, 'id': node_id, 'port': port, 'password': password,
 888          'version': version, 'expansion': expansion, 'timeout': bindings_timeout, 'tls': tls,
 889          'retry_open_timer': retry_open_timer})
 890     return data
 891
 892
 893 def delete_node_xml(node_id):
 894     """Generate xml for Delete node request
 895
 896     :param node_id: Ipv4 address formatted node id
 897     :type node_id: str
 898     :returns: String containing xml data for request
 899
 900     """
 901     templ = Template('''<input xmlns="urn:opendaylight:sxp:controller">
 902   <node-id>$id</node-id>
 903 </input>''')
 904     data = templ.substitute({'id': node_id})
 905     return data
 906
 907
 908 def add_domain_xml_fluorine(node_id, name, sgt, prefixes, origin):
 909     """Generate xml for Add Domain request (Fluorine version: bindings with origin)
 910
 911     :param node_id: Id of node
 912     :type node_id: str
 913     :param name: Name of Domain
 914     :type name: str
 915     :param sgt: Security group
 916     :type sgt: int
 917     :param prefixes: List of ip-prefixes
 918     :type prefixes: str
 919     :param origin: Origin of added bindings
 920     :type origin: str
 921     :returns: String containing xml data for request
 922
 923     """
 924     master_database = ''
 925     if prefixes != 'None':
 926         xml_prefixes = ''
 927         for prefix in prefixes.split(','):
 928             xml_prefixes += '\n' + '<ip-prefix>' + prefix + '</ip-prefix>'
 929         if xml_prefixes:
 930             master_database += '''<master-database>
 931             <binding>
 932                 <sgt>$sgt</sgt>
 933                 $xml_prefixes
 934             </binding>
 935         </master-database>'''
 936             master_database = Template(master_database).substitute(({'sgt': sgt, 'xml_prefixes': xml_prefixes}))
 937
 938     templ = Template('''<input xmlns="urn:opendaylight:sxp:controller">
 939     <node-id>$id</node-id>
 940     <domain-name>$name</domain-name>
 941     <origin>$origin</origin>
 942     $master_database
 943 </input>''')
 944
 945     data = templ.substitute({'name': name, 'id': node_id, 'origin': origin, 'master_database': master_database})
 946     return data
 947
 948
 949 def add_domain_xml_oxygen(node_id, name, sgt, prefixes):
 950     """Generate xml for Add Domain request (Oxygen version: bindings without origin)
 951
 952     :param node_id: Id of node
 953     :type node_id: str
 954     :param name: Name of Domain
 955     :type name: str
 956     :param sgt: Security group
 957     :type sgt: int
 958     :param prefixes: List of ip-prefixes
 959     :type prefixes: str
 960     :returns: String containing xml data for request
 961
 962     """
 963     master_database = ''
 964     if prefixes != 'None':
 965         xml_prefixes = ''
 966         for prefix in prefixes.split(','):
 967             xml_prefixes += '\n' + '<ip-prefix>' + prefix + '</ip-prefix>'
 968         if xml_prefixes:
 969             master_database += '''<master-database>
 970             <binding>
 971                 <sgt>$sgt</sgt>
 972                 $xml_prefixes
 973             </binding>
 974         </master-database>'''
 975             master_database = Template(master_database).substitute(({'sgt': sgt, 'xml_prefixes': xml_prefixes}))
 976
 977     templ = Template('''<input xmlns="urn:opendaylight:sxp:controller">
 978     <node-id>$id</node-id>
 979     <domain-name>$name</domain-name>
 980     $master_database
 981 </input>''')
 982
 983     data = templ.substitute({'name': name, 'id': node_id, 'master_database': master_database})
 984     return data
 985
 986
 987 def delete_domain_xml(node_id, name):
 988     """Generate xml for Remove Domain request
 989
 990     :param node_id: Id of node
 991     :type node_id: str
 992     :param name: Name of Domain
 993     :type name: str
 994     :returns: String containing xml data for request
 995
 996     """
 997     return add_domain_xml(node_id, name)
 998
 999
1000 def get_domain_name(domain_name):
1001     """Generate xml for Get Bindings request
1002
1003     :param domain_name: Name of Domain
1004     :type domain_name: str
1005     :returns: String containing xml data for request
1006
1007     """
1008     if domain_name == 'global':
1009         return ''
1010     else:
1011         return '<domain-name xmlns="urn:opendaylight:sxp:controller">' + domain_name + '</domain-name>'
1012
1013
1014 def add_bindings_xml_fluorine(node_id, domain, sgt, prefixes, origin):
1015     """Generate xml for Add Bindings request (Fluorine version with origin type)
1016
1017     :param node_id: Id of node
1018     :type node_id: str
1019     :param domain: Name of Domain
1020     :type domain: str
1021     :param sgt: Security group
1022     :type sgt: int
1023     :param prefixes: List of ip-prefixes
1024     :type prefixes: str
1025     :param origin: Origin of added bindings
1026     :type origin: str
1027     :returns: String containing xml data for request
1028
1029     """
1030     xml_prefixes = ''
1031     for prefix in prefixes.split(','):
1032         xml_prefixes += '\n' + '<ip-prefix>' + prefix + '</ip-prefix>'
1033     templ = Template('''<input xmlns="urn:opendaylight:sxp:controller">
1034     <node-id>$id</node-id>
1035     <domain-name>$name</domain-name>
1036     <origin>$origin</origin>
1037     <master-database>
1038         <binding>
1039             <sgt>$sgt</sgt>
1040             $xml_prefixes
1041         </binding>
1042     </master-database>
1043 </input>''')
1044     data = templ.substitute({'name': domain, 'id': node_id, 'sgt': sgt, 'xml_prefixes': xml_prefixes, 'origin': origin})
1045     return data
1046
1047
1048 def add_bindings_xml_oxygen(node_id, domain, sgt, prefixes):
1049     """Generate xml for Add Bindings request (Oxygen version without origin type)
1050
1051     :param node_id: Id of node
1052     :type node_id: str
1053     :param domain: Name of Domain
1054     :type domain: str
1055     :param sgt: Security group
1056     :type sgt: int
1057     :param prefixes: List of ip-prefixes
1058     :type prefixes: str
1059     :returns: String containing xml data for request
1060
1061     """
1062     xml_prefixes = ''
1063     for prefix in prefixes.split(','):
1064         xml_prefixes += '\n' + '<ip-prefix>' + prefix + '</ip-prefix>'
1065     templ = Template('''<input xmlns="urn:opendaylight:sxp:controller">
1066     <node-id>$id</node-id>
1067     <domain-name>$name</domain-name>
1068         <binding>
1069             <sgt>$sgt</sgt>
1070             $xml_prefixes
1071         </binding>
1072 </input>''')
1073     data = templ.substitute({'name': domain, 'id': node_id, 'sgt': sgt, 'xml_prefixes': xml_prefixes})
1074     return data
1075
1076
1077 def delete_bindings_xml(node_id, domain, sgt, prefixes):
1078     """Generate xml for Remove Bindings request
1079
1080     :param node_id: Id of node
1081     :type node_id: str
1082     :param domain: Name of Domain
1083     :type domain: str
1084     :param sgt: Security group
1085     :type sgt: int
1086     :param prefixes: Comma separated list of ip-prefixes
1087     :type prefixes: str
1088     :returns: String containing xml data for request
1089
1090     """
1091     xml_prefixes = ''
1092     for prefix in prefixes.split(','):
1093         xml_prefixes += '\n' + '<ip-prefix>' + prefix + '</ip-prefix>'
1094     templ = Template('''<input xmlns="urn:opendaylight:sxp:controller">
1095     <node-id>$id</node-id>
1096     <domain-name>$name</domain-name>
1097     <binding>
1098         <sgt>$sgt</sgt>
1099         $xml_prefixes
1100     </binding>
1101 </input>''')
1102     data = templ.substitute({'name': domain, 'id': node_id, 'sgt': sgt, 'xml_prefixes': xml_prefixes})
1103     return data
1104
1105
1106 def prefix_range(start, end):
1107     """Generate and concatenate ip-prefixes
1108
1109     :param start: Start index
1110     :type start: str
1111     :param end: End index
1112     :type end: str
1113     :returns: String containing concatenated ip-prefixes
1114
1115     """
1116     start = int(start)
1117     end = int(end)
1118     index = 0
1119     prefixes = ''
1120     while index < end:
1121         prefixes += get_ip_from_number(index + start) + '/32'
1122         index += 1
1123         if index < end:
1124             prefixes += ','
1125     return prefixes
1126
1127
1128 def route_definition_xml(virtual_ip, net_mask, interface):
1129     """Generate xml for Add Bindings request
1130
1131     :param interface: Network interface name
1132     :type interface: str
1133     :param net_mask: NetMask of virtual ip
1134     :type net_mask: str
1135     :param virtual_ip: Virtual ip
1136     :type virtual_ip: str
1137     :returns: String containing xml data for request
1138
1139     """
1140     templ = Template('''
1141     <routing-definition>
1142         <ip-address>$vip</ip-address>
1143         <interface>$interface</interface>
1144         <netmask>$mask</netmask>
1145     </routing-definition>
1146     ''')
1147     data = templ.substitute({'mask': net_mask, 'vip': virtual_ip, 'interface': interface})
1148     return data
1149
1150
1151 def route_definitions_xml(routes, old_routes=None):
1152     """Generate xml for Add Bindings request
1153
1154     :param routes: XML formatted data containing RouteDefinitions
1155     :type routes: str
1156     :param old_routes: Routes add to request that needs to persist
1157     :type old_routes: str
1158     :returns: String containing xml data for request
1159
1160     """
1161     if old_routes and "</sxp-cluster-route>" in old_routes:
1162         templ = Template(old_routes.replace("</sxp-cluster-route>", "$routes</sxp-cluster-route>"))
1163     else:
1164         templ = Template('''<sxp-cluster-route xmlns="urn:opendaylight:sxp:cluster:route">
1165     $routes
1166 </sxp-cluster-route>
1167     ''')
1168     data = templ.substitute({'routes': routes})
1169     return data
1170
1171
1172 def add_binding_origin_xml(origin, priority):
1173     """Generate xml for Add Binding Origin request
1174
1175     :param origin: Origin type
1176     :type origin: str
1177     :param priority: Origin priority
1178     :type priority: str
1179     :returns: String containing xml data for request
1180
1181     """
1182     templ = Template('''<input xmlns="urn:opendaylight:sxp:config:controller">
1183     <origin>$origin</origin>
1184     <priority>$priority</priority>
1185 </input>''')
1186     data = templ.substitute({'origin': origin, 'priority': priority})
1187     return data
1188
1189
1190 def update_binding_origin_xml(origin, priority):
1191     """Generate xml for Update Binding Origin request
1192
1193     :param origin: Origin type
1194     :type origin: str
1195     :param priority: Origin priority
1196     :type priority: str
1197     :returns: String containing xml data for request
1198
1199     """
1200     templ = Template('''<input xmlns="urn:opendaylight:sxp:config:controller">
1201     <origin>$origin</origin>
1202     <priority>$priority</priority>
1203 </input>''')
1204     data = templ.substitute({'origin': origin, 'priority': priority})
1205     return data
1206
1207
1208 def delete_binding_origin_xml(origin):
1209     """Generate xml for Delete Binding Origin request
1210
1211     :param origin: Origin type
1212     :type origin: str
1213     :returns: String containing xml data for request
1214
1215     """
1216     templ = Template('''<input xmlns="urn:opendaylight:sxp:config:controller">
1217     <origin>$origin</origin>
1218 </input>''')
1219     data = templ.substitute({'origin': origin})
1220     return data
1221
1222
1223 def find_binding_origin(origins_json, origin):
1224     """Test if Binding origin of specified value is contained in JSON
1225
1226     :param origins_json: JSON containing Binding origins
1227     :type origins_json: str
1228     :param origin: Origin to be found
1229     :type origin: str
1230     :returns: True if Binding origin of specified origin type was found, otherwise False.
1231
1232     """
1233     for json_origin in parse_binding_origins(origins_json):
1234         if json_origin['origin'] == origin:
1235             return True
1236     return False
1237
1238
1239 def find_binding_origin_with_priority(origins_json, origin, priority):
1240     """Test if Binding origin of specified value and priority is contained in JSON
1241
1242     :param origins_json: JSON containing Binding origins
1243     :type origins_json: str
1244     :param origin: Origin to be found
1245     :type origin: str
1246     :param priority: desired priority of origin
1247     :type priority: str
1248     :returns: True if Binding origin of specified origin type with desired priority was found, otherwise False.
1249
1250     """
1251     for json_origin in parse_binding_origins(origins_json):
1252         if json_origin['origin'] == origin:
1253             if json_origin['priority'] == int(priority):
1254                 return True
1255     return False
1256
1257
1258 def parse_binding_origins(origins_json):
1259     """Parse JSON string into Array of Binding origins
1260
1261     :param origins_json: JSON containing Binding origins
1262     :type origins_json: str
1263     :returns: Array containing Binding origins.
1264
1265     """
1266     output = []
1267     for origins in origins_json['binding-origins'].values():
1268         for origin in origins:
1269             output.append(origin)
1270     return output