src/plugins/memif/test/test_memif.py

   1 import socket
   2 import unittest
   3
   4 from scapy.layers.l2 import Ether
   5 from scapy.layers.inet import IP, ICMP
   6 import six
   7
   8 from framework import VppTestCase, VppTestRunner, running_extended_tests
   9 from remote_test import RemoteClass, RemoteVppTestCase
  10 from vpp_memif import remove_all_memif_vpp_config, \
  11     VppSocketFilename, VppMemif
  12 from vpp_ip_route import VppIpRoute, VppRoutePath
  13 from vpp_papi import VppEnum
  14
  15
  16 class TestMemif(VppTestCase):
  17     """ Memif Test Case """
  18
  19     @classmethod
  20     def setUpClass(cls):
  21         # fork new process before client connects to VPP
  22         cls.remote_test = RemoteClass(RemoteVppTestCase)
  23         cls.remote_test.start_remote()
  24         cls.remote_test.set_request_timeout(10)
  25         super(TestMemif, cls).setUpClass()
  26         cls.remote_test.setUpClass(cls.tempdir)
  27         cls.create_pg_interfaces(range(1))
  28         for pg in cls.pg_interfaces:
  29             pg.config_ip4()
  30             pg.admin_up()
  31             pg.resolve_arp()
  32
  33     @classmethod
  34     def tearDownClass(cls):
  35         cls.remote_test.tearDownClass()
  36         cls.remote_test.quit_remote()
  37         for pg in cls.pg_interfaces:
  38             pg.unconfig_ip4()
  39             pg.set_table_ip4(0)
  40             pg.admin_down()
  41         super(TestMemif, cls).tearDownClass()
  42
  43     def tearDown(self):
  44         remove_all_memif_vpp_config(self)
  45         remove_all_memif_vpp_config(self.remote_test)
  46         super(TestMemif, self).tearDown()
  47
  48     def _check_socket_filename(self, dump, socket_id, filename):
  49         for d in dump:
  50             if (d.socket_id == socket_id) and (
  51                     d.socket_filename.rstrip(b"\0") == filename):
  52                 return True
  53         return False
  54
  55     def test_memif_socket_filename_add_del(self):
  56         """ Memif socket filename add/del """
  57
  58         # dump default socket filename
  59         dump = self.vapi.memif_socket_filename_dump()
  60         self.assertTrue(
  61             self._check_socket_filename(
  62                 dump, 0, b"%s/memif.sock" % six.ensure_binary(
  63                     self.tempdir, encoding='utf-8')))
  64
  65         memif_sockets = []
  66         # existing path
  67         memif_sockets.append(
  68             VppSocketFilename(
  69                 self, 1, b"%s/memif1.sock" % six.ensure_binary(
  70                     self.tempdir, encoding='utf-8')))
  71         # default path (test tempdir)
  72         memif_sockets.append(
  73             VppSocketFilename(
  74                 self,
  75                 2,
  76                 b"memif2.sock",
  77                 add_default_folder=True))
  78         # create new folder in default folder
  79         memif_sockets.append(
  80             VppSocketFilename(
  81                 self,
  82                 3,
  83                 b"sock/memif3.sock",
  84                 add_default_folder=True))
  85
  86         for sock in memif_sockets:
  87             sock.add_vpp_config()
  88             dump = sock.query_vpp_config()
  89             self.assertTrue(
  90                 self._check_socket_filename(
  91                     dump,
  92                     sock.socket_id,
  93                     sock.socket_filename))
  94
  95         for sock in memif_sockets:
  96             sock.remove_vpp_config()
  97
  98         dump = self.vapi.memif_socket_filename_dump()
  99         self.assertTrue(
 100             self._check_socket_filename(
 101                 dump, 0, b"%s/memif.sock" % six.ensure_binary(
 102                     self.tempdir, encoding='utf-8')))
 103
 104     def _create_delete_test_one_interface(self, memif):
 105         memif.add_vpp_config()
 106
 107         dump = memif.query_vpp_config()
 108
 109         self.assertTrue(dump)
 110         self.assertEqual(dump.sw_if_index, memif.sw_if_index)
 111         self.assertEqual(dump.role, memif.role)
 112         self.assertEqual(dump.mode, memif.mode)
 113         if (memif.socket_id is not None):
 114             self.assertEqual(dump.socket_id, memif.socket_id)
 115
 116         memif.remove_vpp_config()
 117
 118         dump = memif.query_vpp_config()
 119
 120         self.assertFalse(dump)
 121
 122     def _connect_test_one_interface(self, memif):
 123         self.assertTrue(memif.wait_for_link_up(5))
 124         dump = memif.query_vpp_config()
 125
 126         if memif.role == VppEnum.vl_api_memif_role_t.MEMIF_ROLE_API_SLAVE:
 127             self.assertEqual(dump.ring_size, memif.ring_size)
 128             self.assertEqual(dump.buffer_size, memif.buffer_size)
 129         else:
 130             self.assertEqual(dump.ring_size, 1)
 131             self.assertEqual(dump.buffer_size, 0)
 132
 133     def _connect_test_interface_pair(self, memif0, memif1):
 134         memif0.add_vpp_config()
 135         memif1.add_vpp_config()
 136
 137         memif0.admin_up()
 138         memif1.admin_up()
 139
 140         self._connect_test_one_interface(memif0)
 141         self._connect_test_one_interface(memif1)
 142
 143         memif0.remove_vpp_config()
 144         memif1.remove_vpp_config()
 145
 146     def test_memif_create_delete(self):
 147         """ Memif create/delete interface """
 148
 149         memif = VppMemif(
 150             self,
 151             VppEnum.vl_api_memif_role_t.MEMIF_ROLE_API_SLAVE,
 152             VppEnum.vl_api_memif_mode_t.MEMIF_MODE_API_ETHERNET)
 153         self._create_delete_test_one_interface(memif)
 154         memif.role = VppEnum.vl_api_memif_role_t.MEMIF_ROLE_API_MASTER
 155         self._create_delete_test_one_interface(memif)
 156
 157     def test_memif_create_custom_socket(self):
 158         """ Memif create with non-default socket filename """
 159
 160         memif_sockets = []
 161         # existing path
 162         memif_sockets.append(
 163             VppSocketFilename(
 164                 self, 1, b"%s/memif1.sock" % six.ensure_binary(
 165                     self.tempdir, encoding='utf-8')))
 166         # default path (test tempdir)
 167         memif_sockets.append(
 168             VppSocketFilename(
 169                 self,
 170                 2,
 171                 b"memif2.sock",
 172                 add_default_folder=True))
 173         # create new folder in default folder
 174         memif_sockets.append(
 175             VppSocketFilename(
 176                 self,
 177                 3,
 178                 b"sock/memif3.sock",
 179                 add_default_folder=True))
 180
 181         memif = VppMemif(
 182             self,
 183             VppEnum.vl_api_memif_role_t.MEMIF_ROLE_API_SLAVE,
 184             VppEnum.vl_api_memif_mode_t.MEMIF_MODE_API_ETHERNET)
 185
 186         for sock in memif_sockets:
 187             sock.add_vpp_config()
 188             memif.socket_id = sock.socket_id
 189             memif.role = VppEnum.vl_api_memif_role_t.MEMIF_ROLE_API_SLAVE
 190             self._create_delete_test_one_interface(memif)
 191             memif.role = VppEnum.vl_api_memif_role_t.MEMIF_ROLE_API_MASTER
 192             self._create_delete_test_one_interface(memif)
 193
 194     def test_memif_connect(self):
 195         """ Memif connect """
 196         memif = VppMemif(
 197             self,
 198             VppEnum.vl_api_memif_role_t.MEMIF_ROLE_API_SLAVE,
 199             VppEnum.vl_api_memif_mode_t.MEMIF_MODE_API_ETHERNET,
 200             ring_size=1024,
 201             buffer_size=2048,
 202             secret="abc")
 203
 204         remote_socket = VppSocketFilename(self.remote_test, 1,
 205                                           b"%s/memif.sock" % six.ensure_binary(
 206                                               self.tempdir, encoding='utf-8'))
 207         remote_socket.add_vpp_config()
 208
 209         remote_memif = VppMemif(
 210             self.remote_test,
 211             VppEnum.vl_api_memif_role_t.MEMIF_ROLE_API_MASTER,
 212             VppEnum.vl_api_memif_mode_t.MEMIF_MODE_API_ETHERNET,
 213             socket_id=1,
 214             ring_size=1024,
 215             buffer_size=2048,
 216             secret="abc")
 217
 218         self._connect_test_interface_pair(memif, remote_memif)
 219
 220         memif.role = VppEnum.vl_api_memif_role_t.MEMIF_ROLE_API_MASTER
 221         remote_memif.role = VppEnum.vl_api_memif_role_t.MEMIF_ROLE_API_SLAVE
 222
 223         self._connect_test_interface_pair(memif, remote_memif)
 224
 225     def _create_icmp(self, pg, memif, num):
 226         pkts = []
 227         for i in range(num):
 228             pkt = (Ether(dst=pg.local_mac, src=pg.remote_mac) /
 229                    IP(src=pg.remote_ip4, dst=memif.ip_prefix.address) /
 230                    ICMP(id=memif.if_id, type='echo-request', seq=i))
 231             pkts.append(pkt)
 232         return pkts
 233
 234     def _verify_icmp(self, pg, memif, rx, seq):
 235         ip = rx[IP]
 236         self.assertEqual(ip.src, memif.ip_prefix.address)
 237         self.assertEqual(ip.dst, pg.remote_ip4)
 238         self.assertEqual(ip.proto, 1)
 239         icmp = rx[ICMP]
 240         self.assertEqual(icmp.type, 0)  # echo-reply
 241         self.assertEqual(icmp.id, memif.if_id)
 242         self.assertEqual(icmp.seq, seq)
 243
 244     def test_memif_ping(self):
 245         """ Memif ping """
 246
 247         memif = VppMemif(
 248             self,
 249             VppEnum.vl_api_memif_role_t.MEMIF_ROLE_API_SLAVE,
 250             VppEnum.vl_api_memif_mode_t.MEMIF_MODE_API_ETHERNET)
 251
 252         remote_socket = VppSocketFilename(self.remote_test, 1,
 253                                           b"%s/memif.sock" % six.ensure_binary(
 254                                               self.tempdir, encoding='utf-8'))
 255         remote_socket.add_vpp_config()
 256
 257         remote_memif = VppMemif(
 258             self.remote_test,
 259             VppEnum.vl_api_memif_role_t.MEMIF_ROLE_API_MASTER,
 260             VppEnum.vl_api_memif_mode_t.MEMIF_MODE_API_ETHERNET,
 261             socket_id=1)
 262
 263         memif.add_vpp_config()
 264         memif.config_ip4()
 265         memif.admin_up()
 266
 267         remote_memif.add_vpp_config()
 268         remote_memif.config_ip4()
 269         remote_memif.admin_up()
 270
 271         self.assertTrue(memif.wait_for_link_up(5))
 272         self.assertTrue(remote_memif.wait_for_link_up(5))
 273
 274         # add routing to remote vpp
 275         route = VppIpRoute(self.remote_test, self.pg0._local_ip4_subnet, 24,
 276                            [VppRoutePath(memif.ip_prefix.address, 0xffffffff)],
 277                            register=False)
 278
 279         route.add_vpp_config()
 280
 281         # create ICMP echo-request from local pg to remote memif
 282         packet_num = 10
 283         pkts = self._create_icmp(self.pg0, remote_memif, packet_num)
 284
 285         self.pg0.add_stream(pkts)
 286         self.pg_enable_capture(self.pg_interfaces)
 287         self.pg_start()
 288         capture = self.pg0.get_capture(packet_num, timeout=2)
 289         seq = 0
 290         for c in capture:
 291             self._verify_icmp(self.pg0, remote_memif, c, seq)
 292             seq += 1
 293
 294         route.remove_vpp_config()
 295
 296
 297 if __name__ == '__main__':
 298     unittest.main(testRunner=VppTestRunner)