Merge pull request #42 from derek10cloud/generic-to-named-export

feat: Support named export

Author: jeffreyaven

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.7.5 (2024-10-02)
+
+- Allowing a `list of objects` in the form of `exported_variable (key)` and `renamed_assigned_exported_variable (value)`
+
 ## 1.7.4 (2024-09-19)
 
 - Colorizing the headings in `stack-deploy info` to green

setup.py

@@ -10,7 +10,7 @@
 
 setup(
     name='stackql-deploy',
-    version='1.7.4',
+    version='1.7.5',
     description='Model driven resource provisioning and deployment framework using StackQL.',
     long_description=readme,
     long_description_content_type='text/x-rst',

stackql_deploy/__init__.py

@@ -1 +1 @@
-__version__ = '1.7.4'
+__version__ = '1.7.5'

stackql_deploy/cmd/base.py

@@ -1,4 +1,4 @@
-from ..lib.utils import perform_retries, run_stackql_command, catch_error_and_exit, run_stackql_query, export_vars, show_query, get_type
+from ..lib.utils import perform_retries, run_stackql_command, catch_error_and_exit, run_stackql_query, export_vars, show_query, get_type, check_all_dicts
 from ..lib.config import setup_environment, load_manifest, get_global_context_and_providers, get_full_context
 from ..lib.templating import get_queries
 
@@ -17,11 +17,24 @@ def __init__(self, stackql, vars, logger, stack_dir, stack_env):
     def process_exports(self, resource, exports_query, exports_retries, exports_retry_delay, dry_run, show_queries,ignore_missing_exports=False):
         expected_exports = resource.get('exports', [])
 
+        # Check if all items in expected_exports are dictionaries
+        all_dicts = check_all_dicts(expected_exports, self.logger)
+
         if len(expected_exports) > 0:
             protected_exports = resource.get('protected', [])
-
             if dry_run:
-                export_data = {key: "<evaluated>" for key in expected_exports}
+                export_data = {}
+                if all_dicts:
+                    for item in expected_exports:
+                        for _, val in item.items():
+                            # when item is a dictionary,
+                            # val(expected_exports) is the key to be exported
+                            export_data[val] = "<evaluated>"
+                else:
+                    # when item is not a dictionary,
+                    # item is the key to be exported
+                    for item in expected_exports:
+                        export_data[item] = "<evaluated>"
                 export_vars(self, resource, export_data, expected_exports, protected_exports)
                 self.logger.info(f"📦 dry run exports query for [{resource['name']}]:\n\n/* exports query */\n{exports_query}\n")
             else:
@@ -44,16 +57,31 @@ def process_exports(self, resource, exports_query, exports_retries, exports_retr
 
                 export = exports[0]
                 if len(exports) == 0:
-                    export = {key: '' for key in expected_exports}
+                    export_data = {}
+                    if all_dicts:
+                        for item in expected_exports:
+                            for key, val in item.items():
+                                export_data[val] = ''
+                    else:
+                        export_data[item] = ''
                 else:
                     export_data = {}
-                    for key in expected_exports:
-                        if isinstance(export.get(key), dict) and 'String' in export[key]:
-                            export_data[key] = export[key]['String']
+                    for item in expected_exports:
+                        if all_dicts:
+                            for key, val in item.items():
+                                # when item is a dictionary,
+                                # compare key(expected_exports) with key(export)
+                                # set val(expected_exports) as key and export[key] as value in export_data
+                                if isinstance(export.get(key), dict) and 'String' in export[key]:
+                                    export_data[val] = export[key]['String']
+                                else:
+                                    export_data[val] = export.get(key, '')
                         else:
-                            export_data[key] = export.get(key, '')
-
-                export_vars(self, resource, export_data, expected_exports, protected_exports)
+                            if isinstance(export.get(item), dict) and 'String' in export[item]:
+                                export_data[item] = export[item]['String']
+                            else:
+                                export_data[item] = export.get(item, '')                    
+                export_vars(self, resource, export_data, expected_exports, all_dicts, protected_exports)
 
     def check_if_resource_exists(self, resource_exists, resource, exists_query, exists_retries, exists_retry_delay, dry_run, show_queries, delete_test=False):
         check_type = 'exists'

stackql_deploy/lib/utils.py

@@ -181,18 +181,21 @@ def perform_retries(resource, query, retries, delay, stackql, logger, delete_tes
     elapsed = time.time() - start_time  # Calculate total elapsed time
     return False
 
-def export_vars(self, resource, export, expected_exports, protected_exports):
-    for key in expected_exports:
-        if key not in export:
-            catch_error_and_exit(f"(utils.export_vars) exported key '{key}' not found in exports for {resource['name']}.", self.logger)
-
+def export_vars(self, resource, export, expected_exports, expected_exports_all_dicts, protected_exports):
+    for item in expected_exports:
+        # check if all items are dictionaries
+        if expected_exports_all_dicts:
+            if list(item.values())[0] not in export:
+                catch_error_and_exit(f"(utils.export_vars) exported item '{list(item.values())[0]}' not found in exports for {resource['name']}.", self.logger)
+        else:
+            if item not in export:
+                catch_error_and_exit(f"(utils.export_vars) exported item '{item}' not found in exports for {resource['name']}.", self.logger)
     for key, value in export.items():
         if key in protected_exports:
             mask = '*' * len(str(value))
-            self.logger.info(f"🔒  set protected variable [{key}] to [{mask}] in exports")
+            self.logger.info(f"🔒 set protected variable [{key}] to [{mask}] in exports")
         else:
-            self.logger.info(f"➡️  set [{key}] to [{value}] in exports")
-
+            self.logger.info(f"📤 set [{key}] to [{value}] in exports")
         self.global_context[key] = value  # Update global context with exported values
 
 def run_ext_script(cmd, logger, exports=None):
@@ -220,4 +223,18 @@ def run_ext_script(cmd, logger, exports=None):
         return exported_vars
     except json.JSONDecodeError:
         catch_error_and_exit(f"(utils.run_ext_script) external scripts must return a valid JSON object {result.stdout}", logger)
-        return None
+        return None
+
+def check_all_dicts(items, logger):
+    """ Check if all items(list) are of the same type (either all dicts or all non-dicts).
+    """
+    all_dicts = all(isinstance(item, dict) for item in items)
+    no_dicts = all(not isinstance(item, dict) for item in items)
+
+    if not all_dicts and not no_dicts:
+        catch_error_and_exit(f"type inconsistency: all items({items}) must be either dicts or non-dicts", logger)
+    
+    if all_dicts:
+        return True
+    else:
+        return False