HTML* classes for cgi are now all new-style

Add regression test for old behaviour: Lookup of a value of a
HTMLProperty was possibly via getitem -- for old-style classes this
worked because __getattr__ returned the __getitem__ of a newly created
HTMLItem object, this does no longer work for new-style classes as these
look up special method only on the class not the instance.

Author: schlatterbeck

roundup/cgi/templating.py

@@ -398,7 +398,7 @@ def input_xhtml(**attrs):
     _set_input_default_args(attrs)
     return '<input %s/>'%cgi_escape_attrs(**attrs)
 
-class HTMLInputMixin:
+class HTMLInputMixin(object):
     """ requires a _client property """
     def __init__(self):
         html_version = 'html4'
@@ -421,7 +421,7 @@ def gettext(self, msgid):
 
     _ = gettext
 
-class HTMLPermissions:
+class HTMLPermissions(object):
 
     def view_check(self):
         """ Raise the Unauthorised exception if the user's not permitted to
@@ -1903,7 +1903,7 @@ def field(self, size=30, **kwargs):
         return self.input(name=self._formname, value=value, size=size,
                           **kwargs)
 
-class LinkHTMLProperty(HTMLProperty, object):
+class LinkHTMLProperty(HTMLProperty):
     """ Link HTMLProperty
         Include the above as well as being able to access the class
         information. Stringifying the object itself results in the value
@@ -1912,9 +1912,6 @@ class LinkHTMLProperty(HTMLProperty, object):
         property accessed (so item/assignedto/name would look up the user
         entry identified by the assignedto property on item, and then the
         name property of that user)
-
-        (Has been turned into a new-style class to enable comparisons
-        of values with None, see issue2550830.)
     """
     def __init__(self, *args, **kw):
         HTMLProperty.__init__(self, *args, **kw)
@@ -1936,6 +1933,14 @@ def nothing(*args, **kw):
         i = HTMLItem(self._client, self._prop.classname, self._value)
         return getattr(i, attr)
 
+    def __getitem__(self, item):
+        """Explicitly define __getitem__ -- this used to work earlier
+           due to __getattr__ returning the __getitem__ of HTMLItem -- this
+           lookup doesn't work for new-style classes.
+        """
+        i = HTMLItem(self._client, self._prop.classname, self._value)
+        return i[item]
+
     def plain(self, escape=0):
         """ Render a "plain" representation of the property
         """
@@ -3006,7 +3011,7 @@ def html_calendar(self, request):
         res.append('</table></td></tr></table>')
         return "\n".join(res)
 
-class MissingValue:
+class MissingValue(object):
     def __init__(self, description, **kwargs):
         self.__description = description
         for key, value in kwargs.items():

test/db_test_base.py

@@ -25,6 +25,7 @@
 from roundup.mailer import Mailer
 from roundup import date, password, init, instance, configuration, \
     roundupdb, i18n
+from roundup.cgi.templating import HTMLItem
 
 from mocknull import MockNull
 
@@ -2428,18 +2429,27 @@ def testFilteringTransitiveLinkCache(self):
         ae (result, ['4', '5', '6', '7', '8', '1', '2', '3'])
 
 
-class ClassicInitTest(unittest.TestCase):
+class ClassicInitBase(unittest.TestCase):
     count = 0
     db = None
 
     def setUp(self):
-        ClassicInitTest.count = ClassicInitTest.count + 1
+        ClassicInitBase.count = ClassicInitBase.count + 1
         self.dirname = '_test_init_%s'%self.count
         try:
             shutil.rmtree(self.dirname)
         except OSError, error:
             if error.errno not in (errno.ENOENT, errno.ESRCH): raise
 
+    def tearDown(self):
+        if self.db is not None:
+            self.db.close()
+        try:
+            shutil.rmtree(self.dirname)
+        except OSError, error:
+            if error.errno not in (errno.ENOENT, errno.ESRCH): raise
+
+class ClassicInitTest(ClassicInitBase):
     def testCreation(self):
         ae = self.assertEqual
 
@@ -2467,15 +2477,8 @@ def testCreation(self):
         l = db.issue.list()
         ae(l, [])
 
-    def tearDown(self):
-        if self.db is not None:
-            self.db.close()
-        try:
-            shutil.rmtree(self.dirname)
-        except OSError, error:
-            if error.errno not in (errno.ENOENT, errno.ESRCH): raise
 
-class ConcurrentDBTest(ClassicInitTest):
+class ConcurrentDBTest(ClassicInitBase):
     def testConcurrency(self):
         # The idea here is a read-modify-update cycle in the presence of
         # a cache that has to be properly handled. The same applies if
@@ -2506,5 +2509,73 @@ def inc(db):
         self.assertEqual(db2.priority.get(prio, 'order'), 3.0)
         db2.close()
 
+class HTMLItemTest(ClassicInitBase):
+    class Request :
+        """ Fake html request """
+        rfile = None
+        def start_response (self, a, b) :
+            pass
+        # end def start_response
+    # end class Request
+
+    def setUp(self):
+        super(HTMLItemTest, self).setUp()    
+        self.tracker = tracker = setupTracker(self.dirname, self.backend)
+        db = self.db = tracker.open('admin')
+        req = self.Request()
+        env = dict (PATH_INFO='', REQUEST_METHOD='GET', QUERY_STRING='')
+        self.client = self.tracker.Client(self.tracker, req, env, None)
+        self.client.db = db
+        self.client.language = None
+        self.client.userid = db.getuid()
+        self.client.classname = 'issue'
+        user = {'username': 'worker5', 'realname': 'Worker', 'roles': 'User'}
+        u = self.db.user.create(**user)
+        u_m = self.db.msg.create(author = u, content = 'bla'
+            , date = date.Date ('2006-01-01'))
+        issue = {'title': 'ts1', 'status': '2', 'assignedto': '3',
+                'priority': '3', 'messages' : [u_m], 'nosy' : ['3']}
+        self.db.issue.create(**issue)
+
+    def testHTMLItemAttributes(self):
+        issue = HTMLItem(self.client, 'issue', '1')
+        ae = self.assertEqual
+        ae(issue.title.plain(),'ts1')
+        ae(issue ['title'].plain(),'ts1')
+        ae(issue.status.plain(),'deferred')
+        ae(issue ['status'].plain(),'deferred')
+        ae(issue.assignedto.plain(),'worker5')
+        ae(issue ['assignedto'].plain(),'worker5')
+        ae(issue.priority.plain(),'bug')
+        ae(issue ['priority'].plain(),'bug')
+        ae(issue.messages.plain(),'1')
+        ae(issue ['messages'].plain(),'1')
+        ae(issue.nosy.plain(),'worker5')
+        ae(issue ['nosy'].plain(),'worker5')
+        ae(len(issue.messages),1)
+        ae(len(issue ['messages']),1)
+        ae(len(issue.nosy),1)
+        ae(len(issue ['nosy']),1)
+
+    def testHTMLItemDereference(self):
+        issue = HTMLItem(self.client, 'issue', '1')
+        ae = self.assertEqual
+        ae(str(issue.priority.name),'bug')
+        ae(str(issue.priority['name']),'bug')
+        ae(str(issue ['priority']['name']),'bug')
+        ae(str(issue ['priority'].name),'bug')
+        ae(str(issue.assignedto.username),'worker5')
+        ae(str(issue.assignedto['username']),'worker5')
+        ae(str(issue ['assignedto']['username']),'worker5')
+        ae(str(issue ['assignedto'].username),'worker5')
+        for n in issue.nosy:
+            ae(n.username.plain(),'worker5')
+            ae(n['username'].plain(),'worker5')
+        for n in issue.messages:
+            ae(n.author.username.plain(),'worker5')
+            ae(n.author['username'].plain(),'worker5')
+            ae(n['author'].username.plain(),'worker5')
+            ae(n['author']['username'].plain(),'worker5')
+
 
 # vim: set et sts=4 sw=4 :

test/test_anydbm.py

@@ -19,6 +19,7 @@
 from roundup.backends import get_backend
 
 from db_test_base import DBTest, ROTest, SchemaTest, ClassicInitTest, config
+from db_test_base import HTMLItemTest
 
 class anydbmOpener:
     module = get_backend('anydbm')
@@ -38,6 +39,9 @@ class anydbmSchemaTest(anydbmOpener, SchemaTest):
 class anydbmClassicInitTest(ClassicInitTest):
     backend = 'anydbm'
 
+class anydbmHTMLItemTest(HTMLItemTest):
+    backend = 'anydbm'
+
 from session_common import DBMTest
 class anydbmSessionTest(anydbmOpener, DBMTest):
     pass
@@ -49,6 +53,7 @@ def test_suite():
     suite.addTest(unittest.makeSuite(anydbmROTest))
     suite.addTest(unittest.makeSuite(anydbmSchemaTest))
     suite.addTest(unittest.makeSuite(anydbmClassicInitTest))
+    suite.addTest(unittest.makeSuite(anydbmHTMLItemTest))
     suite.addTest(unittest.makeSuite(anydbmSessionTest))
     return suite
 

test/test_mysql.py

@@ -21,7 +21,7 @@
 from roundup.backends import get_backend, have_backend
 
 from db_test_base import DBTest, ROTest, config, SchemaTest, ClassicInitTest
-from db_test_base import ConcurrentDBTest, FilterCacheTest
+from db_test_base import ConcurrentDBTest, HTMLItemTest, FilterCacheTest
 
 
 class mysqlOpener:
@@ -71,6 +71,15 @@ def tearDown(self):
         ConcurrentDBTest.tearDown(self)
         self.nuke_database()
 
+class mysqlHTMLItemTest(mysqlOpener, HTMLItemTest):
+    backend = 'mysql'
+    def setUp(self):
+        mysqlOpener.setUp(self)
+        HTMLItemTest.setUp(self)
+    def tearDown(self):
+        HTMLItemTest.tearDown(self)
+        self.nuke_database()
+
 class mysqlFilterCacheTest(mysqlOpener, FilterCacheTest):
     backend = 'mysql'
     def setUp(self):
@@ -110,6 +119,7 @@ def test_suite():
         suite.addTest(unittest.makeSuite(mysqlClassicInitTest))
         suite.addTest(unittest.makeSuite(mysqlSessionTest))
         suite.addTest(unittest.makeSuite(mysqlConcurrencyTest))
+        suite.addTest(unittest.makeSuite(mysqlHTMLItemTest))
         suite.addTest(unittest.makeSuite(mysqlFilterCacheTest))
     return suite
 

test/test_postgresql.py

@@ -20,7 +20,7 @@
 from roundup.hyperdb import DatabaseError
 
 from db_test_base import DBTest, ROTest, config, SchemaTest, ClassicInitTest
-from db_test_base import ConcurrentDBTest, FilterCacheTest
+from db_test_base import ConcurrentDBTest, HTMLItemTest, FilterCacheTest
 
 from roundup.backends import get_backend, have_backend
 
@@ -66,6 +66,16 @@ def tearDown(self):
         ConcurrentDBTest.tearDown(self)
         postgresqlOpener.tearDown(self)
 
+class postgresqlHTMLItemTest(postgresqlOpener, HTMLItemTest):
+    backend = 'postgresql'
+    def setUp(self):
+        postgresqlOpener.setUp(self)
+        HTMLItemTest.setUp(self)
+
+    def tearDown(self):
+        HTMLItemTest.tearDown(self)
+        postgresqlOpener.tearDown(self)
+
 class postgresqlFilterCacheTest(postgresqlOpener, FilterCacheTest):
     backend = 'postgresql'
     def setUp(self):
@@ -122,6 +132,7 @@ def test_suite():
     suite.addTest(unittest.makeSuite(postgresqlClassicInitTest))
     suite.addTest(unittest.makeSuite(postgresqlSessionTest))
     suite.addTest(unittest.makeSuite(postgresqlConcurrencyTest))
+    suite.addTest(unittest.makeSuite(postgresqlHTMLItemTest))
     suite.addTest(unittest.makeSuite(postgresqlFilterCacheTest))
     return suite