Add cli tool

Author: costimuraru

hierarchical_yaml/config_generator.py

@@ -18,6 +18,58 @@
 from .remote_state import S3TerraformRemoteStateRetriever
 
 
+class ConfigProcessor(object):
+
+    def process(self, cwd=None, path=None, filters=(), exclude_keys=(), enclosing_key=None, output_format=yaml, print_data=False,
+                output_file=None, skip_interpolations=False, skip_interpolation_validation=False):
+
+        path = self.get_relative_path(path)
+
+        if skip_interpolations:
+            skip_interpolation_validation = True
+
+        if cwd is None:
+            cwd = os.getcwd()
+
+        generator = ConfigGenerator(cwd, path)
+        generator.generate_hierarchy()
+        generator.process_hierarchy()
+
+        if not skip_interpolations:
+            generator.resolve_interpolations()
+            generator.add_dynamic_data()
+            generator.resolve_interpolations()
+
+        if len(filters) > 0:
+            generator.filter_data(filters)
+
+        if len(exclude_keys) > 0:
+            generator.exclude_keys(exclude_keys)
+
+        if not skip_interpolation_validation:
+            generator.validate_interpolations()
+
+        data = generator.add_enclosing_key(enclosing_key) if enclosing_key else generator.generated_data
+
+        formatted_data = generator.output_data(data, output_format)
+
+        if print_data:
+            print(formatted_data)
+
+        if output_file:
+            with open(output_file, 'w') as f:
+                f.write(formatted_data)
+
+        return data
+
+    @staticmethod
+    def get_relative_path(self, path):
+        cwd = os.path.join(os.getcwd(), '')
+        if path.startswith(cwd):
+            return path[len(cwd):]
+        return path
+
+
 class ConfigGenerator(object):
     """
     this class is used to create a config generator object which will be used to generate cluster definition files
@@ -160,55 +212,3 @@ def resolve_interpolations(self):
 
     def validate_interpolations(self):
         self.interpolation_validator.check_all_interpolations_resolved(self.generated_data)
-
-
-class ConfigProcessor(object):
-
-    def process(self, cwd=None, path=None, filters=(), exclude_keys=(), enclosing_key=None, output_format=yaml, print_data=False,
-                output_file=None, skip_interpolations=False, skip_interpolation_validation=False):
-
-        path = self.get_relative_path(path)
-
-        if skip_interpolations:
-            skip_interpolation_validation = True
-
-        if cwd is None:
-            cwd = os.getcwd()
-
-        generator = ConfigGenerator(cwd, path)
-        generator.generate_hierarchy()
-        generator.process_hierarchy()
-
-        if not skip_interpolations:
-            generator.resolve_interpolations()
-            generator.add_dynamic_data()
-            generator.resolve_interpolations()
-
-        if len(filters) > 0:
-            generator.filter_data(filters)
-
-        if len(exclude_keys) > 0:
-            generator.exclude_keys(exclude_keys)
-
-        if not skip_interpolation_validation:
-            generator.validate_interpolations()
-
-        data = generator.add_enclosing_key(enclosing_key) if enclosing_key else generator.generated_data
-
-        formatted_data = generator.output_data(data, output_format)
-
-        if print_data:
-            print(formatted_data)
-
-        if output_file:
-            with open(output_file, 'w') as f:
-                f.write(formatted_data)
-
-        return data
-
-    @staticmethod
-    def get_relative_path(self, path):
-        cwd = os.path.join(os.getcwd(), '')
-        if path.startswith(cwd):
-            return path[len(cwd):]
-        return path

hierarchical_yaml/main.py

@@ -0,0 +1,34 @@
+import argparse
+import os
+from .config_generator import ConfigProcessor
+
+def run(args=None):
+    """ App entry point """
+
+    parser = argparse.ArgumentParser()
+    parser.add_argument('--output-file', dest='output_file', type=str,
+                        help='output file location')
+    parser.add_argument('--format', dest='output_format', type=str, default="yaml",
+                        help='output file format')
+    parser.add_argument('--filter', dest='filter', action='append',
+                        help='keep these keys from the generated data')
+    parser.add_argument('--exclude', dest='exclude', action='append',
+                        help='exclude these keys from generated data')
+    parser.add_argument('--skip-interpolation-validation', action='store_true',
+                        help='will not throw an error if interpolations can not be resolved')
+    parser.add_argument('--skip-interpolation-resolving', action='store_true',
+                        help='do not perform any AWS calls to resolve interpolations')
+    parser.add_argument('--enclosing-key', dest='enclosing_key', type=str,
+                        help='enclose the generated data under a common key')
+    parser.add_argument('--cwd', dest='cwd', type=str, default="",
+                            help='the working directory')
+
+    opts = parser.parse_args(args)
+    cwd = opts.cwd if opts.cwd else os.getcwd()
+    filters = opts.filter if opts.filter else ()
+    excluded_keys = opts.exclude if opts.exclude else ()
+
+    config_processor = ConfigProcessor()
+    config_processor.process(cwd, opts.path, filters, excluded_keys, opts.enclosing_key, opts.output_format,
+                          print_data=True, opts.output_file, opts.skip_interpolation_resolving, 
+                          opts.skip_interpolation_validation)

setup.py

@@ -42,5 +42,9 @@
         'pyyaml',
         'backports.functools_lru_cache',
         'boto3'],
-    entry_points={}
+    entry_points={
+        'console_scripts': [
+            'hyaml = hierarchical_yaml.main:run'
+        ]
+    }
 )