Merge pull request softlayer#386 from sudorandom/issue-296

underscorephil · underscorephil · commit dbe8fd1d7cd9 · 2014-09-22T15:45:06.000-05:00
Adds common CLI options at all levels
diff --git a/SoftLayer/CLI/core.py b/SoftLayer/CLI/core.py
@@ -69,6 +69,25 @@
 VALID_FORMATS = ['raw', 'table', 'json']
 
 
+def _append_common_options(arg_doc):
+    """Append common options to the doc string"""
+    default_format = 'raw'
+    if sys.stdout.isatty():
+        default_format = 'table'
+
+    arg_doc += """
+Standard Options:
+  --format=ARG            Output format. [Options: table, raw] [Default: %s]
+  -C FILE --config=FILE   Config file location. [Default: ~/.softlayer]
+  --debug=LEVEL           Specifies the debug noise level
+                           1=warn, 2=info, 3=debug
+  --timings               Time each API call and display after results
+  --proxy=PROTO:PROXY_URL HTTP[s] proxy to be use to make API calls
+  -h --help               Show this screen
+""" % default_format
+    return arg_doc
+
+
 class CommandParser(object):
     """Helper class to parse commands.
 
@@ -79,22 +98,17 @@ def __init__(self, env):
 
     def get_main_help(self):
         """Get main help text."""
-        return __doc__.strip()
+        return _append_common_options(__doc__).strip()
 
     def get_module_help(self, module_name):
         """Get help text for a module."""
         module = self.env.load_module(module_name)
         arg_doc = module.__doc__
-        return arg_doc.strip()
+        return _append_common_options(arg_doc).strip()
 
     def get_command_help(self, module_name, command_name):
         """Get help text for a specific command."""
         command = self.env.get_command(module_name, command_name)
-
-        default_format = 'raw'
-        if sys.stdout.isatty():
-            default_format = 'table'
-
         arg_doc = command.__doc__
 
         if 'confirm' in command.options:
@@ -103,18 +117,7 @@ def get_command_help(self, module_name, command_name):
   -y, --really  Confirm all prompt actions
 """
 
-        if '[options]' in arg_doc:
-            arg_doc += """
-Standard Options:
-  --format=ARG            Output format. [Options: table, raw] [Default: %s]
-  -C FILE --config=FILE   Config file location. [Default: ~/.softlayer]
-  --debug=LEVEL           Specifies the debug noise level
-                           1=warn, 2=info, 3=debug
-  --timings               Time each API call and display after results
-  --proxy=PROTO:PROXY_URL HTTP[s] proxy to be use to make API calls
-  -h --help               Show this screen
-""" % default_format
-        return arg_doc.strip()
+        return _append_common_options(arg_doc).strip()
 
     def parse_main_args(self, args):
         """Parse root arguments."""
diff --git a/SoftLayer/CLI/modules/summary.py b/SoftLayer/CLI/modules/summary.py
@@ -1,25 +1,22 @@
 """
-usage: sl summary [options]
+usage: sl summary [<command>] [<args>...] [options]
 
 Display summary information about the account
+
+Options:
+  --sortby=ARG  Column to sort by. options: datacenter, vlans,
+                subnets, IPs, networking, hardware, vs
 """
 # :license: MIT, see LICENSE for more details.
+# pylint: disable=missing-docstring
 
 import SoftLayer
 from SoftLayer.CLI import environment
 from SoftLayer.CLI import formatting
 
 
 class Summary(environment.CLIRunnable):
-    """
-usage: sl summary [options]
-
-Display summary information about the account
-
-Options:
-  --sortby=ARG  Column to sort by. options: datacenter, vlans,
-                subnets, IPs, networking, hardware, vs
-"""
+    __doc__ = __doc__
     action = None
 
     def execute(self, args):
diff --git a/SoftLayer/managers/network.py b/SoftLayer/managers/network.py
@@ -337,8 +337,7 @@ def summary_by_datacenter(self):
         unique_network = []
 
         for vlan in self.list_vlans():
-            datacenter = vlan['primaryRouter']['datacenter']
-            name = datacenter['name']
+            name = utils.lookup(vlan, 'primaryRouter', 'datacenter', 'name')
             if name not in datacenters:
                 datacenters[name] = {
                     'hardwareCount': 0,
diff --git a/SoftLayer/tests/CLI/core_tests.py b/SoftLayer/tests/CLI/core_tests.py
@@ -197,7 +197,6 @@ def test_primary_help(self):
         args = self.parser.parse_main_args(args=[])
         self.assertEqual({
             '--help': False,
-            '-h': False,
             '<args>': [],
             '<module>': None,
             '<command>': None,
@@ -207,7 +206,6 @@ def test_primary_help(self):
         args = self.parser.parse_main_args(args=['help'])
         self.assertEqual({
             '--help': False,
-            '-h': False,
             '<args>': [],
             '<module>': 'help',
             '<command>': None,
@@ -217,7 +215,6 @@ def test_primary_help(self):
         args = self.parser.parse_main_args(args=['help', 'module'])
         self.assertEqual({
             '--help': False,
-            '-h': False,
             '<args>': ['module'],
             '<module>': 'help',
             '<command>': None,
