FIX: Workaround AVF interface down until VPP-1934
[csit.git] / resources / libraries / python / Cop.py
index 1ff9a99..29530b1 100644 (file)
@@ -1,4 +1,4 @@
-# Copyright (c) 2016 Cisco and/or its affiliates.
+# Copyright (c) 2019 Cisco and/or its affiliates.
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at:
 
 """COP utilities library."""
 
-from resources.libraries.python.VatExecutor import VatTerminal
+from resources.libraries.python.PapiExecutor import PapiSocketExecutor
 from resources.libraries.python.topology import Topology
 
 
-class Cop(object):
+class Cop:
     """COP utilities."""
 
     @staticmethod
-    def cop_add_whitelist_entry(node, interface, ip_format, fib_id):
+    def cop_add_whitelist_entry(
+            node, interface, ip_version, fib_id, default_cop=0):
         """Add cop whitelisted entry.
 
         :param node: Node to add COP whitelist on.
         :param interface: Interface of the node where the COP is added.
-        :param ip_format: IP format : ip4 or ip6 are valid formats.
+        :param ip_version: IP version. 'ip4' and 'ip6' are valid values.
         :param fib_id: Specify the fib table ID.
+        :param default_cop: 1 => enable non-ip4, non-ip6 filtration,
+            0 => disable it.
         :type node: dict
         :type interface: str
-        :type ip_format: str
+        :type ip_version: str
         :type fib_id: int
+        :type default_cop: int
+        :raises ValueError: If parameter 'ip_version' has incorrect value.
         """
-        if ip_format not in ('ip4', 'ip6'):
-            raise ValueError("Ip not in correct format!")
-        sw_if_index = Topology.get_interface_sw_index(node, interface)
-        with VatTerminal(node) as vat:
-            vat.vat_terminal_exec_cmd_from_template('cop_whitelist.vat',
-                                                    sw_if_index=sw_if_index,
-                                                    ip=ip_format,
-                                                    fib_id=fib_id)
+        if ip_version not in (u"ip4", u"ip6"):
+            raise ValueError(u"IP version is not in correct format")
+
+        cmd = u"cop_whitelist_enable_disable"
+        err_msg = f"Failed to add COP whitelist on interface {interface} " \
+            f"on host {node[u'host']}"
+        args = dict(
+            sw_if_index=Topology.get_interface_sw_index(node, interface),
+            fib_id=int(fib_id),
+            ip4=bool(ip_version == u"ip4"),
+            ip6=bool(ip_version == u"ip6"),
+            default_cop=default_cop
+        )
+
+        with PapiSocketExecutor(node) as papi_exec:
+            papi_exec.add(cmd, **args).get_reply(err_msg)
 
     @staticmethod
     def cop_interface_enable_or_disable(node, interface, state):
@@ -48,21 +61,25 @@ class Cop(object):
 
         :param node: Node to add COP whitelist on.
         :param interface: Interface of the node where the COP is added.
-        :param state: disable/enable COP on the interface.
+        :param state: Enable or disable COP on the interface.
         :type node: dict
         :type interface: str
         :type state: str
+        :raises ValueError: If parameter 'state' has incorrect value.
         """
         state = state.lower()
-        if state in ('enable', 'disable'):
-            if state == 'enable':
-                state = ''
-            sw_if_index = Topology.get_interface_sw_index(node, interface)
-            with VatTerminal(node) as vat:
-                vat.vat_terminal_exec_cmd_from_template('cop_interface.vat',
-                                                        sw_if_index=sw_if_index,
-                                                        state=state)
+        if state in (u"enable", u"disable"):
+            enable = bool(state == u"enable")
         else:
-            raise ValueError(
-                "Possible values are 'enable' or 'disable'!"
-            )
+            raise ValueError(u"Possible state values are 'enable' or 'disable'")
+
+        cmd = u"cop_interface_enable_disable"
+        err_msg = f"Failed to enable/disable COP on interface {interface} " \
+            f"on host {node[u'host']}"
+        args = dict(
+            sw_if_index=Topology.get_interface_sw_index(node, interface),
+            enable_disable=enable
+        )
+
+        with PapiSocketExecutor(node) as papi_exec:
+            papi_exec.add(cmd, **args).get_reply(err_msg)