tgwrap 0.11.4__py3-none-any.whl → 0.11.5__py3-none-any.whl

tgwrap/cli.py

@@ -240,11 +240,37 @@ def run(command, verbose, debug, dry_run, no_lock, update, upgrade,
     help=r'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('--analyze-after-plan', is_flag=True, default=True,
+    help='Analyze the results after a plan',
+    show_default=True
+    )
+@click.option('--analyze-config', '-A', default=None,
+    help='Name of the analyze config file (or set TGWRAP_ANALYZE_CONFIG environment variable)',
+    envvar='TGWRAP_ANALYZE_CONFIG', type=click.Path(),
+    )
+@click.option('--ignore-attributes', '-i',
+    multiple=True, default=[],
+    help=r'A glob of attributes for which, during plan, updates can be ignored, this option can be used multiple times (or set TGWRAP_ANALYZE_IGNORE environment variable)',
+    envvar='TGWRAP_ANALYZE_IGNORE',
+    show_default=True
+    )
+@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.option('--data-collection-endpoint', '-D', default=None,
+    help='Optional URI of an (Azure) data collection endpoint, to which the analyse results will be sent',
+    envvar='TGWRAP_ANALYZE_DATA_COLLECTION_ENDPOINT',
+    show_default=True,
+    )
 @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, continue_on_error, planfile, auto_approve, clean, working_dir, start_at_step,
-    limit_parallelism, include_dir, exclude_dir, terragrunt_args):
+    step_by_step, continue_on_error, planfile, auto_approve, clean, working_dir,
+    start_at_step, limit_parallelism, include_dir, exclude_dir, 
+    analyze_after_plan, analyze_config, ignore_attributes, planfile_dir, data_collection_endpoint,
+    terragrunt_args):
     """ Executes a terragrunt command across multiple projects """
 
     check_latest_version(verbose)
@@ -268,6 +294,11 @@ def run_all(command, verbose, debug, dry_run, no_lock, update, upgrade, exclude_
         limit_parallelism=limit_parallelism,
         include_dirs=include_dir,
         exclude_dirs=exclude_dir,
+        analyze_after_plan=analyze_after_plan,
+        analyze_config=analyze_config,
+        ignore_attributes=ignore_attributes,
+        planfile_dir=planfile_dir,
+        data_collection_endpoint=data_collection_endpoint,
         terragrunt_args=terragrunt_args,
     )
 

tgwrap/main.py

@@ -1124,8 +1124,10 @@ class TgWrap():
         sys.exit(rc.returncode)
 
     def run_all(self, command, debug, dry_run, no_lock, update, upgrade,
-        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):
+        exclude_external_dependencies, step_by_step, continue_on_error, planfile, auto_approve,
+        clean, working_dir, start_at_step, limit_parallelism, include_dirs, exclude_dirs,
+        analyze_after_plan, analyze_config, ignore_attributes, planfile_dir, data_collection_endpoint,
+        terragrunt_args):
         """ Executes a terragrunt command across multiple modules """
 
         self.printer.verbose(f"Attempting to execute 'run-all {command}'")
@@ -1157,6 +1159,7 @@ class TgWrap():
         if clean and not dry_run:
             self.clean(working_dir=working_dir)
 
+        rc = None
         if step_by_step:
             self.printer.verbose(
                 f'This command will be executed for each individual module:\n$ {cmd}'
@@ -1183,9 +1186,29 @@ class TgWrap():
                 self.printer.warning('In dry run mode, no real actions are executed!!')
             else:
                 rc = subprocess.run(shlex.split(cmd))
+
                 self.printer.verbose(rc)
 
-                sys.exit(rc.returncode)
+        # if we are planning, and analyze is requested, we need to run the analysis
+        if analyze_after_plan and command.lower() == 'plan':
+            self.printer.verbose('Analyze after plan requested')
+            self.analyze(
+                exclude_external_dependencies=exclude_external_dependencies,
+                working_dir=working_dir,
+                start_at_step=0,
+                out=None,
+                parallel_execution=None,
+                analyze_config=analyze_config,
+                ignore_attributes=ignore_attributes,
+                include_dirs=include_dirs,
+                exclude_dirs=exclude_dirs,
+                planfile_dir=planfile_dir,
+                data_collection_endpoint=data_collection_endpoint,
+                terragrunt_args=terragrunt_args,
+            )
+
+        if rc:
+            sys.exit(rc.returncode)
 
     def run_import(self, address, id, dry_run, working_dir, no_lock, terragrunt_args):
         """ Executes the terragrunt/terraform import command """

{tgwrap-0.11.4.dist-info → tgwrap-0.11.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: tgwrap
-Version: 0.11.4
+Version: 0.11.5
 Summary: A (terragrunt) wrapper around a (terraform) wrapper around ....
 License: MIT
 Keywords: terraform,terragrunt,terrasafe,python
@@ -145,7 +145,7 @@ export TGWRAP_PLANFILE_DIR=".terragrunt-cache/current"
 
 Or pass it along with the `--planfile-dir|-P` option and it will use that.
 
-### Logging the results
+## 5. Logging the results
 
 `tgwrap` supports logging the analyze results to an [Azure Log Analytics](https://learn.microsoft.com/en-us/azure/azure-monitor/logs/log-analytics-overview) custom table.
 
@@ -214,7 +214,15 @@ The log analytics (custom) table should have a schema that is able to cope with
 | unknown        | Int      |
 | updates        | Int      |
 
-## More than a wrapper
+# Terraform vs OpenTofu
+
+`tgwrap` is compatible with both [terraform](https://www.terraform.io/) and [opentofu](https://opentofu.org/).
+
+As we are **almost** exclusively relying on `terragrunt` to invoke them on our behalf, there is not much exposure to that decision.
+
+However, there is one exception (and maybe there will be more in the future) where this is not true. For that we rely on the existance of the `tf` binary (or symbolic link, or alias and so on). It is managed automatically by the [tenv tool](https://github.com/tofuutils/tenv) (higly recommended!), but if you don't want to use it, make sure you create an alias or something like that.
+
+# More than a wrapper
 
 Over time, tgwrap became more than a wrapper, blantly violating [#1 of the unix philosophy](https://en.wikipedia.org/wiki/Unix_philosophy#:~:text=The%20Unix%20philosophy%20is%20documented,%2C%20as%20yet%20unknown%2C%20program.): 'Make each program do one thing well'.
 

{tgwrap-0.11.4.dist-info → tgwrap-0.11.5.dist-info}/RECORD

@@ -1,13 +1,13 @@
 tgwrap/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tgwrap/analyze.py,sha256=fuET7_L8b6rlv2qnKOYXSlIv5LArvZ39CPktCeQHo7A,10285
-tgwrap/cli.py,sha256=IZuVHCR_9a40WRKpUCWOMVksUKzE_s2fzM26zbJ_N8o,32017
+tgwrap/cli.py,sha256=7VPowJ9DtbtbOsl5s01Vj0rsMTQuin5KhvOTbNTSQZA,33551
 tgwrap/deploy.py,sha256=gwFdRDzJWjkmEzZ8b0GUSrgvJeOKnpnJm1c6mM80OcY,10259
 tgwrap/inspector-resources-template.yml,sha256=Mos8NDzzZ3VxdXgeiVL9cmQfRcIXIHMLf79_KLwdXu8,3297
 tgwrap/inspector.py,sha256=5pW7Ex1lkKRoXY6hZGbCNmSD2iRzgMSfqi9w7gb-AcY,16990
-tgwrap/main.py,sha256=A8Xa1tWsaQgVjQG4VYZWouj0uoIwkMgXIm-prfmF0c8,94907
+tgwrap/main.py,sha256=mPVVWJC_zXz9ozWwvkBGrWn8t9hytI812pCh5zxRd44,95862
 tgwrap/printer.py,sha256=frn1PARd8A28mkRCYR6ybN2x0NBULhNOutn4l2U7REY,2754
-tgwrap-0.11.4.dist-info/LICENSE,sha256=VT-AVxIXt3EQTC-7Hy1uPGnrDNJLqfcgLgJD78fiyx4,1065
-tgwrap-0.11.4.dist-info/METADATA,sha256=e6h-8JnVXLJDh3fILUO5_vDl90TIR0ii_P3PJPtNWNc,17698
-tgwrap-0.11.4.dist-info/WHEEL,sha256=IYZQI976HJqqOpQU6PHkJ8fb3tMNBFjg-Cn-pwAbaFM,88
-tgwrap-0.11.4.dist-info/entry_points.txt,sha256=H8X0PMPmd4aW7Y9iyChZ0Ug6RWGXqhRUvHH-6f6Mxz0,42
-tgwrap-0.11.4.dist-info/RECORD,,
+tgwrap-0.11.5.dist-info/LICENSE,sha256=VT-AVxIXt3EQTC-7Hy1uPGnrDNJLqfcgLgJD78fiyx4,1065
+tgwrap-0.11.5.dist-info/METADATA,sha256=QvyHQUE4WALyXsMIxnN-qRubvp33iv4JxhzS3knJkdw,18355
+tgwrap-0.11.5.dist-info/WHEEL,sha256=IYZQI976HJqqOpQU6PHkJ8fb3tMNBFjg-Cn-pwAbaFM,88
+tgwrap-0.11.5.dist-info/entry_points.txt,sha256=H8X0PMPmd4aW7Y9iyChZ0Ug6RWGXqhRUvHH-6f6Mxz0,42
+tgwrap-0.11.5.dist-info/RECORD,,