[mix-messy-graph] Add checkout and validate file content in verify logic (#202)

jovnc · web-flow · commit d266fd929d60 · 2026-01-01T22:28:01.000+08:00
# Exercise Review ## Exercise Discussion Fixes #71 ## Checklist - [ ] If you require a new remote repository on the `Git-Mastery` organization, have you [created a request](https://github.com/git-mastery/exercises/issues/new?template=request_exercise_repository.md) for it? - [X] Have you written unit tests using [`repo-smith`](https://github.com/git-mastery/repo-smith) to validate the exercise grading scheme? - [X] Have you tested the download script using `test-download.sh`? - [X] Have you verified that this exercise does not already exist or is not currently in review? - [ ] Did you introduce a new grading mechanism that should belong to [`git-autograder`](https://github.com/git-mastery/git-autograder)? - [ ] Did you introduce a new dependency that should belong to [`app`](https://github.com/git-mastery/app)?
diff --git a/mix_messy_graph/test_verify.py b/mix_messy_graph/test_verify.py
@@ -15,7 +15,7 @@
 
 loader = GitAutograderTestLoader(REPOSITORY_NAME, verify)
 
-FEATURES = """
+FEATURES_FILE_CONTENT_DELETE_COMMIT = """
 # Features
 
 ## Creating Books
@@ -32,22 +32,95 @@
 Allows deleting books.
 """
 
+FEATURES_FILE_CONTENT_SEARCH_COMMIT = """
+# Features
+
+## Creating Books
+
+Allows creating one book at a time.
+
+## Searching for Books
+
+Allows searching for books by keywords.
+Works only for book titles.
+"""
+
+FEATURES_FILE_CONTENT_FIX_HEADINGS_COMMIT = """
+# Features
+
+## Creating Books
+
+Allows creating one book at a time.
+"""
+
+
+FEATURES_FILE_CONTENT_CREATE_COMMIT = """
+# Features
+
+## Create Book
+
+Allows creating one book at a time.
+"""
+
+FEATURES_FILE_CONTENT_FEATURES_COMMIT = """
+# Features
+"""
+
 
 def test_base():
     with loader.start() as (test, rs):
-        rs.git.commit(message="Add features.md", allow_empty=True)
+        rs.files.create_or_update("features.md", FEATURES_FILE_CONTENT_FEATURES_COMMIT)
+        rs.git.add("features.md")
+        rs.git.commit(message="Add features.md")
         rs.helper(GitMasteryHelper).create_start_tag()
-        rs.git.commit(message="Mention feature for creating books", allow_empty=True)
+
+        rs.files.create_or_update("features.md", FEATURES_FILE_CONTENT_CREATE_COMMIT)
+        rs.git.add("features.md")
+        rs.git.commit(message="Mention feature for creating books")
         rs.git.tag("v1.0")
-        rs.git.commit(message="Fix phrasing of heading", allow_empty=True)
-        rs.git.commit(message="Add the search feature", allow_empty=True)
-        rs.git.commit(message="Add the delete feature", allow_empty=True)
-        rs.files.create_or_update("features.md", FEATURES)
+
+        rs.files.create_or_update("features.md", FEATURES_FILE_CONTENT_FIX_HEADINGS_COMMIT)
+        rs.git.add("features.md")
+        rs.git.commit(message="Fix phrasing of heading")
+
+        rs.files.create_or_update("features.md", FEATURES_FILE_CONTENT_SEARCH_COMMIT)
+        rs.git.add("features.md")
+        rs.git.commit(message="Add the search feature")
+
+        rs.files.create_or_update("features.md", FEATURES_FILE_CONTENT_DELETE_COMMIT)
+        rs.git.add("features.md")
+        rs.git.commit(message="Add the delete feature")
 
         output = test.run()
         assert_output(output, GitAutograderStatus.SUCCESSFUL)
 
 
+def test_invalid_features_content():
+    with loader.start() as (test, rs):
+        rs.files.create_or_update("features.md", FEATURES_FILE_CONTENT_FEATURES_COMMIT)
+        rs.git.add("features.md")
+        rs.git.commit(message="Add features.md")
+        rs.helper(GitMasteryHelper).create_start_tag()
+
+        rs.files.create_or_update("features.md", FEATURES_FILE_CONTENT_CREATE_COMMIT)
+        rs.git.add("features.md")
+        rs.git.commit(message="Mention feature for creating books")
+        rs.git.tag("v1.0")
+
+        rs.git.commit(message="Fix phrasing of heading", allow_empty=True)
+
+        rs.files.create_or_update("features.md", FEATURES_FILE_CONTENT_SEARCH_COMMIT)
+        rs.git.add("features.md")
+        rs.git.commit(message="Add the search feature")
+
+        rs.files.create_or_update("features.md", FEATURES_FILE_CONTENT_DELETE_COMMIT)
+        rs.git.add("features.md")
+        rs.git.commit(message="Add the delete feature")
+
+        output = test.run()
+        assert_output(output, GitAutograderStatus.UNSUCCESSFUL, [FEATURES_FILE_CONTENT_INVALID.format(commit="Fix phrasing of heading")])
+
+
 def test_non_squash_merge_used():
     with loader.start() as (test, rs):
         rs.git.commit(message="Add features.md", allow_empty=True)
@@ -62,7 +135,7 @@ def test_non_squash_merge_used():
         rs.git.merge("feature-search")
 
         rs.git.commit(message="Add the delete feature", allow_empty=True)
-        rs.files.create_or_update("features.md", FEATURES)
+        rs.files.create_or_update("features.md", FEATURES_FILE_CONTENT_DELETE_COMMIT)
 
         output = test.run()
         # This would fail because the squash merge changes the commit messages and the contents
@@ -91,7 +164,7 @@ def test_non_squash_merge_used_2():
         rs.git.merge("feature-search", no_ff=True)
 
         rs.git.commit(message="Add the delete feature", allow_empty=True)
-        rs.files.create_or_update("features.md", FEATURES)
+        rs.files.create_or_update("features.md", FEATURES_FILE_CONTENT_DELETE_COMMIT)
 
         output = test.run()
         assert_output(
@@ -110,7 +183,7 @@ def test_wrong_commit_message():
         rs.git.commit(message="Fix phrasing of heading", allow_empty=True)
         rs.git.commit(message="Add the search feature!", allow_empty=True)
         rs.git.commit(message="Add the delete feature", allow_empty=True)
-        rs.files.create_or_update("features.md", FEATURES)
+        rs.files.create_or_update("features.md", FEATURES_FILE_CONTENT_DELETE_COMMIT)
 
         output = test.run()
         assert_output(
@@ -132,7 +205,7 @@ def test_missing_commit():
         rs.git.tag("v1.0")
         rs.git.commit(message="Fix phrasing of heading", allow_empty=True)
         rs.git.commit(message="Add the search feature", allow_empty=True)
-        rs.files.create_or_update("features.md", FEATURES)
+        rs.files.create_or_update("features.md", FEATURES_FILE_CONTENT_DELETE_COMMIT)
 
         output = test.run()
         assert_output(
@@ -160,7 +233,7 @@ def test_branches_not_deleted():
         rs.git.branch("feature-delete")
         rs.git.branch("list")
 
-        rs.files.create_or_update("features.md", FEATURES)
+        rs.files.create_or_update("features.md", FEATURES_FILE_CONTENT_DELETE_COMMIT)
 
         output = test.run()
         assert_output(
@@ -183,11 +256,11 @@ def test_features_content_invalid():
         rs.git.commit(message="Fix phrasing of heading", allow_empty=True)
         rs.git.commit(message="Add the search feature", allow_empty=True)
         rs.git.commit(message="Add the delete feature", allow_empty=True)
-        rs.files.create_or_update("features.md", FEATURES[0])
+        rs.files.create_or_update("features.md", FEATURES_FILE_CONTENT_DELETE_COMMIT[0])
 
         output = test.run()
         assert_output(
             output,
             GitAutograderStatus.UNSUCCESSFUL,
-            [FEATURES_FILE_CONTENT_INVALID],
+            [FEATURES_FILE_CONTENT_INVALID.format(commit="Add features.md")],
         )
diff --git a/mix_messy_graph/verify.py b/mix_messy_graph/verify.py
@@ -1,7 +1,9 @@
+from typing import Optional, List
 from git_autograder import (
     GitAutograderOutput,
     GitAutograderExercise,
     GitAutograderStatus,
+    GitAutograderCommit
 )
 from itertools import zip_longest
 
@@ -24,7 +26,7 @@
 LIST_BRANCH_STILL_EXISTS = "Branch 'list' still exists."
 
 MISSING_FEATURES_FILE = "You are missing 'features.md'!"
-FEATURES_FILE_CONTENT_INVALID = "Contents of 'features.md' is not valid! Try again!"
+FEATURES_FILE_CONTENT_INVALID = "Contents of 'features.md' is not valid at commit with message '{commit}'! Try again!"
 
 EXPECTED_COMMIT_MESSAGES = [
     "Add features.md",
@@ -34,7 +36,7 @@
     "Add the delete feature",
 ]
 
-EXPECTED_LINES = [
+EXPECTED_LINES_DELETE_COMMIT = [
     "# Features",
     "## Creating Books",
     "Allows creating one book at a time.",
@@ -45,20 +47,74 @@
     "Allows deleting books.",
 ]
 
+EXPECTED_LINES_SEARCH_COMMIT = [
+    "# Features",
+    "## Creating Books",
+    "Allows creating one book at a time.",
+    "## Searching for Books",
+    "Allows searching for books by keywords.",
+    "Works only for book titles.",
+]
+
+EXPECTED_LINES_FIX_HEADING_COMMIT = [
+    "# Features",
+    "## Creating Books",
+    "Allows creating one book at a time.",
+]
+
+EXPECTED_LINES_CREATE_BOOK_COMMIT = [
+    "# Features",
+    "## Create Book",
+    "Allows creating one book at a time.",
+]
+
+EXPECTED_LINES_FEATURES_COMMIT = [
+    "# Features",
+]
+
 
 def ensure_str(val) -> str:
     if isinstance(val, bytes):
         return val.decode("utf-8", errors="replace").strip()
     return str(val).strip()
 
 
+def get_commit_from_message(
+    commits: List[GitAutograderCommit], message: str
+) -> Optional[GitAutograderCommit]:
+    """Find a commit with the given message from a list of commits."""
+    for commit in commits:
+        if message.strip() == commit.commit.message.strip():
+            return commit
+    return None
+
+
+def verify_commit_file_content(exercise: GitAutograderExercise, commit: GitAutograderCommit | None, file_name: str, expected_content: List[str]):
+    """Checkout to specific commit and verify that the file content of the given commit matches the expected content."""
+    if not commit:
+        return
+    commit.checkout()
+    with exercise.repo.files.file_or_none(file_name) as file:
+        if file is None:
+            raise exercise.wrong_answer([MISSING_FEATURES_FILE])
+
+        contents = [line.strip() for line in file.readlines() if line.strip() != ""]
+        if contents != expected_content:
+            raise exercise.wrong_answer([FEATURES_FILE_CONTENT_INVALID.format(commit=commit.commit.message.strip())])
+    exercise.repo.branches.branch("main").checkout()
+
+
 def verify(exercise: GitAutograderExercise) -> GitAutograderOutput:
     main_branch = exercise.repo.branches.branch("main")
+
+    # Verify that there are no merge commits
     merge_commits = [c for c in main_branch.commits if len(c.parents) > 1]
     if merge_commits:
         raise exercise.wrong_answer([SQUASH_NOT_USED])
 
-    commit_messages = [ensure_str(c.commit.message) for c in main_branch.commits][::-1]
+    # Verify that the commit messages are correct
+    commits = main_branch.commits
+    commit_messages = [ensure_str(c.commit.message) for c in commits][::-1]
     for expected, given in zip_longest(EXPECTED_COMMIT_MESSAGES, commit_messages):
         if expected != given:
             raise exercise.wrong_answer(
@@ -69,6 +125,7 @@ def verify(exercise: GitAutograderExercise) -> GitAutograderOutput:
                 ]
             )
 
+    # Verify that the branches are deleted
     feature_search_branch = exercise.repo.branches.branch_or_none("feature-search")
     feature_delete_branch = exercise.repo.branches.branch_or_none("feature-delete")
     list_branch = exercise.repo.branches.branch_or_none("list")
@@ -83,14 +140,24 @@ def verify(exercise: GitAutograderExercise) -> GitAutograderOutput:
     if branch_exists_messages:
         raise exercise.wrong_answer(branch_exists_messages)
 
-    with exercise.repo.files.file_or_none("features.md") as features_file:
-        if features_file is None:
-            raise exercise.wrong_answer([MISSING_FEATURES_FILE])
+    # Verify that the features.md file is correct
+    # Checkout to specific commit to verify the contents of features.md
+    features_commit = get_commit_from_message(commits, "Add features.md")
+    verify_commit_file_content(exercise, features_commit, "features.md", EXPECTED_LINES_FEATURES_COMMIT)
+
+    create_books_commit = get_commit_from_message(commits, "Mention feature for creating books")
+    verify_commit_file_content(exercise, create_books_commit, "features.md", EXPECTED_LINES_CREATE_BOOK_COMMIT)
+
+    fix_heading_commit = get_commit_from_message(commits, "Fix phrasing of heading")
+    verify_commit_file_content(exercise, fix_heading_commit, "features.md", EXPECTED_LINES_FIX_HEADING_COMMIT)
+
+    add_search_commit = get_commit_from_message(commits, "Add the search feature")
+    verify_commit_file_content(exercise, add_search_commit, "features.md", EXPECTED_LINES_SEARCH_COMMIT)
 
-        contents = [
-            line.strip() for line in features_file.readlines() if line.strip() != ""
-        ]
-        if contents != EXPECTED_LINES:
-            raise exercise.wrong_answer([FEATURES_FILE_CONTENT_INVALID])
+    delete_feature_commit = get_commit_from_message(commits, "Add the delete feature")
+    verify_commit_file_content(exercise, delete_feature_commit, "features.md", EXPECTED_LINES_DELETE_COMMIT)
 
-    return exercise.to_output([], GitAutograderStatus.SUCCESSFUL)
+    return exercise.to_output(
+        ["You have successfully completed the exercise!"], 
+        GitAutograderStatus.SUCCESSFUL
+    )
