make manifest read only (#32)

Author: varun646

src/PythonProjectBootstrapper/ProjectGenerationUtils.py

@@ -10,6 +10,7 @@
 import hashlib
 import itertools
 import os
+from stat import S_IWUSR
 import sys
 from pathlib import Path
 
@@ -99,6 +100,26 @@ def CreateManifest(generated_dir: Path) -> dict[str, str]:
     return manifest_dict
 
 
+# ----------------------------------------------------------------------
+def _ChangeManifestWritePermissions(manifest_filepath: Path, read_only: bool) -> None:
+    """
+    Change write permissions for manifest file
+
+    Args:
+        manifest_filepath (Path): Filepath to manifest file
+        read_only (bool): If true, set to read-only. If false, allow writing to file
+    """
+    PathEx.EnsureFile(manifest_filepath)
+    status = manifest_filepath.stat()
+
+    if read_only:
+        manifest_filepath.chmod(status.st_mode & ~S_IWUSR)
+    else:
+        manifest_filepath.chmod(status.st_mode | S_IWUSR)
+
+    status = manifest_filepath.stat()
+
+
 # ----------------------------------------------------------------------
 def ConditionallyRemoveUnchangedTemplateFiles(
     new_manifest_dict: dict[str, str],
@@ -250,10 +271,15 @@ def CopyToOutputDir(
 # Please do not change the contents :)
 #####################################################################################\n\n"""
 
+    if potential_manifest.is_file():
+        _ChangeManifestWritePermissions(manifest_filepath=potential_manifest, read_only=False)
+
     with open(potential_manifest, "w") as manifest_file:
         manifest_file.write(yaml_comments)
         yaml.dump(merged_manifest, manifest_file)
 
+    _ChangeManifestWritePermissions(manifest_filepath=potential_manifest, read_only=True)
+
     # copy temporary directory to final output directory and remove temporary directory
     shutil.copytree(
         src_dir,

tests/ProjectGenerationUtils_UnitTest.py

@@ -6,6 +6,8 @@
 # ----------------------------------------------------------------------
 import pytest
 import os
+from stat import S_IRUSR, S_IWUSR
+import sys
 from unittest.mock import patch
 
 from pathlib import Path
@@ -164,14 +166,22 @@ def test_CopyToOutputDir_overwritePrompt(fs, overwrite):
         with open(dest / path, "r") as destfile:
             assert content == destfile.read()
 
-    assert (dest / ".manifest.yml").is_file()
+    manifest_filepath = dest / ".manifest.yml"
+    assert manifest_filepath.is_file()
+
+    # check that manifest file has read-only permissions
+    status = manifest_filepath.stat()
+    assert status.st_mode & S_IWUSR == 0
+    assert status.st_mode & S_IRUSR == S_IRUSR
 
 
 # ----------------------------------------------------------------------
 def test_CopyToOutputDir_no_prompt(fs):
     # Test for the following:
     #   - All created files and directories are copied into the dest
     #   - All contents of files are the same in src and dest
+    #   - Created manifest file is read-only
+
     files = [(Path("test/file1"), "abc"), (Path("test/file2"), "def")]
     emptydir_path = Path("emptydir")
 
@@ -189,10 +199,16 @@ def test_CopyToOutputDir_no_prompt(fs):
     fs.create_dir(dest)
 
     directory_changes = CopyToOutputDir(src_dir=src, dest_dir=dest)
+    manifest_filepath = dest / ".manifest.yml"
 
     assert directory_changes.added_files == ["dest/test/file1", "dest/test/file2"]
     assert directory_changes.deleted_files == []
     assert directory_changes.overwritten_files == []
     assert directory_changes.modified_template_files == []
     assert _dirs_equal(expected, dest)
-    assert (dest / ".manifest.yml").is_file()
+    assert (manifest_filepath).is_file()
+
+    # check that manifest file has read-only permissions
+    status = manifest_filepath.stat()
+    assert status.st_mode & S_IWUSR == 0
+    assert status.st_mode & S_IRUSR == S_IRUSR