[sensors-revert] Implement exercise T4L6/sensors-revert (#185)

VikramGoyal23 · web-flow · commit 85c4f2330df4 · 2025-12-24T21:19:20.000+08:00
# Exercise Review ## Exercise Discussion Fixes #146 ## 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/sensors_revert/.gitmastery-exercise.json b/sensors_revert/.gitmastery-exercise.json
@@ -0,0 +1,16 @@
+{
+  "exercise_name": "sensors-revert",
+  "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_revert/README.md b/sensors_revert/README.md
@@ -0,0 +1 @@
+See https://git-mastery.github.io/lessons/revert/exercise-sensors-revert.html
diff --git a/sensors_revert/__init__.py b/sensors_revert/__init__.py
diff --git a/sensors_revert/download.py b/sensors_revert/download.py
@@ -0,0 +1 @@
+def setup(verbose: bool = False): ...
diff --git a/sensors_revert/tests/__init__.py b/sensors_revert/tests/__init__.py
diff --git a/sensors_revert/tests/specs/base.yml b/sensors_revert/tests/specs/base.yml
@@ -0,0 +1,11 @@
+initialization:
+  clone-from: https://github.com/git-mastery/gm-sensors
+  steps:
+    - type: commit
+      empty: true
+      message: Empty commit
+      id: start
+    - type: revert
+      revision: dbac57019977296abff9e4f687f587c4a2d24f02
+    - type: revert
+      revision: 59505167b47f35c12d21bc61d731226b394a5341
diff --git a/sensors_revert/tests/specs/incorrect_readings.yml b/sensors_revert/tests/specs/incorrect_readings.yml
@@ -0,0 +1,14 @@
+initialization:
+  clone-from: https://github.com/git-mastery/gm-sensors
+  steps:
+    - type: commit
+      empty: true
+      message: Empty commit
+      id: start
+    - type: revert
+      revision: dbac57019977296abff9e4f687f587c4a2d24f02
+    - type: revert
+      revision: 59505167b47f35c12d21bc61d731226b394a5341
+    - type: edit-file
+      filename: east.csv
+      contents: 4821\n9304\n1578\n6042\n7189\n2463\n8931\n5710\n 
diff --git a/sensors_revert/tests/specs/missing_files.yml b/sensors_revert/tests/specs/missing_files.yml
@@ -0,0 +1,15 @@
+initialization:
+  clone-from: https://github.com/git-mastery/gm-sensors
+  steps:
+    - type: commit
+      empty: true
+      message: Empty commit
+      id: start
+    - type: delete-file
+      filename: east.csv
+    - type: delete-file
+      filename: north.csv
+    - type: delete-file
+      filename: south.csv
+    - type: delete-file
+      filename: west.csv
diff --git a/sensors_revert/tests/specs/no_revert.yml b/sensors_revert/tests/specs/no_revert.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_revert/tests/specs/no_revert_commit.yml b/sensors_revert/tests/specs/no_revert_commit.yml
@@ -0,0 +1,103 @@
+initialization:
+  clone-from: https://github.com/git-mastery/gm-sensors
+  steps:
+    - type: commit
+      empty: true
+      message: Empty commit
+      id: start
+    - type: edit-file
+      filename: east.csv
+      contents: |
+        4821
+        9304
+        1578
+        6042
+        7189
+        2463
+        8931
+        5710
+        4428
+        3097
+        8652
+        1904
+        7485
+        6379
+        5140
+        9836
+        2057
+        4719
+        3568
+        8243
+
+    - type: edit-file
+      filename: north.csv
+      contents: |
+        6841
+        2307
+        9754
+        4169
+        5823
+        3086
+        7592
+        8420
+        1679
+        5034
+        2918
+        7645
+        8501
+        4576
+        9208
+        3461
+        5789
+        6940
+        1235
+        8890
+
+    - type: edit-file
+      filename: south.csv
+      contents: |
+        7412
+        5068
+        8921
+        3754
+        2809
+        6197
+        4530
+        9674
+        1185
+        7326
+        5401
+        8937
+        2640
+        7083
+        5914
+        3208
+        8745
+        4069
+        1592
+        6831
+
+    - type: edit-file
+      filename: west.csv
+      contents: |
+        5193
+        8042
+        6721
+        4389
+        2075
+        9510
+        3648
+        7281
+        5904
+        1837
+        4416
+        9032
+        7765
+        6208
+        3589
+        8471
+        2940
+        1683
+        7352
+        5129
+        
diff --git a/sensors_revert/tests/specs/only_jan_13_reverted.yml b/sensors_revert/tests/specs/only_jan_13_reverted.yml
@@ -0,0 +1,9 @@
+initialization:
+  clone-from: https://github.com/git-mastery/gm-sensors
+  steps:
+    - type: commit
+      empty: true
+      message: Empty commit
+      id: start
+    - type: revert
+      revision: 59505167b47f35c12d21bc61d731226b394a5341
diff --git a/sensors_revert/tests/specs/only_jan_14_reverted.yml b/sensors_revert/tests/specs/only_jan_14_reverted.yml
@@ -0,0 +1,9 @@
+initialization:
+  clone-from: https://github.com/git-mastery/gm-sensors
+  steps:
+    - type: commit
+      empty: true
+      message: Empty commit
+      id: start
+    - type: revert
+      revision: dbac57019977296abff9e4f687f587c4a2d24f02
diff --git a/sensors_revert/tests/specs/wrong_order_revert.yml b/sensors_revert/tests/specs/wrong_order_revert.yml
@@ -0,0 +1,11 @@
+initialization:
+  clone-from: https://github.com/git-mastery/gm-sensors
+  steps:
+    - type: commit
+      empty: true
+      message: Empty commit
+      id: start
+    - type: revert
+      revision: 59505167b47f35c12d21bc61d731226b394a5341
+    - type: revert
+      revision: dbac57019977296abff9e4f687f587c4a2d24f02
diff --git a/sensors_revert/tests/test_verify.py b/sensors_revert/tests/test_verify.py
@@ -0,0 +1,84 @@
+from git_autograder import GitAutograderStatus, GitAutograderTestLoader, assert_output
+
+from ..verify import (
+    MISSING_FILE,
+    COMMITS_UNREVERTED,
+    COMMITS_REVERTED_WRONG_ORDER,
+    INCORRECT_READINGS,
+    verify,
+)
+
+REPOSITORY_NAME = "sensors-revert"
+
+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_revert():
+    with loader.load("specs/no_revert.yml", "start") as output:
+        assert_output(
+            output,
+            GitAutograderStatus.UNSUCCESSFUL,
+            [COMMITS_UNREVERTED],
+        )
+
+
+def test_wrong_order_revert():
+    with loader.load("specs/wrong_order_revert.yml", "start") as output:
+        assert_output(
+            output,
+            GitAutograderStatus.UNSUCCESSFUL,
+            [COMMITS_REVERTED_WRONG_ORDER],
+        )
+
+
+def test_missing_files():
+    with loader.load("specs/missing_files.yml", "start") as output:
+        assert_output(
+            output,
+            GitAutograderStatus.UNSUCCESSFUL,
+            [MISSING_FILE.format(filename="east.csv"),
+             MISSING_FILE.format(filename="north.csv"),
+             MISSING_FILE.format(filename="south.csv"),
+             MISSING_FILE.format(filename="west.csv"),],
+        )
+
+
+def test_incorrect_readings():
+    with loader.load("specs/incorrect_readings.yml", "start") as output:
+        assert_output(
+            output,
+            GitAutograderStatus.UNSUCCESSFUL,
+            [INCORRECT_READINGS],
+        )
+
+
+def test_no_revert_commit():
+    with loader.load("specs/no_revert_commit.yml", "start") as output:
+        assert_output(
+            output,
+            GitAutograderStatus.UNSUCCESSFUL,
+            [COMMITS_UNREVERTED],
+        )
+
+
+def test_only_jan_14_reverted():
+    with loader.load("specs/only_jan_14_reverted.yml", "start") as output:
+        assert_output(
+            output,
+            GitAutograderStatus.UNSUCCESSFUL,
+            [COMMITS_UNREVERTED],
+        )
+
+
+def test_only_jan_13_reverted():
+    with loader.load("specs/only_jan_13_reverted.yml", "start") as output:
+        assert_output(
+            output,
+            GitAutograderStatus.UNSUCCESSFUL,
+            [COMMITS_REVERTED_WRONG_ORDER],
+        )
diff --git a/sensors_revert/verify.py b/sensors_revert/verify.py
@@ -0,0 +1,80 @@
+from git_autograder import (
+    GitAutograderOutput,
+    GitAutograderExercise,
+    GitAutograderStatus,
+)
+
+MISSING_FILE = "You are missing the {filename} file."
+COMMITS_UNREVERTED = "You have not reverted all the commits yet!"
+COMMITS_REVERTED_WRONG_ORDER = "You have reverted the commits in the wrong order!"
+INCORRECT_READINGS = "The files contain the wrong readings!"
+
+EXPECTED_EAST = (
+    "4821\n9304\n1578\n6042\n7189\n2463\n8931\n5710\n4428\n3097\n8652\n1904\n7485\n6379\n5140\n9836\n2057\n4719\n3568\n8243\n"
+)
+EXPECTED_NORTH = (
+    "6841\n2307\n9754\n4169\n5823\n3086\n7592\n8420\n1679\n5034\n2918\n7645\n8501\n4576\n9208\n3461\n5789\n6940\n1235\n8890\n"
+)
+EXPECTED_SOUTH = (
+    "7412\n5068\n8921\n3754\n2809\n6197\n4530\n9674\n1185\n7326\n5401\n8937\n2640\n7083\n5914\n3208\n8745\n4069\n1592\n6831\n"
+)
+EXPECTED_WEST = (
+    "5193\n8042\n6721\n4389\n2075\n9510\n3648\n7281\n5904\n1837\n4416\n9032\n7765\n6208\n3589\n8471\n2940\n1683\n7352\n5129\n"
+)
+
+
+def verify(exercise: GitAutograderExercise) -> GitAutograderOutput:
+    comments = []
+
+    with exercise.repo.files.file_or_none("east.csv") as east_file:
+        if east_file is None:
+            comments.append(MISSING_FILE.format(filename="east.csv"))
+        else:
+            east_contents = east_file.read()
+
+    with exercise.repo.files.file_or_none("north.csv") as north_file:
+        if north_file is None:
+            comments.append(MISSING_FILE.format(filename="north.csv"))
+        else:
+            north_contents = north_file.read()
+
+    with exercise.repo.files.file_or_none("south.csv") as south_file:
+        if south_file is None:
+            comments.append(MISSING_FILE.format(filename="south.csv"))
+        else:
+            south_contents = south_file.read()
+
+    with exercise.repo.files.file_or_none("west.csv") as west_file:
+        if west_file is None:
+            comments.append(MISSING_FILE.format(filename="west.csv"))
+        else:
+            west_contents = west_file.read()
+
+    if comments:
+        raise exercise.wrong_answer(comments)
+
+    branch = exercise.repo.branches.branch("main")
+    commit_messages = [str(c.commit.message.strip()) for c in branch.commits]
+    commit_messages.reverse()
+
+    reverted_14th = False
+    reverted_13th = False
+    for m in commit_messages:
+        if not reverted_14th and 'Revert "Record data for Jan 14"' in m:
+            reverted_14th = True
+        if not reverted_13th and 'Revert "Record data for Jan 13"' in m:
+            if not reverted_14th:
+                raise exercise.wrong_answer([COMMITS_REVERTED_WRONG_ORDER])
+            reverted_13th = True
+            break
+
+    if not (reverted_14th and reverted_13th):
+        raise exercise.wrong_answer([COMMITS_UNREVERTED])
+
+    if not (east_contents == EXPECTED_EAST
+        and north_contents == EXPECTED_NORTH
+        and south_contents == EXPECTED_SOUTH
+        and west_contents == EXPECTED_WEST):
+        raise exercise.wrong_answer([INCORRECT_READINGS])
+
+    return exercise.to_output(["Good work reverting commits!"], GitAutograderStatus.SUCCESSFUL)

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