Python3: resources and libraries

[csit.git] / resources / libraries / python / GBP.py

diff --git a/resources/libraries/python/GBP.py b/resources/libraries/python/GBP.py
index e0fa07e..3d4d249 100644 (file)
--- a/resources/libraries/python/GBP.py
+++ b/resources/libraries/python/GBP.py
@@ -14,6 +14,7 @@
 """GBP utilities library."""
 
 from enum import IntEnum
+
 from ipaddress import ip_address
 
 from resources.libraries.python.IPUtil import IPUtil
@@ -61,7 +62,14 @@ class GBPRuleAction(IntEnum):
     GBP_API_RULE_REDIRECT = 3
 
 
-class GBP(object):
+class GBPHashMode(IntEnum):
+    """GBP Hash Mode."""
+    GBP_API_HASH_MODE_SRC_IP = 1
+    GBP_API_HASH_MODE_DST_IP = 2
+    GBP_API_HASH_MODE_SYMETRIC = 3
+
+
+class GBP:
     """GBP utilities."""
 
     @staticmethod
@@ -83,9 +91,8 @@ class GBP(object):
         :type ip4_uu_sw_if_index: int
         :type ip6_uu_sw_if_index: int
         """
-        cmd = 'gbp_route_domain_add'
-        err_msg = 'Failed to add GBP route domain on {node}!'\
-                  .format(node=node['host'])
+        cmd = u"gbp_route_domain_add"
+        err_msg = f"Failed to add GBP route domain on {node[u'host']}!"
 
         args_in = dict(
             rd=dict(
@@ -119,14 +126,14 @@ class GBP(object):
         :type uu_fwd_sw_if_index: int
         :type bm_flood_sw_if_index: int
         """
-        cmd = 'gbp_bridge_domain_add'
-        err_msg = 'Failed to add GBP bridge domain on {node}!'\
-                  .format(node=node['host'])
+        cmd = u"gbp_bridge_domain_add"
+        err_msg = f"Failed to add GBP bridge domain on {node[u'host']}!"
 
         args_in = dict(
             bd=dict(
-                flags=getattr(GBPBridgeDomainFlags,
-                              'GBP_BD_API_FLAG_NONE').value,
+                flags=getattr(
+                    GBPBridgeDomainFlags, u"GBP_BD_API_FLAG_NONE"
+                ).value,
                 bvi_sw_if_index=bvi_sw_if_index,
                 uu_fwd_sw_if_index=uu_fwd_sw_if_index,
                 bm_flood_sw_if_index=bm_flood_sw_if_index,
@@ -159,9 +166,8 @@ class GBP(object):
         :type uplink_sw_if_index: int
         :type remote_ep_timeout: int
         """
-        cmd = 'gbp_endpoint_group_add'
-        err_msg = 'Failed to add GBP endpoint group on {node}!'\
-                  .format(node=node['host'])
+        cmd = u"gbp_endpoint_group_add"
+        err_msg = f"Failed to add GBP endpoint group on {node[u'host']}!"
 
         args_in = dict(
             epg=dict(
@@ -194,17 +200,13 @@ class GBP(object):
         :type mac_addr: str
         :type sclass: int
         """
-        cmd = 'gbp_endpoint_add'
-        err_msg = 'Failed to add GBP endpoint on {node}!'\
-                  .format(node=node['host'])
+        cmd = u"gbp_endpoint_add"
+        err_msg = f"Failed to add GBP endpoint on {node[u'host']}!"
 
         ips = list()
-        ips.append(IPUtil.create_ip_address_object(
-            ip_address(unicode(ip_addr))))
-        tun_src = IPUtil.create_ip_address_object(
-            ip_address(unicode('0.0.0.0')))
-        tun_dst = IPUtil.create_ip_address_object(
-            ip_address(unicode('0.0.0.0')))
+        ips.append(IPUtil.create_ip_address_object(ip_address(ip_addr)))
+        tun_src = IPUtil.create_ip_address_object(ip_address(u"0.0.0.0"))
+        tun_dst = IPUtil.create_ip_address_object(ip_address(u"0.0.0.0"))
 
         args_in = dict(
             endpoint=dict(
@@ -213,8 +215,9 @@ class GBP(object):
                 n_ips=len(ips),
                 mac=L2Util.mac_to_bin(mac_addr),
                 sclass=sclass,
-                flags=getattr(GBPEndpointFlags,
-                              'GBP_API_ENDPOINT_FLAG_EXTERNAL').value,
+                flags=getattr(
+                    GBPEndpointFlags, u"GBP_API_ENDPOINT_FLAG_EXTERNAL"
+                ).value,
                 tun=dict(
                     src=tun_src,
                     dst=tun_dst
@@ -238,9 +241,8 @@ class GBP(object):
         :type bd_id: int
         :type rd_id: int
         """
-        cmd = 'gbp_ext_itf_add_del'
-        err_msg = 'Failed to add external GBP interface on {node}!'\
-                  .format(node=node['host'])
+        cmd = u"gbp_ext_itf_add_del"
+        err_msg = u"Failed to add external GBP interface on {node[u'host']}!"
 
         args_in = dict(
             is_add=1,
@@ -248,8 +250,7 @@ class GBP(object):
                 sw_if_index=sw_if_index,
                 bd_id=bd_id,
                 rd_id=rd_id,
-                flags=getattr(GBPExtItfFlags,
-                              'GBP_API_EXT_ITF_F_NONE').value
+                flags=getattr(GBPExtItfFlags, u"GBP_API_EXT_ITF_F_NONE").value
             )
         )
 
@@ -275,20 +276,19 @@ class GBP(object):
         :type rd_id: int
         :type sw_if_index: int
         """
-        cmd = 'gbp_subnet_add_del'
-        err_msg = 'Failed to add GBP subnet on {node}!'\
-                  .format(node=node['host'])
+        cmd = u"gbp_subnet_add_del"
+        err_msg = f"Failed to add GBP subnet on {node[u'host']}!"
 
         args_in = dict(
             is_add=1,
             subnet=dict(
-                type=getattr(GBPSubnetType,
-                             'GBP_API_SUBNET_L3_OUT').value,
+                type=getattr(GBPSubnetType, u"GBP_API_SUBNET_L3_OUT").value,
                 sw_if_index=sw_if_index,
                 sclass=sclass,
                 prefix=dict(
                     address=IPUtil.create_ip_address_object(
-                        ip_address(unicode(address))),
+                        ip_address(address)
+                    ),
                     len=int(subnet_length)
                 ),
                 rd_id=rd_id
@@ -299,27 +299,29 @@ class GBP(object):
             papi_exec.add(cmd, **args_in).get_reply(err_msg)
 
     @staticmethod
-    def gbp_contract_add_del(node, sclass, dclass, acl_index=0):
+    def gbp_contract_add_del(node, sclass, dclass, acl_index=0, hash_mode=None):
         """Add GBP contract.
 
         :param node: Node to add GBP contract on.
         :param sclass: Source CLASS.
         :param dclass: Destination CLASS.
         :param acl_index: Index of ACL rule.
+        :param hash_mode: GBP contract hash mode.
         :type node: dict
         :type sclass: int
         :type dclass: int
         :type acl_index: int
+        :type hash_mode: str
         """
-        cmd = 'gbp_contract_add_del'
-        err_msg = 'Failed to add GBP contract on {node}!'\
-                  .format(node=node['host'])
+        cmd = u"gbp_contract_add_del"
+        err_msg = f"Failed to add GBP contract on {node[u'host']}!"
 
+        hash_mode = u"GBP_API_HASH_MODE_SRC_IP" if hash_mode is None \
+            else hash_mode
         rule_permit = dict(
-            action=getattr(GBPRuleAction,
-                           'GBP_API_RULE_PERMIT').value,
+            action=getattr(GBPRuleAction, u"GBP_API_RULE_PERMIT").value,
             nh_set=dict(
-                hash_mode=list(),
+                hash_mode=getattr(GBPHashMode, hash_mode).value,
                 n_nhs=8,
                 nhs=[dict()]*8,
             )