From e5ff5a36dd126ee57dca4e0b03da2f7704e0a4f5 Mon Sep 17 00:00:00 2001
From: Ole Troan <ot@cisco.com>
Date: Fri, 23 Aug 2019 22:55:18 +0200
Subject: api: enforce vla is last and fixed string type

Enforce that variable length fields are the last element of API messages.

Add a 'fixed' version of string type, since dealing with
multiple variable length strings turned out too painful
for the C language bindings.

The string type is now:
{
  string name[64]; // NUL terminated C-string. Essentially decays to u8 name[64]
  string name[];   // Variable length string with embedded len field (vl_api_string_t)
};

The latter notation could be made available to other types as well.
e.g.
{
  vl_api_address_t addresses[];
}
instead of

{
  u32 n_addr;
  vl_api_address_t addresses[n_addr];
};

Type: fix
Change-Id: I18fa17ef47227633752ab50453e8d20a652a9f9b
Signed-off-by: Ole Troan <ot@cisco.com>
---
 .../python/vpp_papi/tests/test_vpp_serializer.py   | 40 ++++++++++++++++++++--
 1 file changed, 38 insertions(+), 2 deletions(-)

(limited to 'src/vpp-api/python/vpp_papi/tests/test_vpp_serializer.py')

diff --git a/src/vpp-api/python/vpp_papi/tests/test_vpp_serializer.py b/src/vpp-api/python/vpp_papi/tests/test_vpp_serializer.py
index bddaa9e00c2..6ca8e6c4ff3 100755
--- a/src/vpp-api/python/vpp_papi/tests/test_vpp_serializer.py
+++ b/src/vpp-api/python/vpp_papi/tests/test_vpp_serializer.py
@@ -11,11 +11,47 @@ from ipaddress import *
 
 
 class TestLimits(unittest.TestCase):
+    def test_string(self):
+        fixed_string = VPPType('fixed_string',
+                               [['string', 'name', 16]])
+
+        b = fixed_string.pack({'name': 'foobar'})
+        self.assertEqual(len(b), 16)
+
+        # Ensure string is nul terminated
+        self.assertEqual(b.decode('ascii')[6], '\x00')
+
+        nt, size = fixed_string.unpack(b)
+        self.assertEqual(size, 16)
+        self.assertEqual(nt.name, 'foobar')
+
+        # Empty string
+        b = fixed_string.pack({'name': ''})
+        self.assertEqual(len(b), 16)
+        nt, size = fixed_string.unpack(b)
+        self.assertEqual(size, 16)
+        self.assertEqual(nt.name, '')
+
+        # String too long
+        with self.assertRaises(VPPSerializerValueError):
+            b = fixed_string.pack({'name': 'foobarfoobar1234'})
+
+        variable_string = VPPType('variable_string',
+                                  [['string', 'name', 0]])
+        b = variable_string.pack({'name': 'foobar'})
+        self.assertEqual(len(b), 4 + len('foobar'))
+
+        nt, size = variable_string.unpack(b)
+        self.assertEqual(size, 4 + len('foobar'))
+        self.assertEqual(nt.name, 'foobar')
+        self.assertEqual(len(nt.name), len('foobar'))
+
+
     def test_limit(self):
         limited_type = VPPType('limited_type_t',
-                               [['string', 'name', {'limit': 16}]])
+                               [['string', 'name', 0, {'limit': 16}]])
         unlimited_type = VPPType('limited_type_t',
-                                 [['string', 'name']])
+                                 [['string', 'name', 0]])
 
         b = limited_type.pack({'name': 'foobar'})
         self.assertEqual(len(b), 10)
-- 
cgit 1.2.3-korg