Merge branch 'master' of github.com:softlayer/softlayer-python

SoftLayer/CLI/call_api.py

@@ -31,4 +31,4 @@ def cli(env, service, method, parameters, _id, mask, limit, offset):
                              mask=mask,
                              limit=limit,
                              offset=offset)
-    return formatting.iter_to_table(result)
+    env.fout(formatting.iter_to_table(result))

SoftLayer/CLI/cdn/detail.py

@@ -29,4 +29,4 @@ def cli(env, account_id):
     table.add_row(['notes',
                    account.get('cdnAccountNote', formatting.blank())])
 
-    return table
+    env.fout(table)

SoftLayer/CLI/cdn/list.py

@@ -40,4 +40,4 @@ def cli(env, sortby):
         ])
 
     table.sortby = sortby
-    return table
+    env.fout(table)

SoftLayer/CLI/cdn/origin_list.py

@@ -25,4 +25,4 @@ def cli(env, account_id):
                        origin.get('cname', formatting.blank()),
                        origin['originUrl']])
 
-    return table
+    env.fout(table)

SoftLayer/CLI/columns.py

@@ -0,0 +1,58 @@
+"""
+    SoftLayer.CLI.columns
+    ~~~~~~~~~~~~~~~~~~~~~~
+    Utilties for user-defined columns
+
+    :license: MIT, see LICENSE for more details.
+"""
+import click
+
+from SoftLayer import utils
+
+# pylint: disable=unused-argument
+
+
+class ColumnFormatter(object):
+    """Maps each column using a function"""
+    def __init__(self):
+        self.columns = []
+        self.column_funcs = []
+
+    def add_column(self, name, func):
+        """Add a new column along with a formatting function."""
+        self.columns.append(name)
+        self.column_funcs.append(func)
+
+    def row(self, data):
+        """Return a formatted row for the given data."""
+        for column in self.column_funcs:
+            if callable(column):
+                yield column(data)
+            else:
+                yield utils.lookup(data, *column)
+
+
+def get_formatter(column_map):
+    """This function returns a callback to use with click options.
+
+    The retuend function parses a comma-separated value and returns a new
+    ColumnFormatter.
+
+    :param column_map: a dictionary of the form: {col_name: function}.
+    """
+
+    def validate(ctx, param, value):
+        """Click validation function."""
+        try:
+            formatter = ColumnFormatter()
+            for column in [col.strip() for col in value.split(',')]:
+                if column in column_map:
+                    formatter.add_column(column, column_map[column])
+                else:
+                    formatter.add_column(column, (column,))
+
+            return formatter
+        except ValueError:
+            raise click.BadParameter('rolls need to be in format NdM')
+
+    return validate

SoftLayer/CLI/config/__init__.py

@@ -4,6 +4,15 @@
 from SoftLayer.CLI import formatting
 
 
+def _resolve_transport(transport):
+    """recursively look for transports which refer to other transports."""
+    nested_transport = getattr(transport, 'transport', None)
+    if nested_transport is not None:
+        return nested_transport
+
+    return _resolve_transport(nested_transport)
+
+
 def get_settings_from_client(client):
     """Pull out settings from a SoftLayer.BaseClient instance.
 
@@ -21,9 +30,10 @@ def get_settings_from_client(client):
     except AttributeError:
         pass
 
+    transport = _resolve_transport(client.transport)
     try:
-        settings['timeout'] = client.transport.transport.timeout
-        settings['endpoint_url'] = client.transport.transport.endpoint_url
+        settings['timeout'] = transport.timeout
+        settings['endpoint_url'] = transport.endpoint_url
     except AttributeError:
         pass
 

SoftLayer/CLI/config/setup.py

@@ -88,7 +88,7 @@ def cli(env):
     finally:
         config_fd.close()
 
-    return "Configuration Updated Successfully"
+    env.fout("Configuration Updated Successfully")
 
 
 def get_user_input(env):

SoftLayer/CLI/config/show.py

@@ -13,4 +13,4 @@ def cli(env):
     """Show current configuration."""
 
     settings = config.get_settings_from_client(env.client)
-    return config.config_table(settings)
+    env.fout(config.config_table(settings))

SoftLayer/CLI/core.py

@@ -19,9 +19,6 @@
 # pylint: disable=too-many-public-methods, broad-except, unused-argument
 # pylint: disable=redefined-builtin, super-init-not-called
 
-# Disable the cyclic import error. This is handled by an inline import.
-# pylint: disable=cyclic-import
-
 DEBUG_LOGGING_MAP = {
     0: logging.CRITICAL,
     1: logging.WARNING,
@@ -147,24 +144,21 @@ def cli(env,
                 proxy=proxy,
                 config_file=config,
             )
-
-        client.transport = SoftLayer.TimingTransport(client.transport)
         env.client = client
 
+    env.vars['timings'] = SoftLayer.TimingTransport(env.client.transport)
+    env.client.transport = env.vars['timings']
+
 
 @cli.resultcallback()
 @environment.pass_env
-def output_result(env, result, timings=False, **kwargs):
+def output_result(env, timings=False, *args, **kwargs):
     """Outputs the results returned by the CLI and also outputs timings."""
 
-    output = env.fmt(result)
-    if output:
-        env.out(output)
-
-    if timings:
+    if timings and env.vars.get('timings'):
         timing_table = formatting.Table(['service', 'method', 'time'])
 
-        calls = env.client.transport.get_last_calls()
+        calls = env.vars['timings'].get_last_calls()
         for call, _, duration in calls:
             timing_table.add_row([call.service, call.method, duration])
 

SoftLayer/CLI/dns/record_list.py

@@ -46,4 +46,4 @@ def cli(env, zone, data, record, ttl, type):
             record['data']
         ])
 
-    return table
+    env.fout(table)

SoftLayer/CLI/dns/zone_list.py

@@ -27,4 +27,4 @@ def cli(env):
             zone['updateDate'],
         ])
 
-    return table
+    env.fout(table)

SoftLayer/CLI/dns/zone_print.py

@@ -16,4 +16,4 @@ def cli(env, zone):
 
     manager = SoftLayer.DNSManager(env.client)
     zone_id = helpers.resolve_id(manager.resolve_ids, zone, name='zone')
-    return manager.dump_zone(zone_id)
+    env.fout(manager.dump_zone(zone_id))

SoftLayer/CLI/environment.py

@@ -49,6 +49,11 @@ def fmt(self, output):
         """Format output based on current the environment format."""
         return formatting.format_output(output, fmt=self.format)
 
+    def fout(self, output, newline=True):
+        """Format the input and output to the console (stdout)."""
+        if output is not None:
+            self.out(self.fmt(output), newline=newline)
+
     def input(self, prompt, default=None, show_default=True):
         """Provide a command prompt."""
         return click.prompt(prompt, default=default, show_default=show_default)

SoftLayer/CLI/firewall/add.py

@@ -36,7 +36,8 @@ def cli(env, target, firewall_type, high_availability):
             pkg = mgr.get_standard_package(target, is_virt=False)
 
         if not pkg:
-            return "Unable to add firewall - Is network public enabled?"
+            exceptions.CLIAbort(
+                "Unable to add firewall - Is network public enabled?")
 
         env.out("******************")
         env.out("Product: %s" % pkg[0]['description'])
@@ -54,4 +55,4 @@ def cli(env, target, firewall_type, high_availability):
     elif firewall_type == 'server':
         mgr.add_standard_firewall(target, is_virt=False)
 
-    return "Firewall is being created!"
+    env.fout("Firewall is being created!")

SoftLayer/CLI/firewall/cancel.py

@@ -31,4 +31,4 @@ def cli(env, identifier):
     else:
         raise exceptions.CLIAbort('Unknown firewall type: %s' % firewall_type)
 
-    return 'Firewall with id %s is being cancelled!' % identifier
+    env.fout('Firewall with id %s is being cancelled!' % identifier)

SoftLayer/CLI/firewall/detail.py

@@ -23,7 +23,7 @@ def cli(env, identifier):
     else:
         rules = mgr.get_standard_fwl_rules(firewall_id)
 
-    return get_rules_table(rules)
+    env.fout(get_rules_table(rules))
 
 
 def get_rules_table(rules):

SoftLayer/CLI/firewall/edit.py

@@ -175,6 +175,6 @@ def cli(env, identifier):
                         raise exceptions.CLIAbort('Aborted.')
                 else:
                     raise exceptions.CLIAbort('Aborted.')
-                return 'Firewall updated!'
+                env.fout('Firewall updated!')
     else:
         raise exceptions.CLIAbort('Aborted.')

SoftLayer/CLI/firewall/list.py

@@ -70,7 +70,7 @@ def cli(env):
                              'hardwareId')
             ])
 
-    return table
+    env.fout(table)
 
 
 def has_firewall_component(server):

SoftLayer/CLI/globalip/create.py

@@ -41,4 +41,4 @@ def cli(env, ipv6, test):
         table.add_row([price['item']['description'], rate])
 
     table.add_row(['Total monthly cost', "%.2f" % total])
-    return table
+    env.fout(table)

SoftLayer/CLI/globalip/list.py

@@ -47,4 +47,4 @@ def cli(env, ip_version):
                        ip_address['ipAddress']['ipAddress'],
                        assigned,
                        target])
-    return table
+    env.fout(table)

SoftLayer/CLI/image/detail.py

@@ -56,4 +56,4 @@ def cli(env, identifier):
     table.add_row(['datacenters', formatting.listing(sorted(datacenters),
                                                      separator=',')])
 
-    return table
+    env.fout(table)

SoftLayer/CLI/image/import.py

@@ -51,4 +51,4 @@ def cli(env, name, note, osrefcode, uri):
     table.add_row(['created', result['createDate']])
     table.add_row(['guid', result['globalIdentifier']])
     output.append(table)
-    return output
+    env.fout(output)

SoftLayer/CLI/image/list.py

@@ -52,4 +52,4 @@ def cli(env, public):
             image.get('accountId', formatting.blank()),
         ])
 
-    return table
+    env.fout(table)

SoftLayer/CLI/iscsi/detail.py

@@ -51,4 +51,4 @@ def cli(env, identifier, password):
         pass_table.add_row([result['username'], result['password']])
         table.add_row(['users', pass_table])
 
-    return table
+    env.fout(table)

SoftLayer/CLI/iscsi/list.py

@@ -37,4 +37,5 @@ def cli(env):
             iscsi.get('password', formatting.blank()),
             iscsi.get('serviceResourceBackendIpAddress',
                       formatting.blank())])
-    return table
+
+    env.fout(table)

SoftLayer/CLI/loadbal/cancel.py

@@ -26,4 +26,4 @@ def cli(env, identifier):
         raise exceptions.CLIAbort('Aborted.')
 
     mgr.cancel_lb(loadbal_id)
-    return 'Load Balancer with id %s is being cancelled!' % identifier
+    env.fout('Load Balancer with id %s is being cancelled!' % identifier)

SoftLayer/CLI/loadbal/create.py

@@ -22,4 +22,4 @@ def cli(env, billing_id, datacenter):
                               "account. Continue?"):
         raise exceptions.CLIAbort('Aborted.')
     mgr.add_local_lb(billing_id, datacenter=datacenter)
-    return "Load balancer is being created!"
+    env.fout("Load balancer is being created!")

SoftLayer/CLI/loadbal/create_options.py

@@ -32,4 +32,4 @@ def cli(env):
             '%.2f' % float(package['prices'][0]['recurringFee'])
         ])
 
-    return table
+    env.fout(table)

SoftLayer/CLI/loadbal/detail.py

@@ -82,4 +82,5 @@ def cli(env, identifier):
                 table.add_row([' Services', table3])
             else:
                 table.add_row([' Services', 'None'])
-    return table
+
+    env.fout(table)

SoftLayer/CLI/loadbal/group_add.py

@@ -38,4 +38,4 @@ def cli(env, identifier, allocation, port, routing_type, routing_method):
                           routing_type=routing_type,
                           routing_method=routing_method)
 
-    return 'Load balancer service group is being added!'
+    env.fout('Load balancer service group is being added!')

SoftLayer/CLI/loadbal/group_delete.py

@@ -25,4 +25,4 @@ def cli(env, identifier):
         raise exceptions.CLIAbort('Aborted.')
 
     mgr.delete_service_group(group_id)
-    return 'Service group %s is being deleted!' % identifier
+    env.fout('Service group %s is being deleted!' % identifier)

SoftLayer/CLI/loadbal/group_edit.py

@@ -3,6 +3,7 @@
 
 import SoftLayer
 from SoftLayer.CLI import environment
+from SoftLayer.CLI import exceptions
 from SoftLayer.CLI import loadbal
 
 import click
@@ -29,7 +30,8 @@ def cli(env, identifier, allocation, port, routing_type, routing_method):
 
     # check if any input is provided
     if not any([allocation, port, routing_type, routing_method]):
-        return 'At least one property is required to be changed!'
+        raise exceptions.CLIAbort(
+            'At least one property is required to be changed!')
 
     mgr.edit_service_group(loadbal_id,
                            group_id,
@@ -38,4 +40,4 @@ def cli(env, identifier, allocation, port, routing_type, routing_method):
                            routing_type=routing_type,
                            routing_method=routing_method)
 
-    return 'Load balancer service group %s is being updated!' % identifier
+    env.fout('Load balancer service group %s is being updated!' % identifier)

SoftLayer/CLI/loadbal/group_reset.py

@@ -18,4 +18,4 @@ def cli(env, identifier):
     loadbal_id, group_id = loadbal.parse_id(identifier)
 
     mgr.reset_service_group(loadbal_id, group_id)
-    return 'Load balancer service group connections are being reset!'
+    env.fout('Load balancer service group connections are being reset!')

SoftLayer/CLI/loadbal/health_checks.py

@@ -23,4 +23,4 @@ def cli(env):
     for hc_type in hc_types:
         table.add_row([hc_type['id'], hc_type['name']])
 
-    return table
+    env.fout(table)

SoftLayer/CLI/loadbal/list.py

@@ -46,4 +46,4 @@ def cli(env):
             lb_type
         ])
 
-    return table
+    env.fout(table)

SoftLayer/CLI/loadbal/routing_methods.py

@@ -22,4 +22,4 @@ def cli(env):
     for routing_method in routing_methods:
         table.add_row([routing_method['id'], routing_method['name']])
 
-    return table
+    env.fout(table)

SoftLayer/CLI/loadbal/routing_types.py

@@ -21,4 +21,4 @@ def cli(env):
     table.sortby = 'ID'
     for routing_method in routing_methods:
         table.add_row([routing_method['id'], routing_method['name']])
-    return table
+    env.fout(table)

SoftLayer/CLI/loadbal/service_add.py

@@ -50,4 +50,4 @@ def cli(env, identifier, enabled, port, weight, healthcheck_type, ip_address):
                     port=port,
                     weight=weight,
                     hc_type=healthcheck_type)
-    return 'Load balancer service is being added!'
+    env.fout('Load balancer service is being added!')

SoftLayer/CLI/loadbal/service_delete.py

@@ -25,4 +25,4 @@ def cli(env, identifier):
         raise exceptions.CLIAbort('Aborted.')
 
     mgr.delete_service(service_id)
-    return 'Load balancer service %s is being cancelled!' % service_id
+    env.fout('Load balancer service %s is being cancelled!' % service_id)