chore: adds additional type hints to tests and trestlebot pkg

Signed-off-by: Jennifer Power <[email protected]>

tests/trestlebot/tasks/authored/test_ssp.py

@@ -35,7 +35,7 @@
 markdown_dir = "md_ssp"
 
 
-def test_assemble(tmp_trestle_dir) -> None:
+def test_assemble(tmp_trestle_dir: str) -> None:
     """Test to test assemble functionality for SSPs"""
     # Prepare the workspace and generate the markdown
     trestle_root = pathlib.Path(tmp_trestle_dir)
@@ -59,7 +59,7 @@ def test_assemble(tmp_trestle_dir) -> None:
     assert len(ssp.control_implementation.implemented_requirements) == 12
 
 
-def test_assemble_no_ssp_entry(tmp_trestle_dir) -> None:
+def test_assemble_no_ssp_entry(tmp_trestle_dir: str) -> None:
     """Test to test assemble functionality for SSPs"""
     # Prepare the workspace and generate the markdown
     trestle_root = pathlib.Path(tmp_trestle_dir)

tests/trestlebot/tasks/test_assemble_task.py

@@ -41,7 +41,7 @@
 ssp_md_dir = "md_ssp"
 
 
-def test_catalog_assemble_task(tmp_trestle_dir):
+def test_catalog_assemble_task(tmp_trestle_dir: str) -> None:
     """Test catalog assemble at the task level"""
     trestle_root = pathlib.Path(tmp_trestle_dir)
     md_path = os.path.join(cat_md_dir, test_cat)
@@ -58,7 +58,7 @@ def test_catalog_assemble_task(tmp_trestle_dir):
     assert assemble_task.execute() == 0
 
 
-def test_profile_assemble_task(tmp_trestle_dir):
+def test_profile_assemble_task(tmp_trestle_dir: str) -> None:
     """Test profile assemble at the task level"""
     trestle_root = pathlib.Path(tmp_trestle_dir)
     md_path = os.path.join(prof_md_dir, test_prof)
@@ -74,7 +74,7 @@ def test_profile_assemble_task(tmp_trestle_dir):
     assert assemble_task.execute() == 0
 
 
-def test_compdef_assemble_task(tmp_trestle_dir):
+def test_compdef_assemble_task(tmp_trestle_dir: str) -> None:
     """Test compdef assemble at the task level"""
     trestle_root = pathlib.Path(tmp_trestle_dir)
     md_path = os.path.join(compdef_md_dir, test_comp)
@@ -90,7 +90,7 @@ def test_compdef_assemble_task(tmp_trestle_dir):
     assert assemble_task.execute() == 0
 
 
-def test_ssp_assemble_task(tmp_trestle_dir):
+def test_ssp_assemble_task(tmp_trestle_dir: str) -> None:
     """Test ssp assemble at the task level"""
     ssp_index_path = os.path.join(tmp_trestle_dir, "ssp-index.txt")
     with open(ssp_index_path, "w") as f:
@@ -111,7 +111,7 @@ def test_ssp_assemble_task(tmp_trestle_dir):
     assert assemble_task.execute() == 0
 
 
-def test_ssp_assemble_task_no_index_path(tmp_trestle_dir):
+def test_ssp_assemble_task_no_index_path(tmp_trestle_dir: str) -> None:
     """Test ssp assemble at the task level with failure"""
     ssp_index_path = os.path.join(tmp_trestle_dir, "ssp-index.txt")
     with open(ssp_index_path, "w") as f:

tests/trestlebot/test_bot.py

@@ -17,12 +17,15 @@
 """Test for top-level Trestle Bot logic."""
 
 import os
+from typing import Tuple
+
+from git.repo import Repo
 
 import trestlebot.bot as bot
 from tests.testutils import clean
 
 
-def test_stage_files(tmp_repo) -> None:
+def test_stage_files(tmp_repo: Tuple[str, Repo]) -> None:
     repo_path, repo = tmp_repo
 
     # Create test files
@@ -44,7 +47,7 @@ def test_stage_files(tmp_repo) -> None:
     clean(repo_path, repo)
 
 
-def test_local_commit(tmp_repo) -> None:
+def test_local_commit(tmp_repo: Tuple[str, Repo]) -> None:
     repo_path, repo = tmp_repo
 
     # Create a test file
@@ -74,7 +77,7 @@ def test_local_commit(tmp_repo) -> None:
     clean(repo_path, repo)
 
 
-def test_local_commit_with_committer(tmp_repo) -> None:
+def test_local_commit_with_committer(tmp_repo: Tuple[str, Repo]) -> None:
     repo_path, repo = tmp_repo
 
     # Create a test file
@@ -104,7 +107,7 @@ def test_local_commit_with_committer(tmp_repo) -> None:
     clean(repo_path, repo)
 
 
-def test_local_commit_with_author(tmp_repo) -> None:
+def test_local_commit_with_author(tmp_repo: Tuple[str, Repo]) -> None:
     repo_path, repo = tmp_repo
 
     # Create a test file
@@ -136,7 +139,7 @@ def test_local_commit_with_author(tmp_repo) -> None:
     clean(repo_path, repo)
 
 
-def test_run_dry_run(tmp_repo) -> None:
+def test_run_dry_run(tmp_repo: Tuple[str, Repo]) -> None:
     repo_path, repo = tmp_repo
 
     # Create a test file

trestlebot/bot.py

@@ -38,7 +38,7 @@ class RepoException(Exception):
     """
 
 
-def _stage_files(gitwd: Repo, patterns: List[str]):
+def _stage_files(gitwd: Repo, patterns: List[str]) -> None:
     """Stages files in git based on file patterns"""
     for pattern in patterns:
         logging.info(f"Adding file for pattern {pattern}")
@@ -52,7 +52,7 @@ def _local_commit(
     commit_message: str,
     author_name: str = "",
     author_email: str = "",
-):
+) -> None:
     """Creates a local commit in git working directory"""
     try:
         # Set the user and email for the commit
@@ -121,7 +121,7 @@ def run(
                 remote.push(refspec=f"HEAD:{branch}")
 
                 logging.info(f"Changes pushed to {branch} successfully.")
-                return True
+                return 0
 
             except GitCommandError as e:
                 raise RepoException(f"Git push to {branch} failed: {e}") from e

trestlebot/tasks/authored/ssp.py

@@ -50,7 +50,7 @@ def __init__(self, trestle_root: str, comps_by_ssp: Dict[str, str]) -> None:
         self.comps_by_ssp = comps_by_ssp
 
     def assemble(self, model_path: str, version_tag: str = "") -> None:
-        ssp_assemble = SSPAssemble()
+        ssp_assemble: SSPAssemble = SSPAssemble()
         ssp = os.path.basename(model_path)
 
         try:

trestlebot/tasks/authored/types.py

@@ -28,10 +28,10 @@ class AuthoredType(Enum):
     COMPDEF = "compdef"
 
 
-def check_authored_type(string):
+def check_authored_type(input_type: str) -> AuthoredType:
     """Check if the string has a matching AuthoredType, if not raise an error"""
     try:
-        item_type = AuthoredType[string.upper()]
+        item_type = AuthoredType[input_type.upper()]
         return item_type
     except KeyError:
-        raise ValueError(f"Invalid item type: {string}")
+        raise ValueError(f"Invalid item type: {input_type}")