Changeset 14785

Timestamp:

Jul 11, 2015, 2:53:25 PM (9 years ago)

Author:

Steffen Hoffmann

Message:

TagsPlugin: Catch inappropriate macro arguments for ListTagged, refs #12292.

Thanks for the patch including unit tests by Ryan J. Ollos, applied here
with minor modifications.

Location:

tagsplugin/trunk

Files:

• changelog (modified) (1 diff)
• tractags/macros.py (modified) (4 diffs)
• tractags/tests/macros.py (modified) (5 diffs)

tagsplugin/trunk/changelog

@@ -8 +8 @@
  * #11950: The tag TracLink doesn't allow trailing arguments
    by supporting the 'realm' attribute in tag query expressions
+ * #12292: AssertionError: Page 5 out of range
 
  new features

tagsplugin/trunk/tractags/macros.py

@@ -3 +3 @@
 # Copyright (C) 2006 Alec Thomas <alec@swapoff.org>
 # Copyright (C) 2011 Itamar Ostricher <itamarost@gmail.com>
-# Copyright (C) 2011-2014 Steffen Hoffmann <hoff.st@web.de>
+# Copyright (C) 2011-2015 Steffen Hoffmann <hoff.st@web.de>
+# Copyright (C) 2015 Ryan J Ollos <ryan.j.ollos@gmail.com>
 #
 # This software is licensed as described in the file COPYING, which
@@ -15 +16 @@
 
 from trac.config import BoolOption, ListOption, Option
-from trac.core import Component, implements
+from trac.core import Component, TracError, implements
 from trac.resource import Resource, get_resource_description, \
                           get_resource_url, render_resource_link
@@ -357 +358 @@
                 continue
             if ul:
-                # Found new tag for cloud; now add previously prepared one. 
+                # Found new tag for cloud; now add previously prepared one.
                 ul('\n', li)
             else:
@@ -372 +373 @@
     def _paginate(self, req, results, realms):
         query = req.args.get('q', None)
-        current_page = as_int(req.args.get('listtagged_page'), 1)
-        items_per_page = as_int(req.args.get('listtagged_per_page'), None)
-        if items_per_page is None:
+        current_page = as_int(req.args.get('listtagged_page'), 1, min=1)
+        items_per_page = as_int(req.args.get('listtagged_per_page'),
+                                self.items_per_page)
+        if items_per_page < 1:
             items_per_page = self.items_per_page
-        result = Paginator(results, current_page - 1, items_per_page)
+        try:
+            result = Paginator(results, current_page - 1, items_per_page)
+        except (AssertionError, TracError), e:
+            self.log.warn("ListTagged macro: %s", e)
+            current_page = 1
+            result = Paginator(results, current_page - 1, items_per_page)
 
         pagedata = []

tagsplugin/trunk/tractags/tests/macros.py

@@ -4 +4 @@
 # Copyright (C) 2012-2014 Steffen Hoffmann <hoff.st@web.de>
 # Copyright (C) 2014 Jun Omae <jun66j5@gmail.com>
+# Copyright (C) 2015 Ryan J Ollos <ryan.j.ollos@gmail.com>
 #
 # This software is licensed as described in the file COPYING, which
@@ -50 +51 @@
                        % self.db.like(), ('TAGS_%',))
 
+    def _insert_tags(self, tagspace, name, tags):
+        cursor = self.db.cursor()
+        args = [(tagspace, name, tag) for tag in tags]
+        cursor.executemany("INSERT INTO tags (tagspace,name,tag) "
+                           "VALUES (%s,%s,%s)", args)
+
 
 class TagTemplateProviderTestCase(_BaseTestCase):
@@ -65 +72 @@
 
 class ListTaggedMacroTestCase(_BaseTestCase):
-    
+
     def setUp(self):
         _BaseTestCase.setUp(self)
@@ -82 +89 @@
                         str(self.tag_twm.expand_macro(formatter,
                                                       'ListTagged', '')))
+
+    def _test_listtagged_paginate(self, page, per_page=2):
+        self._insert_tags('wiki', 'InterTrac', ('blah',))
+        self._insert_tags('wiki', 'InterWiki', ('blah',))
+        self._insert_tags('wiki', 'WikiStart', ('blah',))
+        self.req.args['listtagged_per_page'] = per_page
+        self.req.args['listtagged_page'] = page
+        context = Mock(env=self.env, href=Href('/'), req=self.req)
+        formatter = Mock(context=context, req=self.req)
+        result = \
+            unicode(self.tag_twm.expand_macro(formatter, 'ListTagged', 'blah'))
+        return result
+
+    def test_listtagged_paginate_page1(self):
+        """Paginate results for page 1 has two items."""
+        result = self._test_listtagged_paginate(1)
+        self.assertTrue('InterTrac' in result)
+        self.assertTrue('InterWiki' in result)
+        self.assertFalse('WikiStart' in result)
+
+    def test_listtagged_paginate_page2(self):
+        """Paginate results for page 2 has one item."""
+        result = self._test_listtagged_paginate(2)
+        self.assertFalse('InterTrac' in result)
+        self.assertFalse('InterWiki' in result)
+        self.assertTrue('WikiStart' in result)
+
+    def test_listtagged_paginate_page_out_of_range(self):
+        """Out of range page defaults to 1."""
+        result = self._test_listtagged_paginate(3)
+        self.assertTrue('InterTrac' in result)
+        self.assertTrue('InterWiki' in result)
+        self.assertFalse('WikiStart' in result)
+
+    def test_listtagged_paginate_page_invalid(self):
+        """Invalid page default to 1."""
+        result = self._test_listtagged_paginate(-1)
+        self.assertTrue('InterTrac' in result)
+        self.assertTrue('InterWiki' in result)
+        self.assertFalse('WikiStart' in result)
+
+    def test_listtagged_paginate_per_page_invalid(self):
+        """Invalid per_page defaults to items_per_page (100)."""
+        result = self._test_listtagged_paginate(2, -1)
+        self.assertTrue('InterTrac' in result)
+        self.assertTrue('InterWiki' in result)
+        self.assertTrue('WikiStart' in result)
 
 
@@ -102 +156 @@
     def _expand_macro(self, content):
         return self.tag_twm.expand_macro(self.formatter, 'TagCloud', content)
-
-    def _insert_tags(self, tagspace, name, tags):
-        cursor = self.db.cursor()
-        args = [(tagspace, name, tag) for tag in tags]
-        cursor.executemany("INSERT INTO tags (tagspace,name,tag) "
-                           "VALUES (%s,%s,%s)", args)
 
     # Tests