tgwrap 0.7.16__tar.gz → 0.7.18__tar.gz

{tgwrap-0.7.16 → tgwrap-0.7.18}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: tgwrap
-Version: 0.7.16
+Version: 0.7.18
 Summary: A (terragrunt) wrapper around a (terraform) wrapper around ....
 Home-page: https://gitlab.com/lunadata/tgwrap
 License: MIT

{tgwrap-0.7.16 → tgwrap-0.7.18}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "tgwrap"
-version = "0.7.16"
+version = "0.7.18"
 description = "A (terragrunt) wrapper around a (terraform) wrapper around ...."
 authors = ["Gerco Grandia <gerco.grandia@4synergy.nl>", "Pascal Alma <pascal.alma@4synergy.nl>"]
 license = "MIT"

{tgwrap-0.7.16 → tgwrap-0.7.18}/setup.py

@@ -22,7 +22,7 @@ entry_points = \
 
 setup_kwargs = {
     'name': 'tgwrap',
-    'version': '0.7.16',
+    'version': '0.7.18',
     'description': 'A (terragrunt) wrapper around a (terraform) wrapper around ....',
     'long_description': '# tg-wrap\n\nThis app simply wraps terragrunt (which is a wrapper around terraform, which is a wrapper around cloud APIs, which is...).\n\nWait, why on earth do we need a wrapper for a wrapper (for a wrapper)?\n\nWell, first of all it is pretty opinionated so what works for us, doesn\'t necessarily work for you.\n\nBut our reasoning for creating this is as follows:\n\n## 1. Less typing\n\nterraform is great, and in combination with terragrunt even greater! But let\'s face it, terragrunt does not excel in conciseness! The options are pretty long, which leads to lots of typing. We don\'t like typing!\n\n## 2. Testing modules locally\n\nHowever, more importantly, we are heavily utilising [TERRAGRUNT_SOURCE](https://terragrunt.gruntwork.io/docs/features/execute-terraform-commands-on-multiple-modules-at-once/#testing-multiple-modules-locally) when developing.\n\nThe thing is that as long as you use `run-all` you can use one setting for that variable (and conveniently set it as an environment variable), while if you run a regular command, you need to specify the full path. Which is obviously different for each project.\n\nWhich leads to (even) more typing, and worse: a higher chance for errors.\n\nLuckily you can use `run-all` and add the appriopriate flags to ensure it behaves like a regular plan|apply|destroy etc. But again, more typing.\n\nNothing a [bunch a aliases](https://gitlab.com/lunadata/terragrunt-utils/-/blob/main/tg-shell.sh) can\'t solve though!\n\n## 3. But the original reason was: Errors when using run-all are challenging\n\nOne of the main boons of terragrunt is the ability to break up large projects in smaller steps while still retaining the inter-dependencies. However, when working on such a large project and something goes wrong somewhere in the middle is pretty challenging.\n\nterragrunt\'s error messages are pretty massive, and this is extrapolated with every individual project in your dependency chain.\n\nAnd if it fails somewhere at the front, it keeps on trying until the last one, blowing up your terminal in the process.\n\nSo we wanted a possibility to run the projects step by step, using the dependency graph of terragrunt and have a bit more control over it.\n\nAnd this was not something a bunch of aliases could solve, hence this wrapper was born. And while we we\'re at it, replacing the aliases with this was then pretty straightforward next step as well.\n\n## 4. Analyzing plan files\n\nWhen using the run-all, analyzing what is about to be changed is not going to be easier. Hence we created the `tgwrap analyze` function that lists all the planned changes and (if a config file is availabe) calculates a drift score and runs a [terrasafe](https://pypi.org/project/terrasafe/) style validation check.\n\nIt needs a config file as follows:\n\n```yaml\n---\n#\n# Critically of resources as interpreted by \'tgwrap analyze\'.\n# It uses it for a \'terrasafe\' like validation if resources can safely be deleted.\n# On top of that it tries to analyze and quantify the drift impact of the changes,\n# so that this can be monitored.\n#\nlow:\n  # defaults:\n  #   terrasafe_level: ignore_deletions\n  #   drift_impact:\n  #     default: minor\n  #     delete: medium\n  azuread_application.: {} # if we you want to use the defaults\n  azuread_app_role_assignment: # or if you want to override these\n    drift_impact:\n      delete: minor\n  # and so on, and so forth\nmedium:\n  # defaults:\n  #   terrasafe_level: ignore_deletion_if_recreation\n  #   drift_impact:\n  #     default: medium\n  #     delete: major\n  azurerm_data_factory_linked_service_key_vault.: {}\n  # and so on, and so forth\nhigh:\n  # defaults:\n  #   terrasafe_level: unauthorized_deletion\n  #   drift_impact:\n  #     default: major\n  #     update: medium\n  azuread_group.:\n    drift_impact:\n      create: minor\n      update: minor\n  azurerm_application_insights.: {}\n  # and so on, and so forth\n```\n\n### Speeding up the performance of analyze\n\nThis `analyze` function turned out to be pretty slow, where most of the time went into the `terragrunt show` function that is executed for each individual module. \n\nThis was a bit surprising as the plan file is already available on the file system, but it turns out that terragrunt is taking quite a bit of time for managing the depdencies. Even when you\'re excluding the external dependencies and are located in a particular module.\n\nSo, if you add the following to your root `terragrunt.hcl`:\n\n```hcl\nterraform {\n  after_hook "link_to_current_module" {\n    commands = ["init", "plan", "apply", "validate", "destroy"]\n    execute  = ["bash", "-c", "ln -sf $(pwd) ${get_terragrunt_dir()}/.terragrunt-cache/current"]\n  }\n}\n```\n\nThe directory where the plan file is stored (including the other resources that terraform needs) becomes predictable and it becomes possible to run a native `terraform show` (instead `terragrunt show`) which dramatically speed up things.\n\nJust set the proper value as an environment variable:\n\n```console\nexport TGWRAP_PLANFILE_DIR=".terragrunt-cache/current"\n```\n\nOr pass it along with the `--planfile-dir|-P` option and it will use that.\n\n## Usage\n\n```console\n# general help\ntgwrap --help\n\ntgwrap run -h\ntgwrap run-all -h\n\n# run a plan\ntgwrap plan # which is the same as tgwrap run plan\n\n# run-all a plan\ntgwrap run-all plan\n\n# run-all with excluding a particular directory\ntgwrap run-all plan -E \'excluded-dir/*\'\n# or a directory somewhere further down in the path\ntgwrap run-all plan -E \'**/excluded-dir/**\'\n\n# or do the same in step-by-step mode\ntgwrap run-all plan -s\n\n# or excluding (aka ignoring) external dependencies\ntgwrap run-all plan -sx\n\n# if you want to add additional arguments it is recommended to use -- as separator (although it *might* work without)\ntgwrap output -- -json\n```\n\n> Note: special precautions are needed when passing on parameters that contain quotes. For instance, if you want to move state like below, escape the double quote in the staate address:\n\n`tgwrap state mv \'azuread_group.this[\\"viewers\\"]\' \'azuread_group.this[\\"readers\\"]\'`\n\n## A word about escaping inputs\n\nYour shell is escaping special characters such as `*` and `"` before passing it to the program (`tgwrap` in this case). So some inputs **need** to be escaped in order to function properly.\n\nFor example:\n\n```console\n# to exclude certain modules from an action (such as analyze):\ntgwrap analyze -E \'integrations/\\*/\\*\'\n\n# to import a resource that has a " in its address:\ntgwrap import -a \'azuread_group.this[\\"my_group\\"]\' -i ${GROUP_ID}\n```\n\n## Deploy manifests\n\nIn order to easily deploy a new version of the terraform (and associated terragrunt) modules, we include a manifest file in the root of the landing zone:\n\n```yaml\n---\ngit_repository: ssh://git@gitlab.com/my-org/my-terraform-modules-repo.git\nbase_path: terragrunt/my-platform # path where the terragrunt modules are stored \nconfig_path: terragrunt/config/platform-dev # path (relative to base path) where the config files are stored\n\ndeploy: # which modules do you want to deploy\n  dtap:\n    applies_to_stages:\n      - dev\n      - tst\n      - acc\n      - prd\n    source_stage: dev\n    source_dir: platform # optional, if the source modules are not directly in the stage dir, but in <stage>/<source_dir> directory\n    base_dir: platform # optional, if you want to deploy the base modules in its own dir, side by side with substacks\n    config_dir: ../../../config # this is relative to where you run the deploy\n    config_files:\n      - my-config.hcl\n      - ../my-config.hcl\n    exclude_modules: # these modules will always be excluded, can be omitted\n      - my-specific-module\n    include_modules: {} # omit or use an empty dict for all of them\n      # or specify your modules as follows\n      # base: {} # just a simple include\n      # networking-connected: # or a bit more complicated\n      #  - source: networking\n      #  - target: networking-connected\n\nsub_stacks:\n  is01:\n    source: shared-integration/intsvc01\n    target: integration/is01\n    exclude_modules:  # a list of modules that will always be excluded, can be omitted\n      - my-specific-module\n  is02:\n    source: shared-integration/intsvc01\n    target: integration/is02\n\n# global configuration files that are deployed as well\n# note that these files are typically applicable to all landing zones and stages!\n# this might lead to unexpected behaviour\n# note that you can exclude syncing these files with a command line switch\nglobal_config_files:\n  root-terragrunt:\n    source: ../../terragrunt.hcl # relative to base_path\n    target: ../../terragrunt.hcl # can be omitted, then it is same as source path\n  terrasafe-config:\n    source: ../../terrasafe-config.json\n```\n\n## Generating change logs\n\ntgwrap can generate a change log by running:\n\n```console\ntgwrap change-log [--changelog-file ./CHANGELOG.md]\n```\n\nThe (optional) change log file will be, if passed along. tgwrap then checks the file for the existance of a start and end markers, in the following format:\n\n```python\n  start_marker = \'<!-- BEGINNING OF OF TGWRAP CHANGELOG SECTION -->\'\n  end_marker = \'<!-- END OF TGWRAP CHANGELOG SECTION -->\'\n```\n\nIf they exist, everything between these lines will be replaced by the new change log.\n\n## Development\n\nIn order to develop, you need to apply it to your terragrunt projects. For that you can use the `--terragrunt-working-dir` option and just run it from the poetry directory. Alternatively you can use the [tgwrap-dev](./tgwrap-dev) script and invoke that from your terragrunt directories. Either put it in your `PATH` or create an alias for convenience.\n',
     'author': 'Gerco Grandia',

{tgwrap-0.7.16 → tgwrap-0.7.18}/tgwrap/cli.py

@@ -774,8 +774,12 @@ def clean(verbose, working_dir):
 @click.option('--working-dir', '-w', default=None,
     help='Working directory, when omitted the current directory is used',
     )
+@click.option('--include-nbr-of-releases', '-i',
+    type=int, default=20, show_default=True,
+    help='Max number of releases to include',
+    )
 @click.version_option(version=__version__)
-def change_log(changelog_file, verbose, working_dir):
+def change_log(changelog_file, verbose, working_dir, include_nbr_of_releases):
     """ Experimental! Generate a change log """
 
     check_latest_version(verbose)
@@ -784,6 +788,7 @@ def change_log(changelog_file, verbose, working_dir):
     tgwrap.change_log(
         changelog_file=changelog_file,
         working_dir=working_dir,
+        include_nbr_of_releases=include_nbr_of_releases,
     )
 
 # this is needed for the vscode debugger to work

{tgwrap-0.7.16 → tgwrap-0.7.18}/tgwrap/main.py

@@ -110,7 +110,7 @@ class TgWrap():
         }
 
         lock_stmt = ''
-        if no_lock and command in ['init', 'validate', 'validate-inputs', 'plan', 'info', 'output', 'show']:
+        if no_lock and command in ['init', 'validate', 'validate-inputs', 'plan', 'info', 'output', 'show', 'state']:
             lock_stmt = '-lock=false'
             self.printer.warning('Terraform state will NOT be locked')
         elif no_lock:
@@ -958,6 +958,9 @@ class TgWrap():
         include_dirs, exclude_dirs, planfile_dir, terragrunt_args):
         """ Analyzes the plan files """
 
+        def calculate_score(major: int, medium: int, minor: int) -> float :
+            return major * 10 + medium + minor / 10
+
         self.printer.verbose("Attempting to 'analyze'")
         if terragrunt_args:
             self.printer.verbose(f"- with additional parameters: {' '.join(terragrunt_args)}")
@@ -1080,14 +1083,25 @@ class TgWrap():
             "major": 0,
             "unknown": 0,
             "total": 0,
+            "score": 0,
         }
 
         for key, value in changes.items():
             for type in ["minor", "medium", "major", "unknown", "total"]:
                 total_drifts[type] += value["drifts"][type]
+            
+            # the formula below is just a way to achieve a numeric results that is coming from the various drift categories
+            value['drifts']['score'] = calculate_score(
+                major = value['drifts']['major'],
+                medium = value['drifts']['medium'],
+                minor = value['drifts']['minor'],
+            )
+            value['drifts']['score'] = value['drifts']['major'] * 10 + value['drifts']['medium'] + value['drifts']['minor'] / 10
 
         # the formula below is just a way to achieve a numeric results that is coming from the various drift categories
         total_drift_score = total_drifts['major'] * 10 + total_drifts['medium'] + total_drifts['minor'] / 10
+        total_drifts['score'] = total_drift_score
+
         self.printer.header(f"Drift score: {total_drift_score} ({total_drifts['major']}.{total_drifts['medium']}.{total_drifts['minor']})")
         if total_drifts["unknown"] > 0:
             self.printer.warning(f"For {total_drifts['unknown']} resources, drift score is not configured, please update configuration!")
@@ -1096,15 +1110,22 @@ class TgWrap():
                 for m in value["unknowns"]:
                     self.printer.warning(f' -> {m}')
 
+
+
         if out:
             # in the output we convert the dict of dicts to a list of dicts as it makes processing
             # (e.g. by telegraph) easier.
-            changes_for_output = []
+            output = {
+                "changes": [],
+                "summary": {},
+            }
             for key, value in changes.items():
                 value['module'] = key
-                changes_for_output.append(value)
+                output["changes"].append(value)
 
-            print(json.dumps(changes_for_output, indent=4))
+            output["summary"] = total_drifts
+
+            print(json.dumps(output, indent=4))
 
         if not ts_validation_successful:
             self.printer.error("Analysis detected unauthorised deletions, please check your configuration!!!")
@@ -1626,7 +1647,7 @@ Note:
         self.printer.verbose(rc)
         self.printer.normal("Cleaned the temporary files")
 
-    def change_log(self, changelog_file, working_dir):
+    def change_log(self, changelog_file, working_dir, include_nbr_of_releases):
         """ Generate a change log """
 
         # Run 'git log' to capture the Git log as a string
@@ -1637,8 +1658,13 @@ Note:
             cwd=working_dir if working_dir else None,
             )
 
-        # Define a regular expression pattern to extract release tags (e.g., vYYYY.MM.DD(.n))
-        release_pattern = r'\b(v\d{4}\.\d{1,2}\.\d{1,2}(\.\d+)?)\b'
+        # Define a regular expression pattern to extract release tags
+        # The following formats are supported:
+        #  vYYYY.MM.DD
+        #  vYYYYMMDD
+        #  vYYYY.MM.DD.01
+        #  vYYYYMMDD.01
+        release_pattern = r'\b(v\d{4}\.?\d{1,2}\.?\d{1,2}(\.\d+)?)\b'
 
         # Split the Git log into individual commit entries
         release_commits = {}
@@ -1654,18 +1680,18 @@ Note:
                     release_commits[current_release] = []
             elif current_release:
                 release_commits[current_release].append(entry)
-
         # Print the grouped commits to the console (you can write them to a file as needed)
         changelog = ""
+        counter = 0
         for release, commits in release_commits.items():
-            changelog = changelog + f"\nRelease: {release}\n  - "
-            # print(f"Release: {release}")
-            # for commit in commits:
-            #     changelog = changelog + f"\n - {commit}"
-                # print(f"  - {commit}")
-            changelog = changelog + '\n  - '.join(commits) + '\n'
-            # print()
-            # changelog = 
+            if len(commits) > 0:
+                counter += 1
+
+                changelog = changelog + f"\nRelease: {release}\n  - "
+                changelog = changelog + '\n  - '.join(commits) + '\n'
+
+            if include_nbr_of_releases and counter > include_nbr_of_releases:
+                break
 
         # do we need to update an existingchange log file?
         if changelog_file: