Implement exercise T4L5/sensors-reset (#164)

jovnc · web-flow · commit 086fffb5c305 · 2025-12-24T21:22:01.000+08:00
# Exercise Review ## Exercise Discussion Fixes #145 ## 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? - [ ] 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/sensors_reset/.gitmastery-exercise.json b/sensors_reset/.gitmastery-exercise.json
@@ -0,0 +1,16 @@
+{
+  "exercise_name": "sensors-reset",
+  "tags": [
+    "git-reset"
+  ],
+  "requires_git": true,
+  "requires_github": true,
+  "base_files": {},
+  "exercise_repo": {
+    "repo_type": "remote",
+    "repo_name": "sensors",
+    "repo_title": "gm-sensors",
+    "create_fork": false,
+    "init": null
+  }
+}
diff --git a/sensors_reset/README.md b/sensors_reset/README.md
@@ -0,0 +1 @@
+See https://git-mastery.github.io/lessons/reset/exercise-sensors-reset.html
diff --git a/sensors_reset/__init__.py b/sensors_reset/__init__.py
diff --git a/sensors_reset/download.py b/sensors_reset/download.py
@@ -0,0 +1 @@
+def setup(verbose: bool = False): ...
diff --git a/sensors_reset/tests/__init__.py b/sensors_reset/tests/__init__.py
diff --git a/sensors_reset/tests/specs/base.yml b/sensors_reset/tests/specs/base.yml
@@ -0,0 +1,16 @@
+initialization:
+  clone-from: https://github.com/git-mastery/gm-sensors
+  steps:
+    - type: commit
+      empty: true
+      message: Empty commit
+      id: start
+    - type: reset
+      revision: "5950516"
+      mode: hard
+    - type: reset
+      revision: "f900a07"
+      mode: mixed
+    - type: reset
+      revision: "c47b187"
+      mode: soft
diff --git a/sensors_reset/tests/specs/incomplete_task_three_reset.yml b/sensors_reset/tests/specs/incomplete_task_three_reset.yml
@@ -0,0 +1,13 @@
+initialization:
+  clone-from: https://github.com/git-mastery/gm-sensors
+  steps:
+    - type: commit
+      empty: true
+      message: Empty commit
+      id: start
+    - type: reset
+      revision: "5950516"
+      mode: hard
+    - type: reset
+      revision: "f900a07"
+      mode: mixed
diff --git a/sensors_reset/tests/specs/incomplete_task_two_reset.yml b/sensors_reset/tests/specs/incomplete_task_two_reset.yml
@@ -0,0 +1,10 @@
+initialization:
+  clone-from: https://github.com/git-mastery/gm-sensors
+  steps:
+    - type: commit
+      empty: true
+      message: Empty commit
+      id: start
+    - type: reset
+      revision: "5950516"
+      mode: hard
diff --git a/sensors_reset/tests/specs/incorrect_head_commit.yml b/sensors_reset/tests/specs/incorrect_head_commit.yml
@@ -0,0 +1,19 @@
+initialization:
+  clone-from: https://github.com/git-mastery/gm-sensors
+  steps:
+    - type: commit
+      empty: true
+      message: Empty commit
+      id: start
+    - type: reset
+      revision: "5950516"
+      mode: hard
+    - type: reset
+      revision: "f900a07"
+      mode: mixed
+    - type: reset
+      revision: "c47b187"
+      mode: soft
+    - type: reset
+      revision: "e45a4fc"
+      mode: soft
diff --git a/sensors_reset/tests/specs/no_changes.yml b/sensors_reset/tests/specs/no_changes.yml
@@ -0,0 +1,7 @@
+initialization:
+  clone-from: https://github.com/git-mastery/gm-sensors
+  steps:
+    - type: commit
+      empty: true
+      message: Empty commit
+      id: start
diff --git a/sensors_reset/tests/specs/wrong_task_three_reset.yml b/sensors_reset/tests/specs/wrong_task_three_reset.yml
@@ -0,0 +1,16 @@
+initialization:
+  clone-from: https://github.com/git-mastery/gm-sensors
+  steps:
+    - type: commit
+      empty: true
+      message: Empty commit
+      id: start
+    - type: reset
+      revision: "5950516"
+      mode: hard
+    - type: reset
+      revision: "f900a07"
+      mode: mixed
+    - type: reset
+      revision: "c47b187"
+      mode: hard
diff --git a/sensors_reset/tests/specs/wrong_task_two_reset.yml b/sensors_reset/tests/specs/wrong_task_two_reset.yml
@@ -0,0 +1,16 @@
+initialization:
+  clone-from: https://github.com/git-mastery/gm-sensors
+  steps:
+    - type: commit
+      empty: true
+      message: Empty commit
+      id: start
+    - type: reset
+      revision: "5950516"
+      mode: hard
+    - type: reset
+      revision: "f900a07"
+      mode: hard
+    - type: reset
+      revision: "c47b187"
+      mode: soft
diff --git a/sensors_reset/tests/test_verify.py b/sensors_reset/tests/test_verify.py
@@ -0,0 +1,70 @@
+from sensors_reset.verify import (
+    CONTAINS_TASK_ONE_COMMITS,
+    CONTAINS_TASK_TWO_COMMIT,
+    CONTAINS_TASK_THREE_COMMIT,
+    WRONG_FILES_IN_STAGING_AREA,
+    WRONG_FILES_IN_WORKING_DIRECTORY,
+    WRONG_HEAD_COMMIT,
+)
+from git_autograder.status import GitAutograderStatus
+from git_autograder.test_utils import assert_output
+from git_autograder import GitAutograderTestLoader
+
+from ..verify import verify
+
+REPOSITORY_NAME = "sensors-reset"
+
+loader = GitAutograderTestLoader(__file__, REPOSITORY_NAME, verify)
+
+
+def test_base():
+    with loader.load("specs/base.yml", "start") as output:
+        assert_output(output, GitAutograderStatus.SUCCESSFUL)
+
+
+def test_no_changes():
+    with loader.load("specs/no_changes.yml", "start") as output:
+        assert_output(
+            output, GitAutograderStatus.UNSUCCESSFUL, [CONTAINS_TASK_ONE_COMMITS]
+        )
+
+
+def test_incomplete_task_two_reset():
+    with loader.load("specs/incomplete_task_two_reset.yml", "start") as output:
+        assert_output(
+            output, GitAutograderStatus.UNSUCCESSFUL, [CONTAINS_TASK_TWO_COMMIT]
+        )
+
+
+def test_incomplete_task_three_reset():
+    with loader.load("specs/incomplete_task_three_reset.yml", "start") as output:
+        assert_output(
+            output, GitAutograderStatus.UNSUCCESSFUL, [CONTAINS_TASK_THREE_COMMIT]
+        )
+
+
+def test_wrong_task_two_reset():
+    with loader.load("specs/wrong_task_two_reset.yml", "start") as output:
+        assert_output(
+            output,
+            GitAutograderStatus.UNSUCCESSFUL,
+            [WRONG_FILES_IN_WORKING_DIRECTORY],
+        )
+
+
+def test_wrong_task_three_reset():
+    with loader.load("specs/wrong_task_three_reset.yml", "start") as output:
+        assert_output(
+            output,
+            GitAutograderStatus.UNSUCCESSFUL,
+            [WRONG_FILES_IN_WORKING_DIRECTORY, WRONG_FILES_IN_STAGING_AREA],
+        )
+
+
+def test_incorrect_head_commit():
+    with loader.load("specs/incorrect_head_commit.yml", "start") as output:
+        assert_output(
+            output,
+            GitAutograderStatus.UNSUCCESSFUL,
+            [WRONG_HEAD_COMMIT],
+        )
diff --git a/sensors_reset/verify.py b/sensors_reset/verify.py
@@ -0,0 +1,84 @@
+from typing import List
+from git_autograder import (
+    GitAutograderOutput,
+    GitAutograderExercise,
+    GitAutograderStatus,
+)
+
+CONTAINS_TASK_ONE_COMMITS = "It seems like the last two commits for Jan 14 and Jan 15 are still present in the commit history."
+CONTAINS_TASK_TWO_COMMIT = (
+    "It seems like the commit from Jan 13 is still present in the commit history."
+)
+CONTAINS_TASK_THREE_COMMIT = (
+    "It seems like the commit from Jan 12 is still present in the commit history."
+)
+WRONG_FILES_IN_STAGING_AREA = (
+    "Unexpected files in staging area. Looks like you used the wrong reset mode."
+)
+WRONG_FILES_IN_WORKING_DIRECTORY = (
+    "Unexpected files in working directory. Looks like you used the wrong reset mode."
+)
+WRONG_HEAD_COMMIT = "The head commit should be the commit from Jan 11."
+
+
+def get_staged_files(exercise: GitAutograderExercise) -> List[str | None]:
+    """Get files that are staged (differ between index and HEAD)."""
+    repo = exercise.repo.repo
+    return [diff_item.a_path for diff_item in repo.head.commit.diff()]
+
+
+def get_unstaged_files(exercise: GitAutograderExercise) -> List[str | None]:
+    """Get files that have unstaged changes (differ between working tree and index)."""
+    repo = exercise.repo.repo
+    return [d.a_path for d in repo.index.diff(None)]
+
+
+def verify(exercise: GitAutograderExercise) -> GitAutograderOutput:
+    branch = exercise.repo.branches.branch_or_none("main")
+    commit_messages = [str(c.commit.message.strip()) for c in branch.commits]
+
+    staged_files = get_staged_files(exercise)
+    unstaged_files = get_unstaged_files(exercise)
+
+    # Task 1: Commits should be removed, changes should not be in staging or working directory
+    if any(
+        msg in commit_messages
+        for msg in [
+            "Record data for Jan 14",
+            "Record data for Jan 15",
+        ]
+    ):
+        raise exercise.wrong_answer([CONTAINS_TASK_ONE_COMMITS])
+
+    # Task 2: Commit should be removed, changes should be in working directory but NOT staged
+    if "Record data for Jan 13" in commit_messages:
+        raise exercise.wrong_answer([CONTAINS_TASK_TWO_COMMIT])
+
+    # Task 3: Commit should be removed, changes should be in staging area
+    if "Record data for Jan 12" in commit_messages:
+        raise exercise.wrong_answer([CONTAINS_TASK_THREE_COMMIT])
+
+    if branch.latest_commit.commit.message.strip() != "Record data for Jan 11":
+        raise exercise.wrong_answer([WRONG_HEAD_COMMIT])
+
+    # 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 = []
+    if len(unstaged_files) != 4 or not all(
+        file in unstaged_files
+        for file in ["east.csv", "north.csv", "south.csv", "west.csv"]
+    ):
+        comments.append(WRONG_FILES_IN_WORKING_DIRECTORY)
+
+    if len(staged_files) != 3 or not all(
+        file in staged_files for file in ["east.csv", "north.csv", "south.csv"]
+    ):
+        comments.append(WRONG_FILES_IN_STAGING_AREA)
+
+    if comments:
+        raise exercise.wrong_answer(comments)
+
+    return exercise.to_output(
+        ["You have reset the repository to the correct state!"],
+        GitAutograderStatus.SUCCESSFUL,
+    )

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+See https://git-mastery.github.io/lessons/reset/exercise-sensors-reset.html`