more small userauditor changes and a unittest

- changes the "roles" loop per alex's suggestion
- figured out (I think) why vim wasn't obeying the modeline and
  corrected it
- removed trailing whitespace per alex
- synchronized classic/minimal templates (boy I wish CVS allowed symlinks)
- added unit tests for userauditor.py: checks timezone, email, and role
  handling

Author: Justus Pendleton

templates/classic/detectors/userauditor.py

@@ -18,21 +18,20 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 #
-#$Id: userauditor.py,v 1.4 2007-08-30 00:31:15 jpend Exp $
+#$Id: userauditor.py,v 1.5 2007-08-31 15:57:47 jpend Exp $
 
 def audit_user_fields(db, cl, nodeid, newvalues):
     ''' Make sure user properties are valid.
 
         - email address has no spaces in it
         - roles specified exist
+        - timezone is valid
     '''
     if newvalues.has_key('address') and ' ' in newvalues['address']:
         raise ValueError, 'Email address must not contain spaces'
 
-    if newvalues.has_key('roles') and newvalues['roles']:
-        roles = [x.lower().strip() for x in newvalues['roles'].split(',')]
-        for rolename in roles:
-            if not db.security.role.has_key(rolename):
+    for rolename in newvalues.get('roles', '').split(','):
+            if rolename and not db.security.role.has_key(rolename.lower().strip()):
                 raise ValueError, 'Role "%s" does not exist'%rolename
 
     if newvalues.has_key('timezone'):
@@ -53,5 +52,6 @@ def audit_user_fields(db, cl, nodeid, newvalues):
 def init(db):
     # fire before changes are made
     db.user.audit('set', audit_user_fields)
-    db.user.audit('create', audit_user_fields) 
-# vim: set filetype=python ts=4 sw=4 et si
+    db.user.audit('create', audit_user_fields)
+
+# vim: filetype=python ts=4 sw=4 et si

templates/minimal/detectors/userauditor.py

@@ -18,26 +18,25 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 #
-#$Id: userauditor.py,v 1.3 2007-08-30 00:31:16 jpend Exp $
+#$Id: userauditor.py,v 1.4 2007-08-31 15:57:47 jpend Exp $
 
 def audit_user_fields(db, cl, nodeid, newvalues):
     ''' Make sure user properties are valid.
 
         - email address has no spaces in it
         - roles specified exist
+        - timezone is valid
     '''
     if newvalues.has_key('address') and ' ' in newvalues['address']:
         raise ValueError, 'Email address must not contain spaces'
 
-    if newvalues.has_key('roles') and newvalues['roles']:
-        roles = [x.lower().strip() for x in newvalues['roles'].split(',')]
-        for rolename in roles:
-            if not db.security.role.has_key(rolename):
+    for rolename in newvalues.get('roles', '').split(','):
+            if rolename and not db.security.role.has_key(rolename.lower().strip()):
                 raise ValueError, 'Role "%s" does not exist'%rolename
 
     if newvalues.has_key('timezone'):
         # validate the timezone by attempting to use it
-        # before we store it to the db
+        # before we store it to the db.
         import roundup.date
         import datetime
         try:
@@ -55,4 +54,4 @@ def init(db):
     db.user.audit('set', audit_user_fields)
     db.user.audit('create', audit_user_fields)
 
-# vim: set filetype=python ts=4 sw=4 et si
+# vim: filetype=python ts=4 sw=4 et si

test/test_userauditor.py

@@ -0,0 +1,85 @@
+# $Id: test_userauditor.py,v 1.1 2007-08-31 15:57:47 jpend Exp $
+
+import os, unittest, shutil
+from db_test_base import setupTracker
+
+class UserAuditorTest(unittest.TestCase):
+    def setUp(self):
+        self.dirname = '_test_user_auditor'
+        self.instance = setupTracker(self.dirname)
+        self.db = self.instance.open('admin')
+
+        try:
+            import pytz
+            self.pytz = True
+        except ImportError:
+            self.pytz = False
+
+        self.db.user.create(username='kyle', address='[email protected]',
+            realname='Kyle Broflovski', roles='User')
+
+    def tearDown(self):
+        self.db.close()
+        try:
+            shutil.rmtree(self.dirname)
+        except OSError, error:
+            if error.errno not in (errno.ENOENT, errno.ESRCH): raise
+
+    def testBadTimezones(self):
+        self.assertRaises(ValueError, self.db.user.create, username='eric', timezone='24')
+
+        userid = self.db.user.lookup('kyle')
+
+        self.assertRaises(ValueError, self.db.user.set, userid, timezone='3000')
+        self.assertRaises(ValueError, self.db.user.set, userid, timezone='24')
+        self.assertRaises(ValueError, self.db.user.set, userid, timezone='-24')
+        self.assertRaises(ValueError, self.db.user.set, userid, timezone='-3000')
+
+        if self.pytz:
+            self.assertRaises(ValueError, self.db.user.set, userid, timezone='MiddleOf/Nowhere')
+
+    def testGoodTimezones(self):
+        self.db.user.create(username='test_user01', timezone='12')
+
+        if self.pytz:
+            self.db.user.create(username='test_user02', timezone='MST')
+
+        userid = self.db.user.lookup('kyle')
+
+        # TODO: roundup should accept non-integer offsets since those are valid
+        # this is the offset for Tehran, Iran
+        #self.db.user.set(userid, timezone='3.5')
+
+        self.db.user.set(userid, timezone='-23')
+        self.db.user.set(userid, timezone='23')
+        self.db.user.set(userid, timezone='0')
+
+        if self.pytz:
+            self.db.user.set(userid, timezone='US/Eastern')
+
+    def testBadEmailAddresses(self):
+        userid = self.db.user.lookup('kyle')
+        self.assertRaises(ValueError, self.db.user.set, userid, address='kyle @ example.com')
+
+    def testBadRoles(self):
+        userid = self.db.user.lookup('kyle')
+        self.assertRaises(ValueError, self.db.user.set, userid, roles='BadRole')
+        self.assertRaises(ValueError, self.db.user.set, userid, roles='User,BadRole')
+
+    def testGoodRoles(self):
+        # make sure we handle commas in weird places
+        self.db.user.set(userid, roles='User,')
+        self.db.user.set(userid, roles=',User')
+        # make sure we strip whitespace
+        self.db.user.set(userid, roles='    User   ')
+
+def test_suite():
+    suite = unittest.TestSuite()
+    suite.addTest(unittest.makeSuite(UserAuditorTest))
+    return suite
+
+if __name__ == '__main__':
+    runner = unittest.TextTestRunner()
+    unittest.main(testRunner=runner)
+
+# vim: filetype=python sts=4 sw=4 et si