feat: add short option to git commit hash retrieval

Signed-off-by: Alex Jones <alex.jones@lowrisc.org>

Author: AlexJones0

src/dvsim/utils/git.py

@@ -28,7 +28,7 @@ def repo_root(path: Path) -> Path | None:
     return None
 
 
-def git_commit_hash(path: Path | None = None) -> str:
+def git_commit_hash(path: Path | None = None, *, short: bool = False) -> str:
     """Hash of the current git commit."""
     root = repo_root(path=path or Path.cwd())
 
@@ -38,6 +38,9 @@ def git_commit_hash(path: Path | None = None) -> str:
 
     r = Repo(root)
 
+    if short:
+        return r.git.rev_parse(r.head, short=True)
+
     return r.head.commit.hexsha
 
 

tests/utils/test_git.py

@@ -58,6 +58,20 @@ def test_git_commit_hash(tmp_path: Path) -> None:
             equal_to(r.head.commit.hexsha),
         )
 
+    @staticmethod
+    def test_git_short_commit_hash(tmp_path: "Path") -> None:
+        """Test that the expected shortened git commit sha is returned."""
+        r = Repo.init(path=tmp_path)
+
+        file = tmp_path / "a"
+        file.write_text("file to commit")
+        r.index.add([file])
+        r.index.commit("initial commit")
+
+        assert_that(
+            git_commit_hash(tmp_path, short=True), equal_to(r.git.rev_parse(r.head, short=True))
+        )
+
     @staticmethod
     def test_git_origin_url(tmp_path: Path) -> None:
         """Test that the expected git remote origin url is returned."""