tests: move test source to vpp/test

- Generate copyright year and version
  instead of using hard-coded data

Type: refactor

Signed-off-by: Dave Wallace <dwallacelf@gmail.com>
Change-Id: I6058f5025323b3aa483f5df4a2c4371e27b5914e

1 files changed, 554 insertions, 0 deletions

diff --git a/test/test_quic.py b/test/test_quic.py
new file mode 100644
index 00000000000..1257f4e2b0a
--- /dev/null
+++ b/test/test_quic.py
@@ -0,0 +1,554 @@
+#!/usr/bin/env python3
+""" Vpp QUIC tests """
+
+import unittest
+import os
+import subprocess
+import signal
+from framework import tag_fixme_vpp_workers
+from framework import VppTestCase, VppTestRunner, running_extended_tests, \
+    Worker
+from vpp_ip_route import VppIpTable, VppIpRoute, VppRoutePath
+
+
+class QUICAppWorker(Worker):
+    """ QUIC Test Application Worker """
+    process = None
+
+    def __init__(self, build_dir, appname, executable_args, logger, role,
+                 testcase, env=None, *args, **kwargs):
+        if env is None:
+            env = {}
+        app = "%s/vpp/bin/%s" % (build_dir, appname)
+        self.args = [app] + executable_args
+        self.role = role
+        self.wait_for_gdb = 'wait-for-gdb'
+        self.testcase = testcase
+        super(QUICAppWorker, self).__init__(self.args, logger, env,
+                                            *args, **kwargs)
+
+    def run(self):
+        super(QUICAppWorker, self).run()
+
+    def teardown(self, logger, timeout):
+        if self.process is None:
+            return False
+        try:
+            logger.debug("Killing worker process (pid %d)" % self.process.pid)
+            os.killpg(os.getpgid(self.process.pid), signal.SIGKILL)
+            self.join(timeout)
+        except OSError as e:
+            logger.debug("Couldn't kill worker process")
+            return True
+        return False
+
+
+class QUICTestCase(VppTestCase):
+    """ QUIC Test Case """
+
+    timeout = 20
+    pre_test_sleep = 0.3
+    post_test_sleep = 0.3
+
+    @classmethod
+    def setUpClass(cls):
+        cls.extra_vpp_plugin_config.append("plugin quic_plugin.so { enable }")
+        super(QUICTestCase, cls).setUpClass()
+
+    def setUp(self):
+        super(QUICTestCase, self).setUp()
+        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)
+        self.vppDebug = 'vpp_debug' in self.build_dir
+
+        self.create_loopback_interfaces(2)
+        self.uri = "quic://%s/1234" % self.loop0.local_ip4
+        table_id = 1
+        for i in self.lo_interfaces:
+            i.admin_up()
+
+            if table_id != 0:
+                tbl = VppIpTable(self, table_id)
+                tbl.add_vpp_config()
+
+            i.set_table_ip4(table_id)
+            i.config_ip4()
+            table_id += 1
+
+        # Configure namespaces
+        self.vapi.app_namespace_add_del(namespace_id="server",
+                                        sw_if_index=self.loop0.sw_if_index)
+        self.vapi.app_namespace_add_del(namespace_id="client",
+                                        sw_if_index=self.loop1.sw_if_index)
+
+        # Add inter-table routes
+        self.ip_t01 = VppIpRoute(self, self.loop1.local_ip4, 32,
+                                 [VppRoutePath("0.0.0.0",
+                                               0xffffffff,
+                                               nh_table_id=2)], table_id=1)
+        self.ip_t10 = VppIpRoute(self, self.loop0.local_ip4, 32,
+                                 [VppRoutePath("0.0.0.0",
+                                               0xffffffff,
+                                               nh_table_id=1)], table_id=2)
+        self.ip_t01.add_vpp_config()
+        self.ip_t10.add_vpp_config()
+        self.logger.debug(self.vapi.cli("show ip fib"))
+
+    def tearDown(self):
+        # Delete inter-table routes
+        self.ip_t01.remove_vpp_config()
+        self.ip_t10.remove_vpp_config()
+
+        for i in self.lo_interfaces:
+            i.unconfig_ip4()
+            i.set_table_ip4(0)
+            i.admin_down()
+        super(QUICTestCase, self).tearDown()
+
+
+class QUICEchoIntTestCase(QUICTestCase):
+    """QUIC Echo Internal Test Case"""
+    test_bytes = ' test-bytes'
+    extra_vpp_punt_config = ["session", "{", "enable", "poll-main", "}"]
+
+    def setUp(self):
+        super(QUICEchoIntTestCase, self).setUp()
+        self.client_args = 'uri {uri} fifo-size 64{testbytes} appns client' \
+            .format(uri=self.uri, testbytes=self.test_bytes)
+        self.server_args = "uri %s fifo-size 64 appns server" % self.uri
+
+    def tearDown(self):
+        super(QUICEchoIntTestCase, self).tearDown()
+
+    def server(self, *args):
+        error = self.vapi.cli(
+            "test echo server %s %s" %
+            (self.server_args, ' '.join(args)))
+        if error:
+            self.logger.critical(error)
+            self.assertNotIn("failed", error)
+
+    def client(self, *args):
+        error = self.vapi.cli(
+            "test echo client %s %s" %
+            (self.client_args, ' '.join(args)))
+        if error:
+            self.logger.critical(error)
+            self.assertNotIn("failed", error)
+
+
+@tag_fixme_vpp_workers
+class QUICEchoIntTransferTestCase(QUICEchoIntTestCase):
+    """QUIC Echo Internal Transfer Test Case"""
+    def test_quic_int_transfer(self):
+        """QUIC internal transfer"""
+        self.server()
+        self.client("no-output", "mbytes", "2")
+
+
+@tag_fixme_vpp_workers
+class QUICEchoIntSerialTestCase(QUICEchoIntTestCase):
+    """QUIC Echo Internal Serial Transfer Test Case"""
+    def test_quic_serial_int_transfer(self):
+        """QUIC serial internal transfer"""
+        self.server()
+        self.client("no-output", "mbytes", "2")
+        self.client("no-output", "mbytes", "2")
+        self.client("no-output", "mbytes", "2")
+        self.client("no-output", "mbytes", "2")
+        self.client("no-output", "mbytes", "2")
+
+
+@tag_fixme_vpp_workers
+class QUICEchoIntMStreamTestCase(QUICEchoIntTestCase):
+    """QUIC Echo Internal MultiStream Test Case"""
+    def test_quic_int_multistream_transfer(self):
+        """QUIC internal multi-stream transfer"""
+        self.server()
+        self.client("nclients", "10", "mbytes", "1", "no-output")
+
+
+class QUICEchoExtTestCase(QUICTestCase):
+    quic_setup = "default"
+    test_bytes = "test-bytes:assert"
+    pre_test_sleep = 1
+    post_test_sleep = 1
+    app = "vpp_echo"
+    evt_q_len = 16384
+    vpp_worker_count = 1
+    server_fifo_size = "1M"
+    client_fifo_size = "4M"
+    extra_vpp_punt_config = ["session", "{",
+                             "enable", "poll-main", "evt_qs_memfd_seg",
+                             "evt_qs_seg_size", "64M",
+                             "event-queue-length", f"{evt_q_len}",
+                             "preallocated-sessions", "1024",
+                             "v4-session-table-buckets", "20000",
+                             "v4-session-table-memory", "64M",
+                             "v4-halfopen-table-buckets", "20000",
+                             "v4-halfopen-table-memory", "64M",
+                             "local-endpoints-table-buckets", "250000",
+                             "local-endpoints-table-memory", "512M",
+                             "}"]
+
+    def setUp(self):
+        super(QUICEchoExtTestCase, self).setUp()
+        common_args = [
+            "uri", self.uri,
+            "json",
+            self.test_bytes,
+            "socket-name", self.get_api_sock_path(),
+            "quic-setup", self.quic_setup,
+            "nthreads", "1",
+            "mq-size", f"{self.evt_q_len}"
+        ]
+        self.server_echo_test_args = common_args + \
+            ["server", "appns", "server", "fifo-size",
+             f"{self.server_fifo_size}"]
+        self.client_echo_test_args = common_args + \
+            ["client", "appns", "client", "fifo-size",
+             f"{self.client_fifo_size}"]
+        error = self.vapi.cli("quic set fifo-size 2M")
+        if error:
+            self.logger.critical(error)
+            self.assertNotIn("failed", error)
+
+    def server(self, *args):
+        _args = self.server_echo_test_args + list(args)
+        self.worker_server = QUICAppWorker(
+            self.build_dir,
+            self.app,
+            _args,
+            self.logger,
+            'server',
+            self)
+        self.worker_server.start()
+        self.sleep(self.pre_test_sleep)
+
+    def client(self, *args):
+        _args = self.client_echo_test_args + list(args)
+        self.worker_client = QUICAppWorker(
+            self.build_dir,
+            self.app,
+            _args,
+            self.logger,
+            'client',
+            self)
+        self.worker_client.start()
+        timeout = None if self.debug_all else self.timeout
+        self.worker_client.join(timeout)
+        if self.worker_client.is_alive():
+            error = f"Client failed to complete in {timeout} seconds!"
+            self.logger.critical(error)
+            return
+        self.worker_server.join(timeout)
+        if self.worker_server.is_alive():
+            error = f"Server failed to complete in {timeout} seconds!"
+            self.logger.critical(error)
+        self.sleep(self.post_test_sleep)
+
+    def validate_ext_test_results(self):
+        server_result = self.worker_server.result
+        client_result = self.worker_client.result
+        self.logger.info("Server worker result is `%s'" %
+                         server_result)
+        self.logger.info("Client worker result is `%s'" %
+                         client_result)
+        server_kill_error = False
+        if self.worker_server.result is None:
+            server_kill_error = self.worker_server.teardown(
+                self.logger, self.timeout)
+        if self.worker_client.result is None:
+            self.worker_client.teardown(self.logger, self.timeout)
+        err_msg = "Wrong server worker return code (%s)" % server_result
+        self.assertEqual(server_result, 0, err_msg)
+        self.assertIsNotNone(
+            client_result,
+            "Timeout! Client worker did not finish in %ss" %
+            self.timeout)
+        err_msg = "Wrong client worker return code (%s)" % client_result
+        self.assertEqual(client_result, 0, err_msg)
+        self.assertFalse(server_kill_error, "Server kill errored")
+
+
+class QUICEchoExtTransferTestCase(QUICEchoExtTestCase):
+    """QUIC Echo External Transfer Test Case"""
+    timeout = 60
+
+    def test_quic_ext_transfer(self):
+        """QUIC external transfer"""
+        self.server()
+        self.client()
+        self.validate_ext_test_results()
+
+
+class QUICEchoExtTransferBigTestCase(QUICEchoExtTestCase):
+    """QUIC Echo External Transfer Big Test Case"""
+    server_fifo_size = '4M'
+    client_fifo_size = '4M'
+    test_bytes = ''
+    timeout = 60
+
+    @unittest.skipUnless(running_extended_tests, "part of extended tests")
+    def test_quic_ext_transfer_big(self):
+        """QUIC external transfer, big stream"""
+        self.server("TX=0", "RX=2G")
+        self.client("TX=2G", "RX=0")
+        self.validate_ext_test_results()
+
+
+class QUICEchoExtQcloseRxTestCase(QUICEchoExtTestCase):
+    """QUIC Echo External Transfer Qclose Rx Test Case"""
+
+    @unittest.skipUnless(running_extended_tests, "part of extended tests")
+    @unittest.skip("testcase under development")
+    def test_quic_ext_qclose_rx(self):
+        """QUIC external transfer, rx close"""
+        self.server("TX=0", "RX=10M", "qclose=Y", "sclose=N")
+        self.client("TX=10M", "RX=0", "qclose=W", "sclose=W")
+        self.validate_ext_test_results()
+
+
+class QUICEchoExtQcloseTxTestCase(QUICEchoExtTestCase):
+    """QUIC Echo External Transfer Qclose Tx Test Case"""
+
+    @unittest.skipUnless(running_extended_tests, "part of extended tests")
+    @unittest.skip("testcase under development")
+    def test_quic_ext_qclose_tx(self):
+        """QUIC external transfer, tx close"""
+        self.server("TX=0", "RX=10M", "qclose=W", "sclose=W",
+                    "rx-results-diff")
+        self.client("TX=10M", "RX=0", "qclose=Y", "sclose=N")
+        self.validate_ext_test_results()
+
+
+class QUICEchoExtEarlyQcloseRxTestCase(QUICEchoExtTestCase):
+    """QUIC Echo External Transfer Early Qclose Rx Test Case"""
+
+    @unittest.skipUnless(running_extended_tests, "part of extended tests")
+    @unittest.skip("testcase under development")
+    def test_quic_ext_early_qclose_rx(self):
+        """QUIC external transfer, early rx close"""
+        self.server("TX=0", "RX=10M", "qclose=Y", "sclose=N")
+        self.client("TX=20M", "RX=0", "qclose=W", "sclose=W",
+                    "tx-results-diff")
+        self.validate_ext_test_results()
+
+
+class QUICEchoExtEarlyQcloseTxTestCase(QUICEchoExtTestCase):
+    """QUIC Echo External Transfer Early Qclose Tx Test Case"""
+
+    @unittest.skipUnless(running_extended_tests, "part of extended tests")
+    @unittest.skip("testcase under development")
+    def test_quic_ext_early_qclose_tx(self):
+        """QUIC external transfer, early tx close"""
+        self.server("TX=0", "RX=20M", "qclose=W", "sclose=W",
+                    "rx-results-diff")
+        self.client("TX=10M", "RX=0", "qclose=Y", "sclose=N")
+        self.validate_ext_test_results()
+
+
+class QUICEchoExtScloseRxTestCase(QUICEchoExtTestCase):
+    """QUIC Echo External Transfer Sclose Rx Test Case"""
+
+    @unittest.skipUnless(running_extended_tests, "part of extended tests")
+    @unittest.skip("testcase under development")
+    def test_quic_ext_sclose_rx(self):
+        """QUIC external transfer, rx stream close"""
+        self.server("TX=0", "RX=10M", "qclose=N", "sclose=Y")
+        self.client("TX=10M", "RX=0", "qclose=W", "sclose=W")
+        self.validate_ext_test_results()
+
+
+class QUICEchoExtScloseTxTestCase(QUICEchoExtTestCase):
+    """QUIC Echo External Transfer Sclose Tx Test Case"""
+
+    @unittest.skipUnless(running_extended_tests, "part of extended tests")
+    @unittest.skip("testcase under development")
+    def test_quic_ext_sclose_tx(self):
+        """QUIC external transfer, tx stream close"""
+        self.server("TX=0", "RX=10M", "qclose=W", "sclose=W")
+        self.client("TX=10M", "RX=0", "qclose=Y", "sclose=Y")
+        self.validate_ext_test_results()
+
+
+class QUICEchoExtEarlyScloseRxTestCase(QUICEchoExtTestCase):
+    """QUIC Echo External Transfer Early Sclose Rx Test Case"""
+
+    @unittest.skipUnless(running_extended_tests, "part of extended tests")
+    @unittest.skip("testcase under development")
+    def test_quic_ext_early_sclose_rx(self):
+        """QUIC external transfer, early rx stream close"""
+        self.server("TX=0", "RX=10M", "qclose=N", "sclose=Y")
+        self.client("TX=20M", "RX=0", "qclose=W", "sclose=W",
+                    "tx-results-diff")
+        self.validate_ext_test_results()
+
+
+class QUICEchoExtEarlyScloseTxTestCase(QUICEchoExtTestCase):
+    """QUIC Echo External Transfer Early Sclose Tx Test Case"""
+
+    @unittest.skipUnless(running_extended_tests, "part of extended tests")
+    @unittest.skip("testcase under development")
+    def test_quic_ext_early_sclose_tx(self):
+        """QUIC external transfer, early tx stream close"""
+        self.server("TX=0", "RX=20M", "qclose=W", "sclose=W",
+                    "rx-results-diff")
+        self.client("TX=10M", "RX=0", "qclose=Y", "sclose=Y")
+        self.validate_ext_test_results()
+
+
+class QUICEchoExtServerStreamTestCase(QUICEchoExtTestCase):
+    """QUIC Echo External Transfer Server Stream Test Case"""
+    quic_setup = "serverstream"
+    timeout = 60
+
+    def test_quic_ext_transfer_server_stream(self):
+        """QUIC external server transfer"""
+        self.server("TX=10M", "RX=0")
+        self.client("TX=0", "RX=10M")
+        self.validate_ext_test_results()
+
+
+class QUICEchoExtServerStreamBigTestCase(QUICEchoExtTestCase):
+    """QUIC Echo External Transfer Server Stream Big Test Case"""
+    quic_setup = "serverstream"
+    server_fifo_size = '4M'
+    client_fifo_size = '4M'
+    test_bytes = ''
+    timeout = 60
+
+    @unittest.skipUnless(running_extended_tests, "part of extended tests")
+    def test_quic_ext_transfer_server_stream_big(self):
+        """QUIC external server transfer, big stream"""
+        self.server("TX=2G", "RX=0")
+        self.client("TX=0", "RX=2G")
+        self.validate_ext_test_results()
+
+
+class QUICEchoExtServerStreamQcloseRxTestCase(QUICEchoExtTestCase):
+    """QUIC Echo External Transfer Server Stream Qclose Rx Test Case"""
+    quic_setup = "serverstream"
+
+    @unittest.skipUnless(running_extended_tests, "part of extended tests")
+    @unittest.skip("testcase under development")
+    def test_quic_ext_server_stream_qclose_rx(self):
+        """QUIC external server transfer, rx close"""
+        self.server("TX=10M", "RX=0", "qclose=W", "sclose=W")
+        self.client("TX=0", "RX=10M", "qclose=Y", "sclose=N")
+        self.validate_ext_test_results()
+
+
+class QUICEchoExtServerStreamQcloseTxTestCase(QUICEchoExtTestCase):
+    """QUIC Echo External Transfer Server Stream Qclose Tx Test Case"""
+    quic_setup = "serverstream"
+
+    @unittest.skipUnless(running_extended_tests, "part of extended tests")
+    @unittest.skip("testcase under development")
+    def test_quic_ext_server_stream_qclose_tx(self):
+        """QUIC external server transfer, tx close"""
+        self.server("TX=10M", "RX=0", "qclose=Y", "sclose=N")
+        self.client("TX=0", "RX=10M", "qclose=W", "sclose=W",
+                    "rx-results-diff")
+        self.validate_ext_test_results()
+
+
+class QUICEchoExtServerStreamEarlyQcloseRxTestCase(QUICEchoExtTestCase):
+    """QUIC Echo External Transfer Server Stream Early Qclose Rx Test Case"""
+    quic_setup = "serverstream"
+
+    @unittest.skipUnless(running_extended_tests, "part of extended tests")
+    @unittest.skip("testcase under development")
+    def test_quic_ext_server_stream_early_qclose_rx(self):
+        """QUIC external server transfer, early rx close"""
+        self.server("TX=20M", "RX=0", "qclose=W", "sclose=W",
+                    "tx-results-diff")
+        self.client("TX=0", "RX=10M", "qclose=Y", "sclose=N")
+        self.validate_ext_test_results()
+
+
+class QUICEchoExtServerStreamEarlyQcloseTxTestCase(QUICEchoExtTestCase):
+    """QUIC Echo External Transfer Server Stream Early Qclose Tx Test Case"""
+    quic_setup = "serverstream"
+
+    @unittest.skipUnless(running_extended_tests, "part of extended tests")
+    @unittest.skip("testcase under development")
+    def test_quic_ext_server_stream_early_qclose_tx(self):
+        """QUIC external server transfer, early tx close"""
+        self.server("TX=10M", "RX=0", "qclose=Y", "sclose=N")
+        self.client("TX=0", "RX=20M", "qclose=W", "sclose=W",
+                    "rx-results-diff")
+        self.validate_ext_test_results()
+
+
+class QUICEchoExtServerStreamScloseRxTestCase(QUICEchoExtTestCase):
+    """QUIC Echo External Transfer Server Stream Sclose Rx Test Case"""
+    quic_setup = "serverstream"
+
+    @unittest.skipUnless(running_extended_tests, "part of extended tests")
+    @unittest.skip("testcase under development")
+    def test_quic_ext_server_stream_sclose_rx(self):
+        """QUIC external server transfer, rx stream close"""
+        self.server("TX=10M", "RX=0", "qclose=W", "sclose=W")
+        self.client("TX=0", "RX=10M", "qclose=N", "sclose=Y")
+        self.validate_ext_test_results()
+
+
+class QUICEchoExtServerStreamScloseTxTestCase(QUICEchoExtTestCase):
+    """QUIC Echo External Transfer Server Stream Sclose Tx Test Case"""
+    quic_setup = "serverstream"
+
+    @unittest.skipUnless(running_extended_tests, "part of extended tests")
+    @unittest.skip("testcase under development")
+    def test_quic_ext_server_stream_sclose_tx(self):
+        """QUIC external server transfer, tx stream close"""
+        self.server("TX=10M", "RX=0", "qclose=Y", "sclose=Y")
+        self.client("TX=0", "RX=10M", "qclose=W", "sclose=W")
+        self.validate_ext_test_results()
+
+
+class QUICEchoExtServerStreamEarlyScloseRxTestCase(QUICEchoExtTestCase):
+    """QUIC Echo External Transfer Server Stream Early Sclose Rx Test Case"""
+    quic_setup = "serverstream"
+
+    @unittest.skipUnless(running_extended_tests, "part of extended tests")
+    @unittest.skip("testcase under development")
+    def test_quic_ext_server_stream_early_sclose_rx(self):
+        """QUIC external server transfer, early rx stream close"""
+        self.server("TX=20M", "RX=0", "qclose=W", "sclose=W",
+                    "tx-results-diff")
+        self.client("TX=0", "RX=10M", "qclose=N", "sclose=Y")
+        self.validate_ext_test_results()
+
+
+class QUICEchoExtServerStreamEarlyScloseTxTestCase(QUICEchoExtTestCase):
+    """QUIC Echo Ext Transfer Server Stream Early Sclose Tx Test Case"""
+    quic_setup = "serverstream"
+
+    @unittest.skipUnless(running_extended_tests, "part of extended tests")
+    @unittest.skip("testcase under development")
+    def test_quic_ext_server_stream_early_sclose_tx(self):
+        """QUIC external server transfer, early tx stream close"""
+        self.server("TX=10M", "RX=0", "qclose=Y", "sclose=Y")
+        self.client("TX=0", "RX=20M", "qclose=W", "sclose=W",
+                    "rx-results-diff")
+        self.validate_ext_test_results()
+
+
+class QUICEchoExtServerStreamWorkersTestCase(QUICEchoExtTestCase):
+    """QUIC Echo External Transfer Server Stream MultiWorker Test Case"""
+    quic_setup = "serverstream"
+
+    @unittest.skipUnless(running_extended_tests, "part of extended tests")
+    @unittest.skip("testcase under development")
+    def test_quic_ext_transfer_server_stream_multi_workers(self):
+        """QUIC external server transfer, multi-worker"""
+        self.server("nclients", "4", "quic-streams", "4", "TX=10M", "RX=0")
+        self.client("nclients", "4", "quic-streams", "4", "TX=0", "RX=10M")
+        self.validate_ext_test_results()
+
+
+if __name__ == '__main__':
+    unittest.main(testRunner=VppTestRunner)