Add mypy step to CI (#195)

Realized we have some type errors that have slipped through. Development
should include typing to avoid footguns

Author: woojiahao

.github/workflows/ci.yml

@@ -43,6 +43,27 @@ jobs:
         run: |
           python -m pytest -s -vv
 
+  mypy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+      - name: Install dependencies
+        run: |
+          pip install -r requirements.txt
+      - name: Set up Git
+        run: |
+          git config --global user.name "github-actions"
+          git config --global user.email "[email protected]"
+          git config --global init.defaultBranch main
+      - name: Run mypy
+        run: |
+          python -m mypy .
+
   format:
     runs-on: ubuntu-latest
     if: github.event_name == 'push' && github.ref == 'refs/heads/main'

branch_previous/test_verify.py

@@ -1,17 +1,19 @@
 from contextlib import contextmanager
 from typing import Iterator, Tuple
 
-from repo_smith.repo_smith import RepoSmith
 from exercise_utils.test import (
     GitAutograderTest,
     GitAutograderTestLoader,
     assert_output,
 )
 from git_autograder.status import GitAutograderStatus
+from repo_smith.repo_smith import RepoSmith
 
 from .verify import (
     MISSING_BRANCH,
     MISSING_COMMIT,
+    MISSING_LOCATION_COMMIT,
+    MISSING_STORY_FILE,
     WRONG_CONTENT,
     WRONG_START,
     verify,
@@ -58,6 +60,52 @@ def test_base():
         assert_output(output, GitAutograderStatus.SUCCESSFUL)
 
 
+def test_location_commit_missing():
+    with loader.start() as (test, rs):
+        rs.files.create_or_update("story.txt", "It was a dark and stormy night.")
+        rs.git.add(all=True)
+        rs.git.commit(message="Describe night")
+
+        rs.files.append("story.txt", "I heard a strange noise.")
+        rs.git.add(all=True)
+        rs.git.commit(message="Mention noise")
+
+        output = test.run()
+        assert_output(
+            output, GitAutograderStatus.UNSUCCESSFUL, [MISSING_LOCATION_COMMIT]
+        )
+
+
+def test_story_file_missing():
+    with loader.start() as (test, rs):
+        rs.files.create_or_update("a.txt", "It was a dark and stormy night.")
+        rs.git.add(all=True)
+        rs.git.commit(message="Describe night")
+
+        rs.files.append("a.txt", "I was alone in my room.")
+        rs.git.add(all=True)
+        rs.git.commit(message="Describe location")
+
+        rs.files.append("a.txt", "I heard a strange noise.")
+        rs.git.add(all=True)
+        rs.git.commit(message="Mention noise")
+
+        rs.git.checkout("visitor-line", start_point="HEAD~1", branch=True)
+
+        rs.files.append("a.txt", "I heard someone knocking at the door.")
+        rs.git.add(all=True)
+        rs.git.commit(message="Mention knocking")
+
+        rs.git.checkout("sleep-line", start_point="HEAD~1", branch=True)
+
+        rs.files.append("a.txt", "I fell asleep on the couch.")
+        rs.git.add(all=True)
+        rs.git.commit(message="Mention sleeping")
+
+        output = test.run()
+        assert_output(output, GitAutograderStatus.UNSUCCESSFUL, [MISSING_STORY_FILE])
+
+
 def test_visitor_missing_branch():
     with base_setup() as (test, rs):
         rs.git.checkout("sleep-line", start_point="HEAD~1", branch=True)

branch_previous/verify.py

@@ -1,12 +1,14 @@
 from typing import List, Optional
 
 from git_autograder import (
-    GitAutograderOutput,
+    GitAutograderCommit,
     GitAutograderExercise,
+    GitAutograderOutput,
     GitAutograderStatus,
-    GitAutograderCommit,
 )
 
+MISSING_LOCATION_COMMIT = "The commit with message 'Describe location' is not found."
+MISSING_STORY_FILE = "The file 'story.txt' is not found."
 MISSING_BRANCH = "The '{branch_name}' branch is missing."
 MISSING_COMMIT = "No commits were made in the '{branch_name}' branch."
 WRONG_START = (
@@ -43,7 +45,6 @@ def verify_branch(
     Check that the given branch exists, starts from the expected commit,
     and contains the expected content in story.txt.
     """
-
     branch_helper = exercise.repo.branches
     if not branch_helper.has_branch(branch_name):
         raise exercise.wrong_answer([MISSING_BRANCH.format(branch_name=branch_name)])
@@ -60,6 +61,9 @@ def verify_branch(
         raise exercise.wrong_answer([WRONG_START.format(branch_name=branch_name)])
 
     with latest_commit.file("story.txt") as content:
+        if content is None:
+            raise exercise.wrong_answer([MISSING_STORY_FILE])
+
         if expected_content not in content:
             raise exercise.wrong_answer(
                 [
@@ -74,6 +78,9 @@ def verify(exercise: GitAutograderExercise) -> GitAutograderOutput:
     commits = exercise.repo.branches.branch("main").commits
     describe_location_commit = get_commit_from_message(commits, "Describe location")
 
+    if describe_location_commit is None:
+        raise exercise.wrong_answer([MISSING_LOCATION_COMMIT])
+
     verify_branch(
         branch_name="visitor-line",
         expected_start_commit=describe_location_commit,

sensors_reset/verify.py

@@ -35,7 +35,7 @@ def get_unstaged_files(exercise: GitAutograderExercise) -> List[str | None]:
 
 
 def verify(exercise: GitAutograderExercise) -> GitAutograderOutput:
-    branch = exercise.repo.branches.branch_or_none("main")
+    branch = exercise.repo.branches.branch("main")
     commit_messages = [str(c.commit.message.strip()) for c in branch.commits]
 
     staged_files = get_staged_files(exercise)
@@ -64,7 +64,7 @@ def verify(exercise: GitAutograderExercise) -> GitAutograderOutput:
 
     # TODO: need a way to verify task by task
     # currently we verify staging area and working directory of all tasks at once, since we cannot get state of each task
-    comments: str = []
+    comments: List[str] = []
     if len(unstaged_files) != 4 or not all(
         file in unstaged_files
         for file in ["east.csv", "north.csv", "south.csv", "west.csv"]

side_track/verify.py

@@ -1,13 +1,15 @@
 import io
+import os
 import sys
 from contextlib import redirect_stdout
 from pathlib import Path
-from typing import Any, Dict, Optional
+from typing import Any, Dict, Optional, cast
 
 from git_autograder import (
     GitAutograderExercise,
     GitAutograderInvalidStateException,
     GitAutograderOutput,
+    GitAutograderRepo,
     GitAutograderStatus,
     GitAutograderWrongAnswerException,
 )
@@ -56,14 +58,13 @@ def verify(exercise: GitAutograderExercise) -> GitAutograderOutput:
         if len(bug_fix_branch.user_commits) < 2:
             raise exercise.wrong_answer([MISSING_COMMITS])
 
+        repo_path: str | os.PathLike = cast(GitAutograderRepo, exercise.repo).repo_path
         # Ensure that they applied the right fix by testing the greet function
         fixed_greet = True
         for name in ["James", "Hi", "Alice", "Bob"]:
             buf = io.StringIO()
             with redirect_stdout(buf):
-                execute_function(
-                    Path(exercise.repo.repo_path) / "greet.py", "greet", {"name": name}
-                )
+                execute_function(Path(repo_path) / "greet.py", "greet", {"name": name})
             print(buf.getvalue().strip())
             if buf.getvalue().strip() != f"Hi {name}":
                 fixed_greet = False
@@ -72,7 +73,7 @@ def verify(exercise: GitAutograderExercise) -> GitAutograderOutput:
         fixed_calculator = True
         for a, b in zip([1, 2, 3, 4, 5], [11, 123, 9, 10, 1]):
             result = execute_function(
-                Path(exercise.repo.repo_path) / "calculator.py", "add", {"a": a, "b": b}
+                Path(repo_path) / "calculator.py", "add", {"a": a, "b": b}
             )
             if result is None:
                 fixed_calculator = False