Bugzilla: Don't overwrite subclass with RHBugzilla

crobinso · crobinso · commit 7b9df009dc49 · 2020-07-16T18:19:44.000-04:00
If a user subclasses Bugzilla, we don't want to overwrite __class__ with the RHBugzilla detection back compat Closes: #129 Signed-off-by: Cole Robinson <crobinso@redhat.com>
diff --git a/bugzilla/base.py b/bugzilla/base.py
@@ -270,9 +270,15 @@ def _init_class_from_url(self):
         """
         from .oldclasses import RHBugzilla  # pylint: disable=cyclic-import
 
-        if self._detect_is_redhat_bugzilla():
+        if not self._detect_is_redhat_bugzilla():
+            return
+
+        self._is_redhat_bugzilla = True
+        if self.__class__ == Bugzilla:
+            # Overriding the class doesn't have any functional effect,
+            # but we continue to do it for API back compat incase anyone
+            # is doing any class comparison. We should drop this in the future
             self.__class__ = RHBugzilla
-            self._is_redhat_bugzilla = True
 
     def _get_field_aliases(self):
         # List of field aliases. Maps old style RHBZ parameter
diff --git a/tests/test_ro_functional.py b/tests/test_ro_functional.py
@@ -19,10 +19,11 @@
     "https://bugzilla.redhat.com")
 
 
-def _open_bz(url, **kwargs):
+def _open_bz(url, bzclass=None, **kwargs):
     if "use_creds" not in kwargs:
         kwargs["use_creds"] = False
-    return tests.utils.open_functional_bz(bugzilla.Bugzilla, url, kwargs)
+    return tests.utils.open_functional_bz(bzclass or bugzilla.Bugzilla,
+            url, kwargs)
 
 
 def _check(out, mincount, expectstr):
@@ -39,11 +40,21 @@ def _test_version(bz, bzversion):
     assert bz.bz_ver_minor == bzversion[1]
 
 
+def test_bugzilla_override():
+    class MyBugzilla(bugzilla.Bugzilla):
+        pass
+
+    bz = _open_bz("bugzilla.redhat.com", bzclass=MyBugzilla)
+    assert bz.__class__ is MyBugzilla
+    assert bz._is_redhat_bugzilla is True  # pylint: disable=protected-access
+
+
 def test_rest_xmlrpc_detection():
     # The default: use XMLRPC
     bz = _open_bz("bugzilla.redhat.com")
     assert bz.is_xmlrpc()
     assert "/xmlrpc.cgi" in bz.url
+    assert bz.__class__ is bugzilla.RHBugzilla
 
     # See /rest in the URL, so use REST
     bz = _open_bz("bugzilla.redhat.com/rest")
