Updated generator to use click

Author: Clark Perkins

stackdio/cli/blueprints/__init__.py

@@ -1,58 +1,43 @@
 from __future__ import print_function
 
-import argparse
 import os
 import json
 import sys
 
-from stackdio.cli.blueprints.generator import BlueprintException, BlueprintGenerator
-
-
-def main():
-    parser = argparse.ArgumentParser(
-        description='invoke the stackdio blueprint generator')
+import click
 
-    parser.add_argument('template_file',
-                        help='The template file to generate from')
+from stackdio.cli.blueprints.generator import BlueprintException, BlueprintGenerator
 
-    parser.add_argument('var_files',
-                        metavar='var_file',
-                        nargs='*',
-                        help='The variable files with your custom config.  They will be loaded '
-                             'from left to right, so variables in the rightmost var files will '
-                             'override those in var files to the left.')
 
-    parser.add_argument('-p', '--prompt',
-                        action='store_true',
-                        help='Prompt user for missing variables')
+CONTEXT_SETTINGS = dict(help_option_names=['-h', '--help'])
 
-    parser.add_argument('-d', '--debug',
-                        action='store_true',
-                        help='Print out json string before parsing the json')
 
-    args = parser.parse_args()
+@click.command(context_settings=CONTEXT_SETTINGS)
+@click.argument('template_file')
+@click.argument('var_files', nargs=-1, type=click.File('r'))
+@click.option('-p', '--prompt', is_flag=True, default=False,
+              help='Prompt user for missing variables')
+@click.option('-d', '--debug', is_flag=True, default=False,
+              help='Print out json string before parsing the json')
+def main(template_file, var_files, prompt, debug):
 
     try:
         # Throw all output to stderr
         gen = BlueprintGenerator([os.path.curdir,
                                   os.path.join(os.path.curdir, 'templates'),
-                                  os.path.dirname(os.path.abspath(args.template_file))],
+                                  os.path.dirname(os.path.abspath(template_file))],
                                  output_stream=sys.stderr)
 
         # Generate the blueprint
-        blueprint = gen.generate(args.template_file,
-                                 var_files=args.var_files,
-                                 prompt=args.prompt,
-                                 debug=args.debug)
+        blueprint = gen.generate(template_file,
+                                 var_files=var_files,
+                                 prompt=prompt,
+                                 debug=debug)
     except BlueprintException:
-        sys.exit(1)
+        raise click.Abort('Error processing blueprint')
 
-    print(json.dumps(blueprint, indent=2))
+    click.echo(json.dumps(blueprint, indent=2))
 
 
 if __name__ == '__main__':
-    try:
-        main()
-    except KeyboardInterrupt:
-        sys.stderr.write('Aborting...\n')
-        sys.exit(1)
+    main()

stackdio/cli/blueprints/generator.py

@@ -4,21 +4,14 @@
 import os
 import json
 
+import click
 import yaml
 from jinja2 import Environment, FileSystemLoader, StrictUndefined, meta
 from jinja2.exceptions import TemplateNotFound, TemplateSyntaxError, UndefinedError
 from jinja2.nodes import Assign, Block, Const, If, Not
 from jinja2.filters import do_replace, evalcontextfilter
 
 
-COLORS = {
-    'brown': '\033[0;33m',
-    'green': '\033[0;32m',
-    'red': '\033[01;31m',
-    'endc': '\033[0m',
-}
-
-
 class BlueprintException(Exception):
     pass
 
@@ -67,9 +60,8 @@ def error_exit(self, message, newlines=1):
         :param newlines: the number of newlines to print at the end
         :return: None
         """
-        self.out_stream.write('{0}{1}{2}'.format(COLORS['red'], message, COLORS['endc']))
-        for i in range(0, newlines):
-            self.out_stream.write('\n')
+        click.secho(message, file=self.out_stream, nl=False, fg='red')
+        click.echo('\n' * newlines, nl=False)
         raise BlueprintException()
 
     def warning(self, message, newlines=1):
@@ -79,17 +71,16 @@ def warning(self, message, newlines=1):
         :param newlines: The number of newlines to print at the end
         :return: None
         """
-        self.out_stream.write('{0}{1}{2}'.format(COLORS['brown'], message, COLORS['endc']))
-        for i in range(0, newlines):
-            self.out_stream.write('\n')
+        click.secho(message, file=self.out_stream, nl=False, fg='yellow')
+        click.echo('\n' * newlines, nl=False)
 
     def prompt(self, message):
         """
         Prompts the user for an input.  Prints the prompt to the configured output stream in green
         :param message: the prompt message
         :return: the value the user inputted
         """
-        self.out_stream.write('{0}{1}{2}'.format(COLORS['green'], message, COLORS['endc']))
+        click.secho(message, file=self.out_stream, nl=False, fg='green')
         raw = sys.stdin.readline().strip()
 
         # This should work nicely - if yaml can't parse it properly, then it should be fine to just
@@ -202,7 +193,7 @@ def generate(self, template_file, var_files=(), variables=None, prompt=False, de
 
         :param template_file: The relative location of the template.  It must be in one of the
         directories you specified when creating the Generator object.
-        :param var_file: The location of the variable file (relative or absolute)
+        :param var_files: The location of the variable file(s) (relative or absolute)
         :param variables: A dict of variables to put in the template.
         :param prompt: Option to prompt for missing variables
         :param debug: Print the output of the template before trying to parse it as JSON
@@ -215,7 +206,7 @@ def generate(self, template_file, var_files=(), variables=None, prompt=False, de
 
             context = {}
             for var_file in var_files:
-                yaml_parsed = yaml.safe_load(open(var_file, 'r'))
+                yaml_parsed = yaml.safe_load(var_file)
                 if yaml_parsed:
                     context.update(yaml_parsed)
 
@@ -287,9 +278,9 @@ def generate(self, template_file, var_files=(), variables=None, prompt=False, de
             template_json = template.render(**context)
 
             if debug:
-                print('\n')
-                print(template_json)
-                print('\n')
+                click.echo('\n')
+                click.echo(template_json)
+                click.echo('\n')
 
             # Return a dict object rather than a string
             return json.loads(template_json)

stackdio/cli/mixins/blueprints.py

@@ -1,15 +1,10 @@
-from __future__ import print_function
 
 import json
 import os
-import argparse
-import sys
 
 import click
 import yaml
-from cmd2 import Cmd
 
-from stackdio.client.exceptions import StackException
 from stackdio.cli.blueprints.generator import BlueprintGenerator, BlueprintException
 from stackdio.cli.utils import print_summary
 
@@ -20,6 +15,9 @@ class BlueprintNotFound(Exception):
 
 @click.group()
 def blueprints():
+    """
+    Perform actions on blueprints
+    """
     pass
 
 
@@ -124,11 +122,6 @@ def create_blueprint(obj, mapping, template, var_file, no_prompt):
     """
     Create a blueprint
     """
-    print(mapping)
-    print(template)
-    print(var_file)
-    print(no_prompt)
-
     client = obj['client']
 
     if not template and not mapping:
@@ -165,19 +158,13 @@ def create_blueprint(obj, mapping, template, var_file, no_prompt):
 
 @blueprints.command(name='create-all')
 @click.pass_obj
-@click.option('--no-prompt', is_flag=True, default=True,
-              help='Don\'t prompt to create all blueprints')
-def create_all_blueprints(obj, no_prompt):
+@click.confirmation_option('-y', '--yes', prompt='Really create all blueprints?')
+def create_all_blueprints(obj):
     """
     Create all the blueprints in the map file
     """
     client = obj['client']
 
-    if no_prompt:
-        really = raw_input('Really create all blueprints (y/n)? ')
-        if really not in ['Y', 'y']:
-            return
-
     blueprint_dir = os.path.expanduser(client.config['blueprint_dir'])
     mapping = yaml.safe_load(open(os.path.join(blueprint_dir, 'mappings.yaml'), 'r'))
 
@@ -192,14 +179,14 @@ def create_all_blueprints(obj, no_prompt):
 
 
 def _get_blueprint_id(client, blueprint_title):
-    blueprints = client.search_blueprints(title=blueprint_title)
+    found_blueprints = client.search_blueprints(title=blueprint_title)
 
-    if len(blueprints) == 0:
-        raise click.UsageError('Blueprint [{0}] does not exist'.format(blueprint_title))
-    elif len(blueprints) > 1:
-        raise click.UsageError('Blueprint [{0}] does not exist'.format(blueprint_title))
+    if len(found_blueprints) == 0:
+        raise click.Abort('Blueprint "{0}" does not exist'.format(blueprint_title))
+    elif len(found_blueprints) > 1:
+        raise click.Abort('Multiple blueprints matching "{0}" were found'.format(blueprint_title))
     else:
-        return blueprints[0]['id']
+        return found_blueprints[0]['id']
 
 
 @blueprints.command(name='delete')
@@ -213,10 +200,7 @@ def delete_blueprint(obj, title):
 
     blueprint_id = _get_blueprint_id(client, title)
 
-    really = raw_input('Really delete blueprint {0} (y/n)? '.format(title))
-    if really not in ['y', 'Y']:
-        click.echo('Aborting deletion')
-        return
+    click.confirm('Really delete blueprint {0}?'.format(title), abort=True)
 
     click.echo('Deleting {0}'.format(title))
     client.delete_blueprint(blueprint_id)