Merge pull request #2 from softlayer/master

Updating my fork

Author: acamacho82

CHANGELOG.md

@@ -1,7 +1,24 @@
 # Change Log
 
+
+## [5.5.1] - 2018-08-31
+- Changes: https://github.com/softlayer/softlayer-python/compare/v5.5.1...v5.5.2
+
++ #1018 Fixed hardware credentials.
++ #1019 support for ticket priorities
++ #1025 create dedicated host with gpu fixed.
+
+
+## [5.5.1] - 2018-08-06
+- Changes: https://github.com/softlayer/softlayer-python/compare/v5.5.0...v5.5.1
+
+- #1006, added paginations to several slcli methods, making them work better with large result sets. 
+- #995, Fixed an issue displaying VLANs.
+- #1011, Fixed an issue displaying some NAS passwords
+- #1014, Ability to delete users
+
 ## [5.5.0] - 2018-07-09
-- Changes: https://github.com/softlayer/softlayer-python/compare/v5.4.4...master
+- Changes: https://github.com/softlayer/softlayer-python/compare/v5.4.4...v5.5.0
 
 - Added a warning when ordering legacy storage volumes
 - Added documentation link to volume-order

CONTRIBUTING.md

@@ -12,3 +12,18 @@ guidelines below.
 * Additional infomration can be found in our [contribution guide](http://softlayer-python.readthedocs.org/en/latest/dev/index.html)
 
 
+## Code style
+
+Code is tested and style checked with tox, you can run the tox tests individually by doing `tox -e <TEST>`
+
+* `autopep8 -r  -v -i --max-line-length 119  SoftLayer/`
+* `autopep8 -r  -v -i --max-line-length 119  tests/`
+* `tox -e analysis`
+* `tox -e py36`
+* `git commit --message="#<ISSUENUMBER> <whatever you did>`
+* `git push origin <issueBranch>`
+* create pull request
+
+
+
+

README.rst

@@ -12,6 +12,9 @@ SoftLayer API Python Client
 .. image:: https://coveralls.io/repos/github/softlayer/softlayer-python/badge.svg?branch=master
     :target: https://coveralls.io/github/softlayer/softlayer-python?branch=master
 
+.. image:: https://build.snapcraft.io/badge/softlayer/softlayer-python.svg
+    :target: https://build.snapcraft.io/user/softlayer/softlayer-python
+
 
 This library provides a simple Python client to interact with `SoftLayer's
 XML-RPC API <http://developer.softlayer.com/reference/softlayerapi>`_. 

SoftLayer/API.py

@@ -214,7 +214,9 @@ def call(self, service, method, *args, **kwargs):
 
         """
         if kwargs.pop('iter', False):
-            return self.iter_call(service, method, *args, **kwargs)
+            # Most of the codebase assumes a non-generator will be returned, so casting to list
+            # keeps those sections working
+            return list(self.iter_call(service, method, *args, **kwargs))
 
         invalid_kwargs = set(kwargs.keys()) - VALID_CALL_ARGS
         if invalid_kwargs:
@@ -267,55 +269,49 @@ def iter_call(self, service, method, *args, **kwargs):
 
         :param service: the name of the SoftLayer API service
         :param method: the method to call on the service
-        :param integer chunk: result size for each API call (defaults to 100)
+        :param integer limit: result size for each API call (defaults to 100)
         :param \\*args: same optional arguments that ``Service.call`` takes
-        :param \\*\\*kwargs: same optional keyword arguments that
-                           ``Service.call`` takes
+        :param \\*\\*kwargs: same optional keyword arguments that ``Service.call`` takes
 
         """
-        chunk = kwargs.pop('chunk', 100)
-        limit = kwargs.pop('limit', None)
-        offset = kwargs.pop('offset', 0)
 
-        if chunk <= 0:
-            raise AttributeError("Chunk size should be greater than zero.")
+        limit = kwargs.pop('limit', 100)
+        offset = kwargs.pop('offset', 0)
 
-        if limit:
-            chunk = min(chunk, limit)
+        if limit <= 0:
+            raise AttributeError("Limit size should be greater than zero.")
 
-        result_count = 0
+        # Set to make unit tests, which call this function directly, play nice.
         kwargs['iter'] = False
-        while True:
-            if limit:
-                # We've reached the end of the results
-                if result_count >= limit:
-                    break
-
-                # Don't over-fetch past the given limit
-                if chunk + result_count > limit:
-                    chunk = limit - result_count
-
-            results = self.call(service, method,
-                                offset=offset, limit=chunk, *args, **kwargs)
+        result_count = 0
+        keep_looping = True
 
-            # It looks like we ran out results
-            if not results:
-                break
+        while keep_looping:
+            # Get the next results
+            results = self.call(service, method, offset=offset, limit=limit, *args, **kwargs)
 
             # Apparently this method doesn't return a list.
             # Why are you even iterating over this?
-            if not isinstance(results, list):
-                yield results
-                break
+            if not isinstance(results, transports.SoftLayerListResult):
+                if isinstance(results, list):
+                    # Close enough, this makes testing a lot easier
+                    results = transports.SoftLayerListResult(results, len(results))
+                else:
+                    yield results
+                    return
 
             for item in results:
                 yield item
                 result_count += 1
 
-            offset += chunk
+            # Got less results than requested, we are at the end
+            if len(results) < limit:
+                keep_looping = False
+            # Got all the needed items
+            if result_count >= results.total_count:
+                keep_looping = False
 
-            if len(results) < chunk:
-                break
+            offset += limit
 
     def __repr__(self):
         return "Client(transport=%r, auth=%r)" % (self.transport, self.auth)

SoftLayer/CLI/hardware/credentials.py

@@ -23,9 +23,9 @@ def cli(env, identifier):
     instance = manager.get_hardware(hardware_id)
 
     table = formatting.Table(['username', 'password'])
-    if 'passwords' not in instance['operatingSystem']:
-        raise exceptions.SoftLayerError("No passwords found in operatingSystem")
-
-    for item in instance['operatingSystem']['passwords']:
-        table.add_row([item.get('username', 'None'), item.get('password', 'None')])
+    for item in instance['softwareComponents']:
+        if 'passwords' not in item:
+            raise exceptions.SoftLayerError("No passwords found in softwareComponents")
+        for credentials in item['passwords']:
+            table.add_row([credentials.get('username', 'None'), credentials.get('password', 'None')])
     env.fout(table)

SoftLayer/CLI/hardware/list.py

@@ -55,8 +55,12 @@
               help='Columns to display. [options: %s]' % ', '.join(column.name for column in COLUMNS),
               default=','.join(DEFAULT_COLUMNS),
               show_default=True)
+@click.option('--limit', '-l',
+              help='How many results to get in one api call, default is 100',
+              default=100,
+              show_default=True)
 @environment.pass_env
-def cli(env, sortby, cpu, domain, datacenter, hostname, memory, network, tag, columns):
+def cli(env, sortby, cpu, domain, datacenter, hostname, memory, network, tag, columns, limit):
     """List hardware servers."""
 
     manager = SoftLayer.HardwareManager(env.client)
@@ -67,7 +71,8 @@ def cli(env, sortby, cpu, domain, datacenter, hostname, memory, network, tag, co
                                     datacenter=datacenter,
                                     nic_speed=network,
                                     tags=tag,
-                                    mask="mask(SoftLayer_Hardware_Server)[%s]" % columns.mask())
+                                    mask="mask(SoftLayer_Hardware_Server)[%s]" % columns.mask(),
+                                    limit=limit)
 
     table = formatting.Table(columns.columns)
     table.sortby = sortby

SoftLayer/CLI/order/place.py

@@ -43,7 +43,7 @@ def cli(env, package_keyname, location, preset, verify, billing, complex_type,
     can then be converted to be made programmatically by calling
     SoftLayer.OrderingManager.place_order() with the same keynames.
 
-    Packages for ordering can be retrived from `slcli order package-list`
+    Packages for ordering can be retrieved from `slcli order package-list`
     Presets for ordering can be retrieved from `slcli order preset-list` (not all packages
     have presets)
 

SoftLayer/CLI/order/place_quote.py

@@ -0,0 +1,91 @@
+"""Place quote"""
+# :license: MIT, see LICENSE for more details.
+
+import json
+
+import click
+
+from SoftLayer.CLI import environment
+from SoftLayer.CLI import formatting
+from SoftLayer.managers import ordering
+
+
+@click.command()
+@click.argument('package_keyname')
+@click.argument('location')
+@click.option('--preset',
+              help="The order preset (if required by the package)")
+@click.option('--name',
+              help="A custom name to be assigned to the quote (optional)")
+@click.option('--send-email',
+              is_flag=True,
+              help="The quote will be sent to the email address associated.")
+@click.option('--complex-type', help=("The complex type of the order. This typically begins"
+                                      " with 'SoftLayer_Container_Product_Order_'."))
+@click.option('--extras',
+              help="JSON string denoting extra data that needs to be sent with the order")
+@click.argument('order_items', nargs=-1)
+@environment.pass_env
+def cli(env, package_keyname, location, preset, name, send_email, complex_type,
+        extras, order_items):
+    """Place a quote.
+
+    This CLI command is used for placing a quote of the specified package in
+    the given location (denoted by a datacenter's long name). Orders made via the CLI
+    can then be converted to be made programmatically by calling
+    SoftLayer.OrderingManager.place_quote() with the same keynames.
+
+    Packages for ordering can be retrieved from `slcli order package-list`
+    Presets for ordering can be retrieved from `slcli order preset-list` (not all packages
+    have presets)
+
+    Items can be retrieved from `slcli order item-list`. In order to find required
+    items for the order, use `slcli order category-list`, and then provide the
+    --category option for each category code in `slcli order item-list`.
+
+    \b
+    Example:
+        # Place quote a VSI with 4 CPU, 16 GB RAM, 100 GB SAN disk,
+        # Ubuntu 16.04, and 1 Gbps public & private uplink in dal13
+        slcli order place-quote --name "foobar" --send-email CLOUD_SERVER DALLAS13 \\
+            GUEST_CORES_4 \\
+            RAM_16_GB \\
+            REBOOT_REMOTE_CONSOLE \\
+            1_GBPS_PUBLIC_PRIVATE_NETWORK_UPLINKS \\
+            BANDWIDTH_0_GB_2 \\
+            1_IP_ADDRESS \\
+            GUEST_DISK_100_GB_SAN \\
+            OS_UBUNTU_16_04_LTS_XENIAL_XERUS_MINIMAL_64_BIT_FOR_VSI \\
+            MONITORING_HOST_PING \\
+            NOTIFICATION_EMAIL_AND_TICKET \\
+            AUTOMATED_NOTIFICATION \\
+            UNLIMITED_SSL_VPN_USERS_1_PPTP_VPN_USER_PER_ACCOUNT \\
+            NESSUS_VULNERABILITY_ASSESSMENT_REPORTING \\
+            --extras '{"virtualGuests": [{"hostname": "test", "domain": "softlayer.com"}]}' \\
+            --complex-type SoftLayer_Container_Product_Order_Virtual_Guest
+
+    """
+    manager = ordering.OrderingManager(env.client)
+
+    if extras:
+        extras = json.loads(extras)
+
+    args = (package_keyname, location, order_items)
+    kwargs = {'preset_keyname': preset,
+              'extras': extras,
+              'quantity': 1,
+              'quote_name': name,
+              'send_email': send_email,
+              'complex_type': complex_type}
+
+    order = manager.place_quote(*args, **kwargs)
+
+    table = formatting.KeyValueTable(['name', 'value'])
+    table.align['name'] = 'r'
+    table.align['value'] = 'l'
+    table.add_row(['id', order['quote']['id']])
+    table.add_row(['name', order['quote']['name']])
+    table.add_row(['created', order['orderDate']])
+    table.add_row(['expires', order['quote']['expirationDate']])
+    table.add_row(['status', order['quote']['status']])
+    env.fout(table)

SoftLayer/CLI/routes.py

@@ -210,6 +210,7 @@
     ('order:place', 'SoftLayer.CLI.order.place:cli'),
     ('order:preset-list', 'SoftLayer.CLI.order.preset_list:cli'),
     ('order:package-locations', 'SoftLayer.CLI.order.package_locations:cli'),
+    ('order:place-quote', 'SoftLayer.CLI.order.place_quote:cli'),
 
     ('rwhois', 'SoftLayer.CLI.rwhois'),
     ('rwhois:edit', 'SoftLayer.CLI.rwhois.edit:cli'),

SoftLayer/CLI/securitygroup/list.py

@@ -16,16 +16,20 @@
 @click.option('--sortby',
               help='Column to sort by',
               type=click.Choice(COLUMNS))
+@click.option('--limit', '-l',
+              help='How many results to get in one api call, default is 100',
+              default=100,
+              show_default=True)
 @environment.pass_env
-def cli(env, sortby):
+def cli(env, sortby, limit):
     """List security groups."""
 
     mgr = SoftLayer.NetworkManager(env.client)
 
     table = formatting.Table(COLUMNS)
     table.sortby = sortby
 
-    sgs = mgr.list_securitygroups()
+    sgs = mgr.list_securitygroups(limit=limit)
     for secgroup in sgs:
         table.add_row([
             secgroup['id'],