Fix s3 backend setting DynamoDB state lock on by default (#77)

Author: hubbcaps

README.md

@@ -77,6 +77,7 @@ ADDITIONAL_TF_OVERRIDE_LOCATIONS=/path/to/module1,path/to/module2 tflocal plan
 
 ## Change Log
 
+* v0.22.0: Fix S3 backend forcing DynamoDB State Lock to be enabled by default
 * v0.21.0: Add ability to drop an override file in additional locations
 * v0.20.1: Fix list config rendering
 * v0.20.0: Fix S3 backend option merging

bin/tflocal

@@ -288,7 +288,6 @@ def generate_s3_backend_config() -> str:
         # note: default values, updated by `backend_config` further below...
         "bucket": "tf-test-state",
         "key": "terraform.tfstate",
-        "dynamodb_table": "tf-test-state",
         "region": get_region(),
         "skip_credentials_validation": True,
         "skip_metadata_api_check": True,
@@ -337,7 +336,8 @@ def generate_s3_backend_config() -> str:
     configs.update(backend_config)
     if not DRY_RUN:
         get_or_create_bucket(configs["bucket"])
-        get_or_create_ddb_table(configs["dynamodb_table"], region=configs["region"])
+        if "dynamodb_table" in configs:
+            get_or_create_ddb_table(configs["dynamodb_table"], region=configs["region"])
     result = TF_S3_BACKEND_CONFIG
     config_options = ""
     for key, value in sorted(configs.items()):

setup.cfg

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

tests/test_apply.py

@@ -205,6 +205,43 @@ def test_s3_backend():
     assert result["ResponseMetadata"]["HTTPStatusCode"] == 200
 
 
+def test_s3_backend_state_lock_default():
+    state_bucket = f"tf-state-{short_uid()}"
+    bucket_name = f"bucket-{short_uid()}"
+    state_region = "us-west-1"
+    dynamodb_client = client("dynamodb", region_name=state_region)
+    table_amount = len(dynamodb_client.list_tables()["TableNames"])
+    config = """
+    terraform {
+      backend "s3" {
+        bucket = "%s"
+        key    = "terraform.tfstate"
+        region = "%s"
+        skip_credentials_validation = true
+      }
+    }
+    resource "aws_s3_bucket" "test-bucket" {
+      bucket = "%s"
+    }
+    """ % (state_bucket, state_region, bucket_name)
+    deploy_tf_script(config)
+
+    # assert that bucket with state file exists
+    s3 = client("s3", region_name=state_region)
+    result = s3.list_objects(Bucket=state_bucket)
+    keys = [obj["Key"] for obj in result["Contents"]]
+    assert "terraform.tfstate" in keys
+
+    # assert that DynamoDB table with state file locks has not been created by default
+    result = dynamodb_client.list_tables()
+    assert len(result["TableNames"]) == table_amount
+
+    # assert that S3 resource has been created
+    s3 = client("s3")
+    result = s3.head_bucket(Bucket=bucket_name)
+    assert result["ResponseMetadata"]["HTTPStatusCode"] == 200
+
+
 def test_dry_run(monkeypatch):
     monkeypatch.setenv("DRY_RUN", "1")
     state_bucket = "tf-state-dry-run"