fix: default identity need when run on gh actions

Fix warnings from mypy.

Author: krerkkiat

CHANGELOG.md

@@ -2,6 +2,9 @@
 
 ## Unreleased
 
+- Fix warnings by mypy.
+- Add a default user's identity to the `Repository`. Git on GitHub's Actions will complain
+  when a command like `git commit` is run without user's identity.
 
 ## v0.1.1a2
 

MAINTENANCE.md

@@ -67,6 +67,7 @@ make html
 
 ## Deployment flow
 
+- Run tox.
 - Update `grading_lib/VERSION` file.
 - Update `CHANGELOG.md` file.
 - Make a commit

grading_lib/common.py

@@ -176,7 +176,7 @@ def tearDown(self) -> None:
                 f"[info]: The temporary directory at '{self.temporary_dir_path}' is not deleted since the DEBUG is set to True."
             )
 
-    def assertArchiveFileIsGzip(self, path: Path):
+    def assertArchiveFileIsGzip(self, path: Path) -> None:
         cmd_result = run_executable(["gunzip", "-t", str(path)])
         self.assertTrue(
             "not in gzip format" not in cmd_result.output,

grading_lib/repository.py

@@ -8,7 +8,6 @@
 from git import Head, Repo
 from git.refs.tag import Tag
 from git.repo.fun import is_git_dir
-from git.util import IterableList
 
 from .common import BaseTestCase, CommandResult, run_executable
 
@@ -54,6 +53,10 @@ def __init__(self, path: str | Path, *args, **kwargs):
                 )
 
             self.repo = Repo(temp_dir_path / "repo", *args, **kwargs)
+            # Some git commands when run on GH Actions need user indentity.
+            with self.repo.config_writer(config_level="repository") as conf_writer:
+                conf_writer.set_value("user.name", "ou-cs3560-grading-script")
+                conf_writer.set_value("user.email", "[email protected]")
         else:
             if is_git_dir(path):
                 self.repo = Repo(path, *args, **kwargs)
@@ -70,7 +73,7 @@ def __init__(self, path: str | Path, *args, **kwargs):
     def __enter__(self):
         return self
 
-    def __exit__(self, exc_type, exc_val, exc_tb):
+    def __exit__(self, exc_type, exc_val, exc_tb) -> None:
         self.cleanup()
 
     def cleanup(self) -> None:
@@ -147,7 +150,7 @@ def create_random_commits(self, amount: int, branch: Head | None = None) -> None
         if branch is not None:
             previous_branch.checkout()
 
-    def get_all_tag_refs(self) -> IterableList:
+    def get_all_tag_refs(self) -> list[Tag]:
         return Tag.list_items(self.repo)
 
     def get_tag_refs_at(self, commit_hash: str) -> list[Tag]:
@@ -167,7 +170,9 @@ def visualize(self) -> str:
 
 
 class RepositoryBaseTestCase(BaseTestCase):
-    def assertHasTagWithNameAt(self, repo: Repository, name: str, commit_hash: str):
+    def assertHasTagWithNameAt(
+        self, repo: Repository, name: str, commit_hash: str
+    ) -> None:
         tag_path = "refs/tags/" + name
         tag_refs = repo.get_tag_refs_at(commit_hash)
         for tag_ref in tag_refs:
@@ -181,7 +186,7 @@ def assertHasTagWithNameAt(self, repo: Repository, name: str, commit_hash: str):
 
     def assertHasTagWithNameAndMessageAt(
         self, repo: Repository, name: str, message: str, commit_hash: str
-    ):
+    ) -> None:
         tag_path = "refs/tags/" + name
         tag_refs = repo.get_tag_refs_at(commit_hash)
         for tag_ref in tag_refs: