Clean up code

Author: jiaxinnns

branch_previous/README.md

@@ -1,34 +1,20 @@
 # branch-previous
 
-You are writing the outline for a story, in `story.txt`. You have written the first few steps of the storyline. You are not very happy with the way the story is progressing, and wish to explore a few alternative storylines starting from a previous step.
+You are writing the outline for a story, in `story.txt`.
+
+You have written the first few steps of the storyline.
+
+You are not very happy with the way the story is progressing, and wish to explore a few alternative storylines starting from a previous step.
 
 ## Task
 
-1. Start a new branch named `visitor-line`, starting from the second commit (i.e., commit with message "Describe location").
-2. Add the line `I heard someone knocking at the door.` to the `story.txt`.
+1. Start a new branch named `visitor-line`, starting from the second commit (i.e., commit `Add second line`).
+2. Add the line `I heard someone knocking at the door`. to the `story.txt`.
 3. Commit the change. You may use any suitable commit message.
 4. Start a new branch named `sleep-line`, starting from the same starting point as before.
-5. Add the line `I fell asleep on the couch.` to the `story.txt`.
+5. Add the line `I fell asleep on the couch`. to the `story.txt`.
 6. Commit the change. You may use any suitable commit message.
 
-## Hints
-
-<details>
-<summary>How do I create a branch from a specific commit?</summary>
-
-You can create a branch from a specific commit using:
-```bash
-git branch <branch-name> <commit-hash>
-```
-
-Or you can checkout directly to a new branch from a specific commit:
-```bash
-git checkout -b <branch-name> <commit-hash>
-```
-</details>
-
-<details>
-<summary>How do I find the commit hash?</summary>
+## Expected Revision Graph
 
-Use `git log` to view the commit history and find the hash of the commit with message "Describe location".
-</details>
+![Expected Revision Graph](horror-story/expected-tree.png)

branch_previous/download.py

@@ -1,32 +1,33 @@
 from exercise_utils.file import create_or_update_file, append_to_file
 from exercise_utils.git import add, commit
-from exercise_utils.gitmastery import create_start_tag
 
-__resources__ = {"README.md": "README.md"}
+__resources__ = {"expected-tree.png": "expected-tree.png"}
 
 
 def setup(verbose: bool = False):
-    # First commit: Describe night
     create_or_update_file(
-        "story.txt", 
-        "It was a dark and stormy night.\n"
+        "story.txt",
+        """
+        It was a dark and stormy night.
+        """
     )
     add(["story.txt"], verbose)
     commit("Describe night", verbose)
 
-    # Second commit: Describe location
     append_to_file(
         "story.txt", 
-        "It was a dark and stormy night.\nI was alone in my room.\n"
+        """
+        I was alone in my room.
+        """
     )
     add(["story.txt"], verbose)
     commit("Describe location", verbose)
 
-    # Third commit: Mention noise
-    create_or_update_file(
+    append_to_file(
         "story.txt",
-        "It was a dark and stormy night.\nI was alone in my room.\nI heard a strange noise.\n",
+        """
+        I heard a strange noise.
+        """
     )
     add(["story.txt"], verbose)
     commit("Mention noise", verbose)
-

branch_previous/res/expected-tree.png

@@ -16,7 +16,7 @@ initialization:
     - type: commit
       message: Describe location
       empty: false
-      id: second_commit
+      id: describe_location_commit
     - type: bash
       runs: echo "I heard a strange noise." >> story.txt
     - type: add
@@ -27,23 +27,23 @@ initialization:
       empty: false
     - type: bash
       runs: |
-        SECOND_COMMIT=$(git log --all --grep="Describe location" --format=%H -n 1)
-        git checkout -b visitor-line $SECOND_COMMIT
+        DESCRIBE_LOCATION_COMMIT=$(git log --all --grep="Describe location" --format=%H -n 1)
+        git checkout -b visitor-line $DESCRIBE_LOCATION_COMMIT
         echo "I heard someone knocking at the door." >> story.txt
     - type: add
       files:
         - story.txt
     - type: commit
-      message: Add visitor line
+      message: Mention knocking
       empty: false
     - type: bash
       runs: |
-        SECOND_COMMIT=$(git log --all --grep="Describe location" --format=%H -n 1)
-        git checkout -b sleep-line $SECOND_COMMIT
+        DESCRIBE_LOCATION_COMMIT=$(git log --all --grep="Describe location" --format=%H -n 1)
+        git checkout -b sleep-line $DESCRIBE_LOCATION_COMMIT
         echo "I fell asleep on the couch." >> story.txt
     - type: add
       files:
         - story.txt
     - type: commit
-      message: Add sleep line
+      message: Mention sleeping
       empty: false

branch_previous/tests/specs/base.yml

@@ -17,7 +17,7 @@ initialization:
     - type: commit
       message: Describe location
       empty: false
-      id: second_commit
+      id: describe_location_commit
     - type: bash
       runs: echo "I heard a strange noise." >> story.txt
     - type: add
@@ -29,12 +29,12 @@ initialization:
     # Only create visitor-line branch, not sleep-line
     - type: bash
       runs: |
-        SECOND_COMMIT=$(git log --all --grep="Describe location" --format=%H -n 1)
-        git checkout -b visitor-line $SECOND_COMMIT
+        DESCRIBE_LOCATION_COMMIT=$(git log --all --grep="Describe location" --format=%H -n 1)
+        git checkout -b visitor-line $DESCRIBE_LOCATION_COMMIT
         echo "I heard someone knocking at the door." >> story.txt
     - type: add
       files:
         - story.txt
     - type: commit
-      message: Add visitor line
+      message: Mention knocking
       empty: false

branch_previous/tests/specs/sleep_branch_missing.yml renamed to branch_previous/tests/specs/sleep_missing_branch.yml

@@ -0,0 +1,50 @@
+initialization:
+  steps:
+    - type: bash
+      runs: echo "It was a dark and stormy night." > story.txt
+    - type: add
+      files:
+        - story.txt
+    - type: commit
+      message: Describe night
+      empty: false
+      id: start
+    - type: bash
+      runs: echo "I was alone in my room." >> story.txt
+    - type: add
+      files:
+        - story.txt
+    - type: commit
+      message: Describe location
+      empty: false
+      id: describe_location_commit
+    - type: bash
+      runs: echo "I heard a strange noise." >> story.txt
+    - type: add
+      files:
+        - story.txt
+    - type: commit
+      message: Mention noise
+      empty: false
+    - type: bash
+      runs: |
+        DESCRIBE_LOCATION_COMMIT=$(git log --all --grep="Describe location" --format=%H -n 1)
+        git checkout -b visitor-line $DESCRIBE_LOCATION_COMMIT
+        echo "I heard someone knocking at the door." >> story.txt
+    - type: add
+      files:
+        - story.txt
+    - type: commit
+      message: Mention knocking
+      empty: false
+    - type: bash
+      runs: |
+        DESCRIBE_LOCATION_COMMIT=$(git log --all --grep="Describe location" --format=%H -n 1)
+        git checkout -b sleep-line $DESCRIBE_LOCATION_COMMIT
+        echo "Wrong content here." >> story.txt
+    - type: add
+      files:
+        - story.txt
+    - type: commit
+      message: Mention sleeping
+      empty: false

branch_previous/tests/specs/sleep_wrong_content.yml

@@ -0,0 +1,32 @@
+initialization:
+  steps:
+    - type: bash
+      runs: echo "It was a dark and stormy night." > story.txt
+    - type: add
+      files:
+        - story.txt
+    - type: commit
+      message: Describe night
+      id: start
+    - type: bash
+      runs: |
+        echo "I was alone in my room." >> story.txt
+    - type: commit
+      message: Describe location
+      empty: false
+      id: second_commit
+    - type: bash
+      runs: |
+        echo "I heard a strange noise." >> story.txt
+    - type: commit
+      message: Mention noise
+      empty: false
+    # Only create sleep-line branch, not visitor-line
+    - type: bash
+      runs: |
+        DESCRIBE_LOCATION_COMMIT=$(git log --all --grep="Describe location" --format=%H -n 1)
+        git checkout -b sleep-line $DESCRIBE_LOCATION_COMMIT
+        echo "I fell asleep on the couch." >> story.txt
+    - type: commit
+      message: Mention sleeping
+      empty: false

branch_previous/tests/specs/visitor_branch_missing.yml

@@ -17,7 +17,7 @@ initialization:
     - type: commit
       message: Describe location
       empty: false
-      id: second_commit
+      id: describe_location_commit
     - type: bash
       runs: echo "I heard a strange noise." >> story.txt
     - type: add
@@ -29,17 +29,17 @@ initialization:
     # visitor-line branch created but no commit made
     - type: bash
       runs: |
-        SECOND_COMMIT=$(git log --all --grep="Describe location" --format=%H -n 1)
-        git branch visitor-line $SECOND_COMMIT
+        DESCRIBE_LOCATION_COMMIT=$(git log --all --grep="Describe location" --format=%H -n 1)
+        git checkout -b visitor-line $DESCRIBE_LOCATION_COMMIT
     # sleep-line branch created with commit
     - type: bash
       runs: |
-        SECOND_COMMIT=$(git log --all --grep="Describe location" --format=%H -n 1)
-        git checkout -b sleep-line $SECOND_COMMIT
+        DESCRIBE_LOCATION_COMMIT=$(git log --all --grep="Describe location" --format=%H -n 1)
+        git checkout -b sleep-line $DESCRIBE_LOCATION_COMMIT
         echo "I fell asleep on the couch." >> story.txt
     - type: add
       files:
         - story.txt
     - type: commit
-      message: Add sleep line
+      message: Mention sleeping
       empty: false

branch_previous/tests/specs/visitor_missing_branch.yml

@@ -17,7 +17,7 @@ initialization:
     - type: commit
       message: Describe location
       empty: false
-      id: second_commit
+      id: describe_location_commit
     - type: bash
       runs: echo "I heard a strange noise." >> story.txt
     - type: add
@@ -28,23 +28,23 @@ initialization:
       empty: false
     - type: bash
       runs: |
-        SECOND_COMMIT=$(git log --all --grep="Describe location" --format=%H -n 1)
-        git checkout -b visitor-line $SECOND_COMMIT
+        DESCRIBE_LOCATION_COMMIT=$(git log --all --grep="Describe location" --format=%H -n 1)
+        git checkout -b visitor-line $DESCRIBE_LOCATION_COMMIT
         echo "Wrong content here." >> story.txt
     - type: add
       files:
         - story.txt
     - type: commit
-      message: Add visitor line
+      message: Mention knocking
       empty: false
     - type: bash
       runs: |
-        SECOND_COMMIT=$(git log --all --grep="Describe location" --format=%H -n 1)
-        git checkout -b sleep-line $SECOND_COMMIT
+        DESCRIBE_LOCATION_COMMIT=$(git log --all --grep="Describe location" --format=%H -n 1)
+        git checkout -b sleep-line $DESCRIBE_LOCATION_COMMIT
         echo "I fell asleep on my couch." >> story.txt
     - type: add
       files:
         - story.txt
     - type: commit
-      message: Add sleep line
+      message: Mention sleeping
       empty: false