rhbugzilla: Move external_bug API wrappers to BugzillaBase

crobinso · crobinso · commit 0bdf89d449dd · 2020-01-10T14:39:12.000-05:00
While RHBugzilla is the only instance that I know of with this
extension enabled, it's not strictly rhbugzilla specific behavior,
and keeping it separate framents the API. Move it

Signed-off-by: Cole Robinson &lt;crobinso@redhat.com&gt;
diff --git a/bugzilla/base.py b/bugzilla/base.py
@@ -1812,3 +1812,139 @@ def updateperms(self, user, action, groups):
         }
 
         return self._backend.user_update(update)
+
+
+    #############################
+    # ExternalBugs API wrappers #
+    #############################
+
+    def add_external_tracker(self, bug_ids, ext_bz_bug_id, ext_type_id=None,
+                             ext_type_description=None, ext_type_url=None,
+                             ext_status=None, ext_description=None,
+                             ext_priority=None):
+        """
+        Wrapper method to allow adding of external tracking bugs using the
+        ExternalBugs::WebService::add_external_bug method.
+
+        This is documented at
+        https://bugzilla.redhat.com/docs/en/html/api/extensions/ExternalBugs/lib/WebService.html#add_external_bug
+
+        bug_ids: A single bug id or list of bug ids to have external trackers
+            added.
+        ext_bz_bug_id: The external bug id (ie: the bug number in the
+            external tracker).
+        ext_type_id: The external tracker id as used by Bugzilla.
+        ext_type_description: The external tracker description as used by
+            Bugzilla.
+        ext_type_url: The external tracker url as used by Bugzilla.
+        ext_status: The status of the external bug.
+        ext_description: The description of the external bug.
+        ext_priority: The priority of the external bug.
+        """
+        param_dict = {'ext_bz_bug_id': ext_bz_bug_id}
+        if ext_type_id is not None:
+            param_dict['ext_type_id'] = ext_type_id
+        if ext_type_description is not None:
+            param_dict['ext_type_description'] = ext_type_description
+        if ext_type_url is not None:
+            param_dict['ext_type_url'] = ext_type_url
+        if ext_status is not None:
+            param_dict['ext_status'] = ext_status
+        if ext_description is not None:
+            param_dict['ext_description'] = ext_description
+        if ext_priority is not None:
+            param_dict['ext_priority'] = ext_priority
+        params = {
+            'bug_ids': listify(bug_ids),
+            'external_bugs': [param_dict],
+        }
+
+        log.debug("Calling ExternalBugs.add_external_bug(%s)", params)
+        return self._backend.externalbugs_add(params)
+
+    def update_external_tracker(self, ids=None, ext_type_id=None,
+                                ext_type_description=None, ext_type_url=None,
+                                ext_bz_bug_id=None, bug_ids=None,
+                                ext_status=None, ext_description=None,
+                                ext_priority=None):
+        """
+        Wrapper method to allow adding of external tracking bugs using the
+        ExternalBugs::WebService::update_external_bug method.
+
+        This is documented at
+        https://bugzilla.redhat.com/docs/en/html/api/extensions/ExternalBugs/lib/WebService.html#update_external_bug
+
+        ids: A single external tracker bug id or list of external tracker bug
+            ids.
+        ext_type_id: The external tracker id as used by Bugzilla.
+        ext_type_description: The external tracker description as used by
+            Bugzilla.
+        ext_type_url: The external tracker url as used by Bugzilla.
+        ext_bz_bug_id: A single external bug id or list of external bug ids
+            (ie: the bug number in the external tracker).
+        bug_ids: A single bug id or list of bug ids to have external tracker
+            info updated.
+        ext_status: The status of the external bug.
+        ext_description: The description of the external bug.
+        ext_priority: The priority of the external bug.
+        """
+        params = {}
+        if ids is not None:
+            params['ids'] = listify(ids)
+        if ext_type_id is not None:
+            params['ext_type_id'] = ext_type_id
+        if ext_type_description is not None:
+            params['ext_type_description'] = ext_type_description
+        if ext_type_url is not None:
+            params['ext_type_url'] = ext_type_url
+        if ext_bz_bug_id is not None:
+            params['ext_bz_bug_id'] = listify(ext_bz_bug_id)
+        if bug_ids is not None:
+            params['bug_ids'] = listify(bug_ids)
+        if ext_status is not None:
+            params['ext_status'] = ext_status
+        if ext_description is not None:
+            params['ext_description'] = ext_description
+        if ext_priority is not None:
+            params['ext_priority'] = ext_priority
+
+        log.debug("Calling ExternalBugs.update_external_bug(%s)", params)
+        return self._backend.externalbugs_update(params)
+
+    def remove_external_tracker(self, ids=None, ext_type_id=None,
+                                ext_type_description=None, ext_type_url=None,
+                                ext_bz_bug_id=None, bug_ids=None):
+        """
+        Wrapper method to allow removal of external tracking bugs using the
+        ExternalBugs::WebService::remove_external_bug method.
+
+        This is documented at
+        https://bugzilla.redhat.com/docs/en/html/api/extensions/ExternalBugs/lib/WebService.html#remove_external_bug
+
+        ids: A single external tracker bug id or list of external tracker bug
+            ids.
+        ext_type_id: The external tracker id as used by Bugzilla.
+        ext_type_description: The external tracker description as used by
+            Bugzilla.
+        ext_type_url: The external tracker url as used by Bugzilla.
+        ext_bz_bug_id: A single external bug id or list of external bug ids
+            (ie: the bug number in the external tracker).
+        bug_ids: A single bug id or list of bug ids to have external tracker
+            info updated.
+        """
+        params = {}
+        if ids is not None:
+            params['ids'] = listify(ids)
+        if ext_type_id is not None:
+            params['ext_type_id'] = ext_type_id
+        if ext_type_description is not None:
+            params['ext_type_description'] = ext_type_description
+        if ext_type_url is not None:
+            params['ext_type_url'] = ext_type_url
+        if ext_bz_bug_id is not None:
+            params['ext_bz_bug_id'] = listify(ext_bz_bug_id)
+        if bug_ids is not None:
+            params['bug_ids'] = listify(bug_ids)
+
+        log.debug("Calling ExternalBugs.remove_external_bug(%s)", params)
+        return self._backend.externalbugs_remove(params)
diff --git a/bugzilla/rhbugzilla.py b/bugzilla/rhbugzilla.py
@@ -111,137 +111,6 @@ def get_alias():
 
         return vals
 
-    def add_external_tracker(self, bug_ids, ext_bz_bug_id, ext_type_id=None,
-                             ext_type_description=None, ext_type_url=None,
-                             ext_status=None, ext_description=None,
-                             ext_priority=None):
-        """
-        Wrapper method to allow adding of external tracking bugs using the
-        ExternalBugs::WebService::add_external_bug method.
-
-        This is documented at
-        https://bugzilla.redhat.com/docs/en/html/api/extensions/ExternalBugs/lib/WebService.html#add_external_bug
-
-        bug_ids: A single bug id or list of bug ids to have external trackers
-            added.
-        ext_bz_bug_id: The external bug id (ie: the bug number in the
-            external tracker).
-        ext_type_id: The external tracker id as used by Bugzilla.
-        ext_type_description: The external tracker description as used by
-            Bugzilla.
-        ext_type_url: The external tracker url as used by Bugzilla.
-        ext_status: The status of the external bug.
-        ext_description: The description of the external bug.
-        ext_priority: The priority of the external bug.
-        """
-        param_dict = {'ext_bz_bug_id': ext_bz_bug_id}
-        if ext_type_id is not None:
-            param_dict['ext_type_id'] = ext_type_id
-        if ext_type_description is not None:
-            param_dict['ext_type_description'] = ext_type_description
-        if ext_type_url is not None:
-            param_dict['ext_type_url'] = ext_type_url
-        if ext_status is not None:
-            param_dict['ext_status'] = ext_status
-        if ext_description is not None:
-            param_dict['ext_description'] = ext_description
-        if ext_priority is not None:
-            param_dict['ext_priority'] = ext_priority
-        params = {
-            'bug_ids': listify(bug_ids),
-            'external_bugs': [param_dict],
-        }
-
-        log.debug("Calling ExternalBugs.add_external_bug(%s)", params)
-        return self._backend.externalbugs_update(params)
-
-    def update_external_tracker(self, ids=None, ext_type_id=None,
-                                ext_type_description=None, ext_type_url=None,
-                                ext_bz_bug_id=None, bug_ids=None,
-                                ext_status=None, ext_description=None,
-                                ext_priority=None):
-        """
-        Wrapper method to allow adding of external tracking bugs using the
-        ExternalBugs::WebService::update_external_bug method.
-
-        This is documented at
-        https://bugzilla.redhat.com/docs/en/html/api/extensions/ExternalBugs/lib/WebService.html#update_external_bug
-
-        ids: A single external tracker bug id or list of external tracker bug
-            ids.
-        ext_type_id: The external tracker id as used by Bugzilla.
-        ext_type_description: The external tracker description as used by
-            Bugzilla.
-        ext_type_url: The external tracker url as used by Bugzilla.
-        ext_bz_bug_id: A single external bug id or list of external bug ids
-            (ie: the bug number in the external tracker).
-        bug_ids: A single bug id or list of bug ids to have external tracker
-            info updated.
-        ext_status: The status of the external bug.
-        ext_description: The description of the external bug.
-        ext_priority: The priority of the external bug.
-        """
-        params = {}
-        if ids is not None:
-            params['ids'] = listify(ids)
-        if ext_type_id is not None:
-            params['ext_type_id'] = ext_type_id
-        if ext_type_description is not None:
-            params['ext_type_description'] = ext_type_description
-        if ext_type_url is not None:
-            params['ext_type_url'] = ext_type_url
-        if ext_bz_bug_id is not None:
-            params['ext_bz_bug_id'] = listify(ext_bz_bug_id)
-        if bug_ids is not None:
-            params['bug_ids'] = listify(bug_ids)
-        if ext_status is not None:
-            params['ext_status'] = ext_status
-        if ext_description is not None:
-            params['ext_description'] = ext_description
-        if ext_priority is not None:
-            params['ext_priority'] = ext_priority
-
-        log.debug("Calling ExternalBugs.update_external_bug(%s)", params)
-        return self._backend.externalbugs_update(params)
-
-    def remove_external_tracker(self, ids=None, ext_type_id=None,
-                                ext_type_description=None, ext_type_url=None,
-                                ext_bz_bug_id=None, bug_ids=None):
-        """
-        Wrapper method to allow removal of external tracking bugs using the
-        ExternalBugs::WebService::remove_external_bug method.
-
-        This is documented at
-        https://bugzilla.redhat.com/docs/en/html/api/extensions/ExternalBugs/lib/WebService.html#remove_external_bug
-
-        ids: A single external tracker bug id or list of external tracker bug
-            ids.
-        ext_type_id: The external tracker id as used by Bugzilla.
-        ext_type_description: The external tracker description as used by
-            Bugzilla.
-        ext_type_url: The external tracker url as used by Bugzilla.
-        ext_bz_bug_id: A single external bug id or list of external bug ids
-            (ie: the bug number in the external tracker).
-        bug_ids: A single bug id or list of bug ids to have external tracker
-            info updated.
-        """
-        params = {}
-        if ids is not None:
-            params['ids'] = listify(ids)
-        if ext_type_id is not None:
-            params['ext_type_id'] = ext_type_id
-        if ext_type_description is not None:
-            params['ext_type_description'] = ext_type_description
-        if ext_type_url is not None:
-            params['ext_type_url'] = ext_type_url
-        if ext_bz_bug_id is not None:
-            params['ext_bz_bug_id'] = listify(ext_bz_bug_id)
-        if bug_ids is not None:
-            params['bug_ids'] = listify(bug_ids)
-
-        log.debug("Calling ExternalBugs.remove_external_bug(%s)", params)
-        return self._backend.externalbugs_remove(params)
-
 
     #################
     # Query methods #
