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