factor out string-to-boolean operations

buildbot · May 27, 2013 · 2da7502 · 2da7502
1 parent be22213
commit 2da7502
Show file tree

Hide file tree

Showing 4 changed files with 58 additions and 11 deletions.
diff --git a/master/buildbot/data/types.py b/master/buildbot/data/types.py
@@ -16,6 +16,7 @@
 # See "Type Validation" in master/docs/developer/tests.rst
 
 import re
+from buildbot import util
 from buildbot.util import json
 from buildbot.data import base
 
@@ -100,16 +101,7 @@ class Boolean(Instance):
     types = (bool,)
 
     def valueFromString(self, arg):
-        return {
-            'on': True,
-            'true': True,
-            'yes': True,
-            '1': True,
-            'off': False,
-            'false': False,
-            'no': False,
-            '0': False,
-        }[arg.lower()]
+        return util.string2boolean(arg)
 
 
 class Link(Instance):

diff --git a/master/buildbot/test/unit/test_util.py b/master/buildbot/test/unit/test_util.py
@@ -208,3 +208,36 @@ def test_nonascii(self):
 
     def test_None(self):
         self.assertEqual(util.ascii2unicode(None), None)
+
+class StringToBoolean(unittest.TestCase):
+
+    def test_it(self):
+        stringValues = [
+            ('on', True),
+            ('true', True),
+            ('yes', True),
+            ('1', True),
+            ('off', False),
+            ('false', False),
+            ('no', False),
+            ('0', False),
+            ('ON', True),
+            ('TRUE', True),
+            ('YES', True),
+            ('OFF', False),
+            ('FALSE', False),
+            ('NO', False),
+        ]
+        for s, b in stringValues:
+            self.assertEqual(util.string2boolean(s), b, repr(s))
+
+    def test_ascii(self):
+        rv = util.ascii2unicode('abcd')
+        self.assertEqual((rv, type(rv)), (u'abcd', unicode))
+
+    def test_nonascii(self):
+        self.assertRaises(UnicodeDecodeError, lambda :
+            util.ascii2unicode('a\x85'))
+
+    def test_None(self):
+        self.assertEqual(util.ascii2unicode(None), None)
diff --git a/master/buildbot/util/__init__.py b/master/buildbot/util/__init__.py
@@ -207,8 +207,20 @@ def do_stop(r):
     wrap._orig = f # for tests
     return wrap
 
+def string2boolean(str):
+    return {
+        'on': True,
+        'true': True,
+        'yes': True,
+        '1': True,
+        'off': False,
+        'false': False,
+        'no': False,
+        '0': False,
+    }[str.lower()]
+
 __all__ = [
     'naturalSort', 'now', 'formatInterval', 'ComparableMixin', 'json',
     'safeTranslate', 'LRUCache', 'none_or_str',
     'NotABranch', 'deferredLocked', 'SerializedInvocation', 'UTC',
-    'diffLists', 'makeList', 'in_reactor' ]
+    'diffLists', 'makeList', 'in_reactor', 'string2boolean' ]
diff --git a/master/docs/developer/utils.rst b/master/docs/developer/utils.rst
@@ -144,6 +144,16 @@ package.
     If given a bytestring, it returns the string decoded as ASCII (and will thus fail for any bytes 0x80 or higher).
     If given a unicode string, it returns it directly.
 
+.. py:function:: string2boolean(str):
+
+    :param str: string
+    :raises KeyError:
+    :returns: boolean
+
+    This function converts a string to a boolean.
+    It is intended to be liberal in what it accepts: case-insensitive, "true", "on", "yes", "1", etc.
+    It raises :py:exc:`KeyError` if the value is not recognized.
+
 .. py:data:: NotABranch
 
     This is a sentinel value used to indicate that no branch is specified.  It