Allow for either q or query parameters in get_search_result method

Author: emlaver

src/cloudant/database.py

@@ -1291,8 +1291,9 @@ def get_search_result(self, ddoc_id, index_name, **query_params):
         :param int limit: Optional number to limit the maximum count of the
             returned documents. In case of a grouped search, this parameter
             limits the number of documents per group.
-        :param query: A Lucene query in the form of ``name:value``.
+        :param query/q: A Lucene query in the form of ``name:value``.
             If name is omitted, the special value ``default`` is used.
+            The ``query`` parameter can be abbreviated as ``q``.
         :param ranges: Optional JSON facet syntax that reuses the standard
             Lucene syntax to return counts of results which fit into each
             specified category. Inclusive range queries are denoted by brackets.
@@ -1325,10 +1326,13 @@ def get_search_result(self, ddoc_id, index_name, **query_params):
 
         :returns: Search query result data in JSON format
         """
-        if not query_params.get('query'):
+        param_q = query_params.get('q')
+        param_query = query_params.get('query')
+        # Either q or query parameter is required
+        if bool(param_q) == bool(param_query):
             raise CloudantArgumentError(
-                'No query parameter found.  Please add a query parameter '
-                'containing Lucene syntax and retry.')
+                'A single query/q parameter is required. '
+                'Found: {0}'.format(query_params))
 
         # Validate query arguments and values
         for key, val in iteritems_(query_params):

tests/unit/database_tests.py

@@ -1207,6 +1207,20 @@ def test_get_search_result_with_invalid_argument(self):
         err = cm.exception
         self.assertEqual(str(err), 'Invalid argument: foo')
 
+    def test_get_search_result_with_both_q_and_query(self):
+        """
+        Test get_search_result by passing in both a q and query parameter
+        """
+        with self.assertRaises(CloudantArgumentError) as cm:
+            self.db.get_search_result('searchddoc001', 'searchindex001',
+                                      query='julia*', q='julia*')
+        err = cm.exception
+        self.assertEqual(
+            str(err),
+            'A single query/q parameter is required. '
+            'Found: {\'q\': \'julia*\', \'query\': \'julia*\'}'
+        )
+
     def test_get_search_result_with_invalid_value_types(self):
         """
         Test get_search_result by passing in invalid value types for
@@ -1252,8 +1266,8 @@ def test_get_search_result_without_query(self):
         err = cm.exception
         self.assertEqual(
             str(err),
-            'No query parameter found.  Please add a query parameter '
-            'containing Lucene syntax and retry.'
+            'A single query/q parameter is required. '
+            'Found: {\'limit\': 10, \'include_docs\': True}'
         )
 
     def test_get_search_result_with_invalid_query_type(self):
@@ -1271,7 +1285,7 @@ def test_get_search_result_with_invalid_query_type(self):
 
     def test_get_search_result_executes_search_query(self):
         """
-        Test get_search_result executes a search query
+        Test get_search_result executes a search with query parameter.
         """
         self.create_search_index()
         self.populate_db_with_documents(100)
@@ -1313,6 +1327,28 @@ def test_get_search_result_executes_search_query(self):
                        'id': 'julia004', 'order': ['julia004', 1]}], 'total_rows': 100}
         )
 
+    def test_get_search_result_executes_search_q(self):
+        """
+        Test get_search_result executes a search query with q parameter.
+        """
+        self.create_search_index()
+        self.populate_db_with_documents(100)
+        resp = self.db.get_search_result(
+            'searchddoc001',
+            'searchindex001',
+            query='julia*',
+            sort='_id<string>',
+            limit=1
+        )
+        self.assertEqual(len(resp['rows']), 1)
+        self.assertTrue(resp['bookmark'])
+        resp.pop('bookmark')
+        self.assertEqual(
+            resp,
+            {'rows': [{'fields': {'name': 'julia'}, 'id': 'julia000',
+                       'order': ['julia000', 0]}], 'total_rows': 100}
+        )
+
     def test_get_search_result_executes_search_query_with_group_option(self):
         """
         Test get_search_result executes a search query with grouping parameters.