Make history/autocomplete work in shell

Author: Clark Perkins

setup.py

@@ -15,8 +15,6 @@
 # limitations under the License.
 #
 
-from __future__ import unicode_literals
-
 import os
 import sys
 
@@ -46,12 +44,13 @@ def test_python_version():
 with open('README.md') as f:
     LONG_DESCRIPTION = f.read()
 
-CFG_DIR = os.path.expanduser("~/.stackdio-cli")
+CFG_DIR = os.path.join(os.path.expanduser('~'), '.stackdio-cli')
 
 requirements = [
     'Jinja2==2.7.3',
     'PyYAML==3.11',
     'click>=6.0,<7.0',
+    'cmd2>=0.6,<0.7',
     'keyring==3.7',
     'readline',
     'requests>=2.4.0,<2.6.0',
@@ -64,7 +63,7 @@ def test_python_version():
     'pylint<=1.2.0',
 ]
 
-if __name__ == "__main__":
+if __name__ == '__main__':
     test_python_version()
 
     setup(
@@ -83,8 +82,8 @@ def test_python_version():
                 [
                     'bootstrap.yaml',
                 ]),
-            (os.path.join(CFG_DIR, "blueprints"),
-                ["blueprints/%s" % f for f in os.listdir("blueprints")]),
+            (os.path.join(CFG_DIR, 'blueprints'),
+                ['blueprints/%s' % f for f in os.listdir('blueprints')]),
         ],
         zip_safe=False,
         install_requires=requirements,
@@ -113,7 +112,6 @@ def test_python_version():
             'Programming Language :: Python :: 3.2',
             'Programming Language :: Python :: 3.3',
             'Programming Language :: Python :: 3.4',
-            'Programming Language :: Python :: 3.5',
             'Topic :: System :: Clustering',
             'Topic :: System :: Distributed Computing',
         ]

stackdio/cli/__init__.py

@@ -14,48 +14,55 @@
 from stackdio.cli import mixins
 from stackdio.cli.shell import get_shell
 from stackdio.client import StackdIO
+from stackdio.client.config import StackdioConfig
+from stackdio.client.exceptions import MissingConfigException
 from stackdio.client.version import __version__
 
 
 CONTEXT_SETTINGS = dict(help_option_names=['-h', '--help'])
 
-CFG_DIR = os.path.expanduser("~/.stackdio-cli/")
-CFG_FILE = os.path.join(CFG_DIR, "config.json")
-KEYRING_SERVICE = "stackdio_cli"
 
+KEYRING_SERVICE = 'stackdio_cli'
 
-def get_client():
-    if not os.path.isfile(CFG_FILE):
-        click.echo('It looks like you haven\'t used this CLI before.  Please run '
-                   '`stackdio-cli configure`'.format(sys.argv[0]))
-        sys.exit(1)
 
-    config = json.load(open(CFG_FILE, 'r'))
-    config['blueprint_dir'] = os.path.expanduser(config.get('blueprint_dir', ''))
+def load_config(fail_on_misconfigure, section='stackdio'):
+    try:
+        return StackdioConfig(section)
+    except MissingConfigException:
+        if fail_on_misconfigure:
+            click.echo('It looks like you haven\'t used this CLI before.  Please run '
+                       '`stackdio-cli configure`'.format(sys.argv[0]))
+            sys.exit(1)
+        else:
+            return None
+
 
+def get_client(config):
     return StackdIO(
-        base_url=config["url"],
+        base_url=config['url'],
         auth=(
-            config["username"],
-            keyring.get_password(KEYRING_SERVICE, config.get("username") or "")
+            config['username'],
+            keyring.get_password(KEYRING_SERVICE, config.get('username') or '')
         ),
         verify=config.get('verify', True)
     )
 
 
 class StackdioObj(object):
 
-    def __init__(self, ctx):
+    def __init__(self, ctx, fail_on_misconfigure):
         super(StackdioObj, self).__init__()
+        self.config = load_config(fail_on_misconfigure)
         self.shell = get_shell(ctx)
-        self.client = get_client()
+        if self.config:
+            self.client = get_client(self.config)
 
 
 @click.group(context_settings=CONTEXT_SETTINGS, invoke_without_command=True)
 @click.version_option(__version__, '-v', '--version')
 @click.pass_context
 def stackdio(ctx):
-    ctx.obj = StackdioObj(ctx)
+    ctx.obj = StackdioObj(ctx, ctx.invoked_subcommand != 'configure')
 
     if ctx.invoked_subcommand is None:
         ctx.obj.shell.cmdloop()
@@ -81,7 +88,11 @@ def formulas():
 
 @stackdio.command()
 def configure():
-    pass
+    config = StackdioConfig(create=True)
+
+    config.prompt_for_config()
+
+    config.save()
 
 
 @stackdio.command('server-version')

stackdio/cli/shell.py

@@ -16,13 +16,12 @@
 #
 
 import os
-from cmd import Cmd
+from cmd2 import Cmd
 
 import click
 
 from stackdio.client.version import __version__
 
-
 try:
     import readline
 except ImportError:

stackdio/client/compat.py

@@ -0,0 +1,23 @@
+# -*- coding: utf-8 -*-
+
+# Copyright 2014,  Digital Reasoning
+#
+# Licensed 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.
+#
+
+try:
+    # Python 2
+    from ConfigParser import ConfigParser, NoOptionError
+except ImportError:
+    # Python 3
+    from configparser import ConfigParser, NoOptionError

stackdio/client/config.py

@@ -0,0 +1,121 @@
+# -*- coding: utf-8 -*-
+
+# Copyright 2014,  Digital Reasoning
+#
+# Licensed 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.
+#
+
+import os
+
+import click
+import requests
+from requests.exceptions import ConnectionError, MissingSchema
+
+from stackdio.client.compat import ConfigParser, NoOptionError
+from stackdio.client.exceptions import MissingConfigException
+
+
+CFG_DIR = os.path.join(os.path.expanduser('~'), '.stackdio')
+CFG_FILE = os.path.join(CFG_DIR, 'client.cfg')
+
+
+class StackdioConfig(object):
+
+    def __init__(self, section='stackdio', config_file=CFG_FILE, create=False):
+        super(StackdioConfig, self).__init__()
+
+        self._cfg_file = config_file
+
+        if not create and not os.path.isfile(config_file):
+            raise MissingConfigException('{0} does not exist'.format(config_file))
+
+        self._config = ConfigParser()
+
+        if create:
+            self._config.add_section(section)
+        else:
+            self._config.read(config_file)
+
+            # Make the blueprint dir usable
+            new_blueprint_dir = os.path.expanduser(self.get('blueprint_dir'))
+            self._config.set(section, 'blueprint_dir', new_blueprint_dir)
+
+        self.section = section
+
+    def save(self):
+        with open(self._cfg_file, 'w') as f:
+            self._config.write(f)
+
+    def __getitem__(self, item):
+        try:
+            return self._config.get(self.section, item)
+        except NoOptionError:
+            raise KeyError(item)
+
+    def __setitem__(self, key, value):
+        self._config.set(self.section, key, value)
+
+    def get(self, item, default=None):
+        try:
+            return self[item]
+        except KeyError:
+            return default
+
+    def items(self):
+        return self._config.items(self.section)
+
+    def prompt_for_config(self):
+        self.get_url()
+
+    def _test_url(self, url):
+        try:
+            r = requests.get(url, verify=self.get('verify', True))
+            return (200 <= r.status_code < 300) or r.status_code == 403
+        except ConnectionError:
+            return False
+        except MissingSchema:
+            print("You might have forgotten http:// or https://")
+            return False
+
+    def get_url(self):
+
+        if self.get('url') is not None:
+            val = click.prompt('Keep existing url', default='y', prompt_suffix=' (y|n)? ')
+            if val not in ('N', 'n'):
+                return
+
+        val = click.prompt('Does your stackd.io server have a self-signed SSL certificate',
+                           default='n', prompt_suffix=' (y|n)? ')
+
+        if val in ('Y', 'y'):
+            self['verify'] = False
+        else:
+            self['verify'] = True
+
+        self['url'] = None
+
+        while self['url'] is None:
+            url = click.prompt('What is the URL of your stackd.io server', prompt_suffix='? ')
+            if url.endswith('api'):
+                url += '/'
+            elif url.endswith('api/'):
+                pass
+            elif url.endswith('/'):
+                url += 'api/'
+            else:
+                url += '/api/'
+            if self._test_url(url):
+                self['url'] = url
+            else:
+                click.echo('There was an error while attempting to contact that server.  '
+                           'Try again.')

stackdio/client/exceptions.py

@@ -16,6 +16,10 @@
 #
 
 
+class MissingConfigException(Exception):
+    pass
+
+
 class StackException(Exception):
     pass