make test: Add VCL LD_PRELOAD tests

- Refactor test code into VclTestCase object.
- Add LDP cut thru and thru host stack tests.

Change-Id: I2b16473df108004c79cc86fe1b7a789485b2dc5b
Signed-off-by: Dave Wallace <dwallacelf@gmail.com>

test/test_vcl.py

@@ -16,84 +16,48 @@ class VclAppWorker(Worker):
         build_dir = os.getenv(var, None)
         if build_dir is None:
             raise Exception("Environment variable `%s' not set" % var)
-        vcl_app_dir = "%s/vpp/.libs" % build_dir
+        vcl_lib_dir = "%s/vpp/.libs" % build_dir
-        self.args = ["%s/%s" % (vcl_app_dir, appname)] + args
+        app = "%s/%s" % (vcl_lib_dir, appname)
+        if not os.path.isfile(app):
+            app = "%s/vpp/%s" % (build_dir, appname)
+            env.update({'LD_PRELOAD':
+                        "%s/libvcl_ldpreload.so.0.0.0" % vcl_lib_dir})
+        self.args = [app] + args
         super(VclAppWorker, self).__init__(self.args, logger, env)
 
 
 class VclTestCase(VppTestCase):
     """ VCL Test Class """
 
-    def validateResults(self, worker_client, worker_server, timeout):
+    def __init__(self, methodName):
-        self.logger.info("Client worker result is `%s'" % worker_client.result)
+        self.server_addr = "127.0.0.1"
-        error = False
+        self.server_port = "22000"
-        if worker_client.result is None:
+        self.timeout = 3
-            try:
+        self.echo_phrase = "Hello, world! Jenny is a friend of mine."
-                error = True
-                self.logger.error(
-                    "Timeout! Client worker did not finish in %ss" % timeout)
-                os.killpg(os.getpgid(worker_client.process.pid),
-                          signal.SIGTERM)
-                worker_client.join()
-            except:
-                self.logger.debug(
-                    "Couldn't kill client worker-spawned process")
-                raise
-        if error:
-            os.killpg(os.getpgid(worker_server.process.pid), signal.SIGTERM)
-            worker_server.join()
-            raise Exception(
-                "Timeout! Client worker did not finish in %ss" % timeout)
-        self.assert_equal(worker_client.result, 0, "Binary test return code")
 
+        super(VclTestCase, self).__init__(methodName)
 
-class VCLCUTTHRUTestCase(VclTestCase):
+    def cut_thru_setup(self):
-    """ VPP Communications Library Test """
-
-    server_addr = "127.0.0.1"
-    server_port = "22000"
-    timeout = 3
-    echo_phrase = "Hello, world! Jenny is a friend of mine"
-
-    def setUp(self):
-        super(VCLCUTTHRUTestCase, self).setUp()
-
         self.vapi.session_enable_disable(is_enabled=1)
 
-    def tearDown(self):
+    def cut_thru_tear_down(self):
         self.vapi.session_enable_disable(is_enabled=0)
 
-        super(VCLCUTTHRUTestCase, self).tearDown()
+    def cut_thru_test(self, server_app, client_app, client_args):
-
-    def test_vcl_cutthru(self):
-        """ run VCL cut-thru test """
         self.env = {'VCL_API_PREFIX': self.shm_prefix,
                     'VCL_APP_SCOPE_LOCAL': "true"}
 
-        worker_server = VclAppWorker("vcl_test_server",
+        worker_server = VclAppWorker(server_app, [self.server_port],
-                                     [self.server_port],
                                      self.logger, self.env)
         worker_server.start()
         self.sleep(0.2)
-        worker_client = VclAppWorker("vcl_test_client",
+        worker_client = VclAppWorker(client_app, client_args,
-                                     [self.server_addr, self.server_port,
-                                      "-E", self.echo_phrase, "-X"],
                                      self.logger, self.env)
         worker_client.start()
         worker_client.join(self.timeout)
         self.validateResults(worker_client, worker_server, self.timeout)
 
-
+    def thru_host_stack_setup(self):
-class VCLTHRUHSTestcase(VclTestCase):
-    """ VCL Thru Hoststack Test """
-
-    server_port = "22000"
-    timeout = 3
-    echo_phrase = "Hello, world! Jenny is a friend of mine"
-
-    def setUp(self):
-        super(VCLTHRUHSTestcase, self).setUp()
-
         self.vapi.session_enable_disable(is_enabled=1)
         self.create_loopback_interfaces(range(2))
 
@@ -116,20 +80,6 @@ class VCLTHRUHSTestcase(VclTestCase):
         self.vapi.app_namespace_add(namespace_id="1", secret=5678,
                                     sw_if_index=self.loop1.sw_if_index)
 
-    def tearDown(self):
-        for i in self.lo_interfaces:
-            i.unconfig_ip4()
-            i.set_table_ip4(0)
-            i.admin_down()
-
-        self.vapi.session_enable_disable(is_enabled=0)
-        super(VCLTHRUHSTestcase, self).tearDown()
-
-    def test_vcl_thru_hoststack(self):
-        """ run VCL thru hoststack test """
-        self.env = {'VCL_API_PREFIX': self.shm_prefix,
-                    'VCL_APP_SCOPE_GLOBAL': "true"}
-
         # Add inter-table routes
         ip_t01 = VppIpRoute(self, self.loop1.local_ip4, 32,
                             [VppRoutePath("0.0.0.0",
@@ -142,24 +92,115 @@ class VCLTHRUHSTestcase(VclTestCase):
         ip_t01.add_vpp_config()
         ip_t10.add_vpp_config()
 
-        self.env.update({'VCL_APP_NAMESPACE_ID': "0",
+    def thru_host_stack_tear_down(self):
-                         'VCL_APP_NAMESPACE_SECRET': "1234"})
+        for i in self.lo_interfaces:
-        worker_server = VclAppWorker("vcl_test_server",
+            i.unconfig_ip4()
-                                     [self.server_port],
+            i.set_table_ip4(0)
+            i.admin_down()
+
+        self.vapi.session_enable_disable(is_enabled=0)
+
+    def thru_host_stack_test(self, server_app, client_app, client_args):
+        self.env = {'VCL_API_PREFIX': self.shm_prefix,
+                    'VCL_APP_SCOPE_GLOBAL': "true",
+                    'VCL_APP_NAMESPACE_ID': "0",
+                    'VCL_APP_NAMESPACE_SECRET': "1234"}
+
+        worker_server = VclAppWorker(server_app, [self.server_port],
                                      self.logger, self.env)
         worker_server.start()
         self.sleep(0.2)
 
         self.env.update({'VCL_APP_NAMESPACE_ID': "1",
                          'VCL_APP_NAMESPACE_SECRET': "5678"})
-        worker_client = VclAppWorker("vcl_test_client",
+        worker_client = VclAppWorker(client_app, client_args,
-                                     [self.loop0.local_ip4, self.server_port,
-                                      "-E", self.echo_phrase, "-X"],
                                      self.logger, self.env)
         worker_client.start()
         worker_client.join(self.timeout)
 
         self.validateResults(worker_client, worker_server, self.timeout)
 
+    def validateResults(self, worker_client, worker_server, timeout):
+        self.logger.info("Client worker result is `%s'" % worker_client.result)
+        error = False
+        if worker_client.result is None:
+            try:
+                error = True
+                self.logger.error(
+                    "Timeout (%ss)! Killing client worker process" % timeout)
+                os.killpg(os.getpgid(worker_client.process.pid),
+                          signal.SIGTERM)
+                worker_client.join()
+            except:
+                self.logger.debug(
+                    "Couldn't kill client worker process")
+                raise
+        if error:
+            os.killpg(os.getpgid(worker_server.process.pid), signal.SIGTERM)
+            worker_server.join()
+            raise Exception(
+                "Timeout! Client worker did not finish in %ss" % timeout)
+        self.assert_equal(worker_client.result, 0, "Binary test return code")
+
+
+class VCLCutThruTestCase(VclTestCase):
+    """ VCL Cut Thru Tests """
+
+    def setUp(self):
+        super(VCLCutThruTestCase, self).setUp()
+
+        self.cut_thru_setup()
+        self.client_echo_test_args = [self.server_addr, self.server_port,
+                                      "-E", self.echo_phrase, "-X"]
+
+    def tearDown(self):
+        self.cut_thru_tear_down()
+
+        super(VCLCutThruTestCase, self).tearDown()
+
+    def test_ldp_cut_thru_echo(self):
+        """ run LDP cut thru echo test """
+
+        self.cut_thru_test("sock_test_server", "sock_test_client",
+                           self.client_echo_test_args)
+
+    def test_vcl_cut_thru_echo(self):
+        """ run VCL cut thru echo test """
+
+        self.cut_thru_test("vcl_test_server", "vcl_test_client",
+                           self.client_echo_test_args)
+
+
+class VCLThruHostStackTestCase(VclTestCase):
+    """ VCL Thru Host Stack Tests """
+
+    def setUp(self):
+        super(VCLThruHostStackTestCase, self).setUp()
+
+        self.thru_host_stack_setup()
+        self.client_echo_test_args = [self.loop0.local_ip4, self.server_port,
+                                      "-E", self.echo_phrase, "-X"]
+
+    def tearDown(self):
+        self.thru_host_stack_tear_down()
+
+        super(VCLThruHostStackTestCase, self).tearDown()
+
+    def test_ldp_thru_host_stack_echo(self):
+        """ run LDP thru host stack echo test """
+
+        self.thru_host_stack_test("sock_test_server", "sock_test_client",
+                                  self.client_echo_test_args)
+        # TBD: Remove this when VPP crash is fixed.
+        self.thru_host_stack_test("vcl_test_server", "vcl_test_client",
+                                  self.client_echo_test_args)
+
+    def test_vcl_thru_host_stack_echo(self):
+        """ run VCL thru host stack echo test """
+
+        # TBD: Enable this when VPP crash is fixed.
+        # self.thru_host_stack_test("vcl_test_server", "vcl_test_client",
+        #                           self.client_echo_test_args)
+
 if __name__ == '__main__':
     unittest.main(testRunner=VppTestRunner)