Merge pull request #1 from acamacho82/updateTo5.5.0

Update to5.5.0

Author: acamacho82

.gitignore

@@ -14,3 +14,5 @@ dist/*
 *.egg-info
 .cache
 .idea
+.pytest_cache/*
+slcli

CHANGELOG.md

@@ -1,8 +1,24 @@
 # Change Log
 
+## [5.5.0] - 2018-07-09
+- Changes: https://github.com/softlayer/softlayer-python/compare/v5.4.4...master
+
+- Added a warning when ordering legacy storage volumes
+- Added documentation link to volume-order
+- Increased slcli output width limit to 999 characters
+- More unit tests
+- Fixed an issue canceling some block storage volumes
+- Fixed `slcli order` to work with network gateways
+- Fixed an issue showing hardware credentials when they do not exist
+- Fixed an issue showing addressSpace when listing virtual servers
+- Updated ordering class to support baremetal servers with multiple GPU
+- Updated prompt-toolkit as a fix for `slcli shell`
+- Fixed `slcli vlan detail` to not fail when objects don't have a hostname
+- Added user management
+
 
 ## [5.4.4] - 2018-04-18
-- Changes: https://github.com/softlayer/softlayer-python/compare/v5.4.3...master
+- Changes: https://github.com/softlayer/softlayer-python/compare/v5.4.3...v5.4.4
 
 - fixed hw list not showing transactions
 - Re-factored RestTransport and XMLRPCTransport, logging is now only done in the DebugTransport

README.rst

@@ -72,6 +72,49 @@ Bugs and feature requests about this library should have a `GitHub issue <https:
 
 Issues with the Softlayer API itself should be addressed by opening a ticket.
 
+
+Examples
+--------
+
+A curated list of examples on how to use this library can be found at `softlayer.github.io <https://softlayer.github.io/python/>`_
+
+Debugging
+---------
+To get the exact API call that this library makes, you can do the following.
+
+For the CLI, just use the -vvv option. If you are using the REST endpoint, this will print out a curl command that you can use, if using XML, this will print the minimal python code to make the request without the softlayer library.
+
+.. code-block:: bash
+  $ slcli -vvv vs list
+
+
+If you are using the library directly in python, you can do something like this.
+
+.. code-bock:: python
+  import SoftLayer
+  import logging
+
+  class invoices():
+
+      def __init__(self):
+          self.client = SoftLayer.Client()
+          debugger = SoftLayer.DebugTransport(self.client.transport)
+          self.client.transport = debugger
+
+      def main(self):
+          mask = "mask[id]"
+          account = self.client.call('Account', 'getObject', mask=mask);
+          print("AccountID: %s" % account['id'])
+
+      def debug(self):
+          for call in self.client.transport.get_last_calls():
+              print(self.client.transport.print_reproduceable(call))
+
+  if __name__ == "__main__":
+      main = example()
+      main.main()
+      main.debug()
+
 System Requirements
 -------------------
 * Python 2.7, 3.3, 3.4, 3.5 or 3.6.

SoftLayer/API.py

@@ -333,6 +333,7 @@ class Service(object):
         :param name str: The service name
 
     """
+
     def __init__(self, client, name):
         self.client = client
         self.name = name

SoftLayer/CLI/block/detail.py

@@ -29,7 +29,7 @@ def cli(env, volume_id):
     table.add_row(['LUN Id', "%s" % block_volume['lunId']])
 
     if block_volume.get('provisionedIops'):
-        table.add_row(['IOPs', int(block_volume['provisionedIops'])])
+        table.add_row(['IOPs', float(block_volume['provisionedIops'])])
 
     if block_volume.get('storageTierLevel'):
         table.add_row([

SoftLayer/CLI/block/list.py

@@ -23,6 +23,7 @@
         mask="storageType.keyName"),
     column_helper.Column('capacity_gb', ('capacityGb',), mask="capacityGb"),
     column_helper.Column('bytes_used', ('bytesUsed',), mask="bytesUsed"),
+    column_helper.Column('iops', ('iops',), mask="iops"),
     column_helper.Column('ip_addr', ('serviceResourceBackendIpAddress',),
                          mask="serviceResourceBackendIpAddress"),
     column_helper.Column('lunId', ('lunId',), mask="lunId"),
@@ -42,6 +43,7 @@
     'storage_type',
     'capacity_gb',
     'bytes_used',
+    'iops',
     'ip_addr',
     'lunId',
     'active_transactions',

SoftLayer/CLI/columns.py

@@ -14,6 +14,7 @@
 
 class Column(object):
     """Column desctribes an attribute and how to fetch/display it."""
+
     def __init__(self, name, path, mask=None):
         self.name = name
         self.path = path
@@ -26,6 +27,7 @@ def __init__(self, name, path, mask=None):
 
 class ColumnFormatter(object):
     """Maps each column using a function"""
+
     def __init__(self):
         self.columns = []
         self.column_funcs = []

SoftLayer/CLI/core.py

@@ -115,17 +115,22 @@ def cli(env,
         **kwargs):
     """Main click CLI entry-point."""
 
-    logger = logging.getLogger()
-    logger.addHandler(logging.StreamHandler())
-    logger.setLevel(DEBUG_LOGGING_MAP.get(verbose, logging.DEBUG))
-
     # Populate environement with client and set it as the context object
     env.skip_confirmations = really
     env.config_file = config
     env.format = format
     env.ensure_client(config_file=config, is_demo=demo, proxy=proxy)
-
     env.vars['_start'] = time.time()
+    logger = logging.getLogger()
+
+    if demo is False:
+        logger.addHandler(logging.StreamHandler())
+    else:
+        # This section is for running CLI tests.
+        logging.getLogger("urllib3").setLevel(logging.WARNING)
+        logger.addHandler(logging.NullHandler())
+
+    logger.setLevel(DEBUG_LOGGING_MAP.get(verbose, logging.DEBUG))
     env.vars['_timings'] = SoftLayer.DebugTransport(env.client.transport)
     env.client.transport = env.vars['_timings']
 

SoftLayer/CLI/exceptions.py

@@ -10,6 +10,7 @@
 # pylint: disable=keyword-arg-before-vararg
 class CLIHalt(SystemExit):
     """Smoothly halt the execution of the command. No error."""
+
     def __init__(self, code=0, *args):
         super(CLIHalt, self).__init__(*args)
         self.code = code
@@ -23,13 +24,15 @@ def __str__(self):
 
 class CLIAbort(CLIHalt):
     """Halt the execution of the command. Gives an exit code of 2."""
+
     def __init__(self, msg, *args):
         super(CLIAbort, self).__init__(code=2, *args)
         self.message = msg
 
 
 class ArgumentError(CLIAbort):
     """Halt the execution of the command because of invalid arguments."""
+
     def __init__(self, msg, *args):
         super(ArgumentError, self).__init__(msg, *args)
         self.message = "Argument Error: %s" % msg

SoftLayer/CLI/file/snapshot/schedule_list.py

@@ -63,7 +63,7 @@ def cli(env, volume_id):
             file_schedule_type,
             replication,
             schedule.get('createDate', '')
-            ]
+        ]
         table_row.extend(schedule_properties)
         table.add_row(table_row)