tgwrap 0.8.11__py3-none-any.whl → 0.8.13__py3-none-any.whl

tgwrap/cli.py

@@ -50,7 +50,7 @@ CLICK_CONTEXT_SETTINGS = dict(help_option_names=['-h', '--help'])
 
 TG_COMMANDS=[
     'init', 'validate', 'validate-inputs', 'plan', 'apply',
-    'destroy', 'info', 'output', 'show',
+    'destroy', 'info', 'output', 'show', 'state',
     ]
 STAGES=['global', 'sbx', 'dev', 'qas', 'run', 'tst', 'acc', 'prd']
 class DefaultGroup(click.Group):
@@ -107,7 +107,7 @@ def main():
         ignore_unknown_options=True,
     ),
 )
-@click.argument('command', type=click.Choice(TG_COMMANDS + ['state', 'render-json']))
+@click.argument('command', type=click.Choice(TG_COMMANDS + ['render-json']))
 @click.option('--verbose', '-v', is_flag=True, default=False,
     help='Verbose printing',
     show_default=True
@@ -210,6 +210,10 @@ def run(command, verbose, debug, dry_run, no_lock, update, upgrade,
     help='Run the command step by step and stop when an error occurs (where applicable)',
     show_default=True
     )
+@click.option('--continue-on-error', '-C', is_flag=True, default=False,
+    help='When running in step by step, continue when an error occurs',
+    show_default=True
+    )
 @click.option('--planfile', '-p', is_flag=True, default=False,
     help='Use the generated planfile when applying the changes',
     show_default=True
@@ -244,7 +248,7 @@ def run(command, verbose, debug, dry_run, no_lock, update, upgrade,
 @click.argument('terragrunt-args', nargs=-1, type=click.UNPROCESSED)
 @click.version_option(version=__version__)
 def run_all(command, verbose, debug, dry_run, no_lock, update, upgrade, exclude_external_dependencies,
-    step_by_step, planfile, auto_approve, clean, working_dir, start_at_step,
+    step_by_step, continue_on_error, planfile, auto_approve, clean, working_dir, start_at_step,
     limit_parallelism, include_dir, exclude_dir, terragrunt_args):
     """ Executes a terragrunt command across multiple projects """
 
@@ -260,6 +264,7 @@ def run_all(command, verbose, debug, dry_run, no_lock, update, upgrade, exclude_
         upgrade=upgrade,
         exclude_external_dependencies=exclude_external_dependencies,
         step_by_step=step_by_step,
+        continue_on_error=continue_on_error,
         planfile=planfile,
         auto_approve=auto_approve,
         clean=clean,
@@ -392,9 +397,10 @@ def run_import(address, id, verbose, dry_run, working_dir, no_lock, terragrunt_a
     help='A glob of a directory that needs to be excluded, this option can be used multiple times. For example: -E "integrations/\*/\*"',
     show_default=True,
     )
-@click.option('--planfile-dir', '-P', default=None,
+@click.option('--planfile-dir', '-P', default='.terragrunt-cache/current',
     help='Relative path to directory with plan file (or set TGWRAP_PLANFILE_DIR environment variable), see README for more details',
     envvar='TGWRAP_PLANFILE_DIR', type=click.Path(),
+    show_default=True,
     )
 @click.argument('terragrunt-args', nargs=-1, type=click.UNPROCESSED)
 @click.version_option(version=__version__)

tgwrap/deploy.py

@@ -171,66 +171,69 @@ def prepare_deploy_config(step, config, source_dir, source_config_dir, target_di
             printer.warning(f'Source path of config file does not exist: {source_path}')
 
     for ss, substack in substack_configs:
-        printer.verbose(f'Found substack : {ss}')
-
-        source_path = os.path.join(
-            source_dir, source_stage, substack['source'], ''
-            )
-        target_path = os.path.join(
-            target_dir, substack['target'], ''
-            )
-
-        include_modules = substack['include_modules'] if len(substack.get('include_modules', {})) > 0 else []
-        printer.verbose(f'Include modules: {include_modules}')
-
-        if include_modules:
-            # get all directories in the substack and create an exlude_modules list from that
-            source_directories = get_directories(source_path)
-            exclude_modules = list(set(source_directories) - set(include_modules))
-        else:
-            exclude_modules = substack.get('exclude_modules', [])
-        
-        if os.path.exists(source_path):
-            deploy_actions[f'substack -> {substack["target"]}'] = {
-                "source": source_path,
-                "target": target_path,
-                "excludes": exclude_modules,
-            }
+        if 'applies_to_stages' in substack and target_stage not in substack['applies_to_stages']:
+            printer.verbose(f'Target stage {target_stage} not applicable for substack {ss}.')
         else:
-            printer.warning(f'Source path of substack does not exist: {source_path}')
-
-        if len(substack.get('configs', [])) > 0:
-            # run some checks and sets some variables
-            if not source_config_dir:
-                raise Exception("Config files must be deployed but 'config_path' variable is not set!")
-            elif not config_dir:
-                raise Exception("Config files must be deployed but 'config_dir' variable is not set!")
+            printer.verbose(f'Found substack : {ss}')
 
+            source_path = os.path.join(
+                source_dir, source_stage, substack['source'], ''
+                )
             target_path = os.path.join(
-                target_dir, config_dir, module_name, target_stage, substack['target'], '',
+                target_dir, substack['target'], ''
                 )
-            # the target path might not exist
-            try:
-                os.makedirs(target_path)
-            except FileExistsError:
-                pass
 
-        for cfg in substack.get('configs', []):
-            printer.verbose(f'Found substack config file : {cfg}')
+            include_modules = substack['include_modules'] if len(substack.get('include_modules', {})) > 0 else []
+            printer.verbose(f'Include modules: {include_modules}')
 
-            full_source_path = os.path.join(
-                source_config_dir, source_stage, substack['source'], cfg
-                )
+            if include_modules:
+                # get all directories in the substack and create an exlude_modules list from that
+                source_directories = get_directories(source_path)
+                exclude_modules = list(set(source_directories) - set(include_modules))
+            else:
+                exclude_modules = substack.get('exclude_modules', [])
             
-            full_target_path = os.path.dirname(os.path.join(target_path, cfg))
-            # print("source: ", full_source_path)
-            # print("target: ", full_target_path)
             if os.path.exists(source_path):
-                deploy_actions[f"substack {substack['target']} configs -> {os.path.join(substack['source'], cfg)}"] = {
-                    "source": full_source_path,
-                    "target": full_target_path,
+                deploy_actions[f'substack -> {substack["target"]}'] = {
+                    "source": source_path,
+                    "target": target_path,
+                    "excludes": exclude_modules,
                 }
             else:
-                printer.warning(f'Source path of config file does not exist: {source_path}')
+                printer.warning(f'Source path of substack does not exist: {source_path}')
+
+            if len(substack.get('configs', [])) > 0:
+                # run some checks and sets some variables
+                if not source_config_dir:
+                    raise Exception("Config files must be deployed but 'config_path' variable is not set!")
+                elif not config_dir:
+                    raise Exception("Config files must be deployed but 'config_dir' variable is not set!")
+
+                target_path = os.path.join(
+                    target_dir, config_dir, module_name, target_stage, substack['target'], '',
+                    )
+                # the target path might not exist
+                try:
+                    os.makedirs(target_path)
+                except FileExistsError:
+                    pass
+
+            for cfg in substack.get('configs', []):
+                printer.verbose(f'Found substack config file : {cfg}')
+
+                full_source_path = os.path.join(
+                    source_config_dir, source_stage, substack['source'], cfg
+                    )
+                
+                full_target_path = os.path.dirname(os.path.join(target_path, cfg))
+                # print("source: ", full_source_path)
+                # print("target: ", full_target_path)
+                if os.path.exists(source_path):
+                    deploy_actions[f"substack {substack['target']} configs -> {os.path.join(substack['source'], cfg)}"] = {
+                        "source": full_source_path,
+                        "target": full_target_path,
+                    }
+                else:
+                    printer.warning(f'Source path of config file does not exist: {source_path}')
 
     return deploy_actions

tgwrap/main.py

@@ -102,7 +102,7 @@ class TgWrap():
             'info': '{base_command} terragrunt-info --terragrunt-non-interactive {update} {upgrade} {common}',
             'plan': '{base_command} {command} --terragrunt-non-interactive  -out={planfile_name} {lock_level} {update} {parallelism} {common}',
             'apply': '{base_command} {command} {non_interactive} {no_auto_approve} {update} {parallelism} {common} {planfile}',
-            'show': '{base_command} {command} --terragrunt-non-interactive {planfile_name} {common}',
+            'show': '{base_command} {command} --terragrunt-non-interactive {common} {planfile_name}',
             'destroy': '{base_command} {command} {non_interactive} {no_auto_approve} {parallelism} {common} {planfile}',
         }
 
@@ -656,7 +656,7 @@ class TgWrap():
         self, command, exclude_external_dependencies, start_at_step, dry_run,
         parallel_execution=False, ask_for_confirmation=False, collect_output_file=None,
         backwards=False, working_dir=None, include_dirs=[], exclude_dirs=[],
-        use_native_terraform=False, add_to_workdir=None,
+        use_native_terraform=False, add_to_workdir=None, continue_on_error=False,
         ):
         "Runs the desired command in the directories as defined in the directed graph"
 
@@ -753,7 +753,7 @@ class TgWrap():
                         progress=progress,
                     )
 
-                    if stop_processing:
+                    if stop_processing and not continue_on_error:
                         self.printer.warning(f"Processing needs to be stopped at step {step_nbr}.")
                         self.printer.normal(
                             f"After you've fixed the problem, you can continue where you left off by adding '--start-at-step {step_nbr}'."
@@ -884,14 +884,14 @@ class TgWrap():
         # tgwrap state mv 'azuread_group.this["viewers"]' 'azuread_group.this["readers"]'
         rc = subprocess.run(
             shlex.split(cmd, posix=False),
-            cwd=cwd,
+            cwd=cwd if cwd else None,
             )
         self.printer.verbose(rc)
 
         sys.exit(rc.returncode)
 
     def run_all(self, command, debug, dry_run, no_lock, update, upgrade,
-        exclude_external_dependencies, step_by_step, planfile, auto_approve, clean,
+        exclude_external_dependencies, step_by_step, continue_on_error, planfile, auto_approve, clean,
         working_dir, start_at_step, limit_parallelism, include_dirs, exclude_dirs, terragrunt_args):
         """ Executes a terragrunt command across multiple modules """
 
@@ -903,10 +903,6 @@ class TgWrap():
         modifying_command = (command.lower() in ['apply', 'destroy'])
         auto_approve = auto_approve if modifying_command else True
 
-        # if the dir is not ending on '/*', add it
-        include_dirs = [dir.rstrip(f'.{os.path.sep}*') + f'{os.path.sep}*' for dir in include_dirs]
-        exclude_dirs = [dir.rstrip(f'.{os.path.sep}*') + f'{os.path.sep}*' for dir in exclude_dirs]
-
         cmd = self._construct_command(
             command=command,
             allow_no_run_all=False,
@@ -933,11 +929,16 @@ class TgWrap():
                 f'This command will be executed for each individual module:\n$ {cmd}'
                 )
 
+            # if the dir is not ending on '/*', add it
+            include_dirs = [dir.rstrip(f'.{os.path.sep}*') + f'{os.path.sep}*' for dir in include_dirs]
+            exclude_dirs = [dir.rstrip(f'.{os.path.sep}*') + f'{os.path.sep}*' for dir in exclude_dirs]
+
             self._run_di_graph(
                 command=cmd,
                 exclude_external_dependencies=exclude_external_dependencies,
                 working_dir=working_dir,
                 ask_for_confirmation=(not auto_approve),
+                continue_on_error=continue_on_error,
                 dry_run=dry_run,
                 start_at_step=start_at_step,
                 backwards=True if command.lower() in ['destroy'] else False,
@@ -1314,6 +1315,10 @@ class TgWrap():
             # and make it unique
             substacks = set(substacks)
 
+            # the manifest file supports both `sub_stacks` and `substack` config name. Annoying to be a bit autistic when it comes to naming :-/
+            substack_configs = manifest.get('sub_stacks', {})
+            substack_configs.update(manifest.get('substacks', {}))
+
             for target_stage in target_stages:
                 target_dir = os.path.join(working_dir, '', target_stage)
                 self.printer.header(f'Deploy stage {target_stage} to {target_dir}...')
@@ -1337,7 +1342,7 @@ class TgWrap():
                                 target_dir=target_dir,
                                 target_stage=target_stage,
                                 substacks=substacks,
-                                substack_configs=manifest.get('sub_stacks', {}).items(),
+                                substack_configs=substack_configs.items(),
                                 tg_file_name=self.TERRAGRUNT_FILE,
                                 verbose=self.printer.print_verbose,
                             )

{tgwrap-0.8.11.dist-info → tgwrap-0.8.13.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: tgwrap
-Version: 0.8.11
+Version: 0.8.13
 Summary: A (terragrunt) wrapper around a (terraform) wrapper around ....
 Home-page: https://gitlab.com/lunadata/tgwrap
 License: MIT
@@ -230,7 +230,7 @@ deploy: # which modules do you want to deploy
       #  - source: networking
       #  - target: networking-connected
 
-sub_stacks:
+substacks:
   is01:
     source: shared-integration/intsvc01
     target: integration/is01
@@ -240,6 +240,8 @@ sub_stacks:
       - my-ss-config.hcl
       - ../my-ss-config-dir
   is02:
+    applies_to_stages: # optional list of stages to include the substack in
+      - dev
     source: shared-integration/intsvc01
     target: integration/is02
 

tgwrap-0.8.13.dist-info/RECORD

@@ -0,0 +1,11 @@
+tgwrap/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+tgwrap/analyze.py,sha256=CsSaGv-be6ATy36z9X7x00gpKY59soJys2VbIzD-tmg,8726
+tgwrap/cli.py,sha256=sWUHP4EYUeKpYP3KgU3t2Er4YLlnwfXNVQkgVwmGFPM,29342
+tgwrap/deploy.py,sha256=bJiox_fz8JsoPreX4woW6-EqAebhpJWnKUVLVeGXkrI,10000
+tgwrap/main.py,sha256=Dqqzqe2x7UXHgAgQL764CfoZ6V0JFbk4TphBkBcYcC8,74872
+tgwrap/printer.py,sha256=dkcOCPIPB-IP6pn8QMpa06xlcqPFVaDvxnz-QEpDJV0,2663
+tgwrap-0.8.13.dist-info/LICENSE,sha256=VT-AVxIXt3EQTC-7Hy1uPGnrDNJLqfcgLgJD78fiyx4,1065
+tgwrap-0.8.13.dist-info/METADATA,sha256=EDgJtU6kePAZrn-aft9LWPDImK_5qEYaBoJCGhY_L3s,11616
+tgwrap-0.8.13.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
+tgwrap-0.8.13.dist-info/entry_points.txt,sha256=H8X0PMPmd4aW7Y9iyChZ0Ug6RWGXqhRUvHH-6f6Mxz0,42
+tgwrap-0.8.13.dist-info/RECORD,,

tgwrap-0.8.11.dist-info/RECORD

@@ -1,11 +0,0 @@
-tgwrap/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-tgwrap/analyze.py,sha256=CsSaGv-be6ATy36z9X7x00gpKY59soJys2VbIzD-tmg,8726
-tgwrap/cli.py,sha256=weYPXnpZ1200L28tNGzVaO_GlX7wAdLn1nQZsHKpe3k,29060
-tgwrap/deploy.py,sha256=oD-H1ojdcSQTbiQHs7BZP9NnbV_MDtlpJFaDRl2-KvU,9578
-tgwrap/main.py,sha256=Eocuece85XM5GHF6TA7OdhxHZqTlbSds5gu7lpZQGQA,74459
-tgwrap/printer.py,sha256=dkcOCPIPB-IP6pn8QMpa06xlcqPFVaDvxnz-QEpDJV0,2663
-tgwrap-0.8.11.dist-info/LICENSE,sha256=VT-AVxIXt3EQTC-7Hy1uPGnrDNJLqfcgLgJD78fiyx4,1065
-tgwrap-0.8.11.dist-info/METADATA,sha256=l8Pmnql-7cijxcy8Hysw3Ka54ZQ2vYumjwDTz6TW3eQ,11529
-tgwrap-0.8.11.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
-tgwrap-0.8.11.dist-info/entry_points.txt,sha256=H8X0PMPmd4aW7Y9iyChZ0Ug6RWGXqhRUvHH-6f6Mxz0,42
-tgwrap-0.8.11.dist-info/RECORD,,