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

tgwrap/cli.py

@@ -17,7 +17,7 @@ import click
 
 from outdated import check_outdated
 
-from .main import TgWrap
+from .main import TgWrap, TG_COMMANDS, STAGES
 
 PACKAGE_NAME = 'tgwrap'
 try:
@@ -48,11 +48,6 @@ def check_latest_version(verbose=False):
 
 CLICK_CONTEXT_SETTINGS = dict(help_option_names=['-h', '--help'])
 
-TG_COMMANDS=[
-    'init', 'validate', 'validate-inputs', 'plan', 'apply',
-    'destroy', 'info', 'output', 'show', 'state', 'force-unlock'
-    ]
-STAGES=['global', 'sbx', 'dev', 'qas', 'run', 'tst', 'acc', 'prd']
 class DefaultGroup(click.Group):
     '''
     Allow a default command for a group
@@ -245,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)
@@ -273,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,
     )
 
@@ -546,8 +572,8 @@ def unlock(module, auto_approve, verbose, dry_run, working_dir):
     help='Clean up files on target side that do not exist as source',
     show_default=True
     )
-@click.option('--include-lock-file', '-i', is_flag=True, default=False,
-    help='Include the terraform lock file',
+@click.option('--include-dotenv-file', '-i', is_flag=True, default=False,
+    help='Include the .env (or .envrc) files',
     show_default=True
     )
 @click.option('--auto-approve', '-a', is_flag=True, default=False,
@@ -568,7 +594,7 @@ def unlock(module, auto_approve, verbose, dry_run, working_dir):
 @click.version_option(version=__version__)
 def sync(
     source_domain, source_stage, target_domain, target_stage, module, auto_approve,
-    verbose, dry_run, clean, include_lock_file, working_dir
+    verbose, dry_run, clean, include_dotenv_file, working_dir
     ):
     """ Syncs the terragrunt config files from one stage to another (and possibly to a different domain) """
 
@@ -584,7 +610,7 @@ def sync(
         auto_approve=auto_approve,
         dry_run=dry_run,
         clean=clean,
-        include_lock_file=include_lock_file,
+        include_dotenv_file=include_dotenv_file,
         working_dir=working_dir,
     )
 
@@ -604,8 +630,8 @@ def sync(
     help='Clean up files on target side that do not exist as source',
     show_default=True
     )
-@click.option('--include-lock-file', '-i', is_flag=True, default=False,
-    help='Include the terraform lock file',
+@click.option('--include-dotenv-file', '-i', is_flag=True, default=False,
+    help='Include the .env (or .envrc) files',
     show_default=True
     )
 @click.option('--auto-approve', '-a', is_flag=True, default=False,
@@ -626,7 +652,7 @@ def sync(
 @click.version_option(version=__version__)
 def sync_dir(
     source_directory, target_directory, auto_approve,
-    verbose, dry_run, clean, include_lock_file, working_dir
+    verbose, dry_run, clean, include_dotenv_file, working_dir
     ):
     """ Syncs the terragrunt config files from one directory to anothery """
 
@@ -639,7 +665,7 @@ def sync_dir(
         auto_approve=auto_approve,
         dry_run=dry_run,
         clean=clean,
-        include_lock_file=include_lock_file,
+        include_dotenv_file=include_dotenv_file,
         working_dir=working_dir,
     )
 

tgwrap/deploy.py

@@ -10,7 +10,7 @@ import shlex
 from .printer import Printer
 
 def run_sync(
-    source_path, target_path, auto_approve, include_lock_file, dry_run, clean, terragrunt_file,
+    source_path, target_path, auto_approve, include_dotenv_file, dry_run, clean, terragrunt_file,
     excludes=[], source_stage=None, target_stage=None, source_domain=None, verbose=False,
     ):
     """ Run a sync copying files from a source to a target path """
@@ -46,8 +46,8 @@ def run_sync(
         dry_run_stmt = '--dry-run' if dry_run else ''
         clean_stmt   = '--delete' if clean else ''
         env_file_stmt   = "--exclude='env.hcl'" if source_stage != target_stage else "--include='env.hcl'"
-        lock_file_stmt  = "--include='.terraform.lock.hcl'" if include_lock_file \
-            else "--exclude='.terraform.lock.hcl'"
+        dotenv_file_stmt  = "--include='.env' --include='.envrc'" if include_dotenv_file \
+            else "--exclude='.env' --exclude='.envrc'"
         excludes_stmt = ' '.join([f"--exclude={x}" for x in excludes])
 
         include_statements = ""
@@ -57,7 +57,7 @@ def run_sync(
         #
         if os.path.isdir(target_path):
             include_statements = \
-                f"--include='{terragrunt_file}' {lock_file_stmt} {env_file_stmt} {excludes_stmt} " + \
+                f"--include='{terragrunt_file}' {dotenv_file_stmt} {env_file_stmt} {excludes_stmt} " + \
                 "--exclude='.terragrunt-cache/' --exclude='.terraform/' " + \
                 "--exclude='terragrunt-debug.tfvars.json' --exclude=planfile " + \
                 "--exclude='.DS_Store' --exclude='*.log' "

tgwrap/main.py

@@ -38,6 +38,35 @@ from .analyze import run_analyze
 from .deploy import prepare_deploy_config, run_sync
 from .inspector import AzureInspector
 
+TG_COMMANDS=[
+    'apply',
+    'destroy',
+    'exec',
+    'force-unlock',
+    'graph',
+    'info',
+    'init',
+    'output',
+    'plan',
+    'run',
+    'show',
+    'state',
+    'taint',
+    'untaint',
+    'validate-inputs',
+    'validate',
+    ]
+STAGES=[
+    'global',
+    'sbx',
+    'dev',
+    'qas',
+    'run',
+    'tst',
+    'acc',
+    'prd',
+    ]
+
 class DateTimeEncoder(json.JSONEncoder):
     def default(self, obj):
         if isinstance(obj, datetime):
@@ -1095,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}'")
@@ -1128,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}'
@@ -1154,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 """
@@ -1241,7 +1293,9 @@ class TgWrap():
         else:
             self.printer.verbose('Use native terraform for module selection')
             use_native_terraform = True
-            cmd = f"terraform show -json {self.PLANFILE_NAME}"
+            # the 'tf' command is part of tenv and determines, based on the existence of .opentofu-version or .terraform-version
+            # whether to use terraform or opentofu
+            cmd = f"tf show -json {self.PLANFILE_NAME}"
 
         config = None
         if analyze_config:
@@ -1448,7 +1502,7 @@ class TgWrap():
 
     def sync(
         self, source_stage, target_stage, source_domain, target_domain, module,
-        auto_approve, dry_run, clean, include_lock_file, working_dir, 
+        auto_approve, dry_run, clean, include_dotenv_file, working_dir, 
         ):
         """ Syncs the terragrunt config files from one stage to another (and possibly to a different domain) """
     
@@ -1476,7 +1530,7 @@ class TgWrap():
             source_domain=source_domain,
             source_stage=source_stage,
             target_stage=target_stage,
-            include_lock_file=include_lock_file,
+            include_dotenv_file=include_dotenv_file,
             auto_approve=auto_approve,
             dry_run=dry_run,
             clean=clean,
@@ -1486,7 +1540,7 @@ class TgWrap():
 
     def sync_dir(
         self, source_directory, target_directory,
-        auto_approve, dry_run, clean, include_lock_file, working_dir, 
+        auto_approve, dry_run, clean, include_dotenv_file, working_dir, 
         ):
         """ Syncs the terragrunt config files from one directory to anothery """
     
@@ -1499,10 +1553,10 @@ class TgWrap():
         run_sync(
             source_path=source_path,
             target_path=target_path,
-            include_lock_file=include_lock_file,
             auto_approve=auto_approve,
             dry_run=dry_run,
             clean=clean,
+            include_dotenv_file=include_dotenv_file,
             terragrunt_file=self.TERRAGRUNT_FILE,
             verbose=self.printer.print_verbose,
         )
@@ -1590,6 +1644,7 @@ class TgWrap():
                         source_path = os.path.join(
                             source_dir, global_config['source']
                             )
+
                         target = global_config.get('target', global_config['source'])
                         target_path = os.path.dirname(
                             os.path.join(
@@ -1625,7 +1680,7 @@ class TgWrap():
                                 source_path=value['source'],
                                 target_path=value['target'],
                                 excludes=value.get('excludes', []),
-                                include_lock_file=True,
+                                include_dotenv_file=True,
                                 auto_approve=True,
                                 dry_run=dry_run,
                                 clean=False,

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: tgwrap
-Version: 0.11.3
+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.5.dist-info/RECORD

@@ -0,0 +1,13 @@
+tgwrap/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+tgwrap/analyze.py,sha256=fuET7_L8b6rlv2qnKOYXSlIv5LArvZ39CPktCeQHo7A,10285
+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=mPVVWJC_zXz9ozWwvkBGrWn8t9hytI812pCh5zxRd44,95862
+tgwrap/printer.py,sha256=frn1PARd8A28mkRCYR6ybN2x0NBULhNOutn4l2U7REY,2754
+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,,

tgwrap-0.11.3.dist-info/RECORD

@@ -1,13 +0,0 @@
-tgwrap/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-tgwrap/analyze.py,sha256=fuET7_L8b6rlv2qnKOYXSlIv5LArvZ39CPktCeQHo7A,10285
-tgwrap/cli.py,sha256=9zvBop3Gm5B2b8K-zXVHEvRUCC7t5ffZUJZEpj1Fxtw,32186
-tgwrap/deploy.py,sha256=-fSk-Ix_HqrXY7KQX_L27TnFzIuhBHYv4xYJW6zRDN4,10243
-tgwrap/inspector-resources-template.yml,sha256=Mos8NDzzZ3VxdXgeiVL9cmQfRcIXIHMLf79_KLwdXu8,3297
-tgwrap/inspector.py,sha256=5pW7Ex1lkKRoXY6hZGbCNmSD2iRzgMSfqi9w7gb-AcY,16990
-tgwrap/main.py,sha256=Vzmy9GEuBT-T6TB_ZzN_lET5ihY0P-9WcPZ_MPCus_k,94366
-tgwrap/printer.py,sha256=frn1PARd8A28mkRCYR6ybN2x0NBULhNOutn4l2U7REY,2754
-tgwrap-0.11.3.dist-info/LICENSE,sha256=VT-AVxIXt3EQTC-7Hy1uPGnrDNJLqfcgLgJD78fiyx4,1065
-tgwrap-0.11.3.dist-info/METADATA,sha256=Q2KwR6I-XkakoBPf2PCchgR5xlcOJJaG0In4V6DedJ8,17698
-tgwrap-0.11.3.dist-info/WHEEL,sha256=IYZQI976HJqqOpQU6PHkJ8fb3tMNBFjg-Cn-pwAbaFM,88
-tgwrap-0.11.3.dist-info/entry_points.txt,sha256=H8X0PMPmd4aW7Y9iyChZ0Ug6RWGXqhRUvHH-6f6Mxz0,42
-tgwrap-0.11.3.dist-info/RECORD,,