cli: fix autocompletion binding bug, make all params lowercase

yadvr · yadvr · commit 36e7a7884efe · 2012-11-06T19:41:07.000+05:30
- fix weird autocompletion bug which won't let you enter the letter b [0] - make set params, api and secret key vars lowercase - use partition to get strings for do_set - while installing, check and only then add readline (requires gcc and can fail) - show monkey prompt by default, let users change if needed [0] http://superuser.com/questions/297527/cant-type-the-b-letter-in-python-shell-in-os-x Signed-off-by: Rohit Yadav <bhaisaab@apache.org>
diff --git a/tools/cli/cloudmonkey/__init__.py b/tools/cli/cloudmonkey/__init__.py
@@ -16,6 +16,6 @@
 # under the License.
 
 try:
-    from cloudmonkey import __version__
+    from version import __version__
 except ImportError, e:
     print e
diff --git a/tools/cli/cloudmonkey/cloudmonkey.py b/tools/cli/cloudmonkey/cloudmonkey.py
@@ -25,15 +25,14 @@
     import logging
     import os
     import pdb
-    import readline
-    import rlcompleter
     import shlex
     import sys
     import types
 
     from clint.textui import colored
     from ConfigParser import ConfigParser, SafeConfigParser
 
+    from version import __version__
     from marvin.cloudstackConnection import cloudConnection
     from marvin.cloudstackException import cloudstackAPIException
     from marvin.cloudstackAPI import *
@@ -43,10 +42,17 @@
     import sys
     sys.exit()
 
-# Use following rules for versioning:
-# <cli major version>.<cloudstack minor version>.<cloudstack major version>
-# Example: For CloudStack 4.1.x, CLI version should be 0.1.4
-__version__ = "0.0.4"
+# Fix autocompletion issue, can be put in .pythonstartup
+try:
+    import readline
+except ImportError, e:
+    print "Module readline not found, autocompletions will fail", e
+else:
+    import rlcompleter
+    if 'libedit' in readline.__doc__:
+        readline.parse_and_bind("bind ^I rl_complete")
+    else:
+        readline.parse_and_bind("tab: complete")
 
 log_fmt = '%(asctime)s - %(filename)s:%(lineno)s - [%(levelname)s] %(message)s'
 logger = logging.getLogger(__name__)
@@ -65,8 +71,8 @@ class CloudStackShell(cmd.Cmd):
 
     def __init__(self):
         self.config_fields = {'host': 'localhost', 'port': '8080',
-                              'apiKey': '', 'secretKey': '',
-                              'prompt': 'cloudmonkey> ', 'color': 'true',
+                              'apikey': '', 'secretkey': '',
+                              'prompt': '🐵 cloudmonkey>', 'color': 'true',
                               'log_file':
                               os.path.expanduser('~/.cloudmonkey_log'),
                               'history_file':
@@ -77,7 +83,7 @@ def __init__(self):
             for key in self.config_fields.keys():
                 setattr(self, key, self.config_fields[key])
             config = self.write_config()
-            print("🐵 Set your apiKey, secretKey, host, port, prompt, color,"
+            print("Set your apikey, secretkey, host, port, prompt, color,"
                   " log_file, history_file using the set command!")
 
         for key in self.config_fields.keys():
@@ -93,12 +99,6 @@ def __init__(self):
         if not os.path.exists(self.config_file):
             config = self.write_config()
 
-        # Fix autocompletion issue
-        if sys.platform == "darwin":
-            readline.parse_and_bind("bind ^I rl_complete")
-        else:
-            readline.parse_and_bind("tab: complete")
-
         # Enable history support
         try:
             if os.path.exists(self.history_file):
@@ -204,7 +204,7 @@ def print_result_as_instance(node):
 
     def make_request(self, command, requests={}):
         conn = cloudConnection(self.host, port=int(self.port),
-                               apiKey=self.apiKey, securityKey=self.secretKey,
+                               apiKey=self.apikey, securityKey=self.secretkey,
                                logging=logging.getLogger("cloudConnection"))
         try:
             response = conn.make_request(command, requests)
@@ -317,28 +317,25 @@ def complete_api(self, text, line, begidx, endidx):
     def do_set(self, args):
         """
         Set config for CloudStack CLI. Available options are:
-        host, port, apiKey, secretKey, log_file, history_file
+        host, port, apikey, secretkey, log_file, history_file
         You may also edit your ~/.cloudmonkey_config instead of using set.
 
         Example:
         set host 192.168.56.2
         set prompt 🐵 cloudmonkey>
         set log_file /var/log/cloudmonkey.log
         """
-        args = shlex.split(args.strip())
-        if len(args) == 2:
-            key, value = args
-            # Note: keys and fields should have same names
-            setattr(self, key, value)
-            self.write_config()
-        else:
-            self.print_shell("Please use the syntax: set valid-key value")
+        args = args.strip().partition(" ")
+        key, value = (args[0], args[2])
+        # Note: keys and class attributes should have same names
+        setattr(self, key, value)
+        self.write_config()
 
     def complete_set(self, text, line, begidx, endidx):
         mline = line.partition(" ")[2]
         offs = len(mline) - len(text)
         return [s[offs:] for s in
-               ['host', 'port', 'apiKey', 'secretKey', 'prompt', 'color',
+               ['host', 'port', 'apikey', 'secretkey', 'prompt', 'color',
                 'log_file', 'history_file'] if s.startswith(mline)]
 
     def do_shell(self, args):
diff --git a/tools/cli/cloudmonkey/version.py b/tools/cli/cloudmonkey/version.py
@@ -0,0 +1,22 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+# Use following rules for versioning:
+# <cli major version>.<cloudstack minor version>.<cloudstack major version>
+# Example: For CloudStack 4.1.x, CLI version should be 0.1.4
+__version__ = "0.0.4"
+
diff --git a/tools/cli/setup.py b/tools/cli/setup.py
@@ -26,6 +26,12 @@
 
 name = 'cloudmonkey'
 version = __version__
+requires = ['clint>=0.3.0',]
+
+try:
+    import readline
+except ImportError:
+    requires.append('readline')
 
 setup(
     name = name,
@@ -41,10 +47,7 @@
     platforms = ("Any",),
     license = 'ASL 2.0',
     packages = find_packages(),
-    install_requires = [
-        'clint>=0.3.0',
-        'readline',
-    ],
+    install_requires = requires,
     include_package_data = True,
     zip_safe = False,
     classifiers = [
