Merge pull request #144 from caphrim007/feature.add-debug-array-and-curl-collections

Adds debug tracing of curl commands

Author: f5-rahm

.travis.yml

@@ -41,6 +41,7 @@ deploy:
     on:
       repo: F5Networks/f5-icontrol-rest-python
       tags: true
+      python: 2.7
   - provider: pypi
     user: $PYPI_USER
     password: $PYPI_PASSWORD

icontrol/session.py

@@ -66,11 +66,17 @@
 from icontrol.exceptions import InvalidScheme
 from icontrol.exceptions import InvalidSuffixCollection
 from icontrol.exceptions import InvalidURIComponentPart
+from six import iteritems
 
 import functools
 import logging
 import requests
 
+try:
+    import json
+except ImportError:
+    import simplejson as json
+
 try:
     # Python 3
     from urllib.parse import urlsplit
@@ -369,6 +375,10 @@ def __init__(self, username, password, **kwargs):
                 On BIG-IQ systems, the value 'local' can be used to refer to
                 local user authentication.
         """
+
+        # Used for holding debug information
+        self._debug = []
+
         verify = kwargs.pop('verify', False)
         timeout = kwargs.pop('timeout', 30)
         token_auth = kwargs.pop('token', None)
@@ -437,7 +447,10 @@ def delete(self, uri, **kwargs):
         :type partition: str
         :param \**kwargs: The :meth:`reqeusts.Session.delete` optional params
         """
-        return self.session.delete(uri, **kwargs)
+        req = requests.Request('DELETE', uri, **kwargs)
+        prepared = self.session.prepare_request(req)
+        self._debug.append(debug_prepared_request(prepared))
+        return self.session.send(prepared)
 
     @decorate_HTTP_verb_method
     def get(self, uri, **kwargs):
@@ -459,7 +472,10 @@ def get(self, uri, **kwargs):
         :type partition: str
         :param \**kwargs: The :meth:`reqeusts.Session.get` optional params
         """
-        return self.session.get(uri, **kwargs)
+        req = requests.Request('GET', uri, **kwargs)
+        prepared = self.session.prepare_request(req)
+        self._debug.append(debug_prepared_request(prepared))
+        return self.session.send(prepared)
 
     @decorate_HTTP_verb_method
     def patch(self, uri, data=None, **kwargs):
@@ -483,7 +499,10 @@ def patch(self, uri, data=None, **kwargs):
         :type partition: str
         :param \**kwargs: The :meth:`reqeusts.Session.patch` optional params
         """
-        return self.session.patch(uri, data=data, **kwargs)
+        req = requests.Request('PATCH', uri, data=data, **kwargs)
+        prepared = self.session.prepare_request(req)
+        self._debug.append(debug_prepared_request(prepared))
+        return self.session.send(prepared)
 
     @decorate_HTTP_verb_method
     def post(self, uri, data=None, json=None, **kwargs):
@@ -509,7 +528,10 @@ def post(self, uri, data=None, json=None, **kwargs):
         :type partition: str
         :param \**kwargs: The :meth:`reqeusts.Session.post` optional params
         """
-        return self.session.post(uri, data=data, json=json, **kwargs)
+        req = requests.Request('POST', uri, data=data, json=json, **kwargs)
+        prepared = self.session.prepare_request(req)
+        self._debug.append(debug_prepared_request(prepared))
+        return self.session.send(prepared)
 
     @decorate_HTTP_verb_method
     def put(self, uri, data=None, **kwargs):
@@ -535,7 +557,10 @@ def put(self, uri, data=None, **kwargs):
         :type partition: str
         :param **kwargs: The :meth:`reqeusts.Session.put` optional params
         """
-        return self.session.put(uri, data=data, **kwargs)
+        req = requests.Request('PUT', uri, data=data, **kwargs)
+        prepared = self.session.prepare_request(req)
+        self._debug.append(debug_prepared_request(prepared))
+        return self.session.send(prepared)
 
     def append_user_agent(self, user_agent):
         """Append text to the User-Agent header for the request.
@@ -568,3 +593,14 @@ def token(self, value):
         been read from a stored value for example.
         """
         self.session.auth.token = value
+
+
+def debug_prepared_request(request):
+    return
+    result = "curl -k -X {0} {1}".format(request.method.upper(), request.url)
+    for k, v in iteritems(request.headers):
+        result = result + " -H '{0}: {1}'".format(k, v)
+    if request.body:
+        kwargs = json.loads(request.body)
+        result = result + " -d '" + json.dumps(kwargs, sort_keys=True) + "'"
+    return result

icontrol/test/unit/test_session.py

@@ -14,6 +14,7 @@
 
 import mock
 import pytest
+import requests
 
 from icontrol import __version__ as VERSION
 from icontrol import session
@@ -27,11 +28,7 @@ def iCRS():
     fake_iCRS.session = mock.MagicMock()
     mock_response = mock.MagicMock()
     mock_response.status_code = 200
-    fake_iCRS.session.delete.return_value = mock_response
-    fake_iCRS.session.get.return_value = mock_response
-    fake_iCRS.session.patch.return_value = mock_response
-    fake_iCRS.session.post.return_value = mock_response
-    fake_iCRS.session.put.return_value = mock_response
+    fake_iCRS.session.send.return_value = mock_response
     return fake_iCRS
 
 
@@ -380,119 +377,109 @@ def test_correct_uri_construction_mgmt_cm(uparts_cm):
 
 # Test exception handling
 def test_wrapped_delete_success(iCRS, uparts):
-    iCRS.delete(uparts['base_uri'], partition='AFN', name='AIN',
-                uri_as_parts=True)
-    assert iCRS.session.delete.call_args ==\
-        mock.call('https://0.0.0.0/mgmt/tm/root/RESTiface/~AFN~AIN')
+    iCRS.delete(uparts['base_uri'], partition='AFN', name='AIN', uri_as_parts=True)
+    assert isinstance(iCRS.session.prepare_request.call_args[0][0], requests.Request)
+    assert iCRS.session.prepare_request.call_args[0][0].url == 'https://0.0.0.0/mgmt/tm/root/RESTiface/~AFN~AIN'
 
 
 def test_wrapped_delete_207_fail(iCRS, uparts):
-    iCRS.session.delete.return_value.status_code = 207
-    with pytest.raises(session.iControlUnexpectedHTTPError) as CHE:
-        iCRS.delete(uparts['base_uri'], partition='A_FOLDER_NAME',
-                    name='AN_INSTANCE_NAME')
-    assert str(CHE.value).startswith('207 Unexpected Error: ')
+    iCRS.session.send.return_value.status_code = 207
+    with pytest.raises(session.iControlUnexpectedHTTPError) as ex:
+        iCRS.delete(uparts['base_uri'], partition='A_FOLDER_NAME', name='AN_INSTANCE_NAME')
+    assert str(ex.value).startswith('207 Unexpected Error: ')
 
 
 def test_wrapped_get_success(iCRS, uparts):
-    iCRS.get(uparts['base_uri'], partition='AFN', name='AIN',
-             uri_as_parts=True)
-    assert iCRS.session.get.call_args ==\
-        mock.call('https://0.0.0.0/mgmt/tm/root/RESTiface/~AFN~AIN')
+    iCRS.get(uparts['base_uri'], partition='AFN', name='AIN', uri_as_parts=True)
+    assert isinstance(iCRS.session.prepare_request.call_args[0][0], requests.Request)
+    assert iCRS.session.prepare_request.call_args[0][0].url == 'https://0.0.0.0/mgmt/tm/root/RESTiface/~AFN~AIN'
 
 
 def test_wrapped_get_success_with_suffix(iCRS, uparts):
-    iCRS.get(uparts['base_uri'], partition='AFN', name='AIN',
-             suffix=uparts['suffix'],
-             uri_as_parts=True)
-    assert iCRS.session.get.call_args ==\
-        mock.call('https://0.0.0.0/mgmt/tm/root/RESTiface/~AFN~AIN/members/m1')
+    iCRS.get(uparts['base_uri'], partition='AFN', name='AIN', suffix=uparts['suffix'], uri_as_parts=True)
+    assert isinstance(iCRS.session.prepare_request.call_args[0][0], requests.Request)
+    assert iCRS.session.prepare_request.call_args[0][0].url == 'https://0.0.0.0/mgmt/tm/root/RESTiface/~AFN~AIN/members/m1'
 
 
 def test_wrapped_get_207_fail(iCRS, uparts):
-    iCRS.session.get.return_value.status_code = 207
-    with pytest.raises(session.iControlUnexpectedHTTPError) as CHE:
-        iCRS.get(uparts['base_uri'], partition='A_FOLDER_NAME',
-                 name='AN_INSTANCE_NAME')
-    assert str(CHE.value).startswith('207 Unexpected Error: ')
+    iCRS.session.send.return_value.status_code = 207
+    with pytest.raises(session.iControlUnexpectedHTTPError) as ex:
+        iCRS.get(uparts['base_uri'], partition='A_FOLDER_NAME', name='AN_INSTANCE_NAME')
+    assert str(ex.value).startswith('207 Unexpected Error: ')
 
 
 def test_wrapped_patch_success(iCRS, uparts):
-    iCRS.patch(uparts['base_uri'], partition='AFN', name='AIN',
-               uri_as_parts=True)
-    assert iCRS.session.patch.call_args ==\
-        mock.call('https://0.0.0.0/mgmt/tm/root/RESTiface/~AFN~AIN', data=None)
+    iCRS.patch(uparts['base_uri'], partition='AFN', name='AIN', uri_as_parts=True)
+    assert isinstance(iCRS.session.prepare_request.call_args[0][0], requests.Request)
+    assert iCRS.session.prepare_request.call_args[0][0].url == 'https://0.0.0.0/mgmt/tm/root/RESTiface/~AFN~AIN'
+    assert iCRS.session.prepare_request.call_args[0][0].data == []
 
 
 def test_wrapped_patch_207_fail(iCRS, uparts):
-    iCRS.session.patch.return_value.status_code = 207
-    with pytest.raises(session.iControlUnexpectedHTTPError) as CHE:
-        iCRS.patch(uparts['base_uri'], partition='A_FOLDER_NAME',
-                   name='AN_INSTANCE_NAME')
-    assert str(CHE.value).startswith('207 Unexpected Error: ')
+    iCRS.session.send.return_value.status_code = 207
+    with pytest.raises(session.iControlUnexpectedHTTPError) as ex:
+        iCRS.patch(uparts['base_uri'], partition='A_FOLDER_NAME', name='AN_INSTANCE_NAME')
+    assert str(ex.value).startswith('207 Unexpected Error: ')
 
 
 def test_wrapped_put_207_fail(iCRS, uparts):
-    iCRS.session.put.return_value.status_code = 207
-    with pytest.raises(session.iControlUnexpectedHTTPError) as CHE:
-        iCRS.put(uparts['base_uri'], partition='A_FOLDER_NAME',
-                 name='AN_INSTANCE_NAME')
-    assert str(CHE.value).startswith('207 Unexpected Error: ')
+    iCRS.session.send.return_value.status_code = 207
+    with pytest.raises(session.iControlUnexpectedHTTPError) as ex:
+        iCRS.put(uparts['base_uri'], partition='A_FOLDER_NAME', name='AN_INSTANCE_NAME')
+    assert str(ex.value).startswith('207 Unexpected Error: ')
 
 
 def test_wrapped_post_207_fail(iCRS, uparts):
-    iCRS.session.post.return_value.status_code = 207
-    with pytest.raises(session.iControlUnexpectedHTTPError) as CHE:
-        iCRS.post(uparts['base_uri'], partition='A_FOLDER_NAME',
-                  name='AN_INSTANCE_NAME')
-    assert str(CHE.value).startswith('207 Unexpected Error: ')
+    iCRS.session.send.return_value.status_code = 207
+    with pytest.raises(session.iControlUnexpectedHTTPError) as ex:
+        iCRS.post(uparts['base_uri'], partition='A_FOLDER_NAME', name='AN_INSTANCE_NAME')
+    assert str(ex.value).startswith('207 Unexpected Error: ')
 
 
 def test_wrapped_post_success(iCRS, uparts):
-    iCRS.post(uparts['base_uri'], partition='AFN', name='AIN',
-              uri_as_parts=True)
-    assert iCRS.session.post.call_args ==\
-        mock.call('https://0.0.0.0/mgmt/tm/root/RESTiface/~AFN~AIN', data=None,
-                  json=None)
+    iCRS.post(uparts['base_uri'], partition='AFN', name='AIN', uri_as_parts=True)
+    assert isinstance(iCRS.session.prepare_request.call_args[0][0], requests.Request)
+    assert iCRS.session.prepare_request.call_args[0][0].url == 'https://0.0.0.0/mgmt/tm/root/RESTiface/~AFN~AIN'
+    assert iCRS.session.prepare_request.call_args[0][0].data == []
+    assert iCRS.session.prepare_request.call_args[0][0].json is None
 
 
 def test_wrapped_post_success_with_data(iCRS, uparts):
-    iCRS.post(uparts['base_uri'], partition='AFN', name='AIN', data={'a': 1},
-              uri_as_parts=True)
-    assert iCRS.session.post.call_args ==\
-        mock.call('https://0.0.0.0/mgmt/tm/root/RESTiface/~AFN~AIN',
-                  data={'a': 1}, json=None)
+    iCRS.post(uparts['base_uri'], partition='AFN', name='AIN', data={'a': 1}, uri_as_parts=True)
+    assert isinstance(iCRS.session.prepare_request.call_args[0][0], requests.Request)
+    assert iCRS.session.prepare_request.call_args[0][0].url == 'https://0.0.0.0/mgmt/tm/root/RESTiface/~AFN~AIN'
+    assert iCRS.session.prepare_request.call_args[0][0].data == {'a': 1}
+    assert iCRS.session.prepare_request.call_args[0][0].json is None
 
 
 def test_wrapped_post_success_with_json(iCRS, uparts):
-    iCRS.post(uparts['base_uri'], partition='AFN', name='AIN', json='{"a": 1}',
-              uri_as_parts=True)
-    assert iCRS.session.post.call_args ==\
-        mock.call('https://0.0.0.0/mgmt/tm/root/RESTiface/~AFN~AIN', data=None,
-                  json='{"a": 1}')
+    iCRS.post(uparts['base_uri'], partition='AFN', name='AIN', json='{"a": 1}', uri_as_parts=True)
+    assert isinstance(iCRS.session.prepare_request.call_args[0][0], requests.Request)
+    assert iCRS.session.prepare_request.call_args[0][0].url == 'https://0.0.0.0/mgmt/tm/root/RESTiface/~AFN~AIN'
+    assert iCRS.session.prepare_request.call_args[0][0].data == []
+    assert iCRS.session.prepare_request.call_args[0][0].json == '{"a": 1}'
 
 
 def test_wrapped_post_success_with_json_and_data(iCRS, uparts):
-    iCRS.post(uparts['base_uri'], partition='AFN', name='AIN', data={'a': 1},
-              json='{"a": 1}', uri_as_parts=True)
-    assert iCRS.session.post.call_args ==\
-        mock.call('https://0.0.0.0/mgmt/tm/root/RESTiface/~AFN~AIN',
-                  data={'a': 1}, json='{"a": 1}')
+    iCRS.post(uparts['base_uri'], partition='AFN', name='AIN', data={'a': 1}, json='{"a": 1}', uri_as_parts=True)
+    assert isinstance(iCRS.session.prepare_request.call_args[0][0], requests.Request)
+    assert iCRS.session.prepare_request.call_args[0][0].url == 'https://0.0.0.0/mgmt/tm/root/RESTiface/~AFN~AIN'
+    assert iCRS.session.prepare_request.call_args[0][0].data == {'a': 1}
+    assert iCRS.session.prepare_request.call_args[0][0].json == '{"a": 1}'
 
 
 def test_wrapped_put_success(iCRS, uparts):
-    iCRS.put(uparts['base_uri'], partition='AFN', name='AIN',
-             uri_as_parts=True)
-    assert iCRS.session.put.call_args ==\
-        mock.call('https://0.0.0.0/mgmt/tm/root/RESTiface/~AFN~AIN', data=None)
+    iCRS.put(uparts['base_uri'], partition='AFN', name='AIN', uri_as_parts=True)
+    assert isinstance(iCRS.session.prepare_request.call_args[0][0], requests.Request)
+    assert iCRS.session.prepare_request.call_args[0][0].url == 'https://0.0.0.0/mgmt/tm/root/RESTiface/~AFN~AIN'
+    assert iCRS.session.prepare_request.call_args[0][0].data == []
 
 
 def test_wrapped_put_success_with_data(iCRS, uparts):
-    iCRS.put(uparts['base_uri'], partition='AFN', name='AIN', data={'b': 2},
-             uri_as_parts=True)
-    assert iCRS.session.put.call_args ==\
-        mock.call('https://0.0.0.0/mgmt/tm/root/RESTiface/~AFN~AIN',
-                  data={'b': 2})
+    iCRS.put(uparts['base_uri'], partition='AFN', name='AIN', data={'b': 2}, uri_as_parts=True)
+    assert isinstance(iCRS.session.prepare_request.call_args[0][0], requests.Request)
+    assert iCRS.session.prepare_request.call_args[0][0].url == 'https://0.0.0.0/mgmt/tm/root/RESTiface/~AFN~AIN'
+    assert iCRS.session.prepare_request.call_args[0][0].data == {'b': 2}
 
 
 def test___init__user_agent():
@@ -531,7 +518,8 @@ def test__init__without_verify():
 
 
 def test__init__with_verify():
-    icrs = session.iControlRESTSession('test_name', 'test_pw',
-                                       token=True, verify='/path/to/cert')
+    icrs = session.iControlRESTSession(
+        'test_name', 'test_pw', token=True, verify='/path/to/cert'
+    )
     assert icrs.session.verify is '/path/to/cert'
     assert icrs.session.auth.verify is '/path/to/cert'

requirements.test.txt

@@ -13,4 +13,5 @@ git+https://github.com/F5Networks/pytest-symbols.git
 python-coveralls==2.7.0
 pyOpenSSL==16.2.0
 requests-mock==1.1.0
-tox
+tox
+six

setup.cfg

@@ -1,2 +1,4 @@
 [bdist_rpm]
-requires =  python-requests >= 2.5.0
+requires = six>=1.9.0
+    six<2.0.0
+    python-requests >= 2.5.0