Drop Terragrunt support and modernize Python codebase (#89)

* Refactor: remove Terragrunt support

Strip out all Terragrunt-specific logic, arguments, and classes (e.g., TerragruntTest).
Remove Terragrunt test fixtures and associated test files (test_tg_all.py).
Clean up test_args.py to remove Terragrunt argument tests.
Update README.md to remove the Terragrunt documentation.

Going forward, this library will only support Terraform and OpenTofu.

* Refactor: Python modernization

- Remove legacy Python 2 future imports.
- Migrate string formatting to f-strings via flynt.
- Replace os.path usage with pathlib.Path.
- Add comprehensive type hinting to TerraformTest and related methods.

* Refactor: parse_args mapping

Replaced long list of if/elif statements with declarative mappings
(bool_flags, inverse_bool_flags, kv_flags) to simplify adding new
flags and reduce cyclomatic complexity.

* Chore: configure and apply yapf formatting

Add .style.yapf using google style to match the Cloud Foundation
Fabric repository. Apply yapf formatting across all python files.

* Chore: update CI to use yapf for linting

Replace autopep8 with yapf in the GitHub Actions linting workflow
and DEV-REQUIREMENTS.txt to enforce the new Google-style formatting
rules defined in .style.yapf.

* Fix: format setup.py with yapf

Author: ludoo

.github/workflows/linting.yml

@@ -47,7 +47,5 @@ jobs:
       - name: Check python formatting
         id: lint
         run: |
-          echo '[pep8]' > pep8
-          echo 'indent-size = 2' >> pep8
-          autopep8 --diff --global-config pep8 --recursive --exit-code \
+          yapf --diff --recursive --parallel \
            *.py test

.style.yapf

@@ -0,0 +1,4 @@
+[style]
+based_on_style=google
+indent_width=2
+split_before_named_assigns=false

DEV-REQUIREMENTS.txt

@@ -1,2 +1,2 @@
-autopep8>=2.0
+yapf>=0.40
 pytest>=7.2

README.md

@@ -46,38 +46,6 @@ def test_modules(plan):
   assert res['values']['location'] == plan.variables['gcs_location']
 ```
 
-## Terragrunt support
-
-Support for Terragrunt actually follows the same principle of the thin `TerraformTest` wrapper.
-
-Please see the following example for how to use it:
-
-```python
-import pytest
-import tftest
-
-
-@pytest.fixture
-def run_all_apply_out(fixtures_dir):
-  # notice for run-all, you need to specify when TerragruntTest is constructed
-  tg = tftest.TerragruntTest('tg_apply_all', fixtures_dir, tg_run_all=True)
-  # the rest is very similar to how you use TerraformTest
-  tg.setup()
-  # to use --terragrunt-<option>, pass in tg_<option in snake case>
-  tg.apply(output=False, tg_non_interactive=True)
-  yield tg.output()
-  tg.destroy(auto_approve=True, tg_non_interactive=True)
-
-  
-def test_run_all_apply(run_all_apply_out):
-    triggers = [o["triggers"] for o in run_all_apply_out]
-    assert [{'name': 'foo', 'template': 'sample template foo'}] in triggers
-    assert [{'name': 'bar', 'template': 'sample template bar'}] in triggers
-    assert [{'name': 'one', 'template': 'sample template one'},
-            {'name': 'two', 'template': 'sample template two'}] in triggers
-    assert len(run_all_apply_out) == 3
-```
-
 ## Caching
 
 The `TerraformTest` `setup`, `init`, `plan`, `apply`, `output` and `destroy` methods have the ability to cache it's associate output to a local `.tftest-cache` directory. For subsequent calls of the method, the cached value can be returned instead of calling the actual underlying `terraform` command. Using the cache value can be significantly faster than running the Terraform command again especially if the command is time-intensive.

setup.py

@@ -16,11 +16,9 @@
 
 from tftest import __version__
 
-
 with open("README.md", "r") as fh:
   long_description = fh.read()
 
-
 setuptools.setup(
     name="tftest",
     version=__version__,

test/fixtures/plan_no_resource_changes/terragrunt.hcl

@@ -11,51 +11,128 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
-
 "Test the function for mapping Terraform arguments."
 import pytest
 
 import tftest
 
-
 ARGS_TESTS = (
-    ({'auto_approve': True}, ['-auto-approve']),
-    ({'auto_approve': False}, []),
-    ({'backend': True}, []),
-    ({'backend': None}, []),
-    ({'backend': False}, ['-backend=false']),
-    ({'color': True}, []),
-    ({'color': False}, ['-no-color']),
-    ({'color': False, 'input': False}, ['-no-color', '-input=false']),
-    ({'force_copy': True}, ['-force-copy']),
-    ({'force_copy': None}, []),
-    ({'force_copy': False}, []),
-    ({'input': True}, []),
-    ({'input': False}, ['-input=false']),
-    ({'json_format': True}, ['-json']),
-    ({'json_format': False}, []),
-    ({'lock': True}, []),
-    ({'lock': False}, ['-lock=false']),
-    ({'plugin_dir': ''}, []),
-    ({'plugin_dir': 'abc'}, ['-plugin-dir', 'abc']),
-    ({'refresh': True}, []),
-    ({'refresh': None}, []),
-    ({'refresh': False}, ['-refresh=false']),
-    ({'upgrade': True}, ['-upgrade']),
-    ({'upgrade': False}, []),
-    ({'tf_var_file': None}, []),
-    ({'tf_var_file': 'foo.tfvar'}, ['-var-file=foo.tfvar']),
-    ({'tf_var_file': ['foo.tfvar', 'bar.tfvar']}, [
-     '-var-file=foo.tfvar', '-var-file=bar.tfvar']),
-    ({'tf_vars': {'text': 'text'}}, ['-var', 'text=text']),
-    ({'tf_vars': {'number': 0}}, ['-var', 'number=0']),
-    ({'tf_vars': {'bool': False}}, ['-var', 'bool=False']),
-    ({'tf_vars': {'dict': {'text': 'text'}}},
-     ['-var', 'dict={"text": "text"}']),
-    ({'tf_vars': {'list': ['item1', 'item2']}},
-     ['-var', 'list=["item1", "item2"]']),
-    ({'tf_vars': {'dict': {'list': ['item1', 'item2']}}},
-     ['-var', 'dict={"list": ["item1", "item2"]}']),
+    ({
+        'auto_approve': True
+    }, ['-auto-approve']),
+    ({
+        'auto_approve': False
+    }, []),
+    ({
+        'backend': True
+    }, []),
+    ({
+        'backend': None
+    }, []),
+    ({
+        'backend': False
+    }, ['-backend=false']),
+    ({
+        'color': True
+    }, []),
+    ({
+        'color': False
+    }, ['-no-color']),
+    ({
+        'color': False,
+        'input': False
+    }, ['-no-color', '-input=false']),
+    ({
+        'force_copy': True
+    }, ['-force-copy']),
+    ({
+        'force_copy': None
+    }, []),
+    ({
+        'force_copy': False
+    }, []),
+    ({
+        'input': True
+    }, []),
+    ({
+        'input': False
+    }, ['-input=false']),
+    ({
+        'json_format': True
+    }, ['-json']),
+    ({
+        'json_format': False
+    }, []),
+    ({
+        'lock': True
+    }, []),
+    ({
+        'lock': False
+    }, ['-lock=false']),
+    ({
+        'plugin_dir': ''
+    }, []),
+    ({
+        'plugin_dir': 'abc'
+    }, ['-plugin-dir', 'abc']),
+    ({
+        'refresh': True
+    }, []),
+    ({
+        'refresh': None
+    }, []),
+    ({
+        'refresh': False
+    }, ['-refresh=false']),
+    ({
+        'upgrade': True
+    }, ['-upgrade']),
+    ({
+        'upgrade': False
+    }, []),
+    ({
+        'tf_var_file': None
+    }, []),
+    ({
+        'tf_var_file': 'foo.tfvar'
+    }, ['-var-file=foo.tfvar']),
+    ({
+        'tf_var_file': ['foo.tfvar', 'bar.tfvar']
+    }, ['-var-file=foo.tfvar', '-var-file=bar.tfvar']),
+    ({
+        'tf_vars': {
+            'text': 'text'
+        }
+    }, ['-var', 'text=text']),
+    ({
+        'tf_vars': {
+            'number': 0
+        }
+    }, ['-var', 'number=0']),
+    ({
+        'tf_vars': {
+            'bool': False
+        }
+    }, ['-var', 'bool=False']),
+    ({
+        'tf_vars': {
+            'dict': {
+                'text': 'text'
+            }
+        }
+    }, ['-var', 'dict={"text": "text"}']),
+    ({
+        'tf_vars': {
+            'list': ['item1', 'item2']
+        }
+    }, ['-var', 'list=["item1", "item2"]']),
+    ({
+        'tf_vars': {
+            'dict': {
+                'list': ['item1', 'item2']
+            }
+        }
+    }, ['-var', 'dict={"list": ["item1", "item2"]}']),
 )
 
 
@@ -65,56 +142,15 @@ def test_args(kwargs, expected):
   assert tftest.parse_args(**kwargs) == expected
 
 
-TERRAGRUNT_ARGS_TESTCASES = [
-    ({"tg_config": "Obama"}, ['--terragrunt-config', 'Obama']),
-    ({"tg_tfpath": "Barrack"}, ['--terragrunt-tfpath', 'Barrack']),
-    ({"tg_no_auto_init": True}, ['--terragrunt-no-auto-init']),
-    ({"tg_no_auto_init": False}, []),
-    ({"tg_no_auto_retry": True}, ['--terragrunt-no-auto-retry']),
-    ({"tg_no_auto_retry": False}, []),
-    ({"tg_non_interactive": True}, ['--terragrunt-non-interactive']),
-    ({"tg_non_interactive": False}, []),
-    ({"tg_working_dir": "George"}, ['--terragrunt-working-dir', 'George']),
-    ({"tg_download_dir": "Bush"}, ['--terragrunt-download-dir', 'Bush']),
-    ({"tg_source": "Clinton"}, ['--terragrunt-source', 'Clinton']),
-    ({"tg_source_update": True}, ['--terragrunt-source-update']),
-    ({"tg_source_update": False}, []),
-    ({"tg_iam_role": "Bill"}, ['--terragrunt-iam-role', 'Bill']),
-    ({"tg_ignore_dependency_errors": True}, [
-     '--terragrunt-ignore-dependency-errors']),
-    ({"tg_ignore_dependency_errors": False}, []),
-    ({"tg_ignore_dependency_order": True}, [
-     '--terragrunt-ignore-dependency-order']),
-    ({"tg_ignore_dependency_order": False}, []),
-    ({"tg_ignore_external_dependencies": "dont care what is here"},
-     ['--terragrunt-ignore-external-dependencies']),
-    ({"tg_include_external_dependencies": True}, [
-     '--terragrunt-include-external-dependencies']),
-    ({"tg_include_external_dependencies": False}, []),
-    ({"tg_parallelism": 20}, ['--terragrunt-parallelism 20']),
-    ({"tg_exclude_dir": "Ronald"}, ['--terragrunt-exclude-dir', 'Ronald']),
-    ({"tg_include_dir": "Reagan"}, ['--terragrunt-include-dir', 'Reagan']),
-    ({"tg_check": True}, ['--terragrunt-check']),
-    ({"tg_check": False}, []),
-    ({"tg_hclfmt_file": "Biden"}, ['--terragrunt-hclfmt-file', 'Biden']),
-    ({"tg_override_attr": {"Iron": "Man", "Captain": "America"}},
-     ['--terragrunt-override-attr=Iron=Man', '--terragrunt-override-attr=Captain=America']),
-    ({"tg_debug": True}, ['--terragrunt-debug']),
-    ({"tg_debug": False}, []),
-
-]
-
-
-@pytest.mark.parametrize("kwargs, expected", TERRAGRUNT_ARGS_TESTCASES)
-def test_terragrunt_args(kwargs, expected):
-  assert tftest.parse_args(**kwargs) == expected
-
-
 def test_var_args():
-  assert sorted(tftest.parse_args(init_vars={'a': 1, 'b': '["2"]'})) == sorted(
-      ["-backend-config=a=1", '-backend-config=b=["2"]'])
-  assert sorted(tftest.parse_args(tf_vars={'a': 1, 'b': '["2"]'})) == sorted(
-      ['-var', 'b=["2"]', '-var', 'a=1'])
+  assert sorted(tftest.parse_args(init_vars={
+      'a': 1,
+      'b': '["2"]'
+  })) == sorted(["-backend-config=a=1", '-backend-config=b=["2"]'])
+  assert sorted(tftest.parse_args(tf_vars={
+      'a': 1,
+      'b': '["2"]'
+  })) == sorted(['-var', 'b=["2"]', '-var', 'a=1'])
 
 
 def test_targets():