refactor: clean up setting helper script executable

Author: fleetingbytes

src/ci_starter/cli/__init__.py

@@ -24,7 +24,7 @@
     LOCKFILE_ARTIFACT,
     SEMANTIC_RELEASE_CONFIG_FILE,
 )
-from ..utils import dump
+from ..utils import dump, make_path_executable
 from .callbacks import WorkDir as WorkDir
 from .callbacks import get_package_name, set_module_name, set_workdir
 from .validations import validate_test_group, validate_workflow_file_name
@@ -101,7 +101,7 @@ def workflows(
     with workdir.helper_script.open("w", encoding="utf-8") as script_file:
         script: str = generate_helper_script()
         script_file.write(script)
-    _make_script_executable = workdir.helper_script.chmod(0o755)
+    make_path_executable(workdir.helper_script)
 
     base_workflow_file = workdir.workflows / workflow_file_name.name
     with base_workflow_file.open("w", encoding="utf-8") as base_workflow:

src/ci_starter/utils.py

@@ -1,5 +1,8 @@
 from collections.abc import Iterable, Mapping
 from pathlib import Path
+from stat import S_IXGRP as EXECUTABLE_FOR_GROUP
+from stat import S_IXOTH as EXECUTABLE_FOR_OTHERS
+from stat import S_IXUSR as EXECUTABLE_FOR_USER
 from sys import version_info
 from typing import TYPE_CHECKING, Any, TextIO
 
@@ -92,3 +95,9 @@ def compare(actual: Version, expected: Version) -> str:
     elif actual.compare(expected) == -1:
         return "older"
     return "same"
+
+
+def make_path_executable(path: Path) -> None:
+    old_mode = path.stat().st_mode
+    executable = old_mode | EXECUTABLE_FOR_USER | EXECUTABLE_FOR_GROUP | EXECUTABLE_FOR_OTHERS
+    path.chmod(executable)

tests/e2e/test_helper_script.py

@@ -0,0 +1,24 @@
+from pathlib import Path
+from stat import S_IXGRP as EXECUTABLE_FOR_GROUP
+from stat import S_IXOTH as EXECUTABLE_FOR_OTHERS
+from stat import S_IXUSR as EXECUTABLE_FOR_USER
+
+from click.testing import CliRunner, Result
+
+from ci_starter.cli import cli
+from ci_starter.constants import HELPER_SCRIPT_FILE_PATH
+from tests.e2e.constants import SUCCESSFUL_RETURN_CODE
+
+
+def is_executable(path: Path) -> bool:
+    mode = path.stat().st_mode
+    return all((mode | EXECUTABLE_FOR_USER, mode | EXECUTABLE_FOR_GROUP, mode | EXECUTABLE_FOR_OTHERS))
+
+
+def test_verify_remote_has_not_changed_is_executable(test_project_path_str: str, cli_runner: CliRunner):
+    result: Result = cli_runner.invoke(cli, ["-C", test_project_path_str, "workflows"])
+    assert result.exit_code == SUCCESSFUL_RETURN_CODE
+
+    script = Path(test_project_path_str, HELPER_SCRIPT_FILE_PATH)
+
+    assert is_executable(script)

tests/e2e/test_verify_remote_has_not_changed.py

@@ -0,0 +1,24 @@
+from pathlib import Path
+from stat import S_IXGRP as EXECUTABLE_FOR_GROUP
+from stat import S_IXOTH as EXECUTABLE_FOR_OTHERS
+from stat import S_IXUSR as EXECUTABLE_FOR_USER
+
+from click.testing import CliRunner, Result
+
+from ci_starter.cli import cli
+from ci_starter.constants import HELPER_SCRIPT_FILE_PATH
+from tests.e2e.constants import SUCCESSFUL_RETURN_CODE
+
+
+def is_executable(path: Path) -> bool:
+    mode = path.stat().st_mode
+    return all((mode | EXECUTABLE_FOR_USER, mode | EXECUTABLE_FOR_GROUP, mode | EXECUTABLE_FOR_OTHERS))
+
+
+def test_helper_script_is_executable(test_project_path_str: str, cli_runner: CliRunner):
+    result: Result = cli_runner.invoke(cli, ["-C", test_project_path_str, "workflows"])
+    assert result.exit_code == SUCCESSFUL_RETURN_CODE
+
+    script = Path(test_project_path_str, HELPER_SCRIPT_FILE_PATH)
+
+    assert is_executable(script)