Merge pull request #26 from git-mastery/fork-repo

Create fork-repo exercise

Author: woojiahao

fork_repo/.gitmastery-exercise.json

@@ -0,0 +1,16 @@
+{
+  "exercise_name": "fork-repo",
+  "tags": [
+    "github-fork"
+  ],
+  "requires_git": true,
+  "requires_github": true,
+  "base_files": {},
+  "exercise_repo": {
+    "repo_type": "local",
+    "repo_name": "ignore-me",
+    "repo_title": null,
+    "create_fork": null,
+    "init": true
+  }
+}

fork_repo/README.md

@@ -0,0 +1,10 @@
+# fork-repo
+
+<!--- Insert exercise description -->
+
+## Task
+
+Create a fork of the repo <https://github.com/git-mastery/gm-shapes> to your
+GitHub account.
+
+Retain the original repo name `gm-shapes`.

fork_repo/__init__.py

@@ -0,0 +1 @@
+def setup(verbose: bool = False): ...

fork_repo/download.py

@@ -0,0 +1,6 @@
+initialization:
+  steps:
+    - type: commit
+      empty: true
+      message: Empty commit
+      id: start

fork_repo/tests/__init__.py

@@ -0,0 +1,104 @@
+import json
+from pathlib import Path
+from typing import Optional
+from unittest.mock import patch
+
+import pytest
+from git.repo import Repo
+from git_autograder import (
+    GitAutograderExercise,
+    GitAutograderTestLoader,
+    GitAutograderWrongAnswerException,
+    assert_output,
+)
+from git_autograder.status import GitAutograderStatus
+
+from ..verify import IMPROPER_GH_CLI_SETUP, NO_FORK_FOUND, NOT_GIT_MASTERY_FORK, verify
+
+REPOSITORY_NAME = "fork-repo"
+
+loader = GitAutograderTestLoader(__file__, REPOSITORY_NAME, verify)
+
+# NOTE: This exercise is a special case where we do not require repo-smith. Instead,
+# we directly mock function calls to verify that all branches are covered for us.
+
+
+# TODO: The current tooling isn't mature enough to handle mock GitAutograderExercise in
+# cases like these. We would ideally need some abstraction rather than creating our own.
+
+
+@pytest.fixture
+def exercise(tmp_path: Path) -> GitAutograderExercise:
+    repo_dir = tmp_path / "ignore-me"
+    repo_dir.mkdir()
+
+    Repo.init(repo_dir)
+    with open(tmp_path / ".gitmastery-exercise.json", "a") as config_file:
+        config_file.write(
+            json.dumps(
+                {
+                    "exercise_name": "remote-control",
+                    "tags": [],
+                    "requires_git": True,
+                    "requires_github": True,
+                    "base_files": {},
+                    "exercise_repo": {
+                        "repo_type": "local",
+                        "repo_name": "ignore-me",
+                        "init": True,
+                        "create_fork": None,
+                        "repo_title": None,
+                    },
+                    "downloaded_at": None,
+                }
+            )
+        )
+
+    exercise = GitAutograderExercise(exercise_path=tmp_path)
+    return exercise
+
+
+def test_pass(exercise: GitAutograderExercise):
+    with (
+        patch("fork_repo.verify.get_username", return_value="dummy"),
+        patch("fork_repo.verify.has_fork", return_value=True),
+        patch("fork_repo.verify.is_parent_git_mastery", return_value=True),
+    ):
+        output = verify(exercise)
+        assert_output(output, GitAutograderStatus.SUCCESSFUL)
+
+
+def test_improper_gh_setup(exercise: GitAutograderExercise):
+    with (
+        patch("fork_repo.verify.get_username", return_value=None),
+        patch("fork_repo.verify.has_fork", return_value=True),
+        patch("fork_repo.verify.is_parent_git_mastery", return_value=True),
+        pytest.raises(GitAutograderWrongAnswerException) as exception,
+    ):
+        verify(exercise)
+
+    assert exception.value.message == [IMPROPER_GH_CLI_SETUP]
+
+
+def test_no_fork(exercise: GitAutograderExercise):
+    with (
+        patch("fork_repo.verify.get_username", return_value="dummy"),
+        patch("fork_repo.verify.has_fork", return_value=False),
+        patch("fork_repo.verify.is_parent_git_mastery", return_value=True),
+        pytest.raises(GitAutograderWrongAnswerException) as exception,
+    ):
+        verify(exercise)
+
+    assert exception.value.message == [NO_FORK_FOUND]
+
+
+def test_not_right_parent(exercise: GitAutograderExercise):
+    with (
+        patch("fork_repo.verify.get_username", return_value="dummy"),
+        patch("fork_repo.verify.has_fork", return_value=True),
+        patch("fork_repo.verify.is_parent_git_mastery", return_value=False),
+        pytest.raises(GitAutograderWrongAnswerException) as exception,
+    ):
+        verify(exercise)
+
+    assert exception.value.message == [NOT_GIT_MASTERY_FORK]

fork_repo/tests/specs/base.yml

@@ -0,0 +1,83 @@
+import os
+import subprocess
+from typing import List, Optional
+
+from git_autograder import (
+    GitAutograderExercise,
+    GitAutograderOutput,
+    GitAutograderStatus,
+)
+
+# NOTE: that we create functions for each command to allow unit testing to mock the
+# return values directly.
+
+ORIGINAL_FORK_NAME = "gm-shapes"
+IMPROPER_GH_CLI_SETUP = "Your Github CLI is not setup correctly"
+NO_FORK_FOUND = f"No fork of git-mastery/{ORIGINAL_FORK_NAME} found. Remember to fork it from https://github.com/git-mastery/gm-shapes and keep the name as gm-shapes"
+NOT_GIT_MASTERY_FORK = f"Your fork was not from git-mastery/{ORIGINAL_FORK_NAME}. Remember to fork it from https://github.com/git-mastery/gm-shapes and keep the name as gm-shapes"
+
+
+def run_command(command: List[str]) -> Optional[str]:
+    try:
+        result = subprocess.run(
+            command,
+            capture_output=True,
+            text=True,
+            check=True,
+            env=dict(os.environ, **{"GH_PAGER": "cat"}),
+        )
+        return result.stdout.strip()
+    except subprocess.CalledProcessError:
+        return None
+
+
+def get_username() -> Optional[str]:
+    return run_command(["gh", "api", "user", "-q", ".login"])
+
+
+def has_fork(username: str) -> bool:
+    result = run_command(
+        [
+            "gh",
+            "repo",
+            "view",
+            f"{username}/{ORIGINAL_FORK_NAME}",
+            "--json",
+            "isFork",
+            "--jq",
+            ".isFork",
+        ]
+    )
+    return result is not None and result == "true"
+
+
+def is_parent_git_mastery(username: str) -> bool:
+    result = run_command(
+        [
+            "gh",
+            "repo",
+            "view",
+            f"{username}/{ORIGINAL_FORK_NAME}",
+            "--json",
+            "parent",
+            "--jq",
+            ".parent.owner.login",
+        ]
+    )
+    return result is not None and result == "git-mastery"
+
+
+def verify(exercise: GitAutograderExercise) -> GitAutograderOutput:
+    username = get_username()
+    if username is None:
+        raise exercise.wrong_answer([IMPROPER_GH_CLI_SETUP])
+
+    if not has_fork(username):
+        raise exercise.wrong_answer([NO_FORK_FOUND])
+
+    if not is_parent_git_mastery(username):
+        raise exercise.wrong_answer([NOT_GIT_MASTERY_FORK])
+
+    return exercise.to_output(
+        ["Great work creating a fork with Github!"], GitAutograderStatus.SUCCESSFUL
+    )