Merge branch 'master' into introduce_ruff

Author: MaxymVlasov

CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file.
 
+# [1.98.0](https://github.com/antonbabenko/pre-commit-terraform/compare/v1.97.4...v1.98.0) (2025-03-25)
+
+
+### Features
+
+* **docker:** Support execution on repos under `git worktree` ([#845](https://github.com/antonbabenko/pre-commit-terraform/issues/845)) ([e64974e](https://github.com/antonbabenko/pre-commit-terraform/commit/e64974ed7745a3c35882b71be49fc89570cb006e))
+
 ## [1.97.4](https://github.com/antonbabenko/pre-commit-terraform/compare/v1.97.3...v1.97.4) (2025-02-26)
 
 

src/pre_commit_terraform/terraform_docs_replace.py

@@ -18,14 +18,20 @@ def populate_argument_parser(subcommand_parser: ArgumentParser) -> None:
         'replace the entire README.md file each time.'
     )
     subcommand_parser.add_argument(
-        '--dest', dest='dest', default='README.md',
+        '--dest',
+        dest='dest',
+        default='README.md',
     )
     subcommand_parser.add_argument(
-        '--sort-inputs-by-required', dest='sort', action='store_true',
+        '--sort-inputs-by-required',
+        dest='sort',
+        action='store_true',
         help='[deprecated] use --sort-by-required instead',
     )
     subcommand_parser.add_argument(
-        '--sort-by-required', dest='sort', action='store_true',
+        '--sort-by-required',
+        dest='sort',
+        action='store_true',
     )
     subcommand_parser.add_argument(
         '--with-aggregate-type-defaults',
@@ -51,8 +57,9 @@ def invoke_cli_app(parsed_cli_args: Namespace) -> ReturnCodeType:
 
     dirs: list[str] = []
     for filename in cast_to(list[str], parsed_cli_args.filenames):
-        if (os.path.realpath(filename) not in dirs and
-                (filename.endswith(".tf") or filename.endswith(".tfvars"))):
+        if os.path.realpath(filename) not in dirs and (
+            filename.endswith('.tf') or filename.endswith('.tfvars')
+        ):
             dirs.append(os.path.dirname(filename))
 
     retval = ReturnCode.OK
@@ -64,13 +71,14 @@ def invoke_cli_app(parsed_cli_args: Namespace) -> ReturnCodeType:
             if cast_to(bool, parsed_cli_args.sort):
                 procArgs.append('--sort-by-required')
             procArgs.append('md')
-            procArgs.append("./{dir}".format(dir=dir))
+            procArgs.append('./{dir}'.format(dir=dir))
             procArgs.append('>')
             procArgs.append(
-                './{dir}/{dest}'.
-                format(dir=dir, dest=cast_to(bool, parsed_cli_args.dest)),
+                './{dir}/{dest}'.format(
+                    dir=dir, dest=cast_to(bool, parsed_cli_args.dest)
+                ),
             )
-            subprocess.check_call(" ".join(procArgs), shell=True)
+            subprocess.check_call(' '.join(procArgs), shell=True)
         except subprocess.CalledProcessError as e:
             print(e)
             retval = ReturnCode.ERROR

tests/pytest/terraform_docs_replace_test.py

@@ -24,8 +24,7 @@ def test_arg_parser_populated() -> None:
 def test_check_is_deprecated() -> None:
     """Verify that `replace-docs` shows a deprecation warning."""
     deprecation_msg_regex = (
-        r'^`terraform_docs_replace` hook is DEPRECATED\.'
-        'For migration.*$'
+        r'^`terraform_docs_replace` hook is DEPRECATED\.For migration.*$'
     )
     with pytest.warns(UserWarning, match=deprecation_msg_regex):
         # not `pytest.deprecated_call()` due to this being a user warning
@@ -70,10 +69,10 @@ def test_check_is_deprecated() -> None:
     'pre_commit_terraform.terraform_docs_replace',
 )
 def test_control_flow_positive(
-        expected_cmds: list[str],
-        mocker: pytest_mock.MockerFixture,
-        monkeypatch: pytest.MonkeyPatch,
-        parsed_cli_args: Namespace,
+    expected_cmds: list[str],
+    mocker: pytest_mock.MockerFixture,
+    monkeypatch: pytest.MonkeyPatch,
+    parsed_cli_args: Namespace,
 ) -> None:
     """Check that the subcommand's happy path works."""
     check_call_mock = mocker.Mock()
@@ -86,7 +85,7 @@ def test_control_flow_positive(
     assert ReturnCode.OK == invoke_cli_app(parsed_cli_args)
 
     executed_commands = [
-        cmd for ((cmd, ), _shell) in check_call_mock.call_args_list
+        cmd for ((cmd,), _shell) in check_call_mock.call_args_list
     ]
 
     assert len(expected_cmds) == check_call_mock.call_count
@@ -98,8 +97,8 @@ def test_control_flow_positive(
     'pre_commit_terraform.terraform_docs_replace',
 )
 def test_control_flow_negative(
-        mocker: pytest_mock.MockerFixture,
-        monkeypatch: pytest.MonkeyPatch,
+    mocker: pytest_mock.MockerFixture,
+    monkeypatch: pytest.MonkeyPatch,
 ) -> None:
     """Check that the subcommand's error processing works."""
     parsed_cli_args = Namespace(

tools/entrypoint.sh

@@ -39,7 +39,7 @@ wdir="$(pwd)"
 if ! su-exec "$USERID" "$BASHPATH" -c "test -w $wdir && test -r $wdir"; then
   echo_error_and_exit "uid:gid $USERID lacks permissions to $wdir/"
 fi
-wdirgitindex="$wdir/.git/index"
+wdirgitindex="$(git rev-parse --git-dir 2>&1)/index" || echo_error_and_exit "${wdirgitindex%/index}"
 if ! su-exec "$USERID" "$BASHPATH" -c "test -w $wdirgitindex && test -r $wdirgitindex"; then
   echo_error_and_exit "uid:gid $USERID cannot write to $wdirgitindex"
 fi