Implement exercise T1L3/undo-init (#179)

desmondwong1215 · web-flow · commit 68f558bca906 · 2025-12-21T02:49:01.000+08:00
# Exercise Review ## Exercise Discussion #165 ## 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/undo_init/.gitmastery-exercise.json b/undo_init/.gitmastery-exercise.json
@@ -0,0 +1,16 @@
+{
+  "exercise_name": "undo-init",
+  "tags": [
+    "git-init"
+  ],
+  "requires_git": true,
+  "requires_github": false,
+  "base_files": {},
+  "exercise_repo": {
+    "repo_type": "local",
+    "repo_name": "my-notes",
+    "repo_title": null,
+    "create_fork": null,
+    "init": false
+  }
+}
diff --git a/undo_init/README.md b/undo_init/README.md
@@ -0,0 +1 @@
+See https://git-mastery.github.io/lessons/init/exercise-undo-init.html
diff --git a/undo_init/__init__.py b/undo_init/__init__.py
diff --git a/undo_init/download.py b/undo_init/download.py
@@ -0,0 +1,23 @@
+import os
+from exercise_utils.file import create_or_update_file
+from exercise_utils.git import init
+
+def setup(verbose: bool = False):
+    create_or_update_file(
+        "todo.txt",
+        """
+        My tasks
+        """
+    )
+
+    os.makedirs("private")
+    os.chdir("private")
+    create_or_update_file(
+        "contacts.txt",
+        """
+        My contacts
+        """
+    )
+
+    os.chdir("..")
+    init(verbose)
diff --git a/undo_init/tests/__init__.py b/undo_init/tests/__init__.py
diff --git a/undo_init/tests/specs/base.yml b/undo_init/tests/specs/base.yml
@@ -0,0 +1,17 @@
+initialization:
+  steps:
+    - type: commit
+      empty: true
+      message: Set initial state
+      id: start
+    - type: new-file
+      filename: todo.txt
+      contents: |
+        My tasks
+    - type: new-file
+      filename: private/contacts.txt
+      contents: |
+        My contacts
+    - type: bash
+      runs: rm -rf .git
+      
diff --git a/undo_init/tests/specs/contacts_file_missing.yml b/undo_init/tests/specs/contacts_file_missing.yml
@@ -0,0 +1,19 @@
+initialization:
+  steps:
+    - type: commit
+      empty: true
+      message: Set initial state
+      id: start
+    - type: new-file
+      filename: todo.txt
+      contents: |
+        My tasks
+    - type: new-file
+      filename: private/contacts.txt
+      contents: |
+        My contacts
+    - type: delete-file
+      filename: private/contacts.txt
+    - type: bash
+      runs: rm -rf .git
+      
diff --git a/undo_init/tests/specs/init_not_undone.yml b/undo_init/tests/specs/init_not_undone.yml
@@ -0,0 +1,15 @@
+initialization:
+  steps:
+    - type: commit
+      empty: true
+      message: Set initial state
+      id: start
+    - type: new-file
+      filename: todo.txt
+      contents: |
+        My tasks
+    - type: new-file
+      filename: private/contacts.txt
+      contents: |
+        My contacts
+        
diff --git a/undo_init/tests/specs/private_dir_missing.yml b/undo_init/tests/specs/private_dir_missing.yml
@@ -0,0 +1,13 @@
+initialization:
+  steps:
+    - type: commit
+      empty: true
+      message: Set initial state
+      id: start
+    - type: new-file
+      filename: todo.txt
+      contents: |
+        My tasks
+    - type: bash
+      runs: rm -rf .git
+      
diff --git a/undo_init/tests/specs/todo_file_missing.yml b/undo_init/tests/specs/todo_file_missing.yml
@@ -0,0 +1,13 @@
+initialization:
+  steps:
+    - type: commit
+      empty: true
+      message: Set initial state
+      id: start
+    - type: new-file
+      filename: private/contacts.txt
+      contents: |
+        My contacts
+    - type: bash
+      runs: rm -rf .git
+      
diff --git a/undo_init/tests/test_verify.py b/undo_init/tests/test_verify.py
@@ -0,0 +1,68 @@
+from unittest import mock
+from git_autograder import GitAutograderStatus, GitAutograderTestLoader, assert_output
+
+from ..verify import (
+    INIT_NOT_UNDONE, 
+    TODO_FILE_MISSING,
+    CONTACTS_FILE_MISSING,
+    PRIVATE_FOLDER_MISSING, 
+    verify
+)
+
+REPOSITORY_NAME = "undo-init"
+
+loader = GitAutograderTestLoader(__file__, REPOSITORY_NAME, verify)
+
+
+def test_base():
+    # We patch the ExerciseRepoConfig to return "ignore" instead of "local"
+    with mock.patch("git_autograder.exercise_config.ExerciseConfig.ExerciseRepoConfig") as mock_config:
+        # Configure the mock to return "ignore" when the loader accesses it
+        instance = mock_config.return_value
+        instance.repo_type = "ignore"
+        instance.repo_name = "repo" # Match the loader's hardcoded name
+        instance.init = False
+
+        with loader.load("specs/base.yml") as output:
+            assert_output(output, GitAutograderStatus.SUCCESSFUL)
+
+
+def test_init_not_undone():
+    with loader.load("specs/init_not_undone.yml") as output:
+        assert_output(output, GitAutograderStatus.UNSUCCESSFUL, [INIT_NOT_UNDONE])
+
+
+def test_todo_file_missing():
+    with mock.patch("git_autograder.exercise_config.ExerciseConfig.ExerciseRepoConfig") as mock_config:
+        instance = mock_config.return_value
+        instance.repo_type = "ignore"
+        instance.repo_name = "repo"
+        instance.init = False
+
+        with loader.load("specs/todo_file_missing.yml") as output:
+            assert_output(output, GitAutograderStatus.UNSUCCESSFUL, [TODO_FILE_MISSING])
+
+
+def test_private_dir_missing():
+    with mock.patch("git_autograder.exercise_config.ExerciseConfig.ExerciseRepoConfig") as mock_config:
+        instance = mock_config.return_value
+        instance.repo_type = "ignore"
+        instance.repo_name = "repo"
+        instance.init = False
+
+        with loader.load("specs/private_dir_missing.yml") as output:
+            assert_output(output, GitAutograderStatus.UNSUCCESSFUL, [
+                PRIVATE_FOLDER_MISSING,
+                CONTACTS_FILE_MISSING
+                ])
+
+
+def test_contacts_file_missing():
+    with mock.patch("git_autograder.exercise_config.ExerciseConfig.ExerciseRepoConfig") as mock_config:
+        instance = mock_config.return_value
+        instance.repo_type = "ignore"
+        instance.repo_name = "repo"
+        instance.init = False
+
+        with loader.load("specs/contacts_file_missing.yml") as output:
+            assert_output(output, GitAutograderStatus.UNSUCCESSFUL, [CONTACTS_FILE_MISSING])
diff --git a/undo_init/verify.py b/undo_init/verify.py
@@ -0,0 +1,39 @@
+import os
+from git_autograder import (
+    GitAutograderOutput,
+    GitAutograderExercise,
+    GitAutograderStatus,
+)
+
+INIT_NOT_UNDONE = "The init operation is not undone."
+TODO_FILE_MISSING = "The todo.txt should not be deleted."
+CONTACTS_FILE_MISSING = "The contacts.txt should not be deleted."
+PRIVATE_FOLDER_MISSING = "The private folder should not be deleted."
+SUCCESS_MESSAGE = "You have successfully undone the init operation!"
+
+def verify(exercise: GitAutograderExercise) -> GitAutograderOutput:
+    repo_root = exercise.exercise_path
+    repo_folder = exercise.config.exercise_repo.repo_name
+    work_dir = os.path.join(repo_root, repo_folder)
+    comments = []
+
+    dot_git_dir_path = os.path.join(work_dir, ".git")
+    if os.path.exists(dot_git_dir_path):
+        comments.append(INIT_NOT_UNDONE)
+    
+    todo_file_path = os.path.join(work_dir, "todo.txt")
+    if not os.path.exists(todo_file_path):
+        comments.append(TODO_FILE_MISSING)
+    
+    private_dir_path = os.path.join(work_dir, "private")
+    if not os.path.exists(private_dir_path):
+        comments.append(PRIVATE_FOLDER_MISSING)
+
+    contacts_file_path = os.path.join(private_dir_path, "contacts.txt")
+    if not os.path.exists(contacts_file_path):
+        comments.append(CONTACTS_FILE_MISSING)
+    
+    if comments:
+        raise exercise.wrong_answer(comments)
+
+    return exercise.to_output([SUCCESS_MESSAGE], GitAutograderStatus.SUCCESSFUL)

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