Change from pass_obj to pass_client

Author: Clark Perkins

stackdio/cli/__init__.py

@@ -7,6 +7,7 @@
 import click
 
 from stackdio.cli.mixins import blueprints, bootstrap, formulas, stacks
+from stackdio.cli.utils import pass_client
 from stackdio.client import StackdioClient
 from stackdio.client.version import __version__
 
@@ -26,26 +27,24 @@ def stackdio(ctx):
                                '`stackdio-cli configure`')
 
     # Put the client in the obj
-    ctx.obj['client'] = client
+    ctx.obj = client
 
 
 @stackdio.command()
-@click.pass_obj
-def configure(obj):
+@pass_client
+def configure(client):
     """
     Configure the client
     """
-    client = obj['client']
-    print('configuring')
+    click.echo('configuring')
 
 
 @stackdio.command('server-version')
-@click.pass_obj
-def server_version(obj):
+@pass_client
+def server_version(client):
     """
     Print the version of the server
     """
-    client = obj['client']
     click.echo('stackdio-server, version {0}'.format(client.get_version()))
 
 
@@ -57,7 +56,7 @@ def server_version(obj):
 
 def main():
     # Just run our CLI tool
-    stackdio(obj={})
+    stackdio()
 
 
 if __name__ == '__main__':

stackdio/cli/mixins/blueprints.py

@@ -6,7 +6,7 @@
 import yaml
 
 from stackdio.cli.blueprints.generator import BlueprintGenerator, BlueprintException
-from stackdio.cli.utils import print_summary
+from stackdio.cli.utils import print_summary, pass_client
 
 
 class BlueprintNotFound(Exception):
@@ -22,13 +22,11 @@ def blueprints():
 
 
 @blueprints.command(name='list')
-@click.pass_obj
-def list_blueprints(obj):
+@pass_client
+def list_blueprints(client):
     """
     List all blueprints
     """
-    client = obj['client']
-
     click.echo('Getting blueprints ... ')
     print_summary('Blueprint', client.list_blueprints())
 
@@ -45,13 +43,11 @@ def _recurse_dir(dirname, extensions, prefix=''):
 
 
 @blueprints.command(name='list-templates')
-@click.pass_obj
-def list_templates(obj):
+@pass_client
+def list_templates(client):
     """
     List all the blueprint templates
     """
-    client = obj['client']
-
     if 'blueprint_dir' not in client.config:
         click.echo('Missing blueprint directory config')
         return
@@ -107,7 +103,7 @@ def _create_single_blueprint(config, template_file, var_files, no_prompt):
 
 
 @blueprints.command(name='create')
-@click.pass_obj
+@pass_client
 @click.option('-m', '--mapping',
               help='The entry in the map file to use')
 @click.option('-t', '--template',
@@ -118,12 +114,10 @@ def _create_single_blueprint(config, template_file, var_files, no_prompt):
                    'var files will override those in var files to the left.')
 @click.option('-n', '--no-prompt', is_flag=True, default=True,
               help='Don\'t prompt for missing variables in the template')
-def create_blueprint(obj, mapping, template, var_file, no_prompt):
+def create_blueprint(client, mapping, template, var_file, no_prompt):
     """
     Create a blueprint
     """
-    client = obj['client']
-
     if not template and not mapping:
         raise click.UsageError('You must specify either a template or a mapping.')
 
@@ -157,14 +151,12 @@ def create_blueprint(obj, mapping, template, var_file, no_prompt):
 
 
 @blueprints.command(name='create-all')
-@click.pass_obj
+@pass_client
 @click.confirmation_option('-y', '--yes', prompt='Really create all blueprints?')
-def create_all_blueprints(obj):
+def create_all_blueprints(client):
     """
     Create all the blueprints in the map file
     """
-    client = obj['client']
-
     blueprint_dir = os.path.expanduser(client.config['blueprint_dir'])
     mapping = yaml.safe_load(open(os.path.join(blueprint_dir, 'mappings.yaml'), 'r'))
 
@@ -190,14 +182,12 @@ def get_blueprint_id(client, blueprint_title):
 
 
 @blueprints.command(name='delete')
-@click.pass_obj
+@pass_client
 @click.argument('title')
-def delete_blueprint(obj, title):
+def delete_blueprint(client, title):
     """
     Delete a blueprint
     """
-    client = obj['client']
-
     blueprint_id = get_blueprint_id(client, title)
 
     click.confirm('Really delete blueprint {0}?'.format(title), abort=True)
@@ -207,15 +197,13 @@ def delete_blueprint(obj, title):
 
 
 @blueprints.command(name='delete-all')
-@click.pass_obj
+@pass_client
 @click.confirmation_option('-y', '--yes', prompt='Really delete all blueprints?  This is '
                            'completely destructive, and you will never get them back.')
-def delete_all_blueprints(obj):
+def delete_all_blueprints(client):
     """
     Delete all blueprints
     """
-    client = obj['client']
-
     for blueprint in client.list_blueprints():
         client.delete_blueprint(blueprint['id'])
         click.secho('Deleted blueprint {0}'.format(blueprint['title']), fg='magenta')

stackdio/cli/mixins/bootstrap.py

@@ -12,7 +12,7 @@
 import keyring
 import yaml
 
-from stackdio.cli.polling import poll_and_wait, TimeoutException
+from stackdio.cli.utils import TimeoutException, poll_and_wait
 
 
 class PublicKeyNotFound(Exception):

stackdio/cli/mixins/formulas.py

@@ -2,7 +2,7 @@
 
 import click
 
-from stackdio.cli.utils import print_summary
+from stackdio.cli.utils import pass_client, print_summary
 
 
 @click.group()
@@ -14,8 +14,8 @@ def formulas():
 
 
 @formulas.command(name='list')
-@click.pass_obj
-def list_formulas(obj):
+@pass_client
+def list_formulas(client):
     """
     List all formulas
     """
@@ -26,12 +26,12 @@ def list_formulas(obj):
 
 
 @formulas.command(name='import')
-@click.pass_obj
+@pass_client
 @click.argument('uri')
 @click.option('-u', '--username', type=click.STRING, help='Git username')
 @click.option('-p', '--password', type=click.STRING, prompt=True, hide_input=True,
               help='Git password')
-def import_formula(obj, uri, username, password):
+def import_formula(client, uri, username, password):
     """
     Import a formula
     """
@@ -56,9 +56,9 @@ def get_formula_id(client, formula_uri):
 
 
 @formulas.command(name='delete')
-@click.pass_obj
+@pass_client
 @click.argument('uri')
-def delete_formula(obj, uri):
+def delete_formula(client, uri):
     """
     Delete a formula
     """

stackdio/cli/mixins/stacks.py

@@ -3,8 +3,7 @@
 import click
 
 from stackdio.cli.mixins.blueprints import get_blueprint_id
-from stackdio.cli.polling import poll_and_wait
-from stackdio.cli.utils import print_summary
+from stackdio.cli.utils import pass_client, print_summary, poll_and_wait
 from stackdio.client.exceptions import StackException
 
 
@@ -20,8 +19,8 @@ def stacks():
 
 
 @stacks.command(name='list')
-@click.pass_obj
-def list_stacks(obj):
+@pass_client
+def list_stacks(client):
     """
     List all stacks
     """
@@ -32,10 +31,10 @@ def list_stacks(obj):
 
 
 @stacks.command(name='launch')
-@click.pass_obj
+@pass_client
 @click.argument('blueprint_title')
 @click.argument('stack_title')
-def launch_stack(obj, blueprint_title, stack_title):
+def launch_stack(client, blueprint_title, stack_title):
     """
     Launch a stack from a blueprint
     """
@@ -68,10 +67,10 @@ def get_stack_id(client, stack_title):
 
 
 @stacks.command(name='history')
-@click.pass_obj
+@pass_client
 @click.argument('stack_title')
 @click.option('-l', '--length', type=click.INT, default=20, help='The number of entries to show')
-def stack_history(obj, stack_title, length):
+def stack_history(client, stack_title, length):
     """
     Print recent history for a stack
     """
@@ -84,9 +83,9 @@ def stack_history(obj, stack_title, length):
 
 
 @stacks.command(name='hostnames')
-@click.pass_obj
+@pass_client
 @click.argument('stack_title')
-def stack_hostnames(obj, stack_title):
+def stack_hostnames(client, stack_title):
     """
     Print hostnames for a stack
     """
@@ -101,9 +100,9 @@ def stack_hostnames(obj, stack_title):
 
 
 @stacks.command(name='delete')
-@click.pass_obj
+@pass_client
 @click.argument('stack_title')
-def delete_stack(obj, stack_title):
+def delete_stack(client, stack_title):
     """
     Delete a stack.  PERMANENT AND DESTRUCTIVE!!!
     """
@@ -120,10 +119,10 @@ def delete_stack(obj, stack_title):
 
 
 @stacks.command(name='action')
-@click.pass_obj
+@pass_client
 @click.argument('stack_title')
 @click.argument('action')
-def perform_action(obj, stack_title, action):
+def perform_action(client, stack_title, action):
     """
     Perform an action on a stack
     """
@@ -195,9 +194,9 @@ def check_status():
 
 
 @stacks.command(name='command-output')
-@click.pass_obj
+@pass_client
 @click.argument('command_id')
-def get_command_output(obj, command_id):
+def get_command_output(client, command_id):
     """
     Get the status and output of a command
     """
@@ -227,9 +226,9 @@ def print_logs(client, stack_id):
 
 
 @stacks.command(name='list-logs')
-@click.pass_obj
+@pass_client
 @click.argument('stack_title')
-def list_stack_logs(obj, stack_title):
+def list_stack_logs(client, stack_title):
     """
     Get a list of stack logs
     """
@@ -241,11 +240,11 @@ def list_stack_logs(obj, stack_title):
 
 
 @stacks.command(name='logs')
-@click.pass_obj
+@pass_client
 @click.argument('stack_title')
 @click.argument('log_type')
 @click.option('-l', '--lines', type=click.INT, default=25, help='number of lines to tail')
-def stack_logs(obj, stack_title, log_type, lines):
+def stack_logs(client, stack_title, log_type, lines):
     """
     Get logs for a stack
     """