Bugzilla: Add requests_session __init__ parameter

crobinso · crobinso · commit 061a4ec9be87 · 2020-01-11T19:26:08.000-05:00
This allows users to pass in a requests_session we will use for
talking to remote bugzilla, which saves us having to expose various
requests bits via the official API

Signed-off-by: Cole Robinson &lt;crobinso@redhat.com&gt;
diff --git a/bugzilla/_session.py b/bugzilla/_session.py
@@ -17,8 +17,8 @@ class _BugzillaSession(object):
     Class to handle the backend agnostic 'requests' setup
     """
     def __init__(self, url, user_agent,
-            cookiecache=None, sslverify=True, cert=None,
-            tokencache=None, api_key=None):
+            cookiecache, sslverify, cert,
+            tokencache, api_key, requests_session=None):
         self._url = url
         self._user_agent = user_agent
         self._scheme = urlparse(url)[0]
@@ -30,13 +30,16 @@ def __init__(self, url, user_agent,
             raise Exception("Invalid URL scheme: %s (%s)" % (
                 self._scheme, url))
 
-        self._session = requests.Session()
+        self._session = requests_session
+        if not self._session:
+            self._session = requests.Session()
+
         if cert:
             self._session.cert = cert
         if self._cookiecache:
             self._session.cookies = self._cookiecache.get_cookiejar()
-
-        self._session.verify = sslverify
+        if sslverify is False:
+            self._session.verify = False
         self._session.headers["User-Agent"] = self._user_agent
         self._session.params["Bugzilla_api_key"] = self._api_key
         self._set_tokencache_param()
diff --git a/bugzilla/base.py b/bugzilla/base.py
@@ -176,7 +176,7 @@ def get_rcfile_default_url():
     def __init__(self, url=-1, user=None, password=None, cookiefile=-1,
                  sslverify=True, tokenfile=-1, use_creds=True, api_key=None,
                  cert=None, configpaths=-1, basic_auth=False,
-                 force_rest=False, force_xmlrpc=False):
+                 force_rest=False, force_xmlrpc=False, requests_session=None):
         """
         :param url: The bugzilla instance URL, which we will connect
             to immediately. Most users will want to specify this at
@@ -211,6 +211,9 @@ def __init__(self, url=-1, user=None, password=None, cookiefile=-1,
         :param force_xmlrpc: Force use of the XMLRPC API. If neither force_X
             parameter are specified, heuristics will be used to determine
             which API to use, with XMLRPC preferred for back compatability.
+        :param requests_session: An optional requests.Session object the
+            API will use to contact the remote bugzilla instance. This
+            way the API user can set up whatever auth bits they may need.
         """
         if url == -1:
             raise TypeError("Specify a valid bugzilla url, or pass url=None")
@@ -224,6 +227,7 @@ def __init__(self, url=-1, user=None, password=None, cookiefile=-1,
 
         self._backend = None
         self._session = None
+        self._user_requests_session = requests_session
         self._sslverify = sslverify
         self._cache = _BugzillaAPICache()
         self._bug_autorefresh = False
@@ -491,7 +495,8 @@ def connect(self, url=None):
                 sslverify=self._sslverify,
                 cert=self.cert,
                 tokencache=self._tokencache,
-                api_key=self.api_key)
+                api_key=self.api_key,
+                requests_session=self._user_requests_session)
         backendclass = self._get_backend_class()
         self._backend = backendclass(url, self._session)
 
diff --git a/tests/test_api_misc.py b/tests/test_api_misc.py
@@ -300,6 +300,16 @@ def test_get_xmlrpc_proxy():
     assert hasattr(bz.get_requests_session(), "request")
 
 
+def test_requests_session_passthrough():
+    import requests
+    session = requests.Session()
+
+    bz = tests.mockbackend.make_bz(
+        bz_kwargs={"requests_session": session, "sslverify": False})
+    assert bz.get_requests_session() is session
+    assert session.verify is False
+
+
 def test_query_url_fail():
     # test some handling of query from_url errors
     query = {"query_format": "advanced", "product": "FOO"}
