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 QUICEchoIntTestCase(QUICTestCase):
 104     """QUIC Echo Internal Test Case"""
 105
 106     def setUp(self):
 107         super(QUICEchoIntTestCase, 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 QUICEchoIntTransferTestCase(QUICEchoIntTestCase):
 130     """QUIC Echo Internal Transfer Test Case"""
 131     def test_quic_int_transfer(self):
 132         self.server()
 133         self.client("no-output", "mbytes", "2")
 134
 135
 136 class QUICEchoIntSerialTestCase(QUICEchoIntTestCase):
 137     """QUIC Echo Internal Serial Transfer Test Case"""
 138     def test_quic_serial_int_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 QUICEchoIntMStreamTestCase(QUICEchoIntTestCase):
 148     """QUIC Echo Internal MultiStream Test Case"""
 149     def test_quic_int_multistream_transfer(self):
 150         self.server()
 151         self.client("nclients", "10", "mbytes", "1", "no-output")
 152
 153
 154 class QUICEchoExtTestCase(QUICTestCase):
 155     extra_vpp_punt_config = ["session", "{", "evt_qs_memfd_seg", "}"]
 156     quic_setup = "default"
 157
 158     def setUp(self):
 159         super(QUICEchoExtTestCase, self).setUp()
 160         common_args = [
 161             "uri",
 162             self.uri,
 163             "json",
 164             "fifo-size",
 165             "64",
 166             "test-bytes:assert",
 167             "socket-name",
 168             self.api_sock]
 169         self.server_echo_test_args = common_args + \
 170             ["server", "appns", "server", "quic-setup", self.quic_setup]
 171         self.client_echo_test_args = common_args + \
 172             ["client", "appns", "client", "quic-setup", self.quic_setup]
 173
 174     def server(self, *args):
 175         _args = self.server_echo_test_args + list(args)
 176         self.worker_server = QUICAppWorker(
 177             self.build_dir,
 178             "vpp_echo",
 179             _args,
 180             self.logger)
 181         self.worker_server.start()
 182         self.sleep(self.pre_test_sleep)
 183
 184     def client(self, *args):
 185         _args = self.client_echo_test_args + list(args)
 186         # self.client_echo_test_args += "use-svm-api"
 187         self.worker_client = QUICAppWorker(
 188             self.build_dir,
 189             "vpp_echo",
 190             _args,
 191             self.logger)
 192         self.worker_client.start()
 193         self.worker_client.join(self.timeout)
 194         self.worker_server.join(self.timeout)
 195         self.sleep(self.post_test_sleep)
 196
 197     def validate_ext_test_results(self):
 198         server_result = self.worker_server.result
 199         client_result = self.worker_client.result
 200         self.logger.info("Server worker result is `%s'" %
 201                          server_result)
 202         self.logger.info("Client worker result is `%s'" %
 203                          client_result)
 204         server_kill_error = False
 205         if self.worker_server.result is None:
 206             server_kill_error = self.worker_server.teardown(
 207                 self.logger, self.timeout)
 208         if self.worker_client.result is None:
 209             self.worker_client.teardown(self.logger, self.timeout)
 210         err_msg = "Wrong server worker return code (%s)" % server_result
 211         self.assertEqual(server_result, 0, err_msg)
 212         self.assertIsNotNone(
 213             client_result,
 214             "Timeout! Client worker did not finish in %ss" %
 215             self.timeout)
 216         err_msg = "Wrong client worker return code (%s)" % client_result
 217         self.assertEqual(client_result, 0, err_msg)
 218         self.assertFalse(server_kill_error, "Server kill errored")
 219
 220
 221 class QUICEchoExtTransferTestCase(QUICEchoExtTestCase):
 222     """QUIC Echo External Transfer Test Case"""
 223     def test_quic_ext_transfer(self):
 224         self.server()
 225         self.client()
 226         self.validate_ext_test_results()
 227
 228
 229 class QUICEchoExtQcloseRxTestCase(QUICEchoExtTestCase):
 230     """QUIC Echo External Transfer Qclose Rx Test Case"""
 231
 232     @unittest.skipUnless(running_extended_tests, "part of extended tests")
 233     def test_quic_ext_qclose_rx(self):
 234         self.server("TX=0", "RX=1Kb", "qclose=Y", "sclose=N")
 235         self.client("TX=1Kb", "RX=0", "qclose=W", "sclose=W")
 236         self.validate_ext_test_results()
 237
 238
 239 class QUICEchoExtQcloseTxTestCase(QUICEchoExtTestCase):
 240     """QUIC Echo External Transfer Qclose Tx Test Case"""
 241
 242     @unittest.skipUnless(running_extended_tests, "part of extended tests")
 243     def test_quic_ext_qclose_tx(self):
 244         self.server("TX=0", "RX=1Kb", "qclose=W", "sclose=W")
 245         self.client("TX=1Kb", "RX=0", "qclose=Y", "sclose=N")
 246         self.validate_ext_test_results()
 247
 248
 249 class QUICEchoExtEarlyQcloseRxTestCase(QUICEchoExtTestCase):
 250     """QUIC Echo External Transfer Early Qclose Rx Test Case"""
 251
 252     @unittest.skipUnless(running_extended_tests, "part of extended tests")
 253     def test_quic_ext_early_qclose_rx(self):
 254         self.server("TX=0", "RX=1Kb", "qclose=Y", "sclose=N")
 255         self.client("TX=2Kb", "RX=0", "qclose=W", "sclose=W")
 256         self.validate_ext_test_results()
 257
 258
 259 class QUICEchoExtEarlyQcloseTxTestCase(QUICEchoExtTestCase):
 260     """QUIC Echo External Transfer Early Qclose Tx Test Case"""
 261
 262     @unittest.skipUnless(running_extended_tests, "part of extended tests")
 263     def test_quic_ext_early_qclose_tx(self):
 264         self.server("TX=0", "RX=2Kb", "qclose=W", "sclose=W")
 265         self.client("TX=1Kb", "RX=0", "qclose=Y", "sclose=N")
 266         self.validate_ext_test_results()
 267
 268
 269 class QUICEchoExtScloseRxTestCase(QUICEchoExtTestCase):
 270     """QUIC Echo External Transfer Sclose Rx Test Case"""
 271
 272     @unittest.skipUnless(running_extended_tests, "part of extended tests")
 273     def test_quic_ext_sclose_rx(self):
 274         self.server("TX=0", "RX=1Kb", "qclose=N", "sclose=Y")
 275         self.client("TX=1Kb", "RX=0", "qclose=W", "sclose=W")
 276         self.validate_ext_test_results()
 277
 278
 279 class QUICEchoExtScloseTxTestCase(QUICEchoExtTestCase):
 280     """QUIC Echo External Transfer Sclose Tx Test Case"""
 281
 282     @unittest.skipUnless(running_extended_tests, "part of extended tests")
 283     def test_quic_ext_sclose_tx(self):
 284         self.server("TX=0", "RX=1Kb", "qclose=W", "sclose=W")
 285         self.client("TX=1Kb", "RX=0", "qclose=N", "sclose=Y")
 286         self.validate_ext_test_results()
 287
 288
 289 class QUICEchoExtEarlyScloseRxTestCase(QUICEchoExtTestCase):
 290     """QUIC Echo External Transfer Early Sclose Rx Test Case"""
 291
 292     @unittest.skipUnless(running_extended_tests, "part of extended tests")
 293     def test_quic_ext_early_sclose_rx(self):
 294         self.server("TX=0", "RX=1Kb", "qclose=N", "sclose=Y")
 295         self.client("TX=2Kb", "RX=0", "qclose=W", "sclose=W")
 296         self.validate_ext_test_results()
 297
 298
 299 class QUICEchoExtEarlyScloseTxTestCase(QUICEchoExtTestCase):
 300     """QUIC Echo External Transfer Early Sclose RTx Test Case"""
 301
 302     @unittest.skipUnless(running_extended_tests, "part of extended tests")
 303     def test_quic_ext_early_sclose_tx(self):
 304         self.server("TX=0", "RX=2Kb", "qclose=W", "sclose=W")
 305         self.client("TX=1Kb", "RX=0", "qclose=N", "sclose=Y")
 306         self.validate_ext_test_results()
 307
 308
 309 class QUICEchoExtServerStreamTestCase(QUICEchoExtTestCase):
 310     """QUIC Echo External Transfer Server Stream Test Case"""
 311     quic_setup = "serverstream"
 312
 313     def test_quic_ext_transfer_server_stream(self):
 314         self.server("TX=1Kb", "RX=0")
 315         self.client("TX=0", "RX=1Kb")
 316         self.validate_ext_test_results()
 317
 318
 319 class QUICEchoExtServerStreamQcloseRxTestCase(QUICEchoExtTestCase):
 320     """QUIC Echo External Transfer Server Stream Qclose Rx Test Case"""
 321     quic_setup = "serverstream"
 322
 323     @unittest.skipUnless(running_extended_tests, "part of extended tests")
 324     def test_quic_ext_server_stream_qclose_rx(self):
 325         self.server("TX=1Kb", "RX=0", "qclose=W", "sclose=W")
 326         self.client("TX=0", "RX=1Kb", "qclose=Y", "sclose=N")
 327         self.validate_ext_test_results()
 328
 329
 330 class QUICEchoExtServerStreamQcloseTxTestCase(QUICEchoExtTestCase):
 331     """QUIC Echo External Transfer Server Stream Qclose Tx Test Case"""
 332     quic_setup = "serverstream"
 333
 334     @unittest.skipUnless(running_extended_tests, "part of extended tests")
 335     def test_quic_ext_server_stream_qclose_tx(self):
 336         self.server("TX=1Kb", "RX=0", "qclose=Y", "sclose=N")
 337         self.client("TX=0", "RX=1Kb", "qclose=W", "sclose=W")
 338         self.validate_ext_test_results()
 339
 340
 341 class QUICEchoExtServerStreamEarlyQcloseRxTestCase(QUICEchoExtTestCase):
 342     """QUIC Echo External Transfer Server Stream Early Qclose Rx Test Case"""
 343     quic_setup = "serverstream"
 344
 345     @unittest.skipUnless(running_extended_tests, "part of extended tests")
 346     def test_quic_ext_server_stream_early_qclose_rx(self):
 347         self.server("TX=2Kb", "RX=0", "qclose=W", "sclose=W")
 348         self.client("TX=0", "RX=1Kb", "qclose=Y", "sclose=N")
 349         self.validate_ext_test_results()
 350
 351
 352 class QUICEchoExtServerStreamEarlyQcloseTxTestCase(QUICEchoExtTestCase):
 353     """QUIC Echo External Transfer Server Stream Early Qclose Tx Test Case"""
 354     quic_setup = "serverstream"
 355
 356     @unittest.skipUnless(running_extended_tests, "part of extended tests")
 357     def test_quic_ext_server_stream_early_qclose_tx(self):
 358         self.server("TX=1Kb", "RX=0", "qclose=Y", "sclose=N")
 359         self.client("TX=0", "RX=2Kb", "qclose=W", "sclose=W")
 360         self.validate_ext_test_results()
 361
 362
 363 class QUICEchoExtServerStreamScloseRxTestCase(QUICEchoExtTestCase):
 364     """QUIC Echo External Transfer Server Stream Sclose Rx Test Case"""
 365     quic_setup = "serverstream"
 366
 367     @unittest.skipUnless(running_extended_tests, "part of extended tests")
 368     def test_quic_ext_server_stream_sclose_rx(self):
 369         self.server("TX=1Kb", "RX=0", "qclose=W", "sclose=W")
 370         self.client("TX=0", "RX=1Kb", "qclose=N", "sclose=Y")
 371         self.validate_ext_test_results()
 372
 373
 374 class QUICEchoExtServerStreamScloseTxTestCase(QUICEchoExtTestCase):
 375     """QUIC Echo External Transfer Server Stream Sclose Tx Test Case"""
 376     quic_setup = "serverstream"
 377
 378     @unittest.skipUnless(running_extended_tests, "part of extended tests")
 379     def test_quic_ext_server_stream_sclose_tx(self):
 380         self.server("TX=1Kb", "RX=0", "qclose=N", "sclose=Y")
 381         self.client("TX=0", "RX=1Kb", "qclose=W", "sclose=W")
 382         self.validate_ext_test_results()
 383
 384
 385 class QUICEchoExtServerStreamEarlyScloseRxTestCase(QUICEchoExtTestCase):
 386     """QUIC Echo External Transfer Server Stream Early Sclose Rx Test Case"""
 387     quic_setup = "serverstream"
 388
 389     @unittest.skipUnless(running_extended_tests, "part of extended tests")
 390     def test_quic_ext_server_stream_early_sclose_rx(self):
 391         self.server("TX=2Kb", "RX=0", "qclose=W", "sclose=W")
 392         self.client("TX=0", "RX=1Kb", "qclose=N", "sclose=Y")
 393         self.validate_ext_test_results()
 394
 395
 396 class QUICEchoExtServerStreamEarlyScloseTxTestCase(QUICEchoExtTestCase):
 397     """QUIC Echo Ext Transfer Server Stream Early Sclose Tx Test Case"""
 398     quic_setup = "serverstream"
 399
 400     @unittest.skipUnless(running_extended_tests, "part of extended tests")
 401     def test_quic_ext_server_stream_early_sclose_tx(self):
 402         self.server("TX=1Kb", "RX=0", "qclose=N", "sclose=Y")
 403         self.client("TX=0", "RX=2Kb", "qclose=W", "sclose=W")
 404         self.validate_ext_test_results()
 405
 406
 407 class QUICEchoExtServerStreamWorkersTestCase(QUICEchoExtTestCase):
 408     """QUIC Echo External Transfer Server Stream MultiWorker Test Case"""
 409     quic_setup = "serverstream"
 410
 411     @unittest.skipUnless(running_extended_tests, "part of extended tests")
 412     def test_quic_ext_transfer_server_stream_multi_workers(self):
 413         self.server("nclients", "4/4", "TX=1Kb", "RX=0")
 414         self.client("nclients", "4/4", "TX=0", "RX=1Kb")
 415         self.validate_ext_test_results()
 416
 417
 418 if __name__ == '__main__':
 419     unittest.main(testRunner=VppTestRunner)