Setup test-download script

Author: woojiahao

.gitignore

@@ -191,4 +191,6 @@ cython_debug/
 #  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
 #  refer to https://docs.cursor.com/context/ignore-files
 .cursorignore
-.cursorindexingignore
+.cursorindexingignore
+
+test-downloads/

test-download.py

@@ -0,0 +1,158 @@
+import subprocess
+import json
+import os
+from pathlib import Path
+import sys
+import shutil
+from typing import Dict, Any
+
+
+def get_username() -> str:
+    result = subprocess.run(
+        ["gh", "api", "user", "-q", ".login"], capture_output=True, text=True
+    )
+
+    if result.returncode == 0:
+        username = result.stdout.splitlines()[0]
+        return username
+    return ""
+
+
+def has_fork(fork_name: str) -> bool:
+    result = subprocess.run(
+        ["gh", "repo", "view", fork_name, "--json", "isFork", "--jq", ".isFork"],
+        capture_output=True,
+        text=True,
+        env=dict(os.environ, **{"GH_PAGER": "cat"}),
+    )
+    return result.returncode == 0 and result.stdout.strip() == "true"
+
+
+def fork(repository_name: str, fork_name: str) -> None:
+    subprocess.run(
+        [
+            "gh",
+            "repo",
+            "fork",
+            repository_name,
+            "--default-branch-only",
+            "--fork-name",
+            fork_name,
+        ],
+        capture_output=True,
+        text=True,
+    )
+
+
+def clone_with_custom_name(repository_name: str, name: str) -> None:
+    subprocess.run(
+        ["gh", "repo", "clone", repository_name, name], capture_output=True, text=True
+    )
+
+
+def init() -> None:
+    subprocess.run(
+        ["git", "init", "--initial-branch=main"], capture_output=True, text=True
+    )
+
+
+def add_all() -> None:
+    subprocess.run(["git", "add", "."], capture_output=True, text=True)
+
+
+def commit(message: str) -> None:
+    subprocess.run(["git", "commit", "-m", message], capture_output=True, text=True)
+
+
+def empty_commit(message: str) -> None:
+    subprocess.run(
+        ["git", "commit", "-m", message, "--allow-empty"],
+        capture_output=True,
+        text=True,
+    )
+
+
+def main(exercise_folder_name: str) -> None:
+    os.makedirs("test-downloads", exist_ok=True)
+    test_folder_name = os.path.join("test-downloads", exercise_folder_name)
+    shutil.rmtree(test_folder_name, ignore_errors=True)
+    os.makedirs(test_folder_name, exist_ok=True)
+
+    starting_files = [".gitmastery-exercise.json", "README.md"]
+    for file in starting_files:
+        shutil.copyfile(
+            os.path.join(exercise_folder_name, file),
+            os.path.join(test_folder_name, file),
+        )
+
+    config = {}
+    with open(
+        os.path.join(exercise_folder_name, ".gitmastery-exercise.json"), "r"
+    ) as exercise_config_file:
+        config = json.load(exercise_config_file)
+
+    base_files = config["base_files"]
+    for resource, path in base_files.items():
+        os.makedirs(Path(path).parent, exist_ok=True)
+        shutil.copyfile(
+            os.path.join(exercise_folder_name, "res", resource),
+            os.path.join(test_folder_name, path),
+        )
+
+    repo_name = config["exercise_repo"]["repo_name"]
+    repo_title = config["exercise_repo"]["repo_title"]
+    if config["exercise_repo"]["repo_type"] == "local":
+        os.makedirs(os.path.join(test_folder_name, repo_name), exist_ok=True)
+    else:
+        username = get_username()
+        exercise_repo = f"git-mastery/{repo_title}"
+        if config["exercise_repo"]["create_fork"]:
+            fork_name = f"{username}-gitmastery-{repo_title}"
+            if not has_fork(fork_name):
+                fork(exercise_repo, fork_name)
+            cur_dir = os.getcwd()
+            os.chdir(os.path.join(test_folder_name))
+            clone_with_custom_name(f"{username}/{fork_name}", repo_name)
+            os.chdir(cur_dir)
+        else:
+            clone_with_custom_name(exercise_repo, repo_name)
+
+    namespace: Dict[str, Any] = {}
+    with open(
+        os.path.join(exercise_folder_name, "download.py"), "r"
+    ) as download_script_file:
+        contents = download_script_file.read()
+        exec(contents, namespace)
+
+    download_resources = namespace.get("__resources__", {})
+    if download_resources:
+        for resource, path in download_resources.items():
+            os.makedirs(Path(path).parent, exist_ok=True)
+            shutil.copyfile(
+                os.path.join(exercise_folder_name, "res", resource),
+                os.path.join(test_folder_name, repo_name, path),
+            )
+
+    os.chdir(os.path.join(test_folder_name, repo_name))
+    if config["exercise_repo"]["init"]:
+        init()
+        if download_resources:
+            add_all()
+            commit("Initial commit")
+        else:
+            empty_commit("Initial commit")
+
+    if "setup" in namespace:
+        namespace["setup"]()
+
+
+if __name__ == "__main__":
+    if len(sys.argv) != 2:
+        print("Missing exercise folder name: ./test-download.py <exercise folder name>")
+        sys.exit(1)
+
+    if not os.path.isdir(sys.argv[1]):
+        print("Invalid exercise folder name")
+        sys.exit(1)
+
+    main(sys.argv[1])

test-download.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+python test-download.py $1