allow to skip overrides by provider alias (#60)

Author: Hoffs

README.md

@@ -41,6 +41,7 @@ The following environment variables can be configured:
     * `default` profile's credentials are configured
     * falls back to the default `AWS_ACCESS_KEY_ID` mock value
 * `AWS_ACCESS_KEY_ID`: AWS Access Key ID to use for multi account setups (default: `test` -> account ID: `000000000000`)
+* `SKIP_ALIASES`: Allows to skip generating AWS provider overrides for specified aliased providers, e.g. `SKIP_ALIASES=aws_secrets,real_aws`
 
 ## Usage
 
@@ -49,6 +50,7 @@ please refer to the man pages of `terraform --help`.
 
 ## Change Log
 
+* v0.19.0: Add `SKIP_ALIASES` configuration environment variable
 * v0.18.2: Fix warning on aliased custom endpoint names
 * v0.18.1: Fix issue with not proxied commands
 * v0.18.0: Add `DRY_RUN` and patch S3 backend entrypoints

bin/tflocal

@@ -221,12 +221,13 @@ def get_providers_file_path() -> str:
 
 def determine_provider_aliases() -> list:
     """Return a list of providers (and aliases) configured in the *.tf files (if any)"""
+    skipped = str(os.environ.get("SKIP_ALIASES") or "").strip().split(",")
     result = []
     tf_files = parse_tf_files()
     for _file, obj in tf_files.items():
         try:
             providers = ensure_list(obj.get("provider", []))
-            aws_providers = [prov["aws"] for prov in providers if prov.get("aws")]
+            aws_providers = [prov["aws"] for prov in providers if prov.get("aws") and prov.get("aws").get("alias") not in skipped]
             result.extend(aws_providers)
         except Exception as e:
             print(f"Warning: Unable to extract providers from {_file}:", e)

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = terraform-local
-version = 0.18.2
+version = 0.19.0
 url = https://github.com/localstack/terraform-local
 author = LocalStack Team
 author_email = info@localstack.cloud

tests/test_apply.py

@@ -353,6 +353,39 @@ def check_override_file_backend_content(override_file, is_legacy: bool = False):
     return new_options_check and not legacy_options_check
 
 
+def test_provider_aliases_ignored(monkeypatch):
+    monkeypatch.setenv("DRY_RUN", "1")
+    config = """
+    provider "aws" {
+      region = "eu-west-1"
+    }
+    provider "aws" {
+      alias      = "us_east_2"
+      region     = "us-east-2"
+      secret_key = "not-overriden"
+    }
+    """
+
+    temp_dir = deploy_tf_script(config, cleanup=False, env_vars={"SKIP_ALIASES": "us_east_2"}, user_input="yes")
+    override_file = os.path.join(temp_dir, "localstack_providers_override.tf")
+    assert check_override_file_content_for_alias(override_file)
+    rmtree(temp_dir)
+
+
+def check_override_file_content_for_alias(override_file):
+    try:
+        with open(override_file, "r") as fp:
+            result = hcl2.load(fp)
+            result = result["provider"]
+    except Exception as e:
+        raise Exception(f'Unable to parse "{override_file}" as HCL file: {e}')
+
+    for p in result:
+        if "aws" in p and "alias" in p["aws"] and p["aws"]["alias"] == "us_east_2":
+            return False
+    return True
+
+
 ###
 # UTIL FUNCTIONS
 ###