added curl reproduceable

Author: allmightyspiff

SoftLayer/CLI/core.py

@@ -149,6 +149,24 @@ def output_diagnostics(env, verbose=0, **kwargs):
 
         env.err(env.fmt(diagnostic_table))
 
+    if verbose > 1:
+        for call in env.client.transport.get_last_calls():
+            call_table = formatting.Table(['','{}::{}'.format(call.service, call.method)])
+            nice_mask = ''
+            if call.mask is not None:
+                nice_mask = call.mask
+
+            call_table.add_row(['id', call.identifier])
+            call_table.add_row(['mask', call.mask])
+            call_table.add_row(['filter', call.filter])
+            call_table.add_row(['limit', call.limit])
+            call_table.add_row(['offset', call.offset])
+            env.err(env.fmt(call_table))
+
+    if verbose > 2:
+        for call in env.client.transport.get_last_calls():
+            env.err(env.client.transport.print_reproduceable(call))
+
 
 def main(reraise_exceptions=False, **kwargs):
     """Main program. Catches several common errors and displays them nicely."""

SoftLayer/transports.py

@@ -120,6 +120,9 @@ def __init__(self):
         #: Exception any exceptions that got caught
         self.exception = None
 
+        #: String Url parameters used in the Rest transport
+        self.params = None
+
 
 class SoftLayerListResult(list):
     """A SoftLayer API list result."""
@@ -165,8 +168,9 @@ def __call__(self, request):
             headers[header_name] = {'id': request.identifier}
 
         if request.mask is not None:
-            headers.update(_format_object_mask_xmlrpc(request.mask,
-                                                      request.service))
+            request.mask = _format_object_mask(request.mask)
+            headers.update(_format_object_mask_xmlrpc(request.mask, request.service))
+
 
         if request.filter is not None:
             headers['%sObjectFilter' % request.service] = request.filter
@@ -261,7 +265,9 @@ def print_reproduceable(self, request):
 ElementTree.dump(xml)
 ==========================''')
 
+
         safe_payload = re.sub(r'<string>[a-z0-9]{64}</string>', r'<string>API_KEY_GOES_HERE</string>', request.payload)
+        safe_payload = re.sub(r'(\s+)', r' ', safe_payload)
         substitutions = dict(url=request.url, payload=safe_payload, transport_headers=request.transport_headers, 
                              timeout=self.timeout, verify=request.verify, cert=request.cert, proxy=_proxies_dict(self.proxy))
         return output.substitute(substitutions)
@@ -301,7 +307,8 @@ def __call__(self, request):
         """
         params = request.headers.copy()
         if request.mask:
-            params['objectMask'] = _format_object_mask(request.mask)
+            request.mask = _format_object_mask(request.mask)
+            params['objectMask'] = request.mask
 
         if request.limit:
             params['limit'] = request.limit
@@ -312,6 +319,8 @@ def __call__(self, request):
         if request.filter:
             params['objectFilter'] = json.dumps(request.filter)
 
+        request.params = params
+
         auth = None
         if request.transport_user:
             auth = requests.auth.HTTPBasicAuth(
@@ -331,9 +340,9 @@ def __call__(self, request):
             method = 'POST'
             body['parameters'] = request.args
 
-        raw_body = None
+
         if body:
-            raw_body = json.dumps(body)
+            request.payload = json.dumps(body)
 
         url_parts = [self.endpoint_url, request.service]
         if request.identifier is not None:
@@ -342,32 +351,29 @@ def __call__(self, request):
         if request.method is not None:
             url_parts.append(request.method)
 
-        url = '%s.%s' % ('/'.join(url_parts), 'json')
+        request.url = '%s.%s' % ('/'.join(url_parts), 'json')
 
         # Prefer the request setting, if it's not None
-        verify = request.verify
-        if verify is None:
-            verify = self.verify
 
-        LOGGER.debug("=== REQUEST ===")
-        LOGGER.debug(url)
-        LOGGER.debug(request.transport_headers)
-        LOGGER.debug(raw_body)
+        if request.verify is None:
+            request.verify = self.verify
+
         try:
-            resp = self.client.request(method, url,
+            resp = self.client.request(method, request.url,
                                        auth=auth,
                                        headers=request.transport_headers,
-                                       params=params,
-                                       data=raw_body,
+                                       params=request.params,
+                                       data=request.payload,
                                        timeout=self.timeout,
-                                       verify=verify,
+                                       verify=request.verify,
                                        cert=request.cert,
                                        proxies=_proxies_dict(self.proxy))
-            LOGGER.debug("=== RESPONSE ===")
-            LOGGER.debug(resp.headers)
-            LOGGER.debug(resp.text)
+
+            request.url = resp.url
+
             resp.raise_for_status()
             result = json.loads(resp.text)
+            request.result = result
 
             if isinstance(result, list):
                 return SoftLayerListResult(
@@ -376,11 +382,36 @@ def __call__(self, request):
                 return result
         except requests.HTTPError as ex:
             message = json.loads(ex.response.text)['error']
-            raise exceptions.SoftLayerAPIError(ex.response.status_code,
-                                               message)
+            request.url = ex.response.url
+            raise exceptions.SoftLayerAPIError(ex.response.status_code, message)
         except requests.RequestException as ex:
+            request.url = ex.response.url
             raise exceptions.TransportError(0, str(ex))
 
+    def print_reproduceable(self, request):
+        """Prints out the minimal python code to reproduce a specific request
+
+        The will also automatically replace the API key so its not accidently exposed.
+
+        :param request request: Request object
+        """
+        command = "curl -u $SL_USER:$SL_APIKEY -X {method} -H {headers} {data} '{uri}'"
+
+        method = REST_SPECIAL_METHODS.get(request.method)
+
+        if method is None:
+            method = 'GET'
+        if request.args:
+            method = 'POST'
+
+        data = ''
+        if request.payload is not None:
+            data = "-d '{}'".format(request.payload)
+
+        headers = ['"{0}: {1}"'.format(k, v) for k, v in request.transport_headers.items()]
+        headers = " -H ".join(headers)
+        return command.format(method=method, headers=headers, data=data, uri=request.url)
+
 
 class DebugTransport(object):
     """Transport that records API call timings."""
@@ -414,11 +445,14 @@ def pre_transport_log(self, call):
         LOGGER.warning("Calling: {}::{}(id={})".format(call.service, call.method, call.identifier))
 
     def post_transport_log(self, call):
-        LOGGER.debug(self.transport.print_reproduceable(call))
+        LOGGER.debug("Returned Data: \n{}".format(call.result))
 
     def get_last_calls(self):
         return self.requests
 
+    def print_reproduceable(self, call):
+        return self.transport.print_reproduceable(call)
+
 class TimingTransport(object):
     """Transport that records API call timings."""
 
@@ -480,7 +514,6 @@ def _format_object_mask_xmlrpc(objectmask, service):
         mheader = '%sObjectMask' % service
     else:
         mheader = 'SoftLayer_ObjectMask'
-        objectmask = _format_object_mask(objectmask)
 
     return {mheader: {'mask': objectmask}}
 
@@ -495,6 +528,7 @@ def _format_object_mask(objectmask):
 
     """
     objectmask = objectmask.strip()
+    objectmask = re.sub(r'(\s+)', r' ', objectmask)
     if (not objectmask.startswith('mask') and
             not objectmask.startswith('[')):
         objectmask = "mask[%s]" % objectmask