Aws_endpoint_url_var (#35)

Author: lakkeger

.github/workflows/build.yml

@@ -10,20 +10,21 @@ on:
 name: Build and Test
 jobs:
   build_test:
-    timeout-minutes: 10
+    timeout-minutes: 30
     runs-on: ubuntu-latest
     env:
       AWS_DEFAULT_REGION: us-east-1
+      DNS_ADDRESS: 127.0.0.1
 
     steps:
     - name: Check out code
       uses: actions/checkout@v3
     - name: Pull LocalStack Docker image
       run: docker pull localstack/localstack &
-    - name: Set up Python 3.10
+    - name: Set up Python 3.11
       uses: actions/setup-python@v2
       with:
-        python-version: '3.10.5'
+        python-version: '3.11'
     - name: Install dependencies
       run: make install
     - name: Run code linter

.gitignore

@@ -1,3 +1,7 @@
+# Custom
+.envrc
+.env
+
 .DS_Store
 *.egg-info/
 dist/
@@ -115,4 +119,4 @@ fabric.properties
 .history
 .ionide
 
-# End of https://www.toptal.com/developers/gitignore/api/pycharm+all,visualstudiocode
+# End of https://www.toptal.com/developers/gitignore/api/pycharm+all,visualstudiocode

Makefile

@@ -19,9 +19,10 @@ test:         ## Run unit/integration tests
 
 publish:      ## Publish the library to the central PyPi repository
 	# build and upload archive
-	($(VENV_RUN) && pip install setuptools && ./setup.py sdist && twine upload dist/*)
+	($(VENV_RUN) && pip install setuptools twine && ./setup.py sdist && twine upload dist/*)
 
 clean:        ## Clean up
 	rm -rf $(VENV_DIR)
+	rm -rf dist/*
 
 .PHONY: clean publish install usage lint test

README.md

@@ -25,8 +25,9 @@ pip install terraform-local
 
 The following environment variables can be configured:
 * `TF_CMD`: Terraform command to call (default: `terraform`)
-* `LOCALSTACK_HOSTNAME`: host name of the target LocalStack instance
-* `EDGE_PORT`: port number of the target LocalStack instance
+* `AWS_ENDPOINT_URL`: hostname and port of the target LocalStack instance
+* `LOCALSTACK_HOSTNAME`: __(Deprecated)__ host name of the target LocalStack instance
+* `EDGE_PORT`: __(Deprecated)__ port number of the target LocalStack instance
 * `S3_HOSTNAME`: special hostname to be used to connect to LocalStack S3 (default: `s3.localhost.localstack.cloud`)
 * `USE_EXEC`: whether to use `os.exec` instead of `subprocess.Popen` (try using this in case of I/O issues)
 * `<SERVICE>_ENDPOINT`: setting a custom service endpoint, e.g., `COGNITO_IDP_ENDPOINT=http://example.com`
@@ -47,6 +48,7 @@ please refer to the man pages of `terraform --help`.
 
 ## Change Log
 
+* v0.16.0: Introducing semantic versioning and AWS_ENDPOINT_URL variable
 * v0.15: Update endpoint overrides for Terraform AWS provider 5.22.0
 * v0.14: Add support to multi-account environments
 * v0.13: Fix S3 automatic `use_s3_path_style` detection when setting S3_HOSTNAME or LOCALSTACK_HOSTNAME

bin/tflocal

@@ -16,23 +16,24 @@ import subprocess
 
 from urllib.parse import urlparse
 
-PARENT_FOLDER = os.path.realpath(os.path.join(os.path.dirname(__file__), '..'))
-if os.path.isdir(os.path.join(PARENT_FOLDER, '.venv')):
+PARENT_FOLDER = os.path.realpath(os.path.join(os.path.dirname(__file__), ".."))
+if os.path.isdir(os.path.join(PARENT_FOLDER, ".venv")):
     sys.path.insert(0, PARENT_FOLDER)
 
 from localstack_client import config  # noqa: E402
 import hcl2  # noqa: E402
 
 DEFAULT_REGION = "us-east-1"
 DEFAULT_ACCESS_KEY = "test"
+AWS_ENDPOINT_URL = os.environ.get("AWS_ENDPOINT_URL")
 CUSTOMIZE_ACCESS_KEY = str(os.environ.get("CUSTOMIZE_ACCESS_KEY")).strip().lower() in ["1", "true"]
 LOCALHOST_HOSTNAME = "localhost.localstack.cloud"
 S3_HOSTNAME = os.environ.get("S3_HOSTNAME") or f"s3.{LOCALHOST_HOSTNAME}"
 USE_EXEC = str(os.environ.get("USE_EXEC")).strip().lower() in ["1", "true"]
 TF_CMD = os.environ.get("TF_CMD") or "terraform"
 LS_PROVIDERS_FILE = os.environ.get("LS_PROVIDERS_FILE") or "localstack_providers_override.tf"
-LOCALSTACK_HOSTNAME = os.environ.get("LOCALSTACK_HOSTNAME") or "localhost"
-EDGE_PORT = int(os.environ.get("EDGE_PORT") or 4566)
+LOCALSTACK_HOSTNAME = urlparse(AWS_ENDPOINT_URL).hostname or os.environ.get("LOCALSTACK_HOSTNAME") or "localhost"
+EDGE_PORT = int(urlparse(AWS_ENDPOINT_URL).port or os.environ.get("EDGE_PORT") or 4566)
 TF_PROVIDER_CONFIG = """
 provider "aws" {
   access_key                  = "<access_key>"
@@ -337,12 +338,12 @@ def get_or_create_ddb_table(table_name: str, region: str = None):
 def parse_tf_files() -> dict:
     """Parse the local *.tf files and return a dict of <filename> -> <resource_dict>"""
     result = {}
-    for _file in glob.glob('*.tf'):
+    for _file in glob.glob("*.tf"):
         try:
-            with open(_file, 'r') as fp:
+            with open(_file, "r") as fp:
                 result[_file] = hcl2.load(fp)
         except Exception as e:
-            print(f"Unable to parse '{_file}' as HCL file: {e}")
+            print(f'Unable to parse "{_file}" as HCL file: {e}')
     return result
 
 
@@ -408,5 +409,5 @@ def main():
         os.remove(config_file)
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     main()

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = terraform-local
-version = 0.15
+version = 0.16.0
 url = https://github.com/localstack/terraform-local
 author = LocalStack Team
 author_email = info@localstack.cloud
@@ -14,6 +14,7 @@ classifiers =
     Programming Language :: Python :: 3.8
     Programming Language :: Python :: 3.9
     Programming Language :: Python :: 3.10
+    Programming Language :: Python :: 3.11
     License :: OSI Approved :: Apache Software License
     Topic :: Software Development :: Testing
 

tests/test_apply.py

@@ -52,12 +52,11 @@ def test_access_key_override_by_profile(monkeypatch, profile_name: str):
     monkeypatch.setenv("CUSTOMIZE_ACCESS_KEY", "1")
     access_key = mock_access_key()
     bucket_name = short_uid()
-    credentials = """
-    [%s]
-    aws_access_key_id = %s
-    aws_secret_access_key = test
-    region = eu-west-1
-    """ % (profile_name, access_key)
+    credentials = """[%s]
+aws_access_key_id = %s
+aws_secret_access_key = test
+region = eu-west-1
+""" % (profile_name, access_key)
     with tempfile.TemporaryDirectory() as temp_dir:
         credentials_file = os.path.join(temp_dir, "credentials")
         with open(credentials_file, "w") as f: