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     def test_quic_internal_transfer(self):
 128         self.server()
 129         self.client("no-output", "mbytes", "2")
 130
 131
 132 class QUICEchoInternalSerialTestCase(QUICEchoInternalTestCase):
 133     """QUIC Echo Internal Serial Transfer Test Case"""
 134     def test_quic_serial_internal_transfer(self):
 135         self.server()
 136         self.client("no-output", "mbytes", "2")
 137         self.client("no-output", "mbytes", "2")
 138         self.client("no-output", "mbytes", "2")
 139         self.client("no-output", "mbytes", "2")
 140         self.client("no-output", "mbytes", "2")
 141
 142
 143 class QUICEchoInternalMStreamTestCase(QUICEchoInternalTestCase):
 144     """QUIC Echo Internal MultiStream Test Case"""
 145     def test_quic_internal_multistream_transfer(self):
 146         self.server()
 147         self.client("nclients", "10", "mbytes", "1", "no-output")
 148
 149
 150 class QUICEchoExternalTestCase(QUICTestCase):
 151     extra_vpp_punt_config = ["session", "{", "evt_qs_memfd_seg", "}"]
 152     quic_setup = "default"
 153
 154     def setUp(self):
 155         super(QUICEchoExternalTestCase, self).setUp()
 156         common_args = [
 157             "uri",
 158             self.uri,
 159             "fifo-size",
 160             "64",
 161             "test-bytes:assert",
 162             "socket-name",
 163             self.api_sock]
 164         self.server_echo_test_args = common_args + \
 165             ["server", "appns", "server", "quic-setup", self.quic_setup]
 166         self.client_echo_test_args = common_args + \
 167             ["client", "appns", "client", "quic-setup", self.quic_setup]
 168
 169     def server(self, *args):
 170         _args = self.server_echo_test_args + list(args)
 171         self.worker_server = QUICAppWorker(
 172             self.build_dir,
 173             "vpp_echo",
 174             _args,
 175             self.logger)
 176         self.worker_server.start()
 177         self.sleep(self.pre_test_sleep)
 178
 179     def client(self, *args):
 180         _args = self.client_echo_test_args + list(args)
 181         # self.client_echo_test_args += "use-svm-api"
 182         self.worker_client = QUICAppWorker(
 183             self.build_dir,
 184             "vpp_echo",
 185             _args,
 186             self.logger)
 187         self.worker_client.start()
 188         self.worker_client.join(self.timeout)
 189         self.worker_server.join(self.timeout)
 190         self.sleep(self.post_test_sleep)
 191
 192     def validate_external_test_results(self):
 193         self.logger.info(
 194             "Client worker result is `%s'" %
 195             self.worker_client.result)
 196         server_result = self.worker_server.result
 197         client_result = self.worker_client.result
 198         server_kill_error = False
 199         if self.worker_server.result is None:
 200             server_kill_error = self.worker_server.teardown(
 201                 self.logger, self.timeout)
 202         if self.worker_client.result is None:
 203             self.worker_client.teardown(self.logger, self.timeout)
 204         self.assertEqual(server_result, 0, "Wrong server worker return code")
 205         self.assertIsNotNone(
 206             client_result,
 207             "Timeout! Client worker did not finish in %ss" %
 208             self.timeout)
 209         self.assertEqual(client_result, 0, "Wrong client worker return code")
 210         self.assertFalse(server_kill_error, "Server kill errored")
 211
 212
 213 class QUICEchoExternalTransferTestCase(QUICEchoExternalTestCase):
 214     """QUIC Echo External Transfer Test Case"""
 215     def test_quic_external_transfer(self):
 216         self.server()
 217         self.client()
 218         self.validate_external_test_results()
 219
 220
 221 class QUICEchoExternalServerStreamTestCase(QUICEchoExternalTestCase):
 222     """QUIC Echo External Transfer Server Stream Test Case"""
 223     quic_setup = "serverstream"
 224
 225     def test_quic_external_transfer_server_stream(self):
 226         self.server("TX=1Kb", "RX=0")
 227         self.client("TX=0", "RX=1Kb")
 228         self.validate_external_test_results()
 229
 230
 231 class QUICEchoExternalServerStreamWorkersTestCase(QUICEchoExternalTestCase):
 232     """QUIC Echo External Transfer Server Stream MultiWorker Test Case"""
 233     quic_setup = "serverstream"
 234
 235     @unittest.skipUnless(running_extended_tests, "part of extended tests")
 236     def test_quic_external_transfer_server_stream_multi_workers(self):
 237         self.server("nclients", "4/4", "TX=1Kb", "RX=0")
 238         self.client("nclients", "4/4", "TX=0", "RX=1Kb")
 239         self.validate_external_test_results()
 240
 241
 242 if __name__ == '__main__':
 243     unittest.main(testRunner=VppTestRunner)