blob: 9d0d25b763d2b255b607b1e962edc8a4e381b3f4 [file] [log] [blame]
Tim Peters2adc6262006-06-13 00:30:50 +00001from unittest import TestCase, main
2import uuid
3
4def importable(name):
5 try:
6 __import__(name)
7 return True
8 except:
9 return False
10
11class TestUUID(TestCase):
12 last_node = None
13
14 def test_UUID(self):
15 equal = self.assertEqual
16 ascending = []
17 for (string, curly, hex, bytes, fields, integer, urn,
18 time, clock_seq, variant, version) in [
19 ('00000000-0000-0000-0000-000000000000',
20 '{00000000-0000-0000-0000-000000000000}',
21 '00000000000000000000000000000000',
22 '\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0',
23 (0, 0, 0, 0, 0, 0),
24 0,
25 'urn:uuid:00000000-0000-0000-0000-000000000000',
26 0, 0, uuid.RESERVED_NCS, None),
27 ('00010203-0405-0607-0809-0a0b0c0d0e0f',
28 '{00010203-0405-0607-0809-0a0b0c0d0e0f}',
29 '000102030405060708090a0b0c0d0e0f',
30 '\0\x01\x02\x03\x04\x05\x06\x07\x08\t\n\x0b\x0c\x0d\x0e\x0f',
31 (0x00010203L, 0x0405, 0x0607, 8, 9, 0x0a0b0c0d0e0fL),
32 0x000102030405060708090a0b0c0d0e0fL,
33 'urn:uuid:00010203-0405-0607-0809-0a0b0c0d0e0f',
34 0x607040500010203L, 0x809, uuid.RESERVED_NCS, None),
35 ('02d9e6d5-9467-382e-8f9b-9300a64ac3cd',
36 '{02d9e6d5-9467-382e-8f9b-9300a64ac3cd}',
37 '02d9e6d59467382e8f9b9300a64ac3cd',
38 '\x02\xd9\xe6\xd5\x94\x67\x38\x2e\x8f\x9b\x93\x00\xa6\x4a\xc3\xcd',
39 (0x02d9e6d5L, 0x9467, 0x382e, 0x8f, 0x9b, 0x9300a64ac3cdL),
40 0x02d9e6d59467382e8f9b9300a64ac3cdL,
41 'urn:uuid:02d9e6d5-9467-382e-8f9b-9300a64ac3cd',
42 0x82e946702d9e6d5L, 0xf9b, uuid.RFC_4122, 3),
43 ('12345678-1234-5678-1234-567812345678',
44 '{12345678-1234-5678-1234-567812345678}',
45 '12345678123456781234567812345678',
46 '\x12\x34\x56\x78'*4,
47 (0x12345678, 0x1234, 0x5678, 0x12, 0x34, 0x567812345678),
48 0x12345678123456781234567812345678,
49 'urn:uuid:12345678-1234-5678-1234-567812345678',
50 0x678123412345678L, 0x1234, uuid.RESERVED_NCS, None),
51 ('6ba7b810-9dad-11d1-80b4-00c04fd430c8',
52 '{6ba7b810-9dad-11d1-80b4-00c04fd430c8}',
53 '6ba7b8109dad11d180b400c04fd430c8',
54 '\x6b\xa7\xb8\x10\x9d\xad\x11\xd1\x80\xb4\x00\xc0\x4f\xd4\x30\xc8',
55 (0x6ba7b810L, 0x9dad, 0x11d1, 0x80, 0xb4, 0x00c04fd430c8L),
56 0x6ba7b8109dad11d180b400c04fd430c8L,
57 'urn:uuid:6ba7b810-9dad-11d1-80b4-00c04fd430c8',
58 0x1d19dad6ba7b810L, 0xb4, uuid.RFC_4122, 1),
59 ('6ba7b811-9dad-11d1-80b4-00c04fd430c8',
60 '{6ba7b811-9dad-11d1-80b4-00c04fd430c8}',
61 '6ba7b8119dad11d180b400c04fd430c8',
62 '\x6b\xa7\xb8\x11\x9d\xad\x11\xd1\x80\xb4\x00\xc0\x4f\xd4\x30\xc8',
63 (0x6ba7b811L, 0x9dad, 0x11d1, 0x80, 0xb4, 0x00c04fd430c8L),
64 0x6ba7b8119dad11d180b400c04fd430c8L,
65 'urn:uuid:6ba7b811-9dad-11d1-80b4-00c04fd430c8',
66 0x1d19dad6ba7b811L, 0xb4, uuid.RFC_4122, 1),
67 ('6ba7b812-9dad-11d1-80b4-00c04fd430c8',
68 '{6ba7b812-9dad-11d1-80b4-00c04fd430c8}',
69 '6ba7b8129dad11d180b400c04fd430c8',
70 '\x6b\xa7\xb8\x12\x9d\xad\x11\xd1\x80\xb4\x00\xc0\x4f\xd4\x30\xc8',
71 (0x6ba7b812L, 0x9dad, 0x11d1, 0x80, 0xb4, 0x00c04fd430c8L),
72 0x6ba7b8129dad11d180b400c04fd430c8L,
73 'urn:uuid:6ba7b812-9dad-11d1-80b4-00c04fd430c8',
74 0x1d19dad6ba7b812L, 0xb4, uuid.RFC_4122, 1),
75 ('6ba7b814-9dad-11d1-80b4-00c04fd430c8',
76 '{6ba7b814-9dad-11d1-80b4-00c04fd430c8}',
77 '6ba7b8149dad11d180b400c04fd430c8',
78 '\x6b\xa7\xb8\x14\x9d\xad\x11\xd1\x80\xb4\x00\xc0\x4f\xd4\x30\xc8',
79 (0x6ba7b814L, 0x9dad, 0x11d1, 0x80, 0xb4, 0x00c04fd430c8L),
80 0x6ba7b8149dad11d180b400c04fd430c8L,
81 'urn:uuid:6ba7b814-9dad-11d1-80b4-00c04fd430c8',
82 0x1d19dad6ba7b814L, 0xb4, uuid.RFC_4122, 1),
83 ('7d444840-9dc0-11d1-b245-5ffdce74fad2',
84 '{7d444840-9dc0-11d1-b245-5ffdce74fad2}',
85 '7d4448409dc011d1b2455ffdce74fad2',
86 '\x7d\x44\x48\x40\x9d\xc0\x11\xd1\xb2\x45\x5f\xfd\xce\x74\xfa\xd2',
87 (0x7d444840L, 0x9dc0, 0x11d1, 0xb2, 0x45, 0x5ffdce74fad2L),
88 0x7d4448409dc011d1b2455ffdce74fad2L,
89 'urn:uuid:7d444840-9dc0-11d1-b245-5ffdce74fad2',
90 0x1d19dc07d444840L, 0x3245, uuid.RFC_4122, 1),
91 ('e902893a-9d22-3c7e-a7b8-d6e313b71d9f',
92 '{e902893a-9d22-3c7e-a7b8-d6e313b71d9f}',
93 'e902893a9d223c7ea7b8d6e313b71d9f',
94 '\xe9\x02\x89\x3a\x9d\x22\x3c\x7e\xa7\xb8\xd6\xe3\x13\xb7\x1d\x9f',
95 (0xe902893aL, 0x9d22, 0x3c7e, 0xa7, 0xb8, 0xd6e313b71d9fL),
96 0xe902893a9d223c7ea7b8d6e313b71d9fL,
97 'urn:uuid:e902893a-9d22-3c7e-a7b8-d6e313b71d9f',
98 0xc7e9d22e902893aL, 0x27b8, uuid.RFC_4122, 3),
99 ('eb424026-6f54-4ef8-a4d0-bb658a1fc6cf',
100 '{eb424026-6f54-4ef8-a4d0-bb658a1fc6cf}',
101 'eb4240266f544ef8a4d0bb658a1fc6cf',
102 '\xeb\x42\x40\x26\x6f\x54\x4e\xf8\xa4\xd0\xbb\x65\x8a\x1f\xc6\xcf',
103 (0xeb424026L, 0x6f54, 0x4ef8, 0xa4, 0xd0, 0xbb658a1fc6cfL),
104 0xeb4240266f544ef8a4d0bb658a1fc6cfL,
105 'urn:uuid:eb424026-6f54-4ef8-a4d0-bb658a1fc6cf',
106 0xef86f54eb424026L, 0x24d0, uuid.RFC_4122, 4),
107 ('f81d4fae-7dec-11d0-a765-00a0c91e6bf6',
108 '{f81d4fae-7dec-11d0-a765-00a0c91e6bf6}',
109 'f81d4fae7dec11d0a76500a0c91e6bf6',
110 '\xf8\x1d\x4f\xae\x7d\xec\x11\xd0\xa7\x65\x00\xa0\xc9\x1e\x6b\xf6',
111 (0xf81d4faeL, 0x7dec, 0x11d0, 0xa7, 0x65, 0x00a0c91e6bf6L),
112 0xf81d4fae7dec11d0a76500a0c91e6bf6L,
113 'urn:uuid:f81d4fae-7dec-11d0-a765-00a0c91e6bf6',
114 0x1d07decf81d4faeL, 0x2765, uuid.RFC_4122, 1),
115 ('fffefdfc-fffe-fffe-fffe-fffefdfcfbfa',
116 '{fffefdfc-fffe-fffe-fffe-fffefdfcfbfa}',
117 'fffefdfcfffefffefffefffefdfcfbfa',
118 '\xff\xfe\xfd\xfc\xff\xfe\xff\xfe\xff\xfe\xff\xfe\xfd\xfc\xfb\xfa',
119 (0xfffefdfcL, 0xfffe, 0xfffe, 0xff, 0xfe, 0xfffefdfcfbfaL),
120 0xfffefdfcfffefffefffefffefdfcfbfaL,
121 'urn:uuid:fffefdfc-fffe-fffe-fffe-fffefdfcfbfa',
122 0xffefffefffefdfcL, 0x3ffe, uuid.RESERVED_FUTURE, None),
123 ('ffffffff-ffff-ffff-ffff-ffffffffffff',
124 '{ffffffff-ffff-ffff-ffff-ffffffffffff}',
125 'ffffffffffffffffffffffffffffffff',
126 '\xff'*16,
127 (0xffffffffL, 0xffffL, 0xffffL, 0xff, 0xff, 0xffffffffffffL),
128 0xffffffffffffffffffffffffffffffffL,
129 'urn:uuid:ffffffff-ffff-ffff-ffff-ffffffffffff',
130 0xfffffffffffffffL, 0x3fff, uuid.RESERVED_FUTURE, None),
131 ]:
132 equivalents = []
133 # Construct each UUID in several different ways.
134 for u in [uuid.UUID(string), uuid.UUID(curly), uuid.UUID(hex),
135 uuid.UUID(bytes=bytes), uuid.UUID(fields=fields),
136 uuid.UUID(int=integer), uuid.UUID(urn)]:
137 # Test all conversions and properties of the UUID object.
138 equal(str(u), string)
139 equal(int(u), integer)
140 equal(u.bytes, bytes)
141 equal(u.fields, fields)
142 equal(u.time_low, fields[0])
143 equal(u.time_mid, fields[1])
144 equal(u.time_hi_version, fields[2])
145 equal(u.clock_seq_hi_variant, fields[3])
146 equal(u.clock_seq_low, fields[4])
147 equal(u.node, fields[5])
148 equal(u.hex, hex)
149 equal(u.int, integer)
150 equal(u.urn, urn)
151 equal(u.time, time)
152 equal(u.clock_seq, clock_seq)
153 equal(u.variant, variant)
154 equal(u.version, version)
155 equivalents.append(u)
156
157 # Different construction methods should give the same UUID.
158 for u in equivalents:
159 for v in equivalents:
160 equal(u, v)
161 ascending.append(u)
162
163 # Test comparison of UUIDs.
164 for i in range(len(ascending)):
165 for j in range(len(ascending)):
166 equal(cmp(i, j), cmp(ascending[i], ascending[j]))
167
168 # Test sorting of UUIDs (above list is in ascending order).
169 resorted = ascending[:]
170 resorted.reverse()
171 resorted.sort()
172 equal(ascending, resorted)
173
174 def test_exceptions(self):
175 badvalue = lambda f: self.assertRaises(ValueError, f)
176 badtype = lambda f: self.assertRaises(TypeError, f)
177
178 # Badly formed hex strings.
179 badvalue(lambda: uuid.UUID(''))
180 badvalue(lambda: uuid.UUID('abc'))
181 badvalue(lambda: uuid.UUID('1234567812345678123456781234567'))
182 badvalue(lambda: uuid.UUID('123456781234567812345678123456789'))
183 badvalue(lambda: uuid.UUID('123456781234567812345678z2345678'))
184
185 # Badly formed bytes.
186 badvalue(lambda: uuid.UUID(bytes='abc'))
187 badvalue(lambda: uuid.UUID(bytes='\0'*15))
188 badvalue(lambda: uuid.UUID(bytes='\0'*17))
189
190 # Badly formed fields.
191 badvalue(lambda: uuid.UUID(fields=(1,)))
192 badvalue(lambda: uuid.UUID(fields=(1, 2, 3, 4, 5)))
193 badvalue(lambda: uuid.UUID(fields=(1, 2, 3, 4, 5, 6, 7)))
194
195 # Field values out of range.
196 badvalue(lambda: uuid.UUID(fields=(-1, 0, 0, 0, 0, 0)))
197 badvalue(lambda: uuid.UUID(fields=(0x100000000L, 0, 0, 0, 0, 0)))
198 badvalue(lambda: uuid.UUID(fields=(0, -1, 0, 0, 0, 0)))
199 badvalue(lambda: uuid.UUID(fields=(0, 0x10000L, 0, 0, 0, 0)))
200 badvalue(lambda: uuid.UUID(fields=(0, 0, -1, 0, 0, 0)))
201 badvalue(lambda: uuid.UUID(fields=(0, 0, 0x10000L, 0, 0, 0)))
202 badvalue(lambda: uuid.UUID(fields=(0, 0, 0, -1, 0, 0)))
203 badvalue(lambda: uuid.UUID(fields=(0, 0, 0, 0x100L, 0, 0)))
204 badvalue(lambda: uuid.UUID(fields=(0, 0, 0, 0, -1, 0)))
205 badvalue(lambda: uuid.UUID(fields=(0, 0, 0, 0, 0x100L, 0)))
206 badvalue(lambda: uuid.UUID(fields=(0, 0, 0, 0, 0, -1)))
207 badvalue(lambda: uuid.UUID(fields=(0, 0, 0, 0, 0, 0x1000000000000L)))
208
209 # Version number out of range.
210 badvalue(lambda: uuid.UUID('00'*16, version=0))
211 badvalue(lambda: uuid.UUID('00'*16, version=6))
212
213 # Integer value out of range.
214 badvalue(lambda: uuid.UUID(int=-1))
215 badvalue(lambda: uuid.UUID(int=1<<128L))
216
217 # Must supply exactly one of hex, bytes, fields, int.
218 h, b, f, i = '00'*16, '\0'*16, (0, 0, 0, 0, 0, 0), 0
219 uuid.UUID(h)
220 uuid.UUID(hex=h)
221 uuid.UUID(bytes=b)
222 uuid.UUID(fields=f)
223 uuid.UUID(int=i)
224
225 # Wrong number of arguments (positional).
226 badtype(lambda: uuid.UUID())
227 badtype(lambda: uuid.UUID(h, b))
228 badtype(lambda: uuid.UUID(h, b, f))
229 badtype(lambda: uuid.UUID(h, b, f, i))
230
231 # Duplicate arguments (named).
232 badtype(lambda: uuid.UUID(hex=h, bytes=b))
233 badtype(lambda: uuid.UUID(hex=h, fields=f))
234 badtype(lambda: uuid.UUID(hex=h, int=i))
235 badtype(lambda: uuid.UUID(bytes=b, fields=f))
236 badtype(lambda: uuid.UUID(bytes=b, int=i))
237 badtype(lambda: uuid.UUID(fields=f, int=i))
238 badtype(lambda: uuid.UUID(hex=h, bytes=b, fields=f))
239 badtype(lambda: uuid.UUID(hex=h, bytes=b, int=i))
240 badtype(lambda: uuid.UUID(hex=h, fields=f, int=i))
241 badtype(lambda: uuid.UUID(bytes=b, int=i, fields=f))
242 badtype(lambda: uuid.UUID(hex=h, bytes=b, int=i, fields=f))
243
244 # Duplicate arguments (positional and named).
245 badtype(lambda: uuid.UUID(h, hex=h))
246 badtype(lambda: uuid.UUID(h, bytes=b))
247 badtype(lambda: uuid.UUID(h, fields=f))
248 badtype(lambda: uuid.UUID(h, int=i))
249 badtype(lambda: uuid.UUID(h, hex=h, bytes=b))
250 badtype(lambda: uuid.UUID(h, hex=h, fields=f))
251 badtype(lambda: uuid.UUID(h, hex=h, int=i))
252 badtype(lambda: uuid.UUID(h, bytes=b, fields=f))
253 badtype(lambda: uuid.UUID(h, bytes=b, int=i))
254 badtype(lambda: uuid.UUID(h, fields=f, int=i))
255 badtype(lambda: uuid.UUID(h, hex=h, bytes=b, fields=f))
256 badtype(lambda: uuid.UUID(h, hex=h, bytes=b, int=i))
257 badtype(lambda: uuid.UUID(h, hex=h, fields=f, int=i))
258 badtype(lambda: uuid.UUID(h, bytes=b, int=i, fields=f))
259 badtype(lambda: uuid.UUID(h, hex=h, bytes=b, int=i, fields=f))
260
261 # Immutability.
262 u = uuid.UUID(h)
263 badtype(lambda: setattr(u, 'hex', h))
264 badtype(lambda: setattr(u, 'bytes', b))
265 badtype(lambda: setattr(u, 'fields', f))
266 badtype(lambda: setattr(u, 'int', i))
267
268 def check_node(self, node, source=''):
269 individual_group_bit = (node >> 40L) & 1
270 universal_local_bit = (node >> 40L) & 2
271 message = "%012x doesn't look like a real MAC address" % node
272 self.assertEqual(individual_group_bit, 0, message)
273 self.assertEqual(universal_local_bit, 0, message)
274 self.assertNotEqual(node, 0, message)
275 self.assertNotEqual(node, 0xffffffffffffL, message)
276 self.assert_(0 <= node, message)
277 self.assert_(node < 1<<48L, message)
278
279 import sys
280 if source:
281 sys.stderr.write('(%s: %012x)' % (source, node))
282 if TestUUID.last_node:
283 self.assertEqual(TestUUID.last_node, node, 'inconsistent node IDs')
284 else:
285 TestUUID.last_node = node
286
287 def test_ifconfig_getnode(self):
288 import os
289 if os.name == 'posix':
290 self.check_node(uuid._ifconfig_getnode(), 'ifconfig')
291
292 def test_ipconfig_getnode(self):
293 import os
294 if os.name == 'nt':
295 self.check_node(uuid._ipconfig_getnode(), 'ipconfig')
296
297 def test_netbios_getnode(self):
298 if importable('win32wnet') and importable('netbios'):
299 self.check_node(uuid._netbios_getnode(), 'netbios')
300
301 def test_random_getnode(self):
302 node = uuid._random_getnode()
303 self.assert_(0 <= node)
304 self.assert_(node < 1<<48L)
305
306 def test_unixdll_getnode(self):
307 import os
308 if importable('ctypes') and os.name == 'posix':
309 self.check_node(uuid._unixdll_getnode(), 'unixdll')
310
311 def test_windll_getnode(self):
312 import os
313 if importable('ctypes') and os.name == 'nt':
314 self.check_node(uuid._windll_getnode(), 'windll')
315
316 def test_getnode(self):
317 self.check_node(uuid.getnode())
318
319 # Test it again to ensure consistency.
320 self.check_node(uuid.getnode())
321
322 def test_uuid1(self):
323 equal = self.assertEqual
324
325 # Make sure uuid4() generates UUIDs that are actually version 1.
326 for u in [uuid.uuid1() for i in range(10)]:
327 equal(u.variant, uuid.RFC_4122)
328 equal(u.version, 1)
329
330 # Make sure the supplied node ID appears in the UUID.
331 u = uuid.uuid1(0)
332 equal(u.node, 0)
333 u = uuid.uuid1(0x123456789abc)
334 equal(u.node, 0x123456789abc)
335 u = uuid.uuid1(0xffffffffffff)
336 equal(u.node, 0xffffffffffff)
337
338 # Make sure the supplied clock sequence appears in the UUID.
339 u = uuid.uuid1(0x123456789abc, 0)
340 equal(u.node, 0x123456789abc)
341 equal(((u.clock_seq_hi_variant & 0x3f) << 8) | u.clock_seq_low, 0)
342 u = uuid.uuid1(0x123456789abc, 0x1234)
343 equal(u.node, 0x123456789abc)
344 equal(((u.clock_seq_hi_variant & 0x3f) << 8) |
345 u.clock_seq_low, 0x1234)
346 u = uuid.uuid1(0x123456789abc, 0x3fff)
347 equal(u.node, 0x123456789abc)
348 equal(((u.clock_seq_hi_variant & 0x3f) << 8) |
349 u.clock_seq_low, 0x3fff)
350
351 def test_uuid3(self):
352 equal = self.assertEqual
353
354 # Test some known version-3 UUIDs.
355 for u, v in [(uuid.uuid3(uuid.NAMESPACE_DNS, 'python.org'),
356 '6fa459ea-ee8a-3ca4-894e-db77e160355e'),
357 (uuid.uuid3(uuid.NAMESPACE_URL, 'http://python.org/'),
358 '9fe8e8c4-aaa8-32a9-a55c-4535a88b748d'),
359 (uuid.uuid3(uuid.NAMESPACE_OID, '1.3.6.1'),
360 'dd1a1cef-13d5-368a-ad82-eca71acd4cd1'),
361 (uuid.uuid3(uuid.NAMESPACE_X500, 'c=ca'),
362 '658d3002-db6b-3040-a1d1-8ddd7d189a4d'),
363 ]:
364 equal(u.variant, uuid.RFC_4122)
365 equal(u.version, 3)
366 equal(u, uuid.UUID(v))
367 equal(str(u), v)
368
369 def test_uuid4(self):
370 equal = self.assertEqual
371
372 # Make sure uuid4() generates UUIDs that are actually version 4.
373 for u in [uuid.uuid4() for i in range(10)]:
374 equal(u.variant, uuid.RFC_4122)
375 equal(u.version, 4)
376
377 def test_uuid5(self):
378 equal = self.assertEqual
379
380 # Test some known version-5 UUIDs.
381 for u, v in [(uuid.uuid5(uuid.NAMESPACE_DNS, 'python.org'),
382 '886313e1-3b8a-5372-9b90-0c9aee199e5d'),
383 (uuid.uuid5(uuid.NAMESPACE_URL, 'http://python.org/'),
384 '4c565f0d-3f5a-5890-b41b-20cf47701c5e'),
385 (uuid.uuid5(uuid.NAMESPACE_OID, '1.3.6.1'),
386 '1447fa61-5277-5fef-a9b3-fbc6e44f4af3'),
387 (uuid.uuid5(uuid.NAMESPACE_X500, 'c=ca'),
388 'cc957dd1-a972-5349-98cd-874190002798'),
389 ]:
390 equal(u.variant, uuid.RFC_4122)
391 equal(u.version, 5)
392 equal(u, uuid.UUID(v))
393 equal(str(u), v)
394
395if __name__ == '__main__':
396 main()