tests: make tests less make dependent
[vpp.git] / test / test_vcl.py
index 64ca002..3875114 100644 (file)
@@ -5,8 +5,9 @@ import unittest
 import os
 import subprocess
 import signal
-from framework import VppTestCase, VppTestRunner, running_extended_tests, \
-    Worker
+import glob
+from config import config
+from framework import VppTestCase, VppTestRunner, Worker
 from vpp_ip_route import VppIpTable, VppIpRoute, VppRoutePath, FibPathProto
 
 iperf3 = '/usr/bin/iperf3'
@@ -26,22 +27,33 @@ _have_iperf3 = have_app(iperf3)
 class VCLAppWorker(Worker):
     """ VCL Test Application Worker """
 
-    def __init__(self, build_dir, appname, executable_args, logger, env=None,
-                 *args, **kwargs):
+    libname = "libvcl_ldpreload.so"
+
+    class LibraryNotFound(Exception):
+        pass
+
+    def __init__(self, appname, executable_args, logger, env=None,
+                 role=None, *args, **kwargs):
+        self.role = role
+        vcl_ldpreload_glob = f"{config.vpp_install_dir}/**/{self.libname}"
+        vcl_ldpreload_so = glob.glob(vcl_ldpreload_glob, recursive=True)
+
+        if len(vcl_ldpreload_so) < 1:
+            raise LibraryNotFound("cannot locate library: {}".format(
+                self.libname))
+
+        vcl_ldpreload_so = vcl_ldpreload_so[0]
 
         if env is None:
             env = {}
-        vcl_lib_dir = "%s/vpp/lib" % build_dir
         if "iperf" in appname:
             app = appname
-            env.update({'LD_PRELOAD':
-                        "%s/libvcl_ldpreload.so" % vcl_lib_dir})
+            env.update({'LD_PRELOAD': vcl_ldpreload_so})
         elif "sock" in appname:
-            app = "%s/vpp/bin/%s" % (build_dir, appname)
-            env.update({'LD_PRELOAD':
-                        "%s/libvcl_ldpreload.so" % vcl_lib_dir})
+            app = f"{config.vpp_build_dir}/vpp/bin/{appname}"
+            env.update({'LD_PRELOAD': vcl_ldpreload_so})
         else:
-            app = "%s/vpp/bin/%s" % (build_dir, appname)
+            app = f"{config.vpp_build_dir}/vpp/bin/{appname}"
         self.args = [app] + executable_args
         super(VCLAppWorker, self).__init__(self.args, logger, env,
                                            *args, **kwargs)
@@ -49,10 +61,13 @@ class VCLAppWorker(Worker):
 
 class VCLTestCase(VppTestCase):
     """ VCL Test Class """
-    extra_vpp_punt_config = ["session", "{", "poll-main", "}"]
+    session_startup = ["poll-main"]
 
     @classmethod
     def setUpClass(cls):
+        if cls.session_startup:
+            conf = "session {" + " ".join(cls.session_startup) + "}"
+            cls.extra_vpp_punt_config = [conf]
         super(VCLTestCase, cls).setUpClass()
 
     @classmethod
@@ -60,11 +75,7 @@ class VCLTestCase(VppTestCase):
         super(VCLTestCase, cls).tearDownClass()
 
     def setUp(self):
-        var = "VPP_BUILD_DIR"
-        self.build_dir = os.getenv(var, None)
-        if self.build_dir is None:
-            raise EnvironmentError("Environment variable `%s' not set" % var)
-        self.vppDebug = 'vpp_debug' in self.build_dir
+        self.vppDebug = 'vpp_debug' in config.vpp_install_dir
         self.server_addr = "127.0.0.1"
         self.server_port = "22000"
         self.server_args = [self.server_port]
@@ -74,12 +85,37 @@ class VCLTestCase(VppTestCase):
         self.echo_phrase = "Hello, world! Jenny is a friend of mine."
         self.pre_test_sleep = 0.3
         self.post_test_sleep = 0.2
+        self.sapi_client_sock = ""
+        self.sapi_server_sock = ""
 
         if os.path.isfile("/tmp/ldp_server_af_unix_socket"):
             os.remove("/tmp/ldp_server_af_unix_socket")
 
         super(VCLTestCase, self).setUp()
 
+    def update_vcl_app_env(self, ns_id, ns_secret, attach_sock):
+        if not ns_id:
+            if 'VCL_APP_NAMESPACE_ID' in self.vcl_app_env:
+                del self.vcl_app_env['VCL_APP_NAMESPACE_ID']
+        else:
+            self.vcl_app_env['VCL_APP_NAMESPACE_ID'] = ns_id
+
+        if not ns_secret:
+            if 'VCL_APP_NAMESPACE_SECRET' in self.vcl_app_env:
+                del self.vcl_app_env['VCL_APP_NAMESPACE_SECRET']
+        else:
+            self.vcl_app_env['VCL_APP_NAMESPACE_SECRET'] = ns_secret
+
+        if not attach_sock:
+            self.vcl_app_env['VCL_VPP_API_SOCKET'] = self.get_api_sock_path()
+            if 'VCL_VPP_SAPI_SOCKET' in self.vcl_app_env:
+                del self.vcl_app_env['VCL_VPP_SAPI_SOCKET']
+        else:
+            sapi_sock = "%s/app_ns_sockets/%s" % (self.tempdir, attach_sock)
+            self.vcl_app_env['VCL_VPP_SAPI_SOCKET'] = sapi_sock
+            if 'VCL_VPP_API_SOCKET' in self.vcl_app_env:
+                del self.vcl_app_env['VCL_VPP_API_SOCKET']
+
     def cut_thru_setup(self):
         self.vapi.session_enable_disable(is_enable=1)
 
@@ -87,14 +123,17 @@ class VCLTestCase(VppTestCase):
         self.vapi.session_enable_disable(is_enable=0)
 
     def cut_thru_test(self, server_app, server_args, client_app, client_args):
-        self.env = {'VCL_VPP_API_SOCKET': self.get_api_sock_path(),
-                    'VCL_APP_SCOPE_LOCAL': "true"}
-        worker_server = VCLAppWorker(self.build_dir, server_app, server_args,
-                                     self.logger, self.env)
+        self.vcl_app_env = {'VCL_APP_SCOPE_LOCAL': "true"}
+
+        self.update_vcl_app_env("", "", self.sapi_server_sock)
+        worker_server = VCLAppWorker(server_app, server_args,
+                                     self.logger, self.vcl_app_env, "server")
         worker_server.start()
         self.sleep(self.pre_test_sleep)
-        worker_client = VCLAppWorker(self.build_dir, client_app, client_args,
-                                     self.logger, self.env)
+
+        self.update_vcl_app_env("", "", self.sapi_client_sock)
+        worker_client = VCLAppWorker(client_app, client_args,
+                                     self.logger, self.vcl_app_env, "client")
         worker_client.start()
         worker_client.join(self.timeout)
         try:
@@ -192,20 +231,17 @@ class VCLTestCase(VppTestCase):
     @unittest.skipUnless(_have_iperf3, "'%s' not found, Skipping.")
     def thru_host_stack_test(self, server_app, server_args,
                              client_app, client_args):
-        self.env = {'VCL_VPP_API_SOCKET': self.get_api_sock_path(),
-                    'VCL_APP_SCOPE_GLOBAL': "true",
-                    'VCL_APP_NAMESPACE_ID': "1",
-                    'VCL_APP_NAMESPACE_SECRET': "1234"}
+        self.vcl_app_env = {'VCL_APP_SCOPE_GLOBAL': "true"}
 
-        worker_server = VCLAppWorker(self.build_dir, server_app, server_args,
-                                     self.logger, self.env)
+        self.update_vcl_app_env("1", "1234", self.sapi_server_sock)
+        worker_server = VCLAppWorker(server_app, server_args,
+                                     self.logger, self.vcl_app_env, "server")
         worker_server.start()
         self.sleep(self.pre_test_sleep)
 
-        self.env.update({'VCL_APP_NAMESPACE_ID': "2",
-                         'VCL_APP_NAMESPACE_SECRET': "5678"})
-        worker_client = VCLAppWorker(self.build_dir, client_app, client_args,
-                                     self.logger, self.env)
+        self.update_vcl_app_env("2", "5678", self.sapi_client_sock)
+        worker_client = VCLAppWorker(client_app, client_args,
+                                     self.logger, self.vcl_app_env, "client")
         worker_client.start()
         worker_client.join(self.timeout)
 
@@ -249,6 +285,7 @@ class LDPCutThruTestCase(VCLTestCase):
 
     @classmethod
     def setUpClass(cls):
+        cls.session_startup = ["poll-main", "use-app-socket-api"]
         super(LDPCutThruTestCase, cls).setUpClass()
 
     @classmethod
@@ -274,6 +311,8 @@ class LDPCutThruTestCase(VCLTestCase):
                                               "-I", "2",
                                               self.server_addr,
                                               self.server_port]
+        self.sapi_client_sock = "default"
+        self.sapi_server_sock = "default"
 
     def tearDown(self):
         super(LDPCutThruTestCase, self).tearDown()
@@ -283,14 +322,13 @@ class LDPCutThruTestCase(VCLTestCase):
         self.logger.debug(self.vapi.cli("show session verbose 2"))
         self.logger.debug(self.vapi.cli("show app mq"))
 
-    @unittest.skipUnless(running_extended_tests, "part of extended tests")
+    @unittest.skipUnless(config.extended, "part of extended tests")
     def test_ldp_cut_thru_echo(self):
         """ run LDP cut thru echo test """
 
         self.cut_thru_test("sock_test_server", self.server_args,
                            "sock_test_client", self.client_echo_test_args)
 
-    @unittest.skipUnless(_have_iperf3, "'%s' not found, Skipping.")
     def test_ldp_cut_thru_iperf3(self):
         """ run LDP cut thru iperf3 test """
 
@@ -298,7 +336,7 @@ class LDPCutThruTestCase(VCLTestCase):
         self.cut_thru_test(iperf3, self.server_iperf3_args,
                            iperf3, self.client_iperf3_args)
 
-    @unittest.skipUnless(running_extended_tests, "part of extended tests")
+    @unittest.skipUnless(config.extended, "part of extended tests")
     def test_ldp_cut_thru_uni_dir_nsock(self):
         """ run LDP cut thru uni-directional (multiple sockets) test """
 
@@ -307,7 +345,7 @@ class LDPCutThruTestCase(VCLTestCase):
                            "sock_test_client",
                            self.client_uni_dir_nsock_test_args)
 
-    @unittest.skipUnless(running_extended_tests, "part of extended tests")
+    @unittest.skipUnless(config.extended, "part of extended tests")
     @unittest.skip("sock test apps need to be improved")
     def test_ldp_cut_thru_bi_dir_nsock(self):
         """ run LDP cut thru bi-directional (multiple sockets) test """
@@ -405,6 +443,14 @@ class VCLThruHostStackEcho(VCLTestCase):
         self.thru_host_stack_tear_down()
         super(VCLThruHostStackEcho, self).tearDown()
 
+    def test_vcl_thru_host_stack_echo(self):
+        """ run VCL IPv4 thru host stack echo test """
+
+        self.thru_host_stack_test("vcl_test_server",
+                                  self.server_args,
+                                  "vcl_test_client",
+                                  self.client_echo_test_args)
+
     def show_commands_at_teardown(self):
         self.logger.debug(self.vapi.cli("show app server"))
         self.logger.debug(self.vapi.cli("show session verbose"))
@@ -416,6 +462,7 @@ class VCLThruHostStackTLS(VCLTestCase):
 
     @classmethod
     def setUpClass(cls):
+        cls.session_startup = ["poll-main", "use-app-socket-api"]
         super(VCLThruHostStackTLS, cls).setUpClass()
 
     @classmethod
@@ -431,6 +478,8 @@ class VCLThruHostStackTLS(VCLTestCase):
         self.client_uni_dir_tls_test_args = ["-N", "1000", "-U", "-X", "-L",
                                              self.loop0.local_ip4,
                                              self.server_port]
+        self.sapi_server_sock = "1"
+        self.sapi_client_sock = "2"
 
     def test_vcl_thru_host_stack_tls_uni_dir(self):
         """ run VCL thru host stack uni-directional TLS test """
@@ -450,6 +499,88 @@ class VCLThruHostStackTLS(VCLTestCase):
         self.logger.debug(self.vapi.cli("show app mq"))
 
 
+class VCLThruHostStackDTLS(VCLTestCase):
+    """ VCL Thru Host Stack DTLS """
+
+    @classmethod
+    def setUpClass(cls):
+        super(VCLThruHostStackDTLS, cls).setUpClass()
+
+    @classmethod
+    def tearDownClass(cls):
+        super(VCLThruHostStackDTLS, cls).tearDownClass()
+
+    def setUp(self):
+        super(VCLThruHostStackDTLS, self).setUp()
+
+        self.thru_host_stack_setup()
+        self.client_uni_dir_dtls_timeout = 20
+        self.server_dtls_args = ["-p", "dtls", self.server_port]
+        self.client_uni_dir_dtls_test_args = ["-N", "1000", "-U", "-X",
+                                              "-p", "dtls", "-T 1400",
+                                              self.loop0.local_ip4,
+                                              self.server_port]
+
+    def test_vcl_thru_host_stack_dtls_uni_dir(self):
+        """ run VCL thru host stack uni-directional DTLS test """
+
+        self.timeout = self.client_uni_dir_dtls_timeout
+        self.thru_host_stack_test("vcl_test_server", self.server_dtls_args,
+                                  "vcl_test_client",
+                                  self.client_uni_dir_dtls_test_args)
+
+    def tearDown(self):
+        self.thru_host_stack_tear_down()
+        super(VCLThruHostStackDTLS, self).tearDown()
+
+    def show_commands_at_teardown(self):
+        self.logger.debug(self.vapi.cli("show app server"))
+        self.logger.debug(self.vapi.cli("show session verbose 2"))
+        self.logger.debug(self.vapi.cli("show app mq"))
+
+
+class VCLThruHostStackQUIC(VCLTestCase):
+    """ VCL Thru Host Stack QUIC """
+
+    @classmethod
+    def setUpClass(cls):
+        cls.extra_vpp_plugin_config.append("plugin quic_plugin.so { enable }")
+        super(VCLThruHostStackQUIC, cls).setUpClass()
+
+    @classmethod
+    def tearDownClass(cls):
+        super(VCLThruHostStackQUIC, cls).tearDownClass()
+
+    def setUp(self):
+        super(VCLThruHostStackQUIC, self).setUp()
+
+        self.thru_host_stack_setup()
+        self.client_uni_dir_quic_timeout = 20
+        self.server_quic_args = ["-p", "quic", self.server_port]
+        self.client_uni_dir_quic_test_args = ["-N", "1000", "-U", "-X",
+                                              "-p", "quic",
+                                              self.loop0.local_ip4,
+                                              self.server_port]
+
+    @unittest.skipUnless(config.extended, "part of extended tests")
+    def test_vcl_thru_host_stack_quic_uni_dir(self):
+        """ run VCL thru host stack uni-directional QUIC test """
+
+        self.timeout = self.client_uni_dir_quic_timeout
+        self.thru_host_stack_test("vcl_test_server", self.server_quic_args,
+                                  "vcl_test_client",
+                                  self.client_uni_dir_quic_test_args)
+
+    def tearDown(self):
+        self.thru_host_stack_tear_down()
+        super(VCLThruHostStackQUIC, self).tearDown()
+
+    def show_commands_at_teardown(self):
+        self.logger.debug(self.vapi.cli("show app server"))
+        self.logger.debug(self.vapi.cli("show session verbose 2"))
+        self.logger.debug(self.vapi.cli("show app mq"))
+
+
 class VCLThruHostStackBidirNsock(VCLTestCase):
     """ VCL Thru Host Stack Bidir Nsock """
 
@@ -729,6 +860,7 @@ class LDPIpv6CutThruTestCase(VCLTestCase):
         super(LDPIpv6CutThruTestCase, self).tearDown()
         self.cut_thru_tear_down()
 
+    @unittest.skipUnless(config.extended, "part of extended tests")
     def test_ldp_ipv6_cut_thru_echo(self):
         """ run LDP IPv6 cut thru echo test """
 
@@ -738,7 +870,6 @@ class LDPIpv6CutThruTestCase(VCLTestCase):
                            self.client_ipv6_echo_test_args)
 
     @unittest.skipUnless(_have_iperf3, "'%s' not found, Skipping.")
-    @unittest.skipUnless(running_extended_tests, "part of extended tests")
     def test_ldp_ipv6_cut_thru_iperf3(self):
         """ run LDP IPv6 cut thru iperf3 test """
 
@@ -746,7 +877,7 @@ class LDPIpv6CutThruTestCase(VCLTestCase):
         self.cut_thru_test(iperf3, self.server_ipv6_iperf3_args,
                            iperf3, self.client_ipv6_iperf3_args)
 
-    @unittest.skipUnless(running_extended_tests, "part of extended tests")
+    @unittest.skipUnless(config.extended, "part of extended tests")
     def test_ldp_ipv6_cut_thru_uni_dir_nsock(self):
         """ run LDP IPv6 cut thru uni-directional (multiple sockets) test """
 
@@ -755,7 +886,7 @@ class LDPIpv6CutThruTestCase(VCLTestCase):
                            "sock_test_client",
                            self.client_ipv6_uni_dir_nsock_test_args)
 
-    @unittest.skipUnless(running_extended_tests, "part of extended tests")
+    @unittest.skipUnless(config.extended, "part of extended tests")
     @unittest.skip("sock test apps need to be improved")
     def test_ldp_ipv6_cut_thru_bi_dir_nsock(self):
         """ run LDP IPv6 cut thru bi-directional (multiple sockets) test """
@@ -817,7 +948,7 @@ class VCLIpv6CutThruTestCase(VCLTestCase):
                            "vcl_test_client",
                            self.client_ipv6_echo_test_args)
 
-    @unittest.skipUnless(running_extended_tests, "part of extended tests")
+    @unittest.skipUnless(config.extended, "part of extended tests")
     def test_vcl_ipv6_cut_thru_uni_dir_nsock(self):
         """ run VCL IPv6 cut thru uni-directional (multiple sockets) test """
 
@@ -826,7 +957,7 @@ class VCLIpv6CutThruTestCase(VCLTestCase):
                            "vcl_test_client",
                            self.client_ipv6_uni_dir_nsock_test_args)
 
-    @unittest.skipUnless(running_extended_tests, "part of extended tests")
+    @unittest.skipUnless(config.extended, "part of extended tests")
     def test_vcl_ipv6_cut_thru_bi_dir_nsock(self):
         """ run VCL IPv6 cut thru bi-directional (multiple sockets) test """