openstack/heat
Code Issues Proposed changes

Less unicode weirdness in short_id

Browse Source 
The function _to_byte_string() deals with binary data, so it should
return... a byte string.

Also Base32 uses strictly valid ASCII characters, so it can be decoded as
ASCII.

This effectively reverts commit 15cbb894f2.

Change-Id: I24b625a41eb8f7fd47f4a3df7ac53c598b01abb6
This commit is contained in:
Zane Bitter 2017-05-01 16:44:59 -04:00
parent 38486dd64e
commit 6834733212
2 changed files with 12 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
heat/common/short_id.py
View File

@ -35,7 +35,7 @@ def _to_byte_string(value, num_bits):
def byte_at(off): def byte_at(off):
return (value >> off if off >= 0 else value << -off) & 0xff return (value >> off if off >= 0 else value << -off) & 0xff
return ''.join(six.unichr(byte_at(offset)) for offset in shifts) return b''.join(six.int2byte(byte_at(offset)) for offset in shifts)
def get_id(source_uuid): def get_id(source_uuid):
@ -53,9 +53,8 @@ def get_id(source_uuid):
random_bytes = _to_byte_string(source_uuid.time, 60) random_bytes = _to_byte_string(source_uuid.time, 60)
# The first 12 bytes (= 60 bits) of base32-encoded output is our data # The first 12 bytes (= 60 bits) of base32-encoded output is our data
encoded = base64.b32encode(random_bytes.encode('latin-1'))[:12] encoded_bytes = base64.b32encode(random_bytes)[:12]
return encoded_bytes.decode('ascii').lower()
return encoded.lower().decode('latin-1')
def generate_id(): def generate_id():

18
heat/tests/test_short_id.py
View File

@ -20,21 +20,21 @@ from heat.tests import common
class ShortIdTest(common.HeatTestCase): class ShortIdTest(common.HeatTestCase):
def test_byte_string_8(self): def test_byte_string_8(self):
self.assertEqual(u'\xab', short_id._to_byte_string(0xab, 8)) self.assertEqual(b'\xab', short_id._to_byte_string(0xab, 8))
self.assertEqual(u'\x05', short_id._to_byte_string(0x05, 8)) self.assertEqual(b'\x05', short_id._to_byte_string(0x05, 8))
def test_byte_string_16(self): def test_byte_string_16(self):
self.assertEqual(u'\xab\xcd', short_id._to_byte_string(0xabcd, 16)) self.assertEqual(b'\xab\xcd', short_id._to_byte_string(0xabcd, 16))
self.assertEqual(u'\x0a\xbc', short_id._to_byte_string(0xabc, 16)) self.assertEqual(b'\x0a\xbc', short_id._to_byte_string(0xabc, 16))
def test_byte_string_12(self): def test_byte_string_12(self):
self.assertEqual(u'\xab\xc0', short_id._to_byte_string(0xabc, 12)) self.assertEqual(b'\xab\xc0', short_id._to_byte_string(0xabc, 12))
self.assertEqual(u'\x0a\xb0', short_id._to_byte_string(0x0ab, 12)) self.assertEqual(b'\x0a\xb0', short_id._to_byte_string(0x0ab, 12))
def test_byte_string_60(self): def test_byte_string_60(self):
val = 0x111111111111111 val = 0x111111111111111
byte_string = short_id._to_byte_string(val, 60) byte_string = short_id._to_byte_string(val, 60)
self.assertEqual('\x11\x11\x11\x11\x11\x11\x11\x10', byte_string) self.assertEqual(b'\x11\x11\x11\x11\x11\x11\x11\x10', byte_string)
def test_get_id_string(self): def test_get_id_string(self):
id = short_id.get_id('11111111-1111-4111-bfff-ffffffffffff') id = short_id.get_id('11111111-1111-4111-bfff-ffffffffffff')
@ -62,10 +62,10 @@ class ShortIdTest(common.HeatTestCase):
self.assertRaises(ValueError, short_id.get_id, source) self.assertRaises(ValueError, short_id.get_id, source)
def test_generate_ids(self): def test_generate_ids(self):
allowed_chars = 'abcdefghijklmnopqrstuvwxyz234567' allowed_chars = [ord(c) for c in u'abcdefghijklmnopqrstuvwxyz234567']
ids = [short_id.generate_id() for i in range(25)] ids = [short_id.generate_id() for i in range(25)]
for id in ids: for id in ids:
self.assertEqual(12, len(id)) self.assertEqual(12, len(id))
self.assertEqual(id, id.translate(allowed_chars)) self.assertFalse(id.translate({c: None for c in allowed_chars}))
self.assertEqual(1, ids.count(id)) self.assertEqual(1, ids.count(id))