Added timeout

Author: magnuswatn

test_wls_rest_python.py

@@ -34,6 +34,7 @@ def test_wls_init():
     assert wls.isLatest is True
     assert wls.lifecycle == 'active'
     assert wls.version == '17.12.3.1'
+    assert wls.timeout == wls_rest_python.DEFAULT_TIMEOUT
     assert wls.edit._url == 'https://edit-link'
     assert wls.session.verify is True
     assert wls.session.auth == ('weblogic', 'Welcome1')
@@ -82,30 +83,54 @@ def test_wls_init_noverify():
         )
     assert wls.session.verify == False
 
+def test_wls_init_nondefault_timeout():
+    collection = {
+        'version': '17.12.3.1',
+        'isLatest': True,
+        'lifecycle': 'active',
+        'links': [
+            {'rel': 'edit', 'href': 'https://edit-link'},
+            {'rel': 'domainRuntime', 'href': 'https://domainruntime-link'},
+        ],
+    }
+    with requests_mock.mock() as r:
+        r.get(
+            'https://wls.example.com:7001/management/weblogic/latest', json=collection
+        )
+        wls = wls_rest_python.WLS(
+            'https://wls.example.com:7001', 'weblogic', 'Welcome1', timeout=832
+        )
+    assert wls.timeout == 832
 
 def test_wls_get():
     fake_wls = MagicMock(spec=wls_rest_python.WLS)
+    fake_wls.timeout = 372
     fake_wls.session = MagicMock()
     fake_wls.session.get = MagicMock()
     wls_rest_python.WLS.get(fake_wls, 'https://url', weird_requests_option='hei')
-    fake_wls.session.get.assert_called_once_with('https://url', weird_requests_option='hei')
+    fake_wls.session.get.assert_called_once_with('https://url', timeout=372,
+                                                 weird_requests_option='hei')
 
 
 def test_wls_post():
     fake_wls = MagicMock(spec=wls_rest_python.WLS)
+    fake_wls.timeout = 372
     fake_wls.session = MagicMock()
     fake_wls.session.post = MagicMock()
     wls_rest_python.WLS.post(fake_wls, 'https://url', weird_requests_option='hei')
     fake_wls.session.post.assert_called_once_with('https://url', headers=None,
+                                                  timeout=372,
                                                   weird_requests_option='hei')
 
 
 def test_wls_delete():
     fake_wls = MagicMock(spec=wls_rest_python.WLS)
+    fake_wls.timeout = 372
     fake_wls.session = MagicMock()
     fake_wls.session.delete = MagicMock()
     wls_rest_python.WLS.delete(fake_wls, 'https://url', weird_requests_option='hei')
     fake_wls.session.delete.assert_called_once_with('https://url', headers=None,
+                                                    timeout=372,
                                                     weird_requests_option='hei')
 
 

wls_rest_python.py

@@ -6,10 +6,13 @@
 import logging
 import requests
 
-__version__ = '0.1.1'
+__version__ = '0.1.2'
 
 logger = logging.getLogger(__name__)
 
+# This is quite high, as the WLS server will, by default,
+# do operations that take "approximately 5 minutes" synchronous.
+DEFAULT_TIMEOUT = 305
 
 class WLSException(Exception):
     """Superclass for exceptions thrown by this module"""
@@ -100,7 +103,8 @@ class WLS(object):
     :param bool verify_ssl: Whether to verify certificates on SSL connections.
     """
 
-    def __init__(self, host, username, password, version='latest', verify=True):
+    def __init__(self, host, username, password, version='latest', verify=True,
+                 timeout=DEFAULT_TIMEOUT):
         self.session = requests.Session()
         self.session.verify = verify
         self.session.auth = (username, password)
@@ -110,6 +114,7 @@ def __init__(self, host, username, password, version='latest', verify=True):
         self.session.headers.update(
             {'Accept': 'application/json', 'User-Agent': user_agent, 'X-Requested-By': user_agent}
         )
+        self.timeout = timeout
         self.base_url = '{}/management/weblogic/{}'.format(host, version)
         collection = self.get(self.base_url)
         self.version = collection['version']
@@ -125,7 +130,7 @@ def get(self, url, **kwargs):
 
         Returns the decoded JSON.
         """
-        response = self.session.get(url, **kwargs)
+        response = self.session.get(url, timeout=self.timeout, **kwargs)
         return self._handle_response(response)
 
     def post(self, url, prefer_async=False, **kwargs):
@@ -136,7 +141,7 @@ def post(self, url, prefer_async=False, **kwargs):
         WLSObject. Otherwise it will return the decoded JSON
         """
         headers = {'Prefer': 'respond-async'} if prefer_async else None
-        response = self.session.post(url, headers=headers, **kwargs)
+        response = self.session.post(url, headers=headers, timeout=self.timeout, **kwargs)
         return self._handle_response(response)
 
     def delete(self, url, prefer_async=False, **kwargs):
@@ -147,7 +152,7 @@ def delete(self, url, prefer_async=False, **kwargs):
         WLSObject. Otherwise it will return the decoded JSON
         """
         headers = {'Prefer': 'respond-async'} if prefer_async else None
-        response = self.session.delete(url, headers=headers, **kwargs)
+        response = self.session.delete(url, headers=headers, timeout=self.timeout, **kwargs)
         return self._handle_response(response)
 
     def _handle_response(self, response):