Commit: ff74de6ff9840e44229fa8dbf8272e63189eb624 - allura (git)

allura

Commit MetaInfo

• Revisión: ff74de6ff9840e44229fa8dbf8272e63189eb624 (tree)
• Tiempo: 2012-07-11 12:45:16
• Autor: Dave Brondsema <dbrondsema@geek...>
• Commiter: Dave Brondsema

Log Message

[#4272] add rest API for ticket searches; refactor paged_search to better name & location

Cambiar Resumen

• modified: ForgeTracker/forgetracker/model/ticket.py
• modified: ForgeTracker/forgetracker/tests/functional/test_rest.py
• modified: ForgeTracker/forgetracker/tests/unit/test_root_controller.py
• modified: ForgeTracker/forgetracker/tracker_main.py

Diferencia incremental

--- a/ForgeTracker/forgetracker/model/ticket.py
+++ b/ForgeTracker/forgetracker/model/ticket.py
@@ -578,7 +578,11 @@ class Ticket(VersionedArtifact, ActivityObject):
 
     @classmethod
     def paged_query(cls, query, limit=None, page=0, sort=None, columns=None, **kw):
-        """Query tickets, sorting and paginating the result."""
+        """
+        Query tickets, filtering for 'read' permission, sorting and paginating the result.
+
+        See also paged_search which does a solr search
+        """
         limit, page, start = g.handle_paging(limit, page, default=25)
         q = cls.query.find(dict(query, app_config_id=c.app.config._id))
         q = q.sort('ticket_num')
@@ -616,6 +620,78 @@ class Ticket(VersionedArtifact, ActivityObject):
             count=count, q=json.dumps(query), limit=limit, page=page, sort=sort,
             **kw)
 
+    @classmethod
+    def paged_search(cls, q, limit=None, page=0, sort=None, columns=None, **kw):
+        """Query tickets from Solr, filtering for 'read' permission, sorting and paginating the result.
+
+        See also paged_query which does a mongo search.
+
+        We do the sorting and skipping right in SOLR, before we ever ask
+        Mongo for the actual tickets.  Other keywords for
+        search_artifact (e.g., history) or for SOLR are accepted through
+        kw.  The output is intended to be used directly in templates,
+        e.g., exposed controller methods can just:
+
+            return paged_query(q, ...)
+
+        If you want all the results at once instead of paged you have
+        these options:
+          - don't call this routine, search directly in mongo
+          - call this routine with a very high limit and TEST that
+            count<=limit in the result
+        limit=-1 is NOT recognized as 'all'.  500 is a reasonable limit.
+        """
+
+        limit, page, start = g.handle_paging(limit, page, default=25)
+        count = 0
+        tickets = []
+        refined_sort = sort if sort else 'ticket_num_i asc'
+        if  'ticket_num_i' not in refined_sort:
+            refined_sort += ',ticket_num_i asc'
+        try:
+            if q:
+                matches = search_artifact(
+                    cls, q,
+                    rows=limit, sort=refined_sort, start=start, fl='ticket_num_i', **kw)
+            else:
+                matches = None
+            solr_error = None
+        except ValueError, e:
+            solr_error = e.args[0]
+            matches = []
+        if matches:
+            count = matches.hits
+            # ticket_numbers is in sorted order
+            ticket_numbers = [match['ticket_num_i'] for match in matches.docs]
+            # but query, unfortunately, returns results in arbitrary order
+            query = cls.query.find(dict(app_config_id=c.app.config._id, ticket_num={'$in':ticket_numbers}))
+            # so stick all the results in a dictionary...
+            ticket_for_num = {}
+            for t in query:
+                ticket_for_num[t.ticket_num] = t
+            # and pull them out in the order given by ticket_numbers
+            tickets = []
+            for tn in ticket_numbers:
+                if tn in ticket_for_num:
+                    if security.has_access(ticket_for_num[tn], 'read'):
+                        tickets.append(ticket_for_num[tn])
+                    else:
+                        count = count -1
+        sortable_custom_fields=c.app.globals.sortable_custom_fields_shown_in_search()
+        if not columns:
+            columns = [dict(name='ticket_num', sort_name='ticket_num_i', label='Ticket Number', active=True),
+                       dict(name='summary', sort_name='snippet_s', label='Summary', active=True),
+                       dict(name='_milestone', sort_name='_milestone_s', label='Milestone', active=True),
+                       dict(name='status', sort_name='status_s', label='Status', active=True),
+                       dict(name='assigned_to', sort_name='assigned_to_s', label='Owner', active=True)]
+            for field in sortable_custom_fields:
+                columns.append(dict(name=field['name'], sort_name=field['sortable_name'], label=field['label'], active=True))
+        return dict(tickets=tickets,
+                    sortable_custom_fields=sortable_custom_fields,
+                    columns=columns,
+                    count=count, q=q, limit=limit, page=page, sort=sort,
+                    solr_error=solr_error, **kw)
+
 class TicketAttachment(BaseAttachment):
     thumbnail_size = (100, 100)
     ArtifactType=Ticket

--- a/ForgeTracker/forgetracker/tests/functional/test_rest.py
+++ b/ForgeTracker/forgetracker/tests/functional/test_rest.py
@@ -3,10 +3,14 @@ pylons.c = pylons.tmpl_context
 pylons.g = pylons.app_globals
 from pylons import c
 
+from datadiff.tools import assert_equal
+from mock import patch
+
 from allura.lib import helpers as h
 from allura.tests import decorators as td
 from alluratest.controller import TestRestApiBase
 
+from forgetracker import model as TM
 
 class TestTrackerApiBase(TestRestApiBase):
 
@@ -113,3 +117,36 @@ class TestRestDiscussion(TestTrackerApiBase):
         assert reply.json['post']['text'] == 'This is a reply', reply.json
         thread = self.api_get('/rest/p/test/bugs/_discuss/thread/%s/' % discussion['threads'][0]['_id'])
         assert len(thread.json['thread']['posts']) == 2, thread.json
+
+class TestRestSearch(TestTrackerApiBase):
+
+    @patch('forgetracker.model.Ticket.paged_search')
+    def test_no_criteria(self, paged_search):
+        paged_search.return_value = dict(tickets=[
+            TM.Ticket(ticket_num=5, summary='our test ticket'),
+        ])
+        r = self.api_get('/rest/p/test/bugs/search')
+        assert_equal(r.status_int, 200)
+        assert_equal(r.json, {'tickets':[
+            {'summary': 'our test ticket', 'ticket_num': 5},
+        ]})
+
+    @patch('forgetracker.model.Ticket.paged_search')
+    def test_some_criteria(self, paged_search):
+        q = 'labels:testing && status:open'
+        paged_search.return_value = dict(tickets=[
+                TM.Ticket(ticket_num=5, summary='our test ticket'),
+            ],
+            sort='status',
+            limit=2,
+            count=1,
+            page=0,
+            q=q,
+        )
+        r = self.api_get('/rest/p/test/bugs/search', q=q, sort='status', limit='2')
+        assert_equal(r.status_int, 200)
+        assert_equal(r.json, {'limit': 2, 'q': q, 'sort':'status', 'count': 1,
+                               'page': 0, 'tickets':[
+                {'summary': 'our test ticket', 'ticket_num': 5},
+            ]
+        })

--- a/ForgeTracker/forgetracker/tests/unit/test_root_controller.py
+++ b/ForgeTracker/forgetracker/tests/unit/test_root_controller.py
@@ -49,7 +49,7 @@ def solr_search_returning_colors_are_wrong_ticket():
     matches = Mock()
     matches.docs = [dict(ticket_num_i=ticket.ticket_num)]
     search_artifact.return_value = matches
-    return patch('forgetracker.tracker_main.search_artifact', search_artifact)
+    return patch('forgetracker.model.ticket.search_artifact', search_artifact)
 
 def mongo_search_returning_colors_are_wrong_ticket():
     ticket = create_colors_are_wrong_ticket()
@@ -82,4 +82,3 @@ def create_ticket(summary, custom_fields):
                     custom_fields=custom_fields)
     session(ticket).flush()
     return ticket
-

--- a/ForgeTracker/forgetracker/tracker_main.py
+++ b/ForgeTracker/forgetracker/tracker_main.py
@@ -331,75 +331,6 @@ class RootController(BaseController):
             bin_counts.append(dict(label=label, count=count))
         return dict(bin_counts=bin_counts)
 
-    def paged_query(self, q, limit=None, page=0, sort=None, columns=None, **kw):
-        """Query tickets, filtering for 'read' permission, sorting and paginating the result.
-
-        We do the sorting and skipping right in SOLR, before we ever ask
-        Mongo for the actual tickets.  Other keywords for
-        search_artifact (e.g., history) or for SOLR are accepted through
-        kw.  The output is intended to be used directly in templates,
-        e.g., exposed controller methods can just:
-
-            return paged_query(q, ...)
-
-        If you want all the results at once instead of paged you have
-        these options:
-          - don't call this routine, search directly in mongo
-          - call this routine with a very high limit and TEST that
-            count<=limit in the result
-        limit=-1 is NOT recognized as 'all'.  500 is a reasonable limit.
-        """
-
-        limit, page, start = g.handle_paging(limit, page, default=25)
-        count = 0
-        tickets = []
-        refined_sort = sort if sort else 'ticket_num_i asc'
-        if  'ticket_num_i' not in refined_sort:
-            refined_sort += ',ticket_num_i asc'
-        try:
-            if q:
-                matches = search_artifact(
-                    TM.Ticket, q,
-                    rows=limit, sort=refined_sort, start=start, fl='ticket_num_i', **kw)
-            else:
-                matches = None
-            solr_error = None
-        except ValueError, e:
-            solr_error = e.args[0]
-            matches = []
-        if matches:
-            count = matches.hits
-            # ticket_numbers is in sorted order
-            ticket_numbers = [match['ticket_num_i'] for match in matches.docs]
-            # but query, unfortunately, returns results in arbitrary order
-            query = TM.Ticket.query.find(dict(app_config_id=c.app.config._id, ticket_num={'$in':ticket_numbers}))
-            # so stick all the results in a dictionary...
-            ticket_for_num = {}
-            for t in query:
-                ticket_for_num[t.ticket_num] = t
-            # and pull them out in the order given by ticket_numbers
-            tickets = []
-            for tn in ticket_numbers:
-                if tn in ticket_for_num:
-                    if has_access(ticket_for_num[tn], 'read'):
-                        tickets.append(ticket_for_num[tn])
-                    else:
-                        count = count -1
-        sortable_custom_fields=c.app.globals.sortable_custom_fields_shown_in_search()
-        if not columns:
-            columns = [dict(name='ticket_num', sort_name='ticket_num_i', label='Ticket Number', active=True),
-                       dict(name='summary', sort_name='snippet_s', label='Summary', active=True),
-                       dict(name='_milestone', sort_name='_milestone_s', label='Milestone', active=True),
-                       dict(name='status', sort_name='status_s', label='Status', active=True),
-                       dict(name='assigned_to', sort_name='assigned_to_s', label='Owner', active=True)]
-            for field in sortable_custom_fields:
-                columns.append(dict(name=field['name'], sort_name=field['sortable_name'], label=field['label'], active=True))
-        return dict(tickets=tickets,
-                    sortable_custom_fields=sortable_custom_fields,
-                    columns=columns,
-                    count=count, q=q, limit=limit, page=page, sort=sort,
-                    solr_error=solr_error, **kw)
-
     @with_trailing_slash
     @h.vardec
     @expose('jinja:forgetracker:templates/tracker/index.html')
@@ -506,7 +437,7 @@ class RootController(BaseController):
             bin = TM.Bin.query.find(dict(app_config_id=c.app.config._id,terms=q)).first()
         if project:
             redirect(c.project.url() + 'search?' + urlencode(dict(q=q, history=kw.get('history'))))
-        result = self.paged_query(q, page=page, sort=sort, columns=columns, **kw)
+        result = TM.Ticket.paged_search(q, page=page, sort=sort, columns=columns, **kw)
         result['allow_edit'] = has_access(c.app, 'update')()
         result['bin'] = bin
         result['help_msg'] = c.app.config.options.get('TicketHelpSearch')
@@ -520,7 +451,7 @@ class RootController(BaseController):
     def search_feed(self, q=None, query=None, project=None, columns=None, page=0, sort=None, **kw):
         if query and not q:
             q = query
-        result = self.paged_query(q, page=page, sort=sort, columns=columns, **kw)
+        result = TM.Ticket.paged_search(q, page=page, sort=sort, columns=columns, **kw)
         response.headers['Content-Type'] = ''
         response.content_type = 'application/xml'
         d = dict(title='Ticket search results', link=h.absurl(c.app.url), description='You searched for %s' % q, language=u'en')
@@ -623,7 +554,7 @@ class RootController(BaseController):
                    sort=validators.UnicodeString(if_empty='ticket_num_i asc')))
     def edit(self, q=None, limit=None, page=None, sort=None, **kw):
         require_access(c.app, 'update')
-        result = self.paged_query(q, sort=sort, limit=limit, page=page, **kw)
+        result = TM.Ticket.paged_search(q, sort=sort, limit=limit, page=page, **kw)
         # if c.app.globals.milestone_names is None:
         #     c.app.globals.milestone_names = ''
         result['globals'] = c.app.globals
@@ -1386,6 +1317,15 @@ class RootRestController(BaseController):
             log.exception(e)
             return dict(status=False, errors=[str(e)])
 
+    @expose('json:')
+    def search(self, q=None, limit=100, page=0, sort=None, **kw):
+        results = TM.Ticket.paged_search(q, limit, page, sort)
+        results['tickets'] = [dict(ticket_num=t.ticket_num, summary=t.summary)
+                              for t in results['tickets']]
+        results.pop('sortable_custom_fields', None)
+        results.pop('columns', None)
+        return results
+
     @expose()
     def _lookup(self, ticket_num, *remainder):
         return TicketRestController(ticket_num), remainder