HC Test: update plugin-ACL tests

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

diff --git a/resources/libraries/python/Classify.py b/resources/libraries/python/Classify.py
index 8dbe3fb..e4fa2a3 100644 (file)
--- a/resources/libraries/python/Classify.py
+++ b/resources/libraries/python/Classify.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2016 Cisco and/or its affiliates.
+# Copyright (c) 2017 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:
@@ -11,6 +11,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+"""Classify utilities library."""
 
 from robot.api import logger
 
@@ -30,7 +31,7 @@ class Classify(object):
         :type node: dict
         :type ip_version: str
         :type direction: str
-        :return (table_index, skip_n, match_n)
+        :returns (table_index, skip_n, match_n)
         table_index: Classify table index.
         skip_n: Number of skip vectors.
         match_n: Number of match vectors.
@@ -62,7 +63,7 @@ class Classify(object):
         :param direction: Direction of traffic - src/dst.
         :type node: dict
         :type direction: str
-        :return (table_index, skip_n, match_n)
+        :returns (table_index, skip_n, match_n)
         table_index: Classify table index.
         skip_n: Number of skip vectors.
         match_n: Number of match vectors.
@@ -93,7 +94,7 @@ class Classify(object):
         :param hex_mask: Classify hex mask.
         :type node: dict
         :type hex_mask: str
-        :return (table_index, skip_n, match_n)
+        :returns (table_index, skip_n, match_n)
         table_index: Classify table index.
         skip_n: Number of skip vectors.
         match_n: Number of match vectors.
@@ -117,9 +118,9 @@ class Classify(object):
         return table_index, skip_n, match_n
 
     @staticmethod
-    def vpp_configures_classify_session_l3(node, acl_method, table_index, skip_n,
-                                          match_n, ip_version, direction,
-                                          address):
+    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.
@@ -150,8 +151,8 @@ class Classify(object):
                                                     address=address)
 
     @staticmethod
-    def vpp_configures_classify_session_l2(node, acl_method, table_index, skip_n,
-                                          match_n, direction, address):
+    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.
@@ -170,17 +171,18 @@ class Classify(object):
         :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)
+            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):
+                                            skip_n, match_n, hex_value):
         """Configuration of classify session with hex value.
 
         :param node: VPP node to setup classify session.
@@ -252,7 +254,7 @@ class Classify(object):
         :type ip_version: str
         :type protocol: str
         :type direction: str
-        :return: Classify hex mask.
+        :returns: Classify hex mask.
         :rtype : str
         :raises ValueError: If protocol is not TCP or UDP.
         :raises ValueError: If direction is not source or destination or
@@ -282,7 +284,7 @@ class Classify(object):
         :type hex_mask: str
         :type source_port: str
         :type destination_port: str
-        :return: Classify hex value.
+        :returns: Classify hex value.
         :rtype: str
         """
         source_port_hex = Classify._port_convert(source_port)
@@ -296,7 +298,7 @@ class Classify(object):
 
         :param port: TCP/UDP port number.
         :type port: str
-        :return: TCP/UDP port number in 4-digit hexadecimal format.
+        :returns: TCP/UDP port number in 4-digit hexadecimal format.
         :rtype: str
         """
         return '{0:04x}'.format(int(port))
@@ -327,7 +329,7 @@ class Classify(object):
         :param table_index: Index of a specific classify table.
         :type node: dict
         :type table_index: int
-        :return: Classify table settings.
+        :returns: Classify table settings.
         :rtype: dict
         """
         with VatTerminal(node) as vat:
@@ -348,7 +350,7 @@ class Classify(object):
         :type node: dict
         :type table_index: int
         :type session_index: int
-        :return: List of classify session settings, or a dictionary of settings
+        :returns: List of classify session settings, or a dictionary of settings
          for a specific classify session.
         :rtype: list or dict
         """
@@ -361,3 +363,34 @@ class Classify(object):
             return data[0][session_index]
         else:
             return data[0]
+
+    @staticmethod
+    def vpp_log_plugin_acl_settings(node):
+        """Retrieve configured settings from the ACL plugin
+         and write to robot log.
+
+        :param node: VPP node.
+        :type node: dict
+        """
+        try:
+            VatExecutor.cmd_from_template(
+                node, "acl_plugin/acl_dump.vat")
+        except (ValueError, RuntimeError):
+            # Fails to parse JSON data in response, but it is still logged
+            pass
+
+    @staticmethod
+    def vpp_log_plugin_acl_interface_assignment(node):
+        """Retrieve interface assignment from the ACL plugin
+        and write to robot log.
+
+        :param node: VPP node.
+        :type node: dict
+        """
+
+        try:
+            VatExecutor.cmd_from_template(
+                node, "acl_plugin/acl_interface_dump.vat", json_out=False)
+        except RuntimeError:
+            # Fails to parse response, but it is still logged
+            pass