Add .profile dot command

Closes awslabs#9.

Author: jamesls

awsshell/__init__.py

@@ -66,7 +66,7 @@ def main():
     completer = shellcomplete.AWSShellCompleter(model_completer)
     shell = app.create_aws_shell(completer, model_completer, doc_data)
     if args.profile:
-        shell.on_profile_change(args.profile)
+        shell.profile = args.profile
     shell.run()
 
 

awsshell/app.py

@@ -82,9 +82,45 @@ def run(self, command, application):
             p.communicate()
 
 
+class ProfileHandler(object):
+    USAGE = (
+        '.profile           # Print the current profile\n'
+        '.profile <name>    # Change the current profile\n'
+    )
+
+    def __init__(self, output=sys.stdout, err=sys.stderr):
+        self._output = output
+        self._err = err
+
+    def run(self, command, application):
+        """Get or set the profile.
+
+        If .profile is called with no args, the current profile
+        is displayed.  If the .profile command is called with a
+        single arg, then the current profile for the application
+        will be set to the new value.
+        """
+        if len(command) == 1:
+            profile = application.profile
+            if profile is None:
+                self._output.write(
+                    "Current shell profile: no profile configured\n"
+                    "You can change profiles using: .profile profile-name\n")
+            else:
+                self._output.write("Current shell profile: %s\n" % profile)
+        elif len(command) == 2:
+            new_profile_name = command[1]
+            application.profile = new_profile_name
+            self._output.write("Current shell profile changed to: %s\n" %
+                               new_profile_name)
+        else:
+            self._err.write("Usage:\n%s\n" % self.USAGE)
+
+
 class DotCommandHandler(object):
     HANDLER_CLASSES = {
         'edit': EditHandler,
+        'profile': ProfileHandler,
     }
 
     def __init__(self, output=sys.stdout, err=sys.stderr):
@@ -163,6 +199,7 @@ def __init__(self, completer, model_completer, docs):
         self.key_manager = None
         self._dot_cmd = DotCommandHandler()
         self._env = os.environ.copy()
+        self._profile = None
 
         # These attrs come from the config file.
         self.config_obj = None
@@ -388,11 +425,12 @@ def create_cli_interface(self, display_completions_in_columns):
         cli = CommandLineInterface(application=app, eventloop=loop)
         return cli
 
-    def on_profile_change(self, new_profile_name):
-        """Handler invoked when the user requests to use a new profile.
+    @property
+    def profile(self):
+        return self._profile
 
-        This will inform the necessary objects to use the new profile.
-        """
+    @profile.setter
+    def profile(self, new_profile_name):
         # There's only two things that need to know about new profile
         # changes.
         #
@@ -409,3 +447,4 @@ def on_profile_change(self, new_profile_name):
         # would be worth it.
         self._env['AWS_DEFAULT_PROFILE'] = new_profile_name
         self.completer.change_profile(new_profile_name)
+        self._profile = new_profile_name

tests/unit/test_app.py

@@ -39,6 +39,48 @@ def test_edit_handler():
     assert command_run[0] == 'my-editor'
 
 
+def test_profile_handler_prints_profile():
+    shell = mock.Mock(spec=app.AWSShell)
+    shell.profile = 'myprofile'
+    stdout = compat.StringIO()
+    handler = app.ProfileHandler(stdout)
+    handler.run(['.profile'], shell)
+    assert stdout.getvalue().strip() == 'Current shell profile: myprofile'
+
+
+def test_profile_handler_when_no_profile_configured():
+    shell = mock.Mock(spec=app.AWSShell)
+    shell.profile = None
+    stdout = compat.StringIO()
+    handler = app.ProfileHandler(stdout)
+    handler.run(['.profile'], shell)
+    assert stdout.getvalue() == (
+        'Current shell profile: no profile configured\n'
+        'You can change profiles using: .profile profile-name\n'
+    )
+
+
+def test_profile_command_changes_profile():
+    shell = mock.Mock(spec=app.AWSShell)
+    shell.profile = 'myprofile'
+    stdout = compat.StringIO()
+    handler = app.ProfileHandler(stdout)
+
+    handler.run(['.profile', 'newprofile'], shell)
+
+    assert shell.profile == 'newprofile'
+
+
+def test_profile_prints_error_on_bad_syntax():
+    stderr = compat.StringIO()
+    handler = app.ProfileHandler(None, stderr)
+    handler.run(['.profile', 'a', 'b', 'c'], None)
+
+    # We don't really care about the exact usage message here,
+    # we just want to ensure usage was written to stderr.
+    assert 'Usage' in stderr.getvalue()
+
+
 def test_prints_error_message_on_unknown_dot_command(errstream):
     handler = app.DotCommandHandler(err=errstream)
     handler.handle_cmd(".unknown foo bar", None)
@@ -48,5 +90,6 @@ def test_prints_error_message_on_unknown_dot_command(errstream):
 def test_delegates_to_complete_changing_profile():
     completer = mock.Mock(spec=shellcomplete.AWSShellCompleter)
     shell = app.AWSShell(completer, mock.Mock(), mock.Mock())
-    shell.on_profile_change('mynewprofile')
+    shell.profile = 'mynewprofile'
     assert completer.change_profile.call_args == mock.call('mynewprofile')
+    assert shell.profile == 'mynewprofile'