bugzilla: Dynamically set version number at connect time

crobinso · crobinso · commit 0ab12792a8c8 · 2016-05-23T18:52:15.000-04:00
This is the beginning of breaking away from hardcoding version
numbers in class names, and requiring a new class for bugzilla
version detection
diff --git a/bugzilla/base.py b/bugzilla/base.py
@@ -313,9 +313,7 @@ def _init_field_aliases(self):
         self._add_field_alias('last_change_time', 'delta_ts')
 
     def _get_user_agent(self):
-        ret = ('Python-urllib bugzilla.py/%s %s' %
-               (__version__, str(self.__class__.__name__)))
-        return ret
+        return 'python-bugzilla/%s' % __version__
     user_agent = property(_get_user_agent)
 
 
@@ -438,6 +436,16 @@ def readconfig(self, configpath=None):
             else:
                 log.debug("bugzillarc: unknown key=%s", key)
 
+    def _set_bz_version(self, version):
+        try:
+            self.bz_ver_major, self.bz_ver_minor = [
+                int(i) for i in version.split(".")[0:2]]
+        except:
+            log.debug("version doesn't match expected format X.Y.Z, "
+                    "assuming 5.0", exc_info=True)
+            self.bz_ver_major = 5
+            self.bz_ver_minor = 0
+
     def connect(self, url=None):
         '''
         Connect to the bugzilla instance with the given url.
@@ -469,6 +477,10 @@ def connect(self, url=None):
             log.info("user and password present - doing login()")
             self.login()
 
+        version = self._proxy.Bugzilla.version()["version"]
+        log.debug("Bugzilla version string: %s", version)
+        self._set_bz_version(version)
+
     def disconnect(self):
         '''
         Disconnect from the given bugzilla instance.
diff --git a/bugzilla/bugzilla3.py b/bugzilla/bugzilla3.py
@@ -13,17 +13,16 @@
 
 
 class Bugzilla3(BugzillaBase):
-    bz_ver_major = 3
-    bz_ver_minor = 0
+    pass
 
 
 class Bugzilla32(Bugzilla3):
-    bz_ver_minor = 2
+    pass
 
 
 class Bugzilla34(Bugzilla32):
-    bz_ver_minor = 4
+    pass
 
 
 class Bugzilla36(Bugzilla34):
-    bz_ver_minor = 6
+    pass
diff --git a/bugzilla/bugzilla4.py b/bugzilla/bugzilla4.py
@@ -12,13 +12,12 @@
 
 
 class Bugzilla4(Bugzilla36):
-    bz_ver_major = 4
-    bz_ver_minor = 0
+    pass
 
 
 class Bugzilla42(Bugzilla4):
-    bz_ver_minor = 2
+    pass
 
 
 class Bugzilla44(Bugzilla42):
-    bz_ver_minor = 4
+    pass
diff --git a/bugzilla/rhbugzilla.py b/bugzilla/rhbugzilla.py
@@ -11,7 +11,7 @@
 
 from logging import getLogger
 
-from .bugzilla4 import Bugzilla44 as _parent
+from .base import BugzillaBase as _parent
 
 log = getLogger(__name__)
 
diff --git a/tests/__init__.py b/tests/__init__.py
@@ -13,6 +13,9 @@
 else:
     from StringIO import StringIO
 
+from bugzilla.base import BugzillaBase
+from bugzilla import RHBugzilla
+
 
 _cleanup = []
 
@@ -36,6 +39,19 @@ def _cleanup_cb():
 REDHAT_URL = None
 
 
+def make_bz(version, *args, **kwargs):
+    cls = BugzillaBase
+    if kwargs.pop("rhbz", False):
+        cls = RHBugzilla
+    if "cookiefile" not in kwargs:
+        kwargs["cookiefile"] = None
+    if "tokenfile" not in kwargs:
+        kwargs["tokenfile"] = None
+    bz = cls(*args, **kwargs)
+    bz._set_bz_version(version)  # pylint: disable=protected-access
+    return bz
+
+
 def diff(orig, new):
     """
     Return a unified diff string between the passed strings
diff --git a/tests/createbug.py b/tests/createbug.py
@@ -11,12 +11,10 @@
 
 import unittest
 
-from bugzilla.bugzilla4 import Bugzilla4
-
 import tests
 
 
-bz4 = Bugzilla4(cookiefile=None, tokenfile=None)
+bz4 = tests.make_bz("4.0.0")
 
 
 class CreatebugTest(unittest.TestCase):
diff --git a/tests/misc.py b/tests/misc.py
@@ -12,7 +12,6 @@
 from __future__ import print_function
 
 import atexit
-import logging
 import os
 import shutil
 import sys
@@ -64,11 +63,8 @@ class MiscAPI(unittest.TestCase):
     Test miscellaneous API bits
     """
     def testUserAgent(self):
-        b3 = bugzilla.Bugzilla3(url=None, cookiefile=None, tokenfile=None)
-        rhbz = bugzilla.RHBugzilla(url=None, cookiefile=None, tokenfile=None)
-
-        self.assertTrue(b3.user_agent.endswith("Bugzilla3"))
-        self.assertTrue(rhbz.user_agent.endswith("RHBugzilla"))
+        b3 = tests.make_bz("3.0.0")
+        self.assertTrue("python-bugzilla" in b3.user_agent)
 
     def testCookies(self):
         cookiesbad = os.path.join(os.getcwd(), "tests/data/cookies-bad.txt")
@@ -83,7 +79,7 @@ def cleanup():
         shutil.copy(cookieslwp, cookiesnew)
 
         # Mozilla should be converted inplace to LWP
-        bugzilla.Bugzilla3(url=None, cookiefile=cookiesnew)
+        tests.make_bz("3.0.0", cookiefile=cookiesnew)
 
         def strip_comments(content):
             return [l for l in content.split("\n") if not l.startswith("#")]
@@ -93,18 +89,18 @@ def strip_comments(content):
 
         # Make sure bad cookies raise an error
         try:
-            bugzilla.Bugzilla3(url=None, cookiefile=cookiesbad)
+            tests.make_bz("3.0.0", cookiefile=cookiesbad)
             raise AssertionError("Expected BugzillaError from parsing %s" %
                                  os.path.basename(cookiesbad))
         except bugzilla.BugzillaError:
             # Expected result
             pass
 
         # Mozilla should 'just work'
-        bugzilla.Bugzilla3(url=None, cookiefile=cookiesmoz)
+        tests.make_bz("3.0.0", cookiefile=cookiesmoz)
 
     def test_readconfig(self):
-        bzapi = bugzilla.RHBugzilla(url=None)
+        bzapi = tests.make_bz("4.4.0", rhbz=True)
         bzapi.url = "foo.example.com"
         temp = tempfile.NamedTemporaryFile(mode="w")
 
@@ -147,8 +143,8 @@ def _testPostCompare(bz, indict, outexpect):
             bz.post_translation({}, outdict)
             self.assertTrue(outdict == outexpect)
 
-        bug3 = bugzilla.Bugzilla3(url=None, cookiefile=None, tokenfile=None)
-        rhbz = bugzilla.RHBugzilla(url=None, cookiefile=None, tokenfile=None)
+        bug3 = tests.make_bz("3.4.0")
+        rhbz = tests.make_bz("4.4.0", rhbz=True)
 
         test1 = {
             "component": ["comp1"],
diff --git a/tests/query.py b/tests/query.py
@@ -13,16 +13,11 @@
 import os
 import unittest
 
-import bugzilla
-from bugzilla.bugzilla3 import Bugzilla34
-from bugzilla.bugzilla4 import Bugzilla4
-from bugzilla.rhbugzilla import RHBugzilla4
-
 import tests
 
-bz34 = Bugzilla34(cookiefile=None, tokenfile=None)
-bz4 = Bugzilla4(cookiefile=None, tokenfile=None)
-rhbz4 = RHBugzilla4(cookiefile=None, tokenfile=None)
+bz34 = tests.make_bz("3.4.0")
+bz4 = tests.make_bz("4.0.0")
+rhbz4 = tests.make_bz("4.4.0", rhbz=True)
 
 
 class BZ34Test(unittest.TestCase):
