Changeset 51:d6bbf24ef053

Timestamp:

Jan 13, 2009, 7:30:35 PM (12 years ago)

Author:

Ralph Meijer <ralphm@…>

Branch:

default

Convert:

svn:b33ecbfc-034c-dc11-8662-000475d9059e/trunk@162

Message:

Address Data Form type checking issues.

Author: ralphm.
Reviewer: tofu.
Fixes #41.

Location:

wokkel

Files:

• data_form.py (modified) (2 diffs)
• test/test_data_form.py (modified) (23 diffs)

wokkel/data_form.py

@@ -220 +220 @@
             for value in self.values:
                 if self.fieldType == 'boolean':
-                    # We send out the textual representation of boolean values
-                    value = bool(int(value))
+                    if isinstance(value, (str, unicode)):
+                        checkValue = value.lower()
+                        if not checkValue in ('0', '1', 'false', 'true'):
+                            raise ValueError("Not a boolean")
+                        value = checkValue in ('1', 'true')
+                    value = bool(value)
                 elif self.fieldType in ('jid-single', 'jid-multi'):
-                    value = value.full()
+                    if not hasattr(value, 'full'):
+                        value = JID(value)
 
                 newValues.append(value)
@@ -249 +254 @@
             if self.fieldType == 'boolean':
                 value = unicode(value).lower()
+            elif self.fieldType in ('jid-single', 'jid-multi'):
+                value = value.full()
+
             field.addElement('value', content=value)
 

wokkel/test/test_data_form.py

@@ -8 +8 @@
 from twisted.trial import unittest
 from twisted.words.xish import domish
-
-from wokkel.data_form import Field, Form, Option, FieldNameRequiredError
+from twisted.words.protocols.jabber import jid
+
+from wokkel import data_form
 
 NS_X_DATA = 'jabber:x:data'
 
-
-
 class OptionTest(unittest.TestCase):
     """
-    Tests for L{Option}.
+    Tests for L{data_form.Option}.
     """
 
     def test_toElement(self):
-        option = Option('value', 'label')
+        option = data_form.Option('value', 'label')
         element = option.toElement()
         self.assertEquals('option', element.name)
@@ -34 +33 @@
 class FieldTest(unittest.TestCase):
     """
-    Tests for L{Field}.
+    Tests for L{data_form.Field}.
     """
 
@@ -41 +40 @@
         Test basic field initialization.
         """
-        field = Field(var='test')
+        field = data_form.Field(var='test')
         self.assertEqual('text-single', field.fieldType)
         self.assertEqual('test', field.var)
 
 
-    def test_noFieldName(self):
-        field = Field()
-        self.assertRaises(FieldNameRequiredError, field.toElement)
-
-
     def test_toElement(self):
         """
         Test rendering to a DOM.
         """
-        field = Field(var='test')
+        field = data_form.Field(var='test')
         element = field.toElement()
 
@@ -71 +65 @@
         Always render the field type, if different from list-single.
         """
-        field = Field('hidden', var='test')
+        field = data_form.Field('hidden', var='test')
         element = field.toElement()
 
@@ -81 +75 @@
         Always render the field type, if asForm is True.
         """
-        field = Field(var='test')
+        field = data_form.Field(var='test')
         element = field.toElement(True)
 
@@ -91 +85 @@
         Test rendering to a DOM with options.
         """
-        field = Field('list-single', var='test')
-        field.options = [Option(u'option1'), Option(u'option2')]
+        field = data_form.Field('list-single', var='test')
+        field.options = [data_form.Option(u'option1'),
+                         data_form.Option(u'option2')]
         element = field.toElement(True)
 
@@ -102 +97 @@
         Test rendering to a DOM with a label.
         """
-        field = Field(var='test', label=u'my label')
+        field = data_form.Field(var='test', label=u'my label')
         element = field.toElement(True)
 
@@ -112 +107 @@
         Test rendering to a DOM with options.
         """
-        field = Field(var='test', desc=u'My desc')
+        field = data_form.Field(var='test', desc=u'My desc')
         element = field.toElement(True)
 
@@ -126 +121 @@
         Test rendering to a DOM with options.
         """
-        field = Field(var='test', required=True)
+        field = data_form.Field(var='test', required=True)
         element = field.toElement(True)
 
@@ -135 +130 @@
 
 
+    def test_toElementJID(self):
+        field = data_form.Field(fieldType='jid-single', var='test',
+                                value=jid.JID(u'test@example.org'))
+        element = field.toElement()
+        self.assertEqual(u'test@example.org', unicode(element.value))
+
+
+    def test_typeCheckNoFieldName(self):
+        """
+        A field not of type fixed must have a var.
+        """
+        field = data_form.Field(fieldType='list-single')
+        self.assertRaises(data_form.FieldNameRequiredError, field.typeCheck)
+
+
+    def test_typeCheckTooManyValues(self):
+        """
+        Expect an exception if too many values are set, depending on type.
+        """
+        field = data_form.Field(fieldType='list-single', var='test',
+                                values=[u'value1', u'value2'])
+        self.assertRaises(data_form.TooManyValuesError, field.typeCheck)
+
+
+    def test_typeCheckBooleanFalse(self):
+        """
+        Test possible False values for a boolean field.
+        """
+        field = data_form.Field(fieldType='boolean', var='test')
+
+        for value in (False, 0, '0', 'false', 'False', []):
+            field.value = value
+            field.typeCheck()
+            self.assertIsInstance(field.value, bool)
+            self.assertFalse(field.value)
+
+
+    def test_typeCheckBooleanTrue(self):
+        """
+        Test possible True values for a boolean field.
+        """
+        field = data_form.Field(fieldType='boolean', var='test')
+
+        for value in (True, 1, '1', 'true', 'True', ['test']):
+            field.value = value
+            field.typeCheck()
+            self.assertIsInstance(field.value, bool)
+            self.assertTrue(field.value)
+
+
+    def test_typeCheckBooleanBad(self):
+        """
+        A bad value for a boolean field should raise a ValueError
+        """
+        field = data_form.Field(fieldType='boolean', var='test')
+        field.value = 'test'
+        self.assertRaises(ValueError, field.typeCheck)
+
+
+    def test_typeCheckJID(self):
+        """
+        The value of jid field should be a JID or coercable to one.
+        """
+        field = data_form.Field(fieldType='jid-single', var='test',
+                                value=jid.JID('test@example.org'))
+        field.typeCheck()
+
+
+    def test_typeCheckJIDString(self):
+        """
+        The string value of jid field should be coercable into a JID.
+        """
+        field = data_form.Field(fieldType='jid-single', var='test',
+                                value='test@example.org')
+        field.typeCheck()
+        self.assertEquals(jid.JID(u'test@example.org'), field.value)
+
+
+    def test_typeCheckJIDBad(self):
+        """
+        An invalid JID string should raise an exception.
+        """
+        field = data_form.Field(fieldType='jid-single', var='test',
+                                value='test@@example.org')
+        self.assertRaises(jid.InvalidFormat, field.typeCheck)
+
+
     def test_fromElementType(self):
         element = domish.Element((NS_X_DATA, 'field'))
         element['type'] = 'fixed'
-        field = Field.fromElement(element)
+        field = data_form.Field.fromElement(element)
         self.assertEquals('fixed', field.fieldType)
 
@@ -144 +226 @@
     def test_fromElementNoType(self):
         element = domish.Element((NS_X_DATA, 'field'))
-        field = Field.fromElement(element)
+        field = data_form.Field.fromElement(element)
         self.assertEquals(None, field.fieldType)
 
@@ -151 +233 @@
         element = domish.Element((NS_X_DATA, 'field'))
         element.addElement("value", content="text")
-        field = Field.fromElement(element)
+        field = data_form.Field.fromElement(element)
         self.assertEquals('text', field.value)
 
@@ -158 +240 @@
 class FormTest(unittest.TestCase):
     """
-    Tests for L{Form}.
+    Tests for L{data_form.Form}.
     """
 
@@ -166 +248 @@
         """
 
-        form = Form('result')
+        form = data_form.Form('result')
         self.assertEqual('result', form.formType)
 
@@ -173 +255 @@
         The toElement method returns a form's DOM representation.
         """
-        form = Form('result')
+        form = data_form.Form('result')
         element = form.toElement()
 
@@ -185 +267 @@
     def test_fromElement(self):
         """
-        The fromElement static method creates a L{Form} from a L{DOM.
+        C{fromElement} creates a L{data_form.Form} from a DOM representation.
         """
         element = domish.Element((NS_X_DATA, 'x'))
         element['type'] = 'result'
-        form = Form.fromElement(element)
+        form = data_form.Form.fromElement(element)
 
         self.assertEquals('result', form.formType)
@@ -202 +284 @@
         """
         element = domish.Element((NS_X_DATA, 'form'))
-        self.assertRaises(Exception, Form.fromElement, element)
+        self.assertRaises(Exception, data_form.Form.fromElement, element)
 
 
@@ -210 +292 @@
         """
         element = domish.Element(('myns', 'x'))
-        self.assertRaises(Exception, Form.fromElement, element)
+        self.assertRaises(Exception, data_form.Form.fromElement, element)
 
 
@@ -216 +298 @@
         element = domish.Element((NS_X_DATA, 'x'))
         element.addElement('title', content='My title')
-        form = Form.fromElement(element)
+        form = data_form.Form.fromElement(element)
 
         self.assertEquals('My title', form.title)
@@ -224 +306 @@
         element = domish.Element((NS_X_DATA, 'x'))
         element.addElement('instructions', content='instruction')
-        form = Form.fromElement(element)
+        form = data_form.Form.fromElement(element)
 
         self.assertEquals(['instruction'], form.instructions)
@@ -232 +314 @@
         element.addElement('instructions', content='instruction 1')
         element.addElement('instructions', content='instruction 2')
-        form = Form.fromElement(element)
+        form = data_form.Form.fromElement(element)
 
         self.assertEquals(['instruction 1', 'instruction 2'], form.instructions)
@@ -240 +322 @@
         element = domish.Element((NS_X_DATA, 'x'))
         element.addElement('field')
-        form = Form.fromElement(element)
+        form = data_form.Form.fromElement(element)
 
         self.assertEquals(1, len(form.fieldList))
@@ -250 +332 @@
         element.addElement('field')['var'] = 'field1'
         element.addElement('field')['var'] = 'field2'
-        form = Form.fromElement(element)
+        form = data_form.Form.fromElement(element)
 
         self.assertEquals(2, len(form.fieldList))