vcl: add dtls test
[vpp.git] / test / test_vcl.py
index 18279e9..8bff4be 100644 (file)
@@ -1,4 +1,4 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 """ Vpp VCL tests """
 
 import unittest
@@ -9,11 +9,28 @@ from framework import VppTestCase, VppTestRunner, running_extended_tests, \
     Worker
 from vpp_ip_route import VppIpTable, VppIpRoute, VppRoutePath, FibPathProto
 
+iperf3 = '/usr/bin/iperf3'
+
+
+def have_app(app):
+    try:
+        subprocess.check_output([app, '-v'])
+    except (subprocess.CalledProcessError, OSError):
+        return False
+    return True
+
+
+_have_iperf3 = have_app(iperf3)
+
 
 class VCLAppWorker(Worker):
     """ VCL Test Application Worker """
 
-    def __init__(self, build_dir, appname, args, logger, env={}):
+    def __init__(self, build_dir, appname, executable_args, logger, env=None,
+                 *args, **kwargs):
+
+        if env is None:
+            env = {}
         vcl_lib_dir = "%s/vpp/lib" % build_dir
         if "iperf" in appname:
             app = appname
@@ -25,12 +42,14 @@ class VCLAppWorker(Worker):
                         "%s/libvcl_ldpreload.so" % vcl_lib_dir})
         else:
             app = "%s/vpp/bin/%s" % (build_dir, appname)
-        self.args = [app] + args
-        super(VCLAppWorker, self).__init__(self.args, logger, env)
+        self.args = [app] + executable_args
+        super(VCLAppWorker, self).__init__(self.args, logger, env,
+                                           *args, **kwargs)
 
 
 class VCLTestCase(VppTestCase):
     """ VCL Test Class """
+    extra_vpp_punt_config = ["session", "{", "poll-main", "}"]
 
     @classmethod
     def setUpClass(cls):
@@ -44,7 +63,7 @@ class VCLTestCase(VppTestCase):
         var = "VPP_BUILD_DIR"
         self.build_dir = os.getenv(var, None)
         if self.build_dir is None:
-            raise Exception("Environment variable `%s' not set" % var)
+            raise EnvironmentError("Environment variable `%s' not set" % var)
         self.vppDebug = 'vpp_debug' in self.build_dir
         self.server_addr = "127.0.0.1"
         self.server_port = "22000"
@@ -62,15 +81,14 @@ class VCLTestCase(VppTestCase):
         super(VCLTestCase, self).setUp()
 
     def cut_thru_setup(self):
-        self.vapi.session_enable_disable(is_enabled=1)
+        self.vapi.session_enable_disable(is_enable=1)
 
     def cut_thru_tear_down(self):
-        self.vapi.session_enable_disable(is_enabled=0)
+        self.vapi.session_enable_disable(is_enable=0)
 
     def cut_thru_test(self, server_app, server_args, client_app, client_args):
-        self.env = {'VCL_API_PREFIX': self.shm_prefix,
+        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)
         worker_server.start()
@@ -86,7 +104,7 @@ class VCLTestCase(VppTestCase):
         self.sleep(self.post_test_sleep)
 
     def thru_host_stack_setup(self):
-        self.vapi.session_enable_disable(is_enabled=1)
+        self.vapi.session_enable_disable(is_enable=1)
         self.create_loopback_interfaces(2)
 
         table_id = 1
@@ -103,9 +121,9 @@ class VCLTestCase(VppTestCase):
             table_id += 1
 
         # Configure namespaces
-        self.vapi.app_namespace_add_del(namespace_id=b"1", secret=1234,
+        self.vapi.app_namespace_add_del(namespace_id="1", secret=1234,
                                         sw_if_index=self.loop0.sw_if_index)
-        self.vapi.app_namespace_add_del(namespace_id=b"2", secret=5678,
+        self.vapi.app_namespace_add_del(namespace_id="2", secret=5678,
                                         sw_if_index=self.loop1.sw_if_index)
 
         # Add inter-table routes
@@ -128,7 +146,7 @@ class VCLTestCase(VppTestCase):
             i.admin_down()
 
     def thru_host_stack_ipv6_setup(self):
-        self.vapi.session_enable_disable(is_enabled=1)
+        self.vapi.session_enable_disable(is_enable=1)
         self.create_loopback_interfaces(2)
 
         table_id = 1
@@ -144,9 +162,9 @@ class VCLTestCase(VppTestCase):
             table_id += 1
 
         # Configure namespaces
-        self.vapi.app_namespace_add_del(namespace_id=b"1", secret=1234,
+        self.vapi.app_namespace_add_del(namespace_id="1", secret=1234,
                                         sw_if_index=self.loop0.sw_if_index)
-        self.vapi.app_namespace_add_del(namespace_id=b"2", secret=5678,
+        self.vapi.app_namespace_add_del(namespace_id="2", secret=5678,
                                         sw_if_index=self.loop1.sw_if_index)
 
         # Add inter-table routes
@@ -169,11 +187,12 @@ class VCLTestCase(VppTestCase):
             i.set_table_ip6(0)
             i.admin_down()
 
-        self.vapi.session_enable_disable(is_enabled=0)
+        self.vapi.session_enable_disable(is_enable=0)
 
+    @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_API_PREFIX': self.shm_prefix,
+        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"}
@@ -197,6 +216,8 @@ class VCLTestCase(VppTestCase):
         self.sleep(self.post_test_sleep)
 
     def validateResults(self, worker_client, worker_server, timeout):
+        if worker_server.process is None:
+            raise RuntimeError('worker_server is not running.')
         if os.path.isdir('/proc/{}'.format(worker_server.process.pid)):
             self.logger.info("Killing server worker process (pid %d)" %
                              worker_server.process.pid)
@@ -218,7 +239,7 @@ class VCLTestCase(VppTestCase):
                     "Couldn't kill client worker process")
                 raise
         if error:
-            raise Exception(
+            raise RuntimeError(
                 "Timeout! Client worker did not finish in %ss" % timeout)
         self.assert_equal(worker_client.result, 0, "Binary test return code")
 
@@ -241,8 +262,8 @@ class LDPCutThruTestCase(VCLTestCase):
         self.client_echo_test_args = ["-E", self.echo_phrase, "-X",
                                       self.server_addr, self.server_port]
         self.client_iperf3_timeout = 20
-        self.client_iperf3_args = ["-V4d", "-t 2", "-c", self.server_addr]
-        self.server_iperf3_args = ["-V4d", "-s"]
+        self.client_iperf3_args = ["-4", "-t 2", "-c", self.server_addr]
+        self.server_iperf3_args = ["-4", "-s"]
         self.client_uni_dir_nsock_timeout = 20
         self.client_uni_dir_nsock_test_args = ["-N", "1000", "-U", "-X",
                                                "-I", "2",
@@ -260,6 +281,7 @@ class LDPCutThruTestCase(VCLTestCase):
 
     def show_commands_at_teardown(self):
         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")
     def test_ldp_cut_thru_echo(self):
@@ -268,30 +290,13 @@ class LDPCutThruTestCase(VCLTestCase):
         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 """
 
-        try:
-            subprocess.check_output(['iperf3', '-v'])
-        except subprocess.CalledProcessError:
-            self.logger.error(
-                "WARNING: Subprocess returned non-0 running 'iperf3 -v")
-            self.logger.error("         'test_ldp_cut_thru_iperf3' not run!")
-            return
-        except OSError as e:
-            self.logger.error(
-                "WARNING: Subprocess returned with OS error (%s) %s\n"
-                "         'iperf3' is likely not installed,",
-                e.errno, e.strerror)
-            self.logger.error("         'test_ldp_cut_thru_iperf3' not run!")
-            return
-        except Exception:
-            self.logger.exception(
-                "Subprocess returned non-0 running 'iperf3 -v")
-
         self.timeout = self.client_iperf3_timeout
-        self.cut_thru_test("iperf3", self.server_iperf3_args,
-                           "iperf3", self.client_iperf3_args)
+        self.cut_thru_test(iperf3, self.server_iperf3_args,
+                           iperf3, self.client_iperf3_args)
 
     @unittest.skipUnless(running_extended_tests, "part of extended tests")
     def test_ldp_cut_thru_uni_dir_nsock(self):
@@ -303,6 +308,7 @@ class LDPCutThruTestCase(VCLTestCase):
                            self.client_uni_dir_nsock_test_args)
 
     @unittest.skipUnless(running_extended_tests, "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 """
 
@@ -346,6 +352,7 @@ class VCLCutThruTestCase(VCLTestCase):
 
     def show_commands_at_teardown(self):
         self.logger.debug(self.vapi.cli("show session verbose 2"))
+        self.logger.debug(self.vapi.cli("show app mq"))
 
     def test_vcl_cut_thru_echo(self):
         """ run VCL cut thru echo test """
@@ -401,6 +408,7 @@ class VCLThruHostStackEcho(VCLTestCase):
     def show_commands_at_teardown(self):
         self.logger.debug(self.vapi.cli("show app server"))
         self.logger.debug(self.vapi.cli("show session verbose"))
+        self.logger.debug(self.vapi.cli("show app mq"))
 
 
 class VCLThruHostStackTLS(VCLTestCase):
@@ -439,6 +447,47 @@ class VCLThruHostStackTLS(VCLTestCase):
     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 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 VCLThruHostStackBidirNsock(VCLTestCase):
@@ -471,6 +520,7 @@ class VCLThruHostStackBidirNsock(VCLTestCase):
 
     def show_commands_at_teardown(self):
         self.logger.debug(self.vapi.cli("show session verbose 2"))
+        self.logger.debug(self.vapi.cli("show app mq"))
 
     def test_vcl_thru_host_stack_bi_dir_nsock(self):
         """ run VCL thru host stack bi-directional (multiple sockets) test """
@@ -496,20 +546,15 @@ class LDPThruHostStackBidirNsock(VCLTestCase):
         super(LDPThruHostStackBidirNsock, self).setUp()
 
         self.thru_host_stack_setup()
-        if self.vppDebug:
-            self.client_bi_dir_nsock_timeout = 20
-            self.client_bi_dir_nsock_test_args = ["-N", "1000", "-B", "-X",
-                                                  # OUCH! Host Stack Bug?
-                                                  # "-I", "2",
-                                                  self.loop0.local_ip4,
-                                                  self.server_port]
-        else:
-            self.client_bi_dir_nsock_timeout = 20
-            self.client_bi_dir_nsock_test_args = ["-N", "1000", "-B", "-X",
-                                                  # OUCH! Host Stack Bug?
-                                                  # "-I", "2",
-                                                  self.loop0.local_ip4,
-                                                  self.server_port]
+        self.client_bi_dir_nsock_timeout = 20
+        self.client_bi_dir_nsock_test_args = ["-N", "1000", "-B", "-X",
+                                              # OUCH! Host Stack Bug?
+                                              # Only fails when running
+                                              # 'make test TEST_JOBS=auto'
+                                              # or TEST_JOBS > 1
+                                              # "-I", "2",
+                                              self.loop0.local_ip4,
+                                              self.server_port]
 
     def tearDown(self):
         self.thru_host_stack_tear_down()
@@ -517,6 +562,7 @@ class LDPThruHostStackBidirNsock(VCLTestCase):
 
     def show_commands_at_teardown(self):
         self.logger.debug(self.vapi.cli("show session verbose 2"))
+        self.logger.debug(self.vapi.cli("show app mq"))
 
     def test_ldp_thru_host_stack_bi_dir_nsock(self):
         """ run LDP thru host stack bi-directional (multiple sockets) test """
@@ -623,8 +669,8 @@ class LDPThruHostStackIperf(VCLTestCase):
 
         self.thru_host_stack_setup()
         self.client_iperf3_timeout = 20
-        self.client_iperf3_args = ["-V4d", "-t 2", "-c", self.loop0.local_ip4]
-        self.server_iperf3_args = ["-V4d", "-s"]
+        self.client_iperf3_args = ["-4", "-t 2", "-c", self.loop0.local_ip4]
+        self.server_iperf3_args = ["-4", "-s"]
 
     def tearDown(self):
         self.thru_host_stack_tear_down()
@@ -632,29 +678,52 @@ class LDPThruHostStackIperf(VCLTestCase):
 
     def show_commands_at_teardown(self):
         self.logger.debug(self.vapi.cli("show session verbose 2"))
+        self.logger.debug(self.vapi.cli("show app mq"))
 
+    @unittest.skipUnless(_have_iperf3, "'%s' not found, Skipping.")
     def test_ldp_thru_host_stack_iperf3(self):
         """ run LDP thru host stack iperf3 test """
 
-        try:
-            subprocess.check_output(['iperf3', '-v'])
-        except subprocess.CalledProcessError:
-            self.logger.error("WARNING: 'iperf3' is not installed,")
-            self.logger.error(
-                "         'test_ldp_thru_host_stack_iperf3' not run!")
-            return
-        except OSError as e:
-            self.logger.error("WARNING: 'iperf3' is not installed,")
-            self.logger.error("         'test' not run!")
-            return
-        except Exception as e:
-            self.logger.error("WARNING: 'iperf3' unexpected error,")
-            self.logger.error("         'test' not run!")
-            return
+        self.timeout = self.client_iperf3_timeout
+        self.thru_host_stack_test(iperf3, self.server_iperf3_args,
+                                  iperf3, self.client_iperf3_args)
+
+
+class LDPThruHostStackIperfUdp(VCLTestCase):
+    """ LDP Thru Host Stack Iperf UDP """
+
+    @classmethod
+    def setUpClass(cls):
+        super(LDPThruHostStackIperfUdp, cls).setUpClass()
+
+    @classmethod
+    def tearDownClass(cls):
+        super(LDPThruHostStackIperfUdp, cls).tearDownClass()
+
+    def setUp(self):
+        super(LDPThruHostStackIperfUdp, self).setUp()
+
+        self.thru_host_stack_setup()
+        self.client_iperf3_timeout = 20
+        self.client_iperf3_args = ["-4", "-t 2", "-u", "-l 1400",
+                                   "-c", self.loop0.local_ip4]
+        self.server_iperf3_args = ["-4", "-s"]
+
+    def tearDown(self):
+        self.thru_host_stack_tear_down()
+        super(LDPThruHostStackIperfUdp, self).tearDown()
+
+    def show_commands_at_teardown(self):
+        self.logger.debug(self.vapi.cli("show session verbose 2"))
+        self.logger.debug(self.vapi.cli("show app mq"))
+
+    @unittest.skipUnless(_have_iperf3, "'%s' not found, Skipping.")
+    def test_ldp_thru_host_stack_iperf3_udp(self):
+        """ run LDP thru host stack iperf3 UDP test """
 
         self.timeout = self.client_iperf3_timeout
-        self.thru_host_stack_test("iperf3", self.server_iperf3_args,
-                                  "iperf3", self.client_iperf3_args)
+        self.thru_host_stack_test(iperf3, self.server_iperf3_args,
+                                  iperf3, self.client_iperf3_args)
 
 
 class LDPIpv6CutThruTestCase(VCLTestCase):
@@ -668,6 +737,10 @@ class LDPIpv6CutThruTestCase(VCLTestCase):
     def tearDownClass(cls):
         super(LDPIpv6CutThruTestCase, cls).tearDownClass()
 
+    def show_commands_at_teardown(self):
+        self.logger.debug(self.vapi.cli("show session verbose 2"))
+        self.logger.debug(self.vapi.cli("show app mq"))
+
     def setUp(self):
         super(LDPIpv6CutThruTestCase, self).setUp()
 
@@ -678,9 +751,9 @@ class LDPIpv6CutThruTestCase(VCLTestCase):
         self.client_ipv6_echo_test_args = ["-6", "-E", self.echo_phrase, "-X",
                                            self.server_ipv6_addr,
                                            self.server_port]
-        self.client_ipv6_iperf3_args = ["-V6d", "-t 2", "-c",
+        self.client_ipv6_iperf3_args = ["-6", "-t 2", "-c",
                                         self.server_ipv6_addr]
-        self.server_ipv6_iperf3_args = ["-V6d", "-s"]
+        self.server_ipv6_iperf3_args = ["-6", "-s"]
         self.client_ipv6_uni_dir_nsock_test_args = ["-N", "1000", "-U", "-X",
                                                     "-6",
                                                     "-I", "2",
@@ -704,21 +777,14 @@ class LDPIpv6CutThruTestCase(VCLTestCase):
                            "sock_test_client",
                            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 """
 
-        try:
-            subprocess.check_output(['iperf3', '-v'])
-        except:
-            self.logger.error("WARNING: 'iperf3' is not installed,")
-            self.logger.error(
-                "         'test_ldp_ipv6_cut_thru_iperf3' not run!")
-            return
-
         self.timeout = self.client_iperf3_timeout
-        self.cut_thru_test("iperf3", self.server_ipv6_iperf3_args,
-                           "iperf3", self.client_ipv6_iperf3_args)
+        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")
     def test_ldp_ipv6_cut_thru_uni_dir_nsock(self):
@@ -730,6 +796,7 @@ class LDPIpv6CutThruTestCase(VCLTestCase):
                            self.client_ipv6_uni_dir_nsock_test_args)
 
     @unittest.skipUnless(running_extended_tests, "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 """
 
@@ -750,6 +817,10 @@ class VCLIpv6CutThruTestCase(VCLTestCase):
     def tearDownClass(cls):
         super(VCLIpv6CutThruTestCase, cls).tearDownClass()
 
+    def show_commands_at_teardown(self):
+        self.logger.debug(self.vapi.cli("show session verbose 2"))
+        self.logger.debug(self.vapi.cli("show app mq"))
+
     def setUp(self):
         super(VCLIpv6CutThruTestCase, self).setUp()
 
@@ -774,6 +845,10 @@ class VCLIpv6CutThruTestCase(VCLTestCase):
         super(VCLIpv6CutThruTestCase, self).tearDown()
         self.cut_thru_tear_down()
 
+    def show_commands_at_teardown(self):
+        self.logger.debug(self.vapi.cli("show session verbose 2"))
+        self.logger.debug(self.vapi.cli("show app mq"))
+
     def test_vcl_ipv6_cut_thru_echo(self):
         """ run VCL IPv6 cut thru echo test """