[mix-messy-docs] Implement verification

Author: woojiahao

mix_messy_docs/verify.py

@@ -1,11 +1,94 @@
+from os import EX_TEMPFAIL
 from git_autograder import (
     GitAutograderOutput,
     GitAutograderExercise,
     GitAutograderStatus,
 )
 
+MISSING_DEVELOPMENT_BRANCH = "You are missing the 'development' branch!"
+WRONG_BRANCH_POINT = "You did not branch from the commit with tag v1.0!"
+FEATURE_SEARCH_BRANCH_STILL_EXISTS = (
+    "Branch 'feature-search' still exists! Remember to delete it after merging!"
+)
+FEATURE_DELETE_BRANCH_STILL_EXISTS = (
+    "Branch 'feature-delete' still exists! Remember to delete it after merging!"
+)
+LIST_BRANCH_STILL_EXISTS = (
+    "Branch 'list' still exists! Remember to rename it to 'feature-list'!"
+)
+FEATURE_LIST_BRANCH_MISSING = "Branch 'feature-list' is missing. Did you misspell it?"
+MERGE_FEATURE_SEARCH_FIRST = "You need to merge 'feature-search' first!"
+MERGE_FEATURE_DELETE_SECOND = "You need to merge 'feature-delete' second!"
+MISSING_FEATURES_FILE = "You are missing 'features.md'!"
+FEATURES_FILE_CONTENT_INVALID = "Contents of 'features.md' is not valid! Try again!"
+
+RESET_MESSAGE = 'Reset the repository using "gitmastery progress reset" and start again'
+
+
+EXPECTED_LINES = [
+    "# Features",
+    "## Create Book",
+    "Allows creating one book at a time.",
+    "## Searching for Books",
+    "Allows searching for books by keywords.",
+    "Works only for book titles.",
+    "## Deleting Books",
+    "Allows deleting books.",
+]
+
 
 def verify(exercise: GitAutograderExercise) -> GitAutograderOutput:
-    # INSERT YOUR GRADING CODE HERE
+    development_branch = exercise.repo.branches.branch_or_none("development")
+    if development_branch is None:
+        raise exercise.wrong_answer([MISSING_DEVELOPMENT_BRANCH])
+
+    tag_commit = exercise.repo.repo.tags["v1.0"].commit
+    development_commit = development_branch.latest_commit
+    branched_from_tag_hexsha = exercise.repo.repo.git.merge_base(
+        tag_commit.hexsha, development_commit.hexsha
+    )
+    # Alternative is to use reflog which states where the branch is created from
+    if branched_from_tag_hexsha != tag_commit.hexsha:
+        # Not branched from this but maybe somewhere earlier
+        raise exercise.wrong_answer([WRONG_BRANCH_POINT])
+
+    reflog = development_branch.reflog
+    merge_logs = [log for log in reflog if "merge" in log.action]
+    # reflog returns it in reverse order
+    has_feature_delete_commit_merge = (
+        len(merge_logs) >= 1
+        and merge_logs[0].action == "commit (merge)"
+        and "feature-delete" in merge_logs[0].message
+    )
+    has_feature_search_merge = (
+        len(merge_logs) >= 2 and merge_logs[1].action == "merge feature-search"
+    )
+    if not has_feature_search_merge:
+        raise exercise.wrong_answer([MERGE_FEATURE_SEARCH_FIRST, RESET_MESSAGE])
+
+    if not has_feature_delete_commit_merge:
+        raise exercise.wrong_answer([MERGE_FEATURE_DELETE_SECOND, RESET_MESSAGE])
+
+    feature_list_branch = exercise.repo.branches.branch_or_none("feature-list")
+    list_branch = exercise.repo.branches.branch_or_none("list")
+    if list_branch is not None and feature_list_branch is None:
+        raise exercise.wrong_answer([LIST_BRANCH_STILL_EXISTS])
+    elif list_branch is None and feature_list_branch is None:
+        raise exercise.wrong_answer([FEATURE_LIST_BRANCH_MISSING])
+
+    with exercise.repo.files.file_or_none("features.md") as features_file:
+        if features_file is None:
+            raise exercise.wrong_answer([MISSING_FEATURES_FILE])
+
+        contents = [
+            line.strip() for line in features_file.readlines() if line.strip() != ""
+        ]
+        if contents != EXPECTED_LINES:
+            raise exercise.wrong_answer([FEATURES_FILE_CONTENT_INVALID])
 
-    return exercise.to_output([], GitAutograderStatus.SUCCESSFUL)
+    return exercise.to_output(
+        [
+            "Great work using all of the concepts you've learnt about branching to mix the messy documentation!"
+        ],
+        GitAutograderStatus.SUCCESSFUL,
+    )