CSIT-49: HC Test: Policy - security groups
[csit.git] / resources / libraries / python / Classify.py
index 7d62e26..dfa5c33 100644 (file)
@@ -21,8 +21,8 @@ class Classify(object):
     """Classify utilities."""
 
     @staticmethod
-    def vpp_create_classify_table(node, ip_version, direction):
-        """Create classify table.
+    def vpp_creates_classify_table_l3(node, ip_version, direction):
+        """Create classify table for IP address filtering.
 
         :param node: VPP node to create classify table.
         :param ip_version: Version of IP protocol.
@@ -54,7 +54,38 @@ class Classify(object):
         return table_index, skip_n, match_n
 
     @staticmethod
-    def vpp_create_classify_table_hex(node, hex_mask):
+    def vpp_creates_classify_table_l2(node, direction):
+        """Create classify table for MAC address filtering.
+
+        :param node: VPP node to create classify table.
+        :param direction: Direction of traffic - src/dst.
+        :type node: dict
+        :type direction: str
+        :return (table_index, skip_n, match_n)
+        table_index: Classify table index.
+        skip_n: Number of skip vectors.
+        match_n: Number of match vectors.
+        :rtype: tuple(int, int, int)
+        :raises RuntimeError: If VPP can't create table.
+        """
+        output = VatExecutor.cmd_from_template(node,
+                                               "classify_add_table_l2.vat",
+                                               direction=direction)
+
+        if output[0]["retval"] == 0:
+            table_index = output[0]["new_table_index"]
+            skip_n = output[0]["skip_n_vectors"]
+            match_n = output[0]["match_n_vectors"]
+            logger.trace('Classify table with table_index {} created on node {}'
+                         .format(table_index, node['host']))
+        else:
+            raise RuntimeError('Unable to create classify table on node {}'
+                               .format(node['host']))
+
+        return table_index, skip_n, match_n
+
+    @staticmethod
+    def vpp_creates_classify_table_hex(node, hex_mask):
         """Create classify table with hex mask.
 
         :param node: VPP node to create classify table based on hex mask.
@@ -85,9 +116,10 @@ class Classify(object):
         return table_index, skip_n, match_n
 
     @staticmethod
-    def vpp_configure_classify_session(node, acl_method, table_index, skip_n,
-                                       match_n, ip_version, direction, address):
-        """Configuration of classify session.
+    def vpp_configures_classify_session_l3(node, acl_method, table_index, skip_n,
+                                          match_n, ip_version, direction,
+                                          address):
+        """Configuration of classify session for IP address filtering.
 
         :param node: VPP node to setup classify session.
         :param acl_method: ACL method - deny/permit.
@@ -117,7 +149,36 @@ class Classify(object):
                                                     address=address)
 
     @staticmethod
-    def vpp_configure_classify_session_hex(node, acl_method, table_index,
+    def vpp_configures_classify_session_l2(node, acl_method, table_index, skip_n,
+                                          match_n, direction, address):
+        """Configuration of classify session for MAC address filtering.
+
+        :param node: VPP node to setup classify session.
+        :param acl_method: ACL method - deny/permit.
+        :param table_index: Classify table index.
+        :param skip_n: Number of skip vectors based on mask.
+        :param match_n: Number of match vectors based on mask.
+        :param direction: Direction of traffic - src/dst.
+        :param address: IPv4 or IPv6 address.
+        :type node: dict
+        :type acl_method: str
+        :type table_index: int
+        :type skip_n: int
+        :type match_n: int
+        :type direction: str
+        :type address: str
+        """
+        with VatTerminal(node) as vat:
+            vat.vat_terminal_exec_cmd_from_template("classify_add_session_l2.vat",
+                                                    acl_method=acl_method,
+                                                    table_index=table_index,
+                                                    skip_n=skip_n,
+                                                    match_n=match_n,
+                                                    direction=direction,
+                                                    address=address)
+
+    @staticmethod
+    def vpp_configures_classify_session_hex(node, acl_method, table_index,
                                            skip_n, match_n, hex_value):
         """Configuration of classify session with hex value.
 
@@ -219,3 +280,46 @@ class Classify(object):
             # base value of classify hex table for IPv6 TCP/UDP ports
         else:
             raise ValueError("Invalid IP version!")
+
+    @staticmethod
+    def get_classify_table_data(node, table_index):
+        """Retrieve settings for classify table by ID.
+
+        :param node: VPP node to retrieve classify data from.
+        :param table_index: Index of a specific classify table.
+        :type node: dict
+        :type table_index: int
+        :return: Classify table settings.
+        :rtype: dict
+        """
+        with VatTerminal(node) as vat:
+            data = vat.vat_terminal_exec_cmd_from_template(
+                "classify_table_info.vat",
+                table_id=table_index
+            )
+        return data[0]
+
+    @staticmethod
+    def get_classify_session_data(node, table_index, session_index=None):
+        """Retrieve settings for all classify sessions in a table,
+        or for a specific classify session.
+
+        :param node: VPP node to retrieve classify data from.
+        :param table_index: Index of a classify table.
+        :param session_index: Index of a specific classify session. (Optional)
+        :type node: dict
+        :type table_index: int
+        :type session_index: int
+        :return: List of classify session settings, or a dictionary of settings
+         for a specific classify session.
+        :rtype: list or dict
+        """
+        with VatTerminal(node) as vat:
+            data = vat.vat_terminal_exec_cmd_from_template(
+                "classify_session_dump.vat",
+                table_id=table_index
+            )
+        if session_index is not None:
+            return data[0][session_index]
+        else:
+            return data[0]