bugzilla: Throw an error unless user explicitly sets url=None

crobinso · crobinso · commit 4cc60bd752d7 · 2016-05-24T07:37:18.000-04:00
The default of allowing an empty URL isn't friendly for
new API users. Instead require users to explicitly opt in
to skipping the initial URL connection, by setting url=None,
since this is the far less common scenario
diff --git a/bugzilla/base.py b/bugzilla/base.py
@@ -231,9 +231,13 @@ def fix_url(url):
             url = url + '/xmlrpc.cgi'
         return url
 
-    def __init__(self, url=None, user=None, password=None, cookiefile=-1,
+    def __init__(self, url=-1, user=None, password=None, cookiefile=-1,
                  sslverify=True, tokenfile=-1):
         """
+        :param url: The bugzilla instance URL, which we will connect
+            to immediately. Most users will want to specify this at
+            __init__ time, but you can defer connecting by passing
+            url=None and calling connect(URL) manually
         :param cookiefile: If -1, use the default path. If None, don't use
             or save any cookiefile.
         :param tokenfile: If -1, use the default path. If None, don't use
@@ -242,7 +246,10 @@ def __init__(self, url=None, user=None, password=None, cookiefile=-1,
             False to disable SSL verification, but it can also be a path
             to file or directory for custom certs.
         """
-        self._init_class_from_url(url, sslverify)
+        if url is -1:
+            raise TypeError("Specify a valid bugzilla url, or pass url=None")
+        if url is not None:
+            self._init_class_from_url(url, sslverify)
 
         # Settings the user might want to tweak
         self.user = user or ''
@@ -277,8 +284,6 @@ def _init_class_from_url(self, url, sslverify):
         Detect if we should use RHBugzilla class, and if so, set it
         """
         from bugzilla import RHBugzilla
-        if url is None:
-            return
 
         url = self.fix_url(url)
         log.debug("Detecting subclass for %s", url)
diff --git a/tests/__init__.py b/tests/__init__.py
@@ -47,6 +47,8 @@ def make_bz(version, *args, **kwargs):
         kwargs["cookiefile"] = None
     if "tokenfile" not in kwargs:
         kwargs["tokenfile"] = None
+    if "url" not in kwargs:
+        kwargs["url"] = None
     bz = cls(*args, **kwargs)
     bz._set_bz_version(version)  # pylint: disable=protected-access
     return bz
diff --git a/tests/bug.py b/tests/bug.py
@@ -13,13 +13,13 @@
 import sys
 import unittest
 
+import tests
 from tests import StringIO
 
-from bugzilla import RHBugzilla
 from bugzilla.bug import _Bug
 
 
-rhbz = RHBugzilla(cookiefile=None, tokenfile=None)
+rhbz = tests.make_bz("4.4.0", rhbz=True)
 
 
 class BugTest(unittest.TestCase):
diff --git a/tests/modify.py b/tests/modify.py
@@ -11,12 +11,10 @@
 
 import unittest
 
-from bugzilla.rhbugzilla import RHBugzilla
-
 import tests
 
 
-rhbz = RHBugzilla(cookiefile=None, tokenfile=None)
+rhbz = tests.make_bz("4.4.0", rhbz=True)
 
 
 class ModifyTest(unittest.TestCase):
