Configure ACL via static file

This patch allows user to configure ACL/vFW SampleVNF ACL
via configuration file provided in TC definition. The
Yardstick applies the rules to SampleVNF from specified config
file + rules generated by Yardstick (default rules).

The example of SampleVNF ACL CLI commands generated/applied
by Yardstick can be found at (using default ACL config file):

ACL VNF ACL CLI commands:
  acl/tc_heat_rfc2544_ipv4_1rule_1flow_64B_trex.yaml
  http://paste.openstack.org/show/723303/

vFW VNF ACL CLI commands:
  vfw/tc_heat_rfc2544_ipv4_1rule_1flow_64B_trex.yaml
  http://paste.openstack.org/show/723304/

Change-Id: I76a630261a982083b628e3985fc3bec14ca495db
Signed-off-by: Mytnyk, Volodymyr <volodymyrx.mytnyk@intel.com>
(cherry picked from commit 3fdca97ff5053770161059a34a95fd39463eaecd)

5 files changed, 154 insertions, 64 deletions

diff --git a/tests/unit/network_services/helpers/test_samplevnf_helper.py b/tests/unit/network_services/helpers/test_samplevnf_helper.py
index 3b6c89d3a..4145b46d0 100644
--- a/tests/unit/network_services/helpers/test_samplevnf_helper.py
+++ b/tests/unit/network_services/helpers/test_samplevnf_helper.py
@@ -227,7 +227,7 @@ class TestMultiPortConfig(unittest.TestCase):
             mock.Mock(return_value={'link_config': 0, 'arp_config': '',
                                     'arp_config6': '', 'actions': '',
                                     'arp_route_tbl': '', 'arp_route_tbl6': '',
-                                    'rules': ''})
+                                    'flows': ''})
         opnfv_vnf.port_pair_list = [("xe0", "xe1")]
         self.assertIsNotNone(opnfv_vnf.generate_script(self.VNFD))
         opnfv_vnf.lb_config = 'HW'
@@ -253,66 +253,6 @@ class TestMultiPortConfig(unittest.TestCase):
         opnfv_vnf.generate_rule_config = mock.Mock()
         self.assertIsNotNone(opnfv_vnf.generate_script_data())
 
-    def test_generate_rule_config(self):
-        topology_file = mock.Mock()
-        config_tpl = mock.Mock()
-        tmp_file = mock.Mock()
-        vnfd_mock = mock.MagicMock()
-        opnfv_vnf = samplevnf_helper.MultiPortConfig(
-            topology_file, config_tpl, tmp_file, vnfd_mock)
-        opnfv_vnf.get_config_tpl_data = mock.MagicMock()
-        opnfv_vnf.socket = 0
-        opnfv_vnf.start_core = 0
-        opnfv_vnf.update_write_parser = mock.MagicMock()
-        opnfv_vnf.generate_script_data = \
-            mock.Mock(return_value={'link_config': 0, 'arp_config': '',
-                                    'arp_config6': '', 'actions': '',
-                                    'rules': ''})
-        opnfv_vnf.port_pair_list = [("xe0", "xe1")]
-        opnfv_vnf.get_port_pairs = mock.Mock()
-        opnfv_vnf.vnf_type = 'ACL'
-        opnfv_vnf.get_ports_gateway = mock.Mock(return_value=u'1.1.1.1')
-        opnfv_vnf.get_netmask_gateway = mock.Mock(
-            return_value=u'255.255.255.0')
-        opnfv_vnf.get_ports_gateway6 = mock.Mock(return_value=u'1.1.1.1')
-        opnfv_vnf.get_netmask_gateway6 = mock.Mock(
-            return_value=u'255.255.255.0')
-        opnfv_vnf.txrx_pipeline = ''
-        opnfv_vnf.vnfd = self.VNFD['vnfd:vnfd-catalog']['vnfd'][0]
-        opnfv_vnf.interfaces = opnfv_vnf.vnfd['vdu'][0]['external-interface']
-        opnfv_vnf.rules = ''
-        self.assertIsNotNone(opnfv_vnf.generate_rule_config())
-        opnfv_vnf.rules = 'new'
-        self.assertIsNotNone(opnfv_vnf.generate_rule_config())
-
-    def test_generate_action_config(self):
-        topology_file = mock.Mock()
-        config_tpl = mock.Mock()
-        tmp_file = mock.Mock()
-        vnfd_mock = mock.MagicMock()
-        opnfv_vnf = samplevnf_helper.MultiPortConfig(
-            topology_file, config_tpl, tmp_file, vnfd_mock)
-        opnfv_vnf.get_config_tpl_data = mock.MagicMock()
-        opnfv_vnf.socket = 0
-        opnfv_vnf.start_core = 0
-        opnfv_vnf.update_write_parser = mock.MagicMock()
-        opnfv_vnf.generate_script_data = \
-            mock.Mock(return_value={'link_config': 0, 'arp_config': '',
-                                    'arp_config6': '', 'actions': '',
-                                    'rules': ''})
-        opnfv_vnf.port_pair_list = [("xe0", "xe1")]
-        opnfv_vnf.get_port_pairs = mock.Mock()
-        opnfv_vnf.vnf_type = 'VFW'
-        opnfv_vnf.get_ports_gateway = mock.Mock(return_value=u'1.1.1.1')
-        opnfv_vnf.get_netmask_gateway = mock.Mock(
-            return_value=u'255.255.255.0')
-        opnfv_vnf.get_ports_gateway6 = mock.Mock(return_value=u'1.1.1.1')
-        opnfv_vnf.get_netmask_gateway6 = mock.Mock(
-            return_value=u'255.255.255.0')
-        opnfv_vnf.txrx_pipeline = ''
-        opnfv_vnf.rules = ''
-        self.assertIsNotNone(opnfv_vnf.generate_action_config())
-
     def test_generate_arp_config6(self):
         topology_file = mock.Mock()
         config_tpl = mock.Mock()
diff --git a/tests/unit/network_services/vnf_generic/vnf/test_acl_vnf.py b/tests/unit/network_services/vnf_generic/vnf/test_acl_vnf.py
index efde669d2..c21071826 100644
--- a/tests/unit/network_services/vnf_generic/vnf/test_acl_vnf.py
+++ b/tests/unit/network_services/vnf_generic/vnf/test_acl_vnf.py
@@ -16,10 +16,13 @@
 import unittest
 import mock
 import os
+import re
+import copy
 
 from tests.unit import STL_MOCKS
 from tests.unit.network_services.vnf_generic.vnf.test_base import mock_ssh
 from yardstick.common import utils
+from yardstick.common import exceptions
 
 
 STLClient = mock.MagicMock()
@@ -28,6 +31,7 @@ stl_patch.start()
 
 if stl_patch:
     from yardstick.network_services.vnf_generic.vnf.acl_vnf import AclApproxVnf
+    from yardstick.network_services.vnf_generic.vnf.base import VnfdHelper
     from yardstick.network_services.nfvi.resource import ResourceProfile
     from yardstick.network_services.vnf_generic.vnf.acl_vnf import AclApproxSetupEnvSetupEnvHelper
 
@@ -311,7 +315,6 @@ class TestAclApproxVnf(unittest.TestCase):
         acl_approx_vnf._run()
         acl_approx_vnf.ssh_helper.run.assert_called_once()
 
-    @mock.patch("yardstick.network_services.vnf_generic.vnf.acl_vnf.YangModel")
     @mock.patch.object(utils, 'find_relative_file')
     @mock.patch("yardstick.network_services.vnf_generic.vnf.sample_vnf.Context")
     @mock.patch(SSH_HELPER)
@@ -350,6 +353,145 @@ class TestAclApproxVnf(unittest.TestCase):
 
 class TestAclApproxSetupEnvSetupEnvHelper(unittest.TestCase):
 
+    ACL_CONFIG = {"access-list-entries": [{
+                     "actions": [
+                       "count",
+                       {"fwd": {
+                           "port": 0
+                         }
+                       }
+                     ],
+                     "matches": {
+                       "destination-ipv4-network": "152.16.0.0/24",
+                       "destination-port-range": {
+                         "lower-port": 0,
+                         "upper-port": 65535
+                       },
+                       "source-ipv4-network": "0.0.0.0/0",
+                       "source-port-range": {
+                         "lower-port": 0,
+                         "upper-port": 65535
+                       },
+                       "protocol-mask": 255,
+                       "protocol": 127,
+                       "priority": 1
+                     },
+                     "rule-name": "rule1588"
+                   }
+                 ]}
+
+    def test_get_default_flows(self):
+        """Check if default ACL SampleVNF CLI commands are
+        generated correctly"""
+        ssh_helper = mock.Mock()
+        vnfd_helper = VnfdHelper({'vdu': [
+            {'external-interface': [
+                {
+                    'virtual-interface': {
+                        'local_ip': '152.16.100.19',
+                        'netmask': '255.255.255.0',
+                        'dpdk_port_num': 0,
+                        'dst_ip': '152.16.100.20',
+                        'vld_id': 'uplink_0',
+                        'ifname': 'xe0',
+                    },
+                    'vnfd-connection-point-ref': 'xe0',
+                    'name': 'xe0'
+                },
+                {
+                    'virtual-interface': {
+                        'local_ip': '152.16.40.19',
+                        'netmask': '255.255.255.0',
+                        'dpdk_port_num': 1,
+                        'dst_ip': '152.16.40.20',
+                        'vld_id': 'downlink_0',
+                        'ifname': 'xe1',
+                    },
+                    'vnfd-connection-point-ref': 'xe1',
+                    'name': 'xe1'
+                }
+            ]}
+        ]})
+        setup_helper = AclApproxSetupEnvSetupEnvHelper(vnfd_helper, ssh_helper, None)
+        self.check_acl_commands(setup_helper.get_flows_config(), [
+            # format: (<cli pattern>, <number of expected matches>)
+            ("^p action add [0-9]+ accept$", 2),
+            ("^p action add [0-9]+ count$", 2),
+            ("^p action add [0-9]+ fwd 1$", 1),
+            ("^p action add [0-9]+ fwd 0$", 1),
+            ("^p acl add 1 152.16.100.0 24 152.16.40.0 24 0 65535 0 65535 0 0 [0-9]+$", 1),
+            ("^p acl add 1 152.16.40.0 24 152.16.100.0 24 0 65535 0 65535 0 0 [0-9]+$", 1),
+            ("^p acl applyruleset$", 1)
+        ])
+
+    @mock.patch.object(AclApproxSetupEnvSetupEnvHelper, 'get_default_flows')
+    def test_get_flows_config(self, get_default_flows):
+        """Check if provided ACL config can be converted to
+        ACL SampleVNF CLI commands correctly"""
+        ssh_helper = mock.Mock()
+        setup_helper = AclApproxSetupEnvSetupEnvHelper(None, ssh_helper, None)
+        get_default_flows.return_value = ({}, [])
+        self.check_acl_commands(setup_helper.get_flows_config(self.ACL_CONFIG), [
+            # format: (<cli pattern>, <number of expected matches>)
+            ("^p action add [0-9]+ count$", 1),
+            ("^p action add [0-9]+ fwd 0$", 1),
+            ("^p acl add 1 0.0.0.0 0 152.16.0.0 24 0 65535 0 65535 127 0 [0-9]+$", 1),
+            ("^p acl applyruleset$", 1)
+        ])
+
+    @mock.patch.object(AclApproxSetupEnvSetupEnvHelper, 'get_default_flows')
+    def test_get_flows_config_invalid_action(self, get_default_flows):
+        """Check if incorrect ACL config fails to convert
+        to ACL SampleVNF CLI commands"""
+        ssh_helper = mock.Mock()
+        setup_helper = AclApproxSetupEnvSetupEnvHelper(None, ssh_helper, None)
+        get_default_flows.return_value = ({}, [])
+        # duplicate config and add invald action
+        acl_config = copy.deepcopy(self.ACL_CONFIG)
+        acl_config['access-list-entries'][0]["actions"].append({"xnat": {}})
+        self.assertRaises(exceptions.AclUknownActionTemplate,
+            setup_helper.get_flows_config, acl_config)
+
+    @mock.patch.object(AclApproxSetupEnvSetupEnvHelper, 'get_default_flows')
+    def test_get_flows_config_invalid_action_param(self, get_default_flows):
+        """Check if ACL config with invalid action parameter fails to convert
+        to ACL SampleVNF CLI commands"""
+        ssh_helper = mock.Mock()
+        setup_helper = AclApproxSetupEnvSetupEnvHelper(None, ssh_helper, None)
+        get_default_flows.return_value = ({}, [])
+        # duplicate config and add action with invalid parameter
+        acl_config = copy.deepcopy(self.ACL_CONFIG)
+        acl_config['access-list-entries'][0]["actions"].append(
+            {"nat": {"xport": 0}})
+        self.assertRaises(exceptions.AclMissingActionArguments,
+            setup_helper.get_flows_config, acl_config)
+
+    def check_acl_commands(self, config, expected_cli_patterns):
+        """Check if expected ACL CLI commands (given as a list of patterns,
+        `expected_cli_patterns` parameter) present in SampleVNF ACL
+        configuration (given as a multiline string, `config` parameter)"""
+        # Example of expected config:
+        # ---------------------------
+        # p action add 1 accept
+        # p action add 1 fwd 1
+        # p action add 2 accept
+        # p action add 2 count
+        # p action add 2 fwd 0
+        # p acl add 1 152.16.100.0 24 152.16.40.0 24 0 65535 0 65535 0 0 1
+        # p acl add 1 152.16.40.0 24 152.16.100.0 24 0 65535 0 65535 0 0 2
+        # p acl applyruleset
+        # ---------------------------
+        # NOTE: The config above consists of actions ids, which are actually
+        # unknown (generated at runtime), thus it's incorrect just to compare
+        # the example ACL config above with the configuration returned by
+        # get_flows_config() function. It's more correct to use CLI patterns
+        # (RE) to find the required SampleVNF CLI commands in the multiline
+        # string (SampleVNF ACL configuration).
+        for pattern, num_of_match in expected_cli_patterns:
+            # format: (<cli pattern>, <number of expected matches>)
+            result = re.findall(pattern, config, re.MULTILINE)
+            self.assertEqual(len(result), num_of_match)
+
     @mock.patch('yardstick.network_services.vnf_generic.vnf.sample_vnf.open')
     @mock.patch.object(utils, 'find_relative_file')
     @mock.patch('yardstick.network_services.vnf_generic.vnf.sample_vnf.MultiPortConfig')
@@ -359,14 +501,17 @@ class TestAclApproxSetupEnvSetupEnvHelper(unittest.TestCase):
         ssh_helper = mock.Mock()
         scenario_helper = mock.Mock()
         scenario_helper.vnf_cfg = {'lb_config': 'HW'}
+        scenario_helper.options = {}
         scenario_helper.all_options = {}
 
         acl_approx_setup_helper = AclApproxSetupEnvSetupEnvHelper(vnfd_helper,
                                                                   ssh_helper,
                                                                   scenario_helper)
 
+        acl_approx_setup_helper.get_flows_config = mock.Mock()
         acl_approx_setup_helper.ssh_helper.provision_tool = mock.Mock(return_value='tool_path')
         acl_approx_setup_helper.ssh_helper.all_ports = mock.Mock()
         acl_approx_setup_helper.vnfd_helper.port_nums = mock.Mock(return_value=[0, 1])
         expected = 'sudo tool_path -p 0x3 -f /tmp/acl_config -s /tmp/acl_script  --hwlb 3'
         self.assertEqual(acl_approx_setup_helper.build_config(), expected)
+        acl_approx_setup_helper.get_flows_config.assert_called_once()
diff --git a/tests/unit/network_services/vnf_generic/vnf/test_cgnapt_vnf.py b/tests/unit/network_services/vnf_generic/vnf/test_cgnapt_vnf.py
index b7731b649..c549da8f9 100644
--- a/tests/unit/network_services/vnf_generic/vnf/test_cgnapt_vnf.py
+++ b/tests/unit/network_services/vnf_generic/vnf/test_cgnapt_vnf.py
@@ -88,6 +88,7 @@ link 1 up
         ssh_helper = mock.Mock()
         scenario_helper = mock.Mock()
         scenario_helper.vnf_cfg = {'lb_config': 'HW'}
+        scenario_helper.options = {}
         scenario_helper.all_options = {}
 
         cgnat_approx_setup_helper = CgnaptApproxSetupEnvHelper(vnfd_helper,
diff --git a/tests/unit/network_services/vnf_generic/vnf/test_sample_vnf.py b/tests/unit/network_services/vnf_generic/vnf/test_sample_vnf.py
index ff71bed9d..edffa1c12 100644
--- a/tests/unit/network_services/vnf_generic/vnf/test_sample_vnf.py
+++ b/tests/unit/network_services/vnf_generic/vnf/test_sample_vnf.py
@@ -572,6 +572,7 @@ class TestDpdkVnfSetupEnvHelper(unittest.TestCase):
         ssh_helper = mock.Mock()
         scenario_helper = mock.Mock()
         scenario_helper.vnf_cfg = {}
+        scenario_helper.options = {}
         scenario_helper.all_options = {}
         dpdk_setup_helper = DpdkVnfSetupEnvHelper(vnfd_helper, ssh_helper, scenario_helper)
 
@@ -583,6 +584,7 @@ class TestDpdkVnfSetupEnvHelper(unittest.TestCase):
         self.assertGreaterEqual(mock_multi_port_config.generate_config.call_count, 1)
         self.assertGreaterEqual(mock_multi_port_config.generate_script.call_count, 1)
 
+        scenario_helper.options = {'rules': 'fake_file'}
         scenario_helper.vnf_cfg = {'file': 'fake_file'}
         dpdk_setup_helper = DpdkVnfSetupEnvHelper(vnfd_helper, ssh_helper, scenario_helper)
         mock_open_rf.side_effect = mock.mock_open(read_data='fake_data')
@@ -590,7 +592,7 @@ class TestDpdkVnfSetupEnvHelper(unittest.TestCase):
 
         result = dpdk_setup_helper.build_config()
 
-        mock_open_rf.assert_called_once()
+        mock_open_rf.assert_called()
         self.assertEqual(result, expected)
         self.assertGreaterEqual(ssh_helper.upload_config_file.call_count, 2)
         self.assertGreaterEqual(mock_find.call_count, 1)
diff --git a/tests/unit/network_services/vnf_generic/vnf/test_vfw_vnf.py b/tests/unit/network_services/vnf_generic/vnf/test_vfw_vnf.py
index aaad66381..d141ac7a6 100644
--- a/tests/unit/network_services/vnf_generic/vnf/test_vfw_vnf.py
+++ b/tests/unit/network_services/vnf_generic/vnf/test_vfw_vnf.py
@@ -334,7 +334,6 @@ pipeline>
         vfw_approx_vnf.ssh_helper.run.assert_called_once()
 
     @mock.patch.object(utils, 'find_relative_file')
-    @mock.patch("yardstick.network_services.vnf_generic.vnf.vfw_vnf.YangModel")
     @mock.patch("yardstick.network_services.vnf_generic.vnf.sample_vnf.Context")
     @mock.patch(SSH_HELPER)
     def test_instantiate(self, ssh, *args):
@@ -363,12 +362,15 @@ class TestFWApproxSetupEnvHelper(unittest.TestCase):
         ssh_helper = mock.Mock()
         scenario_helper = mock.Mock()
         scenario_helper.vnf_cfg = {'lb_config': 'HW'}
+        scenario_helper.options = {}
         scenario_helper.all_options = {}
 
         vfw_approx_setup_helper = FWApproxSetupEnvHelper(vnfd_helper, ssh_helper, scenario_helper)
+        vfw_approx_setup_helper.get_flows_config = mock.Mock()
 
         vfw_approx_setup_helper.ssh_helper.provision_tool = mock.Mock(return_value='tool_path')
         vfw_approx_setup_helper.ssh_helper.all_ports = mock.Mock()
         vfw_approx_setup_helper.vnfd_helper.port_nums = mock.Mock(return_value=[0, 1])
         expected = 'sudo tool_path -p 0x3 -f /tmp/vfw_config -s /tmp/vfw_script  --hwlb 3'
         self.assertEqual(vfw_approx_setup_helper.build_config(), expected)
+        vfw_approx_setup_helper.get_flows_config.assert_called_once()