src/vpp-api/python/tests/test_vpp_serializer.py

   1 #!/usr/bin/env python
   2
   3 import unittest
   4 from vpp_papi.vpp_serializer import VPPType, VPPEnumType
   5 from vpp_papi.vpp_serializer import VPPUnionType, VPPMessage
   6 from socket import inet_pton, AF_INET, AF_INET6
   7 import logging
   8 import sys
   9
  10
  11 class TestAddType(unittest.TestCase):
  12
  13     def test_union(self):
  14         un = VPPUnionType('test_union',
  15                           [['u8', 'is_bool'],
  16                            ['u32', 'is_int']])
  17
  18         b = un.pack({'is_int': 0x12345678})
  19         self.assertEqual(len(b), 4)
  20         nt = un.unpack(b)
  21         self.assertEqual(nt.is_bool, 0x12)
  22         self.assertEqual(nt.is_int, 0x12345678)
  23
  24     def test_address(self):
  25         af = VPPEnumType('vl_api_address_family_t', [["ADDRESS_IP4", 0],
  26                                                      ["ADDRESS_IP6", 1],
  27                                                      {"enumtype": "u32"}])
  28         ip4 = VPPType('vl_api_ip4_address_t', [['u8', 'address', 4]])
  29         ip6 = VPPType('vl_api_ip6_address_t', [['u8', 'address', 16]])
  30         VPPUnionType('vl_api_address_union_t',
  31                      [["vl_api_ip4_address_t", "ip4"],
  32                       ["vl_api_ip6_address_t", "ip6"]])
  33
  34         address = VPPType('address', [['vl_api_address_family_t', 'af'],
  35                                       ['vl_api_address_union_t', 'un']])
  36
  37         b = ip4.pack({'address': inet_pton(AF_INET, '1.1.1.1')})
  38         self.assertEqual(len(b), 4)
  39         nt = ip4.unpack(b)
  40         self.assertEqual(nt.address, inet_pton(AF_INET, '1.1.1.1'))
  41
  42         b = ip6.pack({'address': inet_pton(AF_INET6, '1::1')})
  43         self.assertEqual(len(b), 16)
  44
  45         b = address.pack({'af': af.ADDRESS_IP4,
  46                           'un':
  47                           {'ip4':
  48                            {'address': inet_pton(AF_INET, '2.2.2.2')}}})
  49         self.assertEqual(len(b), 20)
  50
  51         nt = address.unpack(b)
  52         self.assertEqual(nt.af, af.ADDRESS_IP4)
  53         self.assertEqual(nt.un.ip4.address,
  54                          inet_pton(AF_INET, '2.2.2.2'))
  55         self.assertEqual(nt.un.ip6.address,
  56                          inet_pton(AF_INET6, '0202:0202::'))
  57
  58     def test_arrays(self):
  59         # Test cases
  60         # 1. Fixed list
  61         # 2. Fixed list of variable length sub type
  62         # 3. Variable length type
  63         #
  64         ip4 = VPPType('ip4_address', [['u8', 'address', 4]])
  65         listip4 = VPPType('list_ip4_t', [['ip4_address', 'addresses', 4]])
  66         valistip4 = VPPType('list_ip4_t',
  67                             [['u8', 'count'],
  68                              ['ip4_address', 'addresses', 0, 'count']])
  69
  70         valistip4_legacy = VPPType('list_ip4_t',
  71                                    [['u8', 'foo'],
  72                                     ['ip4_address', 'addresses', 0]])
  73
  74         addresses = []
  75         for i in range(4):
  76             addresses.append({'address': inet_pton(AF_INET, '2.2.2.2')})
  77         b = listip4.pack({'addresses': addresses})
  78         self.assertEqual(len(b), 16)
  79         nt = listip4.unpack(b)
  80
  81         self.assertEqual(nt.addresses[0].address,
  82                          inet_pton(AF_INET, '2.2.2.2'))
  83
  84         b = valistip4.pack({'count': len(addresses), 'addresses': addresses})
  85         self.assertEqual(len(b), 17)
  86
  87         nt = valistip4.unpack(b)
  88         self.assertEqual(nt.count, 4)
  89         self.assertEqual(nt.addresses[0].address,
  90                          inet_pton(AF_INET, '2.2.2.2'))
  91
  92         b = valistip4_legacy.pack({'foo': 1, 'addresses': addresses})
  93         self.assertEqual(len(b), 17)
  94         nt = valistip4_legacy.unpack(b)
  95         self.assertEqual(len(nt.addresses), 4)
  96         self.assertEqual(nt.addresses[0].address,
  97                          inet_pton(AF_INET, '2.2.2.2'))
  98
  99     def test_message(self):
 100         foo = VPPMessage('foo', [['u16', '_vl_msg_id'],
 101                                  ['u8', 'client_index'],
 102                                  ['u8', 'something'],
 103                                  {"crc": "0x559b9f3c"}])
 104         b = foo.pack({'_vl_msg_id': 1, 'client_index': 5,
 105                       'something': 200})
 106         self.assertEqual(len(b), 4)
 107         nt = foo.unpack(b)
 108         self.assertEqual(nt.something, 200)
 109
 110     def test_abf(self):
 111
 112         fib_mpls_label = VPPType('vl_api_fib_mpls_label_t',
 113                                  [['u8', 'is_uniform'],
 114                                   ['u32', 'label'],
 115                                   ['u8', 'ttl'],
 116                                   ['u8', 'exp']])
 117
 118         label_stack = {'is_uniform': 0,
 119                        'label': 0,
 120                        'ttl': 0,
 121                        'exp': 0}
 122
 123         b = fib_mpls_label.pack(label_stack)
 124         self.assertEqual(len(b), 7)
 125
 126         fib_path = VPPType('vl_api_fib_path_t',
 127                            [['u32', 'sw_if_index'],
 128                             ['u32', 'table_id'],
 129                             ['u8', 'weight'],
 130                             ['u8', 'preference'],
 131                             ['u8', 'is_local'],
 132                             ['u8', 'is_drop'],
 133                             ['u8', 'is_udp_encap'],
 134                             ['u8', 'is_unreach'],
 135                             ['u8', 'is_prohibit'],
 136                             ['u8', 'is_resolve_host'],
 137                             ['u8', 'is_resolve_attached'],
 138                             ['u8', 'is_dvr'],
 139                             ['u8', 'is_source_lookup'],
 140                             ['u8', 'afi'],
 141                             ['u8', 'next_hop', 16],
 142                             ['u32', 'next_hop_id'],
 143                             ['u32', 'rpf_id'],
 144                             ['u32', 'via_label'],
 145                             ['u8', 'n_labels'],
 146                             ['vl_api_fib_mpls_label_t', 'label_stack', 16]])
 147         label_stack_list = []
 148         for i in range(16):
 149             label_stack_list.append(label_stack)
 150
 151         paths = {'is_udp_encap': 0,
 152                  'next_hop': b'\x10\x02\x02\xac',
 153                  'table_id': 0,
 154                  'afi': 0,
 155                  'weight': 1,
 156                  'next_hop_id': 4294967295,
 157                  'label_stack': label_stack_list,
 158                  'n_labels': 0,
 159                  'sw_if_index': 4294967295,
 160                  'preference': 0}
 161
 162         b = fib_path.pack(paths)
 163         self.assertEqual(len(b), (7*16) + 49)
 164
 165         abf_policy = VPPType('vl_api_abf_policy_t',
 166                              [['u32', 'policy_id'],
 167                               ['u32', 'acl_index'],
 168                               ['u8', 'n_paths'],
 169                               ['vl_api_fib_path_t', 'paths', 0, 'n_paths']])
 170
 171         policy = {
 172             'n_paths': 1,
 173             'paths': [paths],
 174             'acl_index': 0,
 175             'policy_id': 10}
 176
 177         b = abf_policy.pack(policy)
 178         self.assertEqual(len(b), (7*16) + 49 + 9)
 179
 180         abf_policy_add_del = VPPMessage('abf_policy_add_del',
 181                                         [['u16', '_vl_msg_id'],
 182                                          ['u32', 'client_index'],
 183                                          ['u32', 'context'],
 184                                          ['u8', 'is_add'],
 185                                          ['vl_api_abf_policy_t', 'policy']])
 186
 187         b = abf_policy_add_del.pack({'is_add': 1,
 188                                      'context': 66,
 189                                      '_vl_msg_id': 1066,
 190                                      'policy': policy})
 191
 192         nt = abf_policy_add_del.unpack(b)
 193         self.assertEqual(nt.policy.paths[0].next_hop,
 194                          b'\x10\x02\x02\xac\x00\x00\x00\x00'
 195                          b'\x00\x00\x00\x00\x00\x00\x00\x00')
 196
 197     def test_bier(self):
 198
 199         bier_table_id = VPPType('vl_api_bier_table_id_t',
 200                                 [['u8', 'bt_set'],
 201                                  ['u8', 'bt_sub_domain'],
 202                                  ['u8', 'bt_hdr_len_id']])
 203
 204         bier_imp_add = VPPMessage('bier_imp_add',
 205                                   [['u32', 'client_index'],
 206                                    ['u32', 'context'],
 207                                    ['vl_api_bier_table_id_t', 'bi_tbl_id'],
 208                                    ['u16', 'bi_src'],
 209                                    ['u8', 'bi_n_bytes'],
 210                                    ['u8', 'bi_bytes', 0, 'bi_n_bytes']])
 211
 212         table_id = {'bt_set': 0,
 213                     'bt_sub_domain': 0,
 214                     'bt_hdr_len_id': 0}
 215
 216         bibytes = b'foobar'
 217
 218         b = bier_imp_add.pack({'bi_tbl_id': table_id,
 219                                'bi_n_bytes': len(bibytes),
 220                                'bi_bytes': bibytes})
 221
 222         self.assertEqual(len(b), 20)
 223
 224
 225 if __name__ == '__main__':
 226     unittest.main()