src/plugins/quic/test/test_quic.py

   1 #!/usr/bin/env python
   2 """ Vpp QUIC tests """
   3
   4 import unittest
   5 import os
   6 import subprocess
   7 import signal
   8 from framework import VppTestCase, VppTestRunner, running_extended_tests, \
   9     Worker
  10 from vpp_ip_route import VppIpTable, VppIpRoute, VppRoutePath
  11
  12
  13 class QUICAppWorker(Worker):
  14     """ QUIC Test Application Worker """
  15     process = None
  16
  17     def __init__(self, build_dir, appname, args, logger, env={}):
  18         app = "%s/vpp/bin/%s" % (build_dir, appname)
  19         self.args = [app] + args
  20         super(QUICAppWorker, self).__init__(self.args, logger, env)
  21
  22     def run(self):
  23         super(QUICAppWorker, self).run()
  24
  25     def teardown(self, logger, timeout):
  26         if self.process is None:
  27             return False
  28         try:
  29             logger.debug("Killing worker process (pid %d)" % self.process.pid)
  30             os.killpg(os.getpgid(self.process.pid), signal.SIGKILL)
  31             self.join(timeout)
  32         except OSError as e:
  33             logger.debug("Couldn't kill worker process")
  34             return True
  35         return False
  36
  37
  38 class QUICTestCase(VppTestCase):
  39     """ QUIC Test Case """
  40     @classmethod
  41     def setUpClass(cls):
  42         cls.extra_vpp_plugin_config.append("plugin quic_plugin.so { enable }")
  43         super(QUICTestCase, cls).setUpClass()
  44
  45     def setUp(self):
  46         super(QUICTestCase, self).setUp()
  47         var = "VPP_BUILD_DIR"
  48         self.build_dir = os.getenv(var, None)
  49         if self.build_dir is None:
  50             raise Exception("Environment variable `%s' not set" % var)
  51         self.vppDebug = 'vpp_debug' in self.build_dir
  52         self.timeout = 20
  53         self.vapi.session_enable_disable(is_enabled=1)
  54         self.pre_test_sleep = 0.3
  55         self.post_test_sleep = 0.2
  56
  57         self.create_loopback_interfaces(2)
  58         self.uri = "quic://%s/1234" % self.loop0.local_ip4
  59         table_id = 1
  60         for i in self.lo_interfaces:
  61             i.admin_up()
  62
  63             if table_id != 0:
  64                 tbl = VppIpTable(self, table_id)
  65                 tbl.add_vpp_config()
  66
  67             i.set_table_ip4(table_id)
  68             i.config_ip4()
  69             table_id += 1
  70
  71         # Configure namespaces
  72         self.vapi.app_namespace_add_del(namespace_id=b"server",
  73                                         sw_if_index=self.loop0.sw_if_index)
  74         self.vapi.app_namespace_add_del(namespace_id=b"client",
  75                                         sw_if_index=self.loop1.sw_if_index)
  76
  77         # Add inter-table routes
  78         self.ip_t01 = VppIpRoute(self, self.loop1.local_ip4, 32,
  79                                  [VppRoutePath("0.0.0.0",
  80                                                0xffffffff,
  81                                                nh_table_id=2)], table_id=1)
  82         self.ip_t10 = VppIpRoute(self, self.loop0.local_ip4, 32,
  83                                  [VppRoutePath("0.0.0.0",
  84                                                0xffffffff,
  85                                                nh_table_id=1)], table_id=2)
  86         self.ip_t01.add_vpp_config()
  87         self.ip_t10.add_vpp_config()
  88         self.logger.debug(self.vapi.cli("show ip fib"))
  89
  90     def tearDown(self):
  91         self.vapi.session_enable_disable(is_enabled=0)
  92         # Delete inter-table routes
  93         self.ip_t01.remove_vpp_config()
  94         self.ip_t10.remove_vpp_config()
  95
  96         for i in self.lo_interfaces:
  97             i.unconfig_ip4()
  98             i.set_table_ip4(0)
  99             i.admin_down()
 100         super(QUICTestCase, self).tearDown()
 101
 102
 103 class QUICEchoInternalTestCase(QUICTestCase):
 104     """QUIC Echo Internal Test Case"""
 105
 106     def setUp(self):
 107         super(QUICEchoInternalTestCase, self).setUp()
 108         self.client_args = "uri %s fifo-size 64 test-bytes appns client" \
 109             % self.uri
 110         self.server_args = "uri %s fifo-size 64 appns server" % self.uri
 111
 112     def server(self, *args):
 113         error = self.vapi.cli(
 114             "test echo server %s %s" %
 115             (self.server_args, ' '.join(args)))
 116         if error:
 117             self.logger.critical(error)
 118             self.assertNotIn("failed", error)
 119
 120     def client(self, *args):
 121         error = self.vapi.cli(
 122             "test echo client %s %s" %
 123             (self.client_args, ' '.join(args)))
 124         if error:
 125             self.logger.critical(error)
 126             self.assertNotIn("failed", error)
 127
 128
 129 class QUICEchoInternalTransferTestCase(QUICEchoInternalTestCase):
 130     """QUIC Echo Internal Transfer Test Case"""
 131     def test_quic_internal_transfer(self):
 132         self.server()
 133         self.client("no-output", "mbytes", "2")
 134
 135
 136 class QUICEchoInternalSerialTestCase(QUICEchoInternalTestCase):
 137     """QUIC Echo Internal Serial Transfer Test Case"""
 138     def test_quic_serial_internal_transfer(self):
 139         self.server()
 140         self.client("no-output", "mbytes", "2")
 141         self.client("no-output", "mbytes", "2")
 142         self.client("no-output", "mbytes", "2")
 143         self.client("no-output", "mbytes", "2")
 144         self.client("no-output", "mbytes", "2")
 145
 146
 147 class QUICEchoInternalMStreamTestCase(QUICEchoInternalTestCase):
 148     """QUIC Echo Internal MultiStream Test Case"""
 149     def test_quic_internal_multistream_transfer(self):
 150         self.server()
 151         self.client("nclients", "10", "mbytes", "1", "no-output")
 152
 153
 154 class QUICEchoExternalTestCase(QUICTestCase):
 155     extra_vpp_punt_config = ["session", "{", "evt_qs_memfd_seg", "}"]
 156     quic_setup = "default"
 157
 158     def setUp(self):
 159         super(QUICEchoExternalTestCase, self).setUp()
 160         common_args = [
 161             "uri",
 162             self.uri,
 163             "fifo-size",
 164             "64",
 165             "test-bytes:assert",
 166             "socket-name",
 167             self.api_sock]
 168         self.server_echo_test_args = common_args + \
 169             ["server", "appns", "server", "quic-setup", self.quic_setup]
 170         self.client_echo_test_args = common_args + \
 171             ["client", "appns", "client", "quic-setup", self.quic_setup]
 172
 173     def server(self, *args):
 174         _args = self.server_echo_test_args + list(args)
 175         self.worker_server = QUICAppWorker(
 176             self.build_dir,
 177             "vpp_echo",
 178             _args,
 179             self.logger)
 180         self.worker_server.start()
 181         self.sleep(self.pre_test_sleep)
 182
 183     def client(self, *args):
 184         _args = self.client_echo_test_args + list(args)
 185         # self.client_echo_test_args += "use-svm-api"
 186         self.worker_client = QUICAppWorker(
 187             self.build_dir,
 188             "vpp_echo",
 189             _args,
 190             self.logger)
 191         self.worker_client.start()
 192         self.worker_client.join(self.timeout)
 193         self.worker_server.join(self.timeout)
 194         self.sleep(self.post_test_sleep)
 195
 196     def validate_external_test_results(self):
 197         self.logger.info(
 198             "Client worker result is `%s'" %
 199             self.worker_client.result)
 200         server_result = self.worker_server.result
 201         client_result = self.worker_client.result
 202         server_kill_error = False
 203         if self.worker_server.result is None:
 204             server_kill_error = self.worker_server.teardown(
 205                 self.logger, self.timeout)
 206         if self.worker_client.result is None:
 207             self.worker_client.teardown(self.logger, self.timeout)
 208         self.assertEqual(server_result, 0, "Wrong server worker return code")
 209         self.assertIsNotNone(
 210             client_result,
 211             "Timeout! Client worker did not finish in %ss" %
 212             self.timeout)
 213         self.assertEqual(client_result, 0, "Wrong client worker return code")
 214         self.assertFalse(server_kill_error, "Server kill errored")
 215
 216
 217 class QUICEchoExternalTransferTestCase(QUICEchoExternalTestCase):
 218     """QUIC Echo External Transfer Test Case"""
 219     def test_quic_external_transfer(self):
 220         self.server()
 221         self.client()
 222         self.validate_external_test_results()
 223
 224
 225 class QUICEchoExternalServerStreamTestCase(QUICEchoExternalTestCase):
 226     """QUIC Echo External Transfer Server Stream Test Case"""
 227     quic_setup = "serverstream"
 228
 229     def test_quic_external_transfer_server_stream(self):
 230         self.server("TX=1Kb", "RX=0")
 231         self.client("TX=0", "RX=1Kb")
 232         self.validate_external_test_results()
 233
 234
 235 class QUICEchoExternalServerStreamWorkersTestCase(QUICEchoExternalTestCase):
 236     """QUIC Echo External Transfer Server Stream MultiWorker Test Case"""
 237     quic_setup = "serverstream"
 238
 239     @unittest.skipUnless(running_extended_tests, "part of extended tests")
 240     def test_quic_external_transfer_server_stream_multi_workers(self):
 241         self.server("nclients", "4/4", "TX=1Kb", "RX=0")
 242         self.client("nclients", "4/4", "TX=0", "RX=1Kb")
 243         self.validate_external_test_results()
 244
 245
 246 if __name__ == '__main__':
 247     unittest.main(testRunner=VppTestRunner)