base: Add query_return_extra

crobinso · crazyscientist · commit 794865f9c45d · 2024-02-15T09:36:07.000+01:00
This is like `query()`, but the return value is altered to be
(buglist, values), where `values` is raw dictionary output from
the API call, excluding the bug content. For example this may
include a `limit` value if the bugzilla instance puts an implied
limit on returned result numbers.

bugzilla.redhat.com also has a custom extension to report
`total_matches` for a query, which lets user know if the returned
results are complete or not

Signed-off-by: Cole Robinson &lt;crobinso@redhat.com&gt;
diff --git a/bugzilla/base.py b/bugzilla/base.py
@@ -1312,13 +1312,14 @@ def add_email(key, value, count):
         self.pre_translation(query)
         return query
 
-    def query(self, query):
-        """
-        Pass search terms to bugzilla and and return a list of matching
-        Bug objects.
 
-        See `build_query` for more details about constructing the
-        `query` dict parameter.
+    def query_return_extra(self, query):
+        """
+        Same as `query()`, but the return value is altered to be
+        (buglist, values), where `values` is raw dictionary output from
+        the API call, excluding the bug content. For example this may
+        include a `limit` value if the bugzilla instance puts an implied
+        limit on returned result numbers.
         """
         try:
             r = self._backend.bug_search(query)
@@ -1334,9 +1335,23 @@ def query(self, query):
                 "appear to support API queries derived from bugzilla "
                 "web URL queries." % e) from None
 
-        log.debug("Query returned %s bugs", len(r['bugs']))
-        return [Bug(self, dict=b,
-                autorefresh=self.bug_autorefresh) for b in r['bugs']]
+        rawbugs = r.pop("bugs")
+        log.debug("Query returned %s bugs", len(rawbugs))
+        bugs = [Bug(self, dict=b,
+                autorefresh=self.bug_autorefresh) for b in rawbugs]
+
+        return bugs, r
+
+    def query(self, query):
+        """
+        Pass search terms to bugzilla and and return a list of matching
+        Bug objects.
+
+        See `build_query` for more details about constructing the
+        `query` dict parameter.
+        """
+        bugs, dummy = self.query_return_extra(query)
+        return bugs
 
     def pre_translation(self, query):
         """
diff --git a/tests/data/mockreturn/test_query1.txt b/tests/data/mockreturn/test_query1.txt
@@ -1 +1 @@
-{'bugs': [{'assigned_to_detail': {'real_name': 'Libvirt Maintainers', 'email': 'libvirt-maint', 'name': 'libvirt-maint', 'id': 311982}, 'summary': 'RFE: qemu: Support a managed autoconnect mode for host USB devices', 'status': 'NEW', 'assigned_to': 'Libvirt Maintainers', 'id': 508645}, {'assigned_to_detail': {'real_name': 'Cole Robinson', 'email': 'crobinso', 'name': 'crobinso', 'id': 199727}, 'summary': 'RFE: warn users at guest start if networks/storage pools are inactive', 'status': 'NEW', 'assigned_to': 'Cole Robinson', 'id': 668543}]}
+{'bugs': [{'assigned_to_detail': {'real_name': 'Libvirt Maintainers', 'email': 'libvirt-maint', 'name': 'libvirt-maint', 'id': 311982}, 'summary': 'RFE: qemu: Support a managed autoconnect mode for host USB devices', 'status': 'NEW', 'assigned_to': 'Libvirt Maintainers', 'id': 508645}, {'assigned_to_detail': {'real_name': 'Cole Robinson', 'email': 'crobinso', 'name': 'crobinso', 'id': 199727}, 'summary': 'RFE: warn users at guest start if networks/storage pools are inactive', 'status': 'NEW', 'assigned_to': 'Cole Robinson', 'id': 668543}], 'limit': 0, 'FOOFAKEVALUE': 'hello'}
diff --git a/tests/test_api_misc.py b/tests/test_api_misc.py
@@ -305,3 +305,12 @@ def test_query_url_fail():
         bz.query(query)
     except Exception as e:
         assert checkstr not in str(e)
+
+
+def test_query_return_extra():
+    bz = tests.mockbackend.make_bz(version="5.1.0",
+            bug_search_args=None,
+            bug_search_return="data/mockreturn/test_query1.txt")
+    dummy, extra = bz.query_return_extra({})
+    assert extra['limit'] == 0
+    assert extra['FOOFAKEVALUE'] == "hello"

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		-{'bugs': [{'assigned_to_detail': {'real_name': 'Libvirt Maintainers', 'email': 'libvirt-maint', 'name': 'libvirt-maint', 'id': 311982}, 'summary': 'RFE: qemu: Support a managed autoconnect mode for host USB devices', 'status': 'NEW', 'assigned_to': 'Libvirt Maintainers', 'id': 508645}, {'assigned_to_detail': {'real_name': 'Cole Robinson', 'email': 'crobinso', 'name': 'crobinso', 'id': 199727}, 'summary': 'RFE: warn users at guest start if networks/storage pools are inactive', 'status': 'NEW', 'assigned_to': 'Cole Robinson', 'id': 668543}]}
	`1`	+{'bugs': [{'assigned_to_detail': {'real_name': 'Libvirt Maintainers', 'email': 'libvirt-maint', 'name': 'libvirt-maint', 'id': 311982}, 'summary': 'RFE: qemu: Support a managed autoconnect mode for host USB devices', 'status': 'NEW', 'assigned_to': 'Libvirt Maintainers', 'id': 508645}, {'assigned_to_detail': {'real_name': 'Cole Robinson', 'email': 'crobinso', 'name': 'crobinso', 'id': 199727}, 'summary': 'RFE: warn users at guest start if networks/storage pools are inactive', 'status': 'NEW', 'assigned_to': 'Cole Robinson', 'id': 668543}], 'limit': 0, 'FOOFAKEVALUE': 'hello'}