36fed881e33416466f410dc1896f0fa6d9a7f64a
[samba.git] / source3 / python / examples / tdbpack / test_tdbpack.py
1 #! /usr/bin/env python2.2
2
3 __doc__ = """test case for samba.tdbkpack functions
4
5 tdbpack provides a means of pickling values into binary formats
6 compatible with that used by the samba tdbpack()/tdbunpack()
7 functions.
8
9 Numbers are always stored in little-endian format; strings are stored
10 in either DOS or Unix codepage as appropriate.
11
12 The format for any particular element is encoded as a short ASCII
13 string, with one character per field."""
14
15 # Copyright (C) 2002 Hewlett-Packard.
16
17 __author__ = 'Martin Pool <mbp@sourcefrog.net>'
18
19 import unittest
20 # import tdbutil
21 import samba.tdbpack
22
23 packer = samba.tdbpack.pack
24 unpacker = samba.tdbpack.unpack
25
26
27 class PackTests(unittest.TestCase):
28     symm_cases = [('B', ['hello' * 51], '\xff\0\0\0' + 'hello' * 51),
29              ('w', [42], '\x2a\0'),
30              ('www', [42, 2, 69], '\x2a\0\x02\0\x45\0'),
31              ('wd', [42, 256], '\x2a\0\0\x01\0\0'),
32              ('w', [0], '\0\0'),
33              ('w', [255], '\xff\0'),
34              ('w', [256], '\0\x01'),
35              ('w', [0xdead], '\xad\xde'),
36              ('w', [0xffff], '\xff\xff'),
37              ('p', [0], '\0\0\0\0'),
38              ('p', [1], '\x01\0\0\0'),
39              ('d', [0x01020304], '\x04\x03\x02\x01'),
40              ('d', [0x7fffffff], '\xff\xff\xff\x7f'),
41              ('d', [0x80000000], '\x00\x00\x00\x80'),
42              ('d', [-1], '\xff\xff\xff\xff'),
43              ('d', [-255], '\x01\xff\xff\xff'),
44              ('d', [-256], '\x00\xff\xff\xff'),
45              ('ddd', [1, 10, 50], '\x01\0\0\0\x0a\0\0\0\x32\0\0\0'),
46              ('ff', ['hello', 'world'], 'hello\0world\0'),
47              ('fP', ['hello', 'world'], 'hello\0world\0'),
48              ('PP', ['hello', 'world'], 'hello\0world\0'),
49              ('B', [''], '\0\0\0\0'),
50              ('B', ['hello'], '\x05\0\0\0hello'),
51              ('BB', ['hello\0world', 'now'],
52               '\x0b\0\0\0hello\0world\x03\0\0\0now'),
53              ('pd', [1, 10], '\x01\0\0\0\x0a\0\0\0'),
54              ('BBB', ['hello', '', 'world'],
55               '\x05\0\0\0hello\0\0\0\0\x05\0\0\0world'),
56
57              # strings are sequences in Python, there's no getting away
58              # from it
59              ('ffff', 'evil', 'e\0v\0i\0l\0'),
60              ('BBBB', 'evil',                   
61               '\x01\0\0\0e'
62               '\x01\0\0\0v'
63               '\x01\0\0\0i'
64               '\x01\0\0\0l'),
65
66              ('', [], ''),
67
68              # exercise some long strings
69              ('PP', ['hello' * 255, 'world' * 255],
70               'hello' * 255 + '\0' + 'world' * 255 + '\0'),
71              ('PP', ['hello' * 40000, 'world' * 50000],
72               'hello' * 40000 + '\0' + 'world' * 50000 + '\0'),
73              ('B', ['hello' * 51], '\xff\0\0\0' + 'hello' * 51),
74              ('BB', ['hello' * 40000, 'world' * 50000],
75               '\x40\x0d\x03\0' + 'hello' * 40000 + '\x90\xd0\x03\x00' + 'world' * 50000),
76              ]
77
78     def test_symmetric(self):
79         """Cookbook of symmetric pack/unpack tests
80         """
81         for format, values, expected in self.symm_cases:
82             self.assertEquals(packer(format, values), expected)
83             out, rest = unpacker(format, expected)
84             self.assertEquals(rest, '')
85             self.assertEquals(list(values), list(out))
86         
87     
88     def test_pack(self):
89         """Cookbook of expected pack values
90
91         These can't be used for the symmetric test because the unpacked value is
92         not "canonical".
93         """
94         cases = [('w', (42,), '\x2a\0'),
95                  ('p', [None], '\0\0\0\0'),
96                  ('p', ['true'], '\x01\0\0\0'),
97
98                  ('w', {1: 'fruit'}, '\x01\0'),
99                  # passing a dictionary is dodgy, but it gets coerced to keys
100                  # as if you called list()
101                  ]
102
103         for format, values, expected in cases:
104             self.assertEquals(packer(format, values), expected)
105
106     def test_unpack_extra(self):
107         # Test leftover data
108         for format, values, packed in self.symm_cases:
109             out, rest = unpacker(format, packed + 'hello sailor!')
110             self.assertEquals(rest, 'hello sailor!')
111             self.assertEquals(list(values), list(out))
112         
113
114     def test_unpack(self):
115         """Cookbook of tricky unpack tests"""
116         cases = [
117                  ]
118         for format, values, expected in cases:
119             out, rest = unpacker(format, expected)
120             self.assertEquals(rest, '')
121             self.assertEquals(list(values), list(out))
122
123
124     def test_pack_failures(self):
125         """Expected errors for incorrect packing"""
126         cases = [('w', [], IndexError),
127                  ('w', (), IndexError),
128                  ('w', {}, IndexError),
129                  ('ww', [2], IndexError),
130                  ('w', 2, TypeError),
131                  ('', [1, 2, 3], IndexError),
132                  ('w', None, TypeError),
133                  ('wwwwwwwwwwww', [], IndexError),
134                  ('w', [2, 3], IndexError),
135                  ('w', [0x60A15EC5L], TypeError),
136                  ('w', [None], TypeError),
137                  ('w', xrange(10000), IndexError),
138                  ('d', [], IndexError),
139                  ('d', [0L], TypeError),
140                  ('p', [], IndexError),
141                  ('f', [2], TypeError),
142                  ('P', [None], TypeError),
143                  ('P', (), IndexError),
144                  ('f', [packer], TypeError),
145                  ('fw', ['hello'], IndexError),
146                  ('f', [u'hello'], TypeError),
147                  ('B', [2], TypeError),
148                  (None, [2, 3, 4], TypeError),
149                  (ord('f'), [20], TypeError),
150                  (['w', 'w'], [2, 2], TypeError),
151                  ('Q', [2], ValueError),
152                  ('fQ', ['2', 3], ValueError),
153                  ('fQ', ['2'], IndexError),
154                  (2, [2], TypeError),
155                  ({}, {}, TypeError)]
156         for format, values, throwable_class in cases:
157             def do_pack():
158                 packer(format, values)
159             self.assertRaises(throwable_class, do_pack)
160
161
162     def test_unpack_failures(self):
163         """Expected errors for incorrect unpacking"""
164         cases = [('$', '', ValueError),
165                  ('Q', '', ValueError),
166                  ('Q$', '', ValueError),
167                  ('f', '', IndexError),
168                  ('d', '', IndexError),
169                  ('d', '2', IndexError),
170                  ('d', '22', IndexError),
171                  ('d', '222', IndexError),
172                  ('w', '', IndexError),
173                  ('w', '2', IndexError),
174                  ('f', 'hello', IndexError),
175                  ('f', '', IndexError),
176                  ('p', '\x01\0', IndexError),
177                  ('B', '\xff\0\0\0hello', IndexError),
178                  ('B', '\xff\0', IndexError),
179                  ('B', '\x01\0\0\0', IndexError),
180                  ('B', '\x05\0\0\0hell', IndexError),
181                  ('B', '\xff\xff\xff\xff', ValueError),
182                  ('B', 'foobar', IndexError),
183                  ('BB', '\x01\0\0\0a\x01', IndexError),
184                  ]
185         
186         for format, values, throwable_class in cases:
187             def do_unpack():
188                 unpacker(format, values)
189             self.assertRaises(throwable_class, do_unpack)
190
191         
192
193 if __name__ == '__main__':
194     unittest.main()
195