bluetooth: Added script for converting the Web Bluetooth blacklist.

tools/web_bluetooth/compact_blacklist.py

+#!/usr/bin/env python
+# Copyright (c) 2016 The Chromium Authors. All rights reserved.

[scottmg, 2016/08/29 15:34:02]

no (c)

+# Use of this source code is governed by a BSD-style license that can be
+# found in the LICENSE file.
+
+"""Script for converting the Web Bluetooth GATT blacklist into the format
+expected by ContentBrowserClient#GetWebBluetoothBlacklist.
+
+See:
+https://github.com/WebBluetoothCG/registries/blob/master/gatt_blacklist.txt
+content/public/browser/content_browser_client.h
+
+Usage:
+  compact_blacklist.py <gatt_blacklist.txt>
+"""
+
+import collections
+import string
+import sys
+
+blacklist = collections.OrderedDict()

[scottmg, 2016/08/29 15:34:03]

I would make this g_blacklist, or BLACKLIST, or better, make it a local in the
try block of main() and pass it into process()

+
+UUID_LENGTH = 36
+UUID_BASE_POSTFIX = '-0000-1000-8000-00805f9b34fb'
+
+
+class BadLineException(Exception):
+    pass

[scottmg, 2016/08/29 15:34:02]

2-space indent in Chromium still afaik:
https://www.chromium.org/chromium-os/python-style-guidelines.

+
+
+class InvalidUUIDException(Exception):
+    pass
+
+
+class DuplicateUUIDException(Exception):
+    pass
+
+
+class InvalidExclusionException(Exception):
+    pass
+
+
+def valid_uuid(uuid):

[scottmg, 2016/08/29 15:34:03]

Functions should be UpperCase-style.

+    if len(uuid) != UUID_LENGTH:
+        return False
+    for i in range(UUID_LENGTH):
+        if i in [8, 13, 18, 23]:
+            if uuid[i] != '-':
+                return False
+        else:
+            if uuid[i] not in string.hexdigits:
+                return False
+    return True
+
+
+# Note: this function shortens all UUIDs that use the Bluetooth base

[scottmg, 2016/08/29 15:34:02]

Make this a """ docstring instead of a block comment before the function.

+# UUID even thought the specification states that only an assigned

[scottmg, 2016/08/29 15:34:02]

"thought" -> "though"

+# UUID can be shortened. In this case it works fine, since the constructor in
+# bluetooth_uuid.cc also works the same way.
+def shorten_uuid(uuid):
+    if uuid[8:] == UUID_BASE_POSTFIX:
+        new_uuid = '%x' % int(uuid[:8], 16)
+        if len(new_uuid) in [4, 8]:
+            uuid = new_uuid
+    return uuid
+
+
+def process(line):
+    line = line.strip().lower()
+    if not line or line.startswith('#'):
+        return
+    fields = line.split()
+    if len(fields) not in [1, 2]:
+        raise BadLineException('Badly formatted line: %s' % line)
+    uuid = fields[0]
+    if not valid_uuid(uuid):
+        raise InvalidUUIDException('Invalid UUID: %s' % line)
+    uuid = shorten_uuid(uuid)
+    if uuid in blacklist:
+        raise DuplicateUUIDException('Duplicate UUID: %s' % line)
+    if len(fields) == 1:
+        blacklist[uuid] = 'e'
+    elif fields[1] == 'exclude-writes':
+        blacklist[uuid] = 'w'
+    elif fields[1] == 'exclude-reads':
+        blacklist[uuid] = 'r'
+    else:
+        raise InvalidExclusionException('Invalid exclusion value: %s' % line)
+
+
+def main():
+    if len(sys.argv) != 2:
+        sys.exit('Usage: %s <gatt_blacklist.txt>' % sys.argv[0])

[scottmg, 2016/08/29 15:34:03]

print and return 1 here

+
+    try:
+        with open(sys.argv[1]) as f:
+            for line in f:
+                process(line)
+        print(','.join('%s:%s' % (uuid, blacklist[uuid]) for uuid in blacklist))

[scottmg, 2016/08/29 15:34:03]

return 0 after here

+    except Exception as e:
+        sys.exit('Failed to compact blacklist. %s' % e)

[scottmg, 2016/08/29 15:34:02]

and here

+
+
+if __name__ == '__main__':
+    main()

[scottmg, 2016/08/29 15:34:02]

sys.exit(main()) here