Merge branch '1026' of github.com:allmightyspiff/softlayer-python into 1026

Author: allmightyspiff

CHANGELOG.md

@@ -1,7 +1,17 @@
 # Change Log
 
 
-## [5.5.1] - 2018-08-31
+## [5.5.3] - 2018-08-31
+- Changes: https://github.com/softlayer/softlayer-python/compare/v5.5.2...v5.5.3
+
++ Added `slcli user delete`
++ #1023 Added `slcli order quote` to let users create a quote from the slcli.
++ #1032 Fixed vs upgrades when using flavors.
++ #1034 Added pagination to ticket list commands
++ #1037 Fixed DNS manager to be more flexible and support more zone types.
++ #1044 Pinned Click library version at >=5 < 7
+
+## [5.5.2] - 2018-08-31
 - Changes: https://github.com/softlayer/softlayer-python/compare/v5.5.1...v5.5.2
 
 + #1018 Fixed hardware credentials.

README.rst

@@ -17,7 +17,7 @@ SoftLayer API Python Client
 
 
 This library provides a simple Python client to interact with `SoftLayer's
-XML-RPC API <http://developer.softlayer.com/reference/softlayerapi>`_. 
+XML-RPC API <https://softlayer.github.io/reference/softlayerapi>`_.
 
 A command-line interface is also included and can be used to manage various
 SoftLayer products and services.
@@ -120,7 +120,7 @@ If you are using the library directly in python, you can do something like this.
 
 System Requirements
 -------------------
-* Python 2.7, 3.3, 3.4, 3.5 or 3.6.
+* Python 2.7, 3.3, 3.4, 3.5, 3.6, or 3.7.
 * A valid SoftLayer API username and key.
 * A connection to SoftLayer's private network is required to use
   our private network API endpoints.
@@ -129,7 +129,7 @@ Python Packages
 ---------------
 * six >= 1.7.0
 * prettytable >= 0.7.0
-* click >= 5
+* click >= 5, < 7
 * requests >= 2.18.4
 * prompt_toolkit >= 0.53
 * pygments >= 2.0.0

SoftLayer/CLI/columns.py

@@ -57,7 +57,7 @@ def mask(self):
 def get_formatter(columns):
     """This function returns a callback to use with click options.
 
-    The retuend function parses a comma-separated value and returns a new
+    The returend function parses a comma-separated value and returns a new
     ColumnFormatter.
 
     :param columns: a list of Column instances

SoftLayer/CLI/dns/record_add.py

@@ -5,24 +5,86 @@
 
 import SoftLayer
 from SoftLayer.CLI import environment
+from SoftLayer.CLI import exceptions
 from SoftLayer.CLI import helpers
 # pylint: disable=redefined-builtin
 
 
 @click.command()
-@click.argument('zone')
 @click.argument('record')
-@click.argument('type')
+@click.argument('record_type')
 @click.argument('data')
+@click.option('--zone',
+              help="Zone name or identifier that the resource record will be associated with.\n"
+                   "Required for all record types except PTR")
 @click.option('--ttl',
-              type=click.INT,
-              default=7200,
+              default=900,
               show_default=True,
               help='TTL value in seconds, such as 86400')
+@click.option('--priority',
+              default=10,
+              show_default=True,
+              help='The priority of the target host. (MX or SRV type only)')
+@click.option('--protocol',
+              type=click.Choice(['tcp', 'udp', 'tls']),
+              default='tcp',
+              show_default=True,
+              help='The protocol of the service, usually either TCP or UDP. (SRV type only)')
+@click.option('--port',
+              type=click.INT,
+              help='The TCP/UDP/TLS port on which the service is to be found. (SRV type only)')
+@click.option('--service',
+              help='The symbolic name of the desired service. (SRV type only)')
+@click.option('--weight',
+              default=5,
+              show_default=True,
+              help='Relative weight for records with same priority. (SRV type only)')
 @environment.pass_env
-def cli(env, zone, record, type, data, ttl):
-    """Add resource record."""
+def cli(env, record, record_type, data, zone, ttl, priority, protocol, port, service, weight):
+    """Add resource record.
+
+    Each resource record contains a RECORD and DATA property, defining a resource's name and it's target data.
+    Domains contain multiple types of resource records so it can take one of the following values: A, AAAA, CNAME,
+    MX, SPF, SRV, and PTR.
+
+    About reverse records (PTR), the RECORD value must to be the public Ip Address of device you would like to manage
+    reverse DNS.
+
+        slcli dns record-add 10.10.8.21 PTR myhost.com --ttl=900
+
+    Examples:
+
+        slcli dns record-add myhost.com A 192.168.1.10 --zone=foobar.com --ttl=900
+
+        slcli dns record-add myhost.com AAAA 2001:DB8::1 --zone=foobar.com
+
+        slcli dns record-add 192.168.1.2 MX 192.168.1.10 --zone=foobar.com --priority=11 --ttl=1800
+
+        slcli dns record-add myhost.com TXT "txt-verification=rXOxyZounZs87oacJSKvbUSIQ" --zone=2223334
+
+        slcli dns record-add myhost.com SPF "v=spf1 include:_spf.google.com ~all" --zone=2223334
+
+        slcli dns record-add myhost.com SRV 192.168.1.10 --zone=2223334 --service=foobar --port=80 --protocol=TCP
+
+    """
 
     manager = SoftLayer.DNSManager(env.client)
-    zone_id = helpers.resolve_id(manager.resolve_ids, zone, name='zone')
-    manager.create_record(zone_id, record, type, data, ttl=ttl)
+    record_type = record_type.upper()
+
+    if zone and record_type != 'PTR':
+        zone_id = helpers.resolve_id(manager.resolve_ids, zone, name='zone')
+
+        if record_type == 'MX':
+            manager.create_record_mx(zone_id, record, data, ttl=ttl, priority=priority)
+        elif record_type == 'SRV':
+            manager.create_record_srv(zone_id, record, data, protocol, port, service,
+                                      ttl=ttl, priority=priority, weight=weight)
+        else:
+            manager.create_record(zone_id, record, record_type, data, ttl=ttl)
+
+    elif record_type == 'PTR':
+        manager.create_record_ptr(record, data, ttl=ttl)
+    else:
+        raise exceptions.CLIAbort("%s isn't a valid record type or zone is missing" % record_type)
+
+    click.secho("%s record added successfully" % record_type, fg='green')

SoftLayer/CLI/order/package_list.py

@@ -7,7 +7,8 @@
 from SoftLayer.CLI import formatting
 from SoftLayer.managers import ordering
 
-COLUMNS = ['name',
+COLUMNS = ['id',
+           'name',
            'keyName',
            'type']
 
@@ -51,6 +52,7 @@ def cli(env, keyword, package_type):
 
     for package in packages:
         table.add_row([
+            package['id'],
             package['name'],
             package['keyName'],
             package['type']['keyName']

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

@@ -211,6 +211,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/virt/capacity/__init__.py

@@ -1,42 +1,42 @@
 """Manages Reserved Capacity."""
 # :license: MIT, see LICENSE for more details.
+
 import importlib
-import click
-import types
-import SoftLayer
 import os
-from SoftLayer.CLI import environment
-from SoftLayer.CLI import formatting
 
-from pprint import pprint as pp
-class capacityCommands(click.MultiCommand):
+import click
+
+CONTEXT = {'help_option_names': ['-h', '--help'],
+           'max_content_width': 999}
+
+
+class CapacityCommands(click.MultiCommand):
     """Loads module for capacity related commands."""
 
-    def __init__(self, *path, **attrs):
+    def __init__(self, **attrs):
         click.MultiCommand.__init__(self, **attrs)
         self.path = os.path.dirname(__file__)
 
     def list_commands(self, ctx):
         """List all sub-commands."""
- 
-        rv = []
+        commands = []
         for filename in os.listdir(self.path):
             if filename == '__init__.py':
                 continue
             if filename.endswith('.py'):
-                rv.append(filename[:-3])
-        rv.sort()
-        return rv
+                commands.append(filename[:-3])
+        commands.sort()
+        return commands
 
-    def get_command(self, ctx, name):
+    def get_command(self, ctx, cmd_name):
         """Get command for click."""
-        path = "%s.%s" % (__name__, name)
+        path = "%s.%s" % (__name__, cmd_name)
         module = importlib.import_module(path)
         return getattr(module, 'cli')
 
-@click.group(cls=capacityCommands, 
-             help="Manages virtual server reserved capacity")
-@environment.pass_env
-def cli(env):
-    """Manages Capacity"""
+
+# Required to get the sub-sub-sub command to work.
+@click.group(cls=CapacityCommands, context_settings=CONTEXT)
+def cli():
+    """Base command for all capacity related concerns"""
     pass