assignment-codeval 0.0.32__py3-none-any.whl → 0.0.34__py3-none-any.whl

assignment_codeval/commons.py

@@ -1,14 +1,17 @@
 from typing import NoReturn
 
 import click
+import re
 import time
 import dataclasses
 
 
 def despace(name):
-    # we need to replace spaces with _ to work well with scripts
     # we need to remove the : so that it doesn't mess up docker
-    return name.replace(" ", "_").replace(":","")
+    # (removed rather than replaced to keep existing names stable)
+    # everything else that isn't a word character, . or - becomes _ so the
+    # name is a single path component that is safe in scripts and the shell
+    return re.sub(r"[^\w.-]", "_", name.replace(":", ""))
 
 
 @dataclasses.dataclass(init=True, repr=True, frozen=True)

assignment_codeval/submissions.py

@@ -1,5 +1,7 @@
 import os
+import posixpath
 import re
+import shlex
 import shutil
 import subprocess
 import time
@@ -16,6 +18,7 @@ import requests
 
 from assignment_codeval.canvas_utils import connect_to_canvas, get_course, get_courses, get_assignment
 from assignment_codeval.commons import debug, error, info, warn, despace
+from assignment_codeval.github_connect import _read_desired_commit
 
 # Bookkeeping files the tool writes into each student directory. A student must
 # never be able to clobber these via an attachment filename — in particular
@@ -514,6 +517,64 @@ def upload_submission_comments(submissions_dir, codeval_prefix, delete):
                     warn(f"no submission found for {student_id} in {course_name}: {assignment_name}")
 
 
+def _github_fetch_problem(dirpath, submission_dir):
+    """For a GitHub submission whose fetch failed, build the student-facing message.
+
+    Returns None when the submission is not GitHub-based (no github_repo in
+    metadata.txt) or when the checkout matches the submitted commit, so the
+    caller proceeds with normal grading.
+
+    Covers both failure shapes: no checkout at all (clone failed, bad digest)
+    and a clone whose gh_success.txt is missing or stale (the submitted commit
+    could not be checked out, e.g. it was never pushed) — grading that tree
+    would silently grade the wrong commit. github-setup-repo leaves its
+    clone/checkout errors (bad digest, failed clone, failed checkout) in
+    comments.txt; include them so the student sees why the fetch failed
+    instead of a misleading complaint about a missing assignment directory.
+    """
+    metadata_path = os.path.join(dirpath, "metadata.txt")
+    has_github_repo = False
+    if os.path.exists(metadata_path):
+        with open(metadata_path, "r") as f:
+            has_github_repo = any(
+                line.startswith("github_repo=") and line.split("=", 1)[1].strip()
+                for line in f)
+    if not has_github_repo:
+        return None
+
+    desired = _read_desired_commit(os.path.join(dirpath, "content.txt"))
+    recorded = None
+    try:
+        with open(os.path.join(dirpath, "gh_success.txt"), "r") as f:
+            recorded = f.readline().strip() or None
+    except OSError:
+        pass
+
+    if os.path.isdir(submission_dir):
+        # Mirror github-setup-repo: a recorded checkout is good if it matches
+        # the submitted digest, or if the digest is unreadable (leave as-is).
+        if recorded and (not desired or recorded == desired):
+            return None
+        out = (b"your repository was cloned, but the commit digest you submitted in Canvas\n"
+               b"could not be checked out, so your submission was not graded. Make sure you\n"
+               b"have pushed your commits and submitted only the digest of your final\n"
+               b"pushed commit (the 40-character output of `git rev-parse HEAD`) in Canvas.\n")
+    else:
+        out = (b"your submission could not be fetched from GitHub, so it was not graded.\n"
+               b"Make sure you have pushed your commits and submitted only the digest of\n"
+               b"your final commit (the 40-character output of `git rev-parse HEAD`) in Canvas.\n")
+    try:
+        with open(os.path.join(dirpath, "comments.txt"), "rb") as f:
+            prior = f.read()
+    except OSError:
+        prior = b""
+    # Include only clone logs written by github-setup-repo, never the result
+    # of a previous evaluation run (which would nest on re-runs).
+    if prior.startswith((b"cloning", "❌".encode())):
+        out += b"\nDetails of the failed fetch:\n" + prior
+    return out
+
+
 @click.command()
 @click.argument('codeval_dir', metavar="CODEVAL_DIR", required=False)
 @click.option("--submissions-dir", help="directory containing submissions COURSE/ASSIGNMENT/STUDENT_ID",
@@ -559,6 +620,18 @@ def evaluate_submissions(codeval_dir, submissions_dir):
         with open(os.path.join(dirpath, "codeval_path.txt"), "w") as f:
             f.write(os.path.abspath(codeval_file))
 
+        # A GitHub submission with no checkout, or a checkout that isn't the
+        # submitted commit, means the fetch failed (bad digest, failed clone
+        # or checkout). Say that, rather than falling through to a misleading
+        # "<dir> does not exist" message or grading the wrong commit.
+        fetch_failure = _github_fetch_problem(dirpath, submission_dir)
+        if fetch_failure is not None:
+            info("writing results")
+            with open(f"{dirpath}/comments.txt", "wb") as fd:
+                fd.write(fetch_failure)
+            info("continuing")
+            continue
+
         # First pass: get CTO, CD tags, and collect Z files (don't extract yet)
         compile_timeout = 20
         assignment_working_dir = "."
@@ -620,7 +693,16 @@ def evaluate_submissions(codeval_dir, submissions_dir):
                                 os.chmod(os.path.join(dest_dir, f.filename), perms)
 
         if not move_to_next_submission:
-            command = raw_command.replace("EVALUATE", "cd /submissions 2>/dev/null || true; assignment-codeval run-evaluation codeval.txt")
+            # Mount the whole submission and cd to the working directory
+            # inside the container: mounting only the working directory would
+            # hide the repository's .git (which lives at the submission root)
+            # from git-based tests.
+            container_working_dir = posixpath.normpath(
+                posixpath.join("/submissions", assignment_working_dir.replace("\\", "/")))
+            command = raw_command.replace(
+                "EVALUATE",
+                f"cd {shlex.quote(container_working_dir)} 2>/dev/null || true; "
+                "assignment-codeval run-evaluation codeval.txt")
 
             with TemporaryDirectory("cedir", dir="/var/tmp") as link_dir:
                 submission_link = os.path.join(link_dir, "submissions")
@@ -647,7 +729,7 @@ def evaluate_submissions(codeval_dir, submissions_dir):
                                         os.path.join(full_assignment_working_dir, ref_file),
                                         submission_dir)
 
-                    command = command.replace("SUBMISSIONS", full_assignment_working_dir)
+                    command = command.replace("SUBMISSIONS", submission_link)
                     info(f"command to execute: {command}")
                     p = subprocess.Popen(command, shell=True, stdout=subprocess.PIPE, stderr=subprocess.STDOUT)
                     try:

{assignment_codeval-0.0.32.dist-info → assignment_codeval-0.0.34.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: assignment-codeval
-Version: 0.0.32
+Version: 0.0.34
 Summary: CodEval for evaluating programming assignments
 Requires-Python: >=3.12
 Description-Content-Type: text/markdown

{assignment_codeval-0.0.32.dist-info → assignment_codeval-0.0.34.dist-info}/RECORD

@@ -3,7 +3,7 @@ assignment_codeval/ai_benchmark.py,sha256=8WkLYD72NNS_82pF3IVpvXgBJDMN8PBYjmw4fV
 assignment_codeval/canvas_utils.py,sha256=NF2xw10A1okVtDnP98YRzEiSo7QlqYF-IVAih4-WeLQ,5998
 assignment_codeval/check_grading.py,sha256=rnNdp8T_XWckDfF1zUi3r70BMe9CPNTD-RfjfarI-CM,5889
 assignment_codeval/cli.py,sha256=Vl27zNI7kI0QEZoXTIE2aTrraEJWj9vgJiyVWou3vgU,1357
-assignment_codeval/commons.py,sha256=rr09qHacHoLmmU8S9sBss4_utb0DH8-IyL9Dsj0ycE0,1412
+assignment_codeval/commons.py,sha256=hnos85_OZsMv2OmALzFzXQe23HYIsbTnxXjINJUghEQ,1583
 assignment_codeval/convertMD2Html.py,sha256=oNFY63WgxiXfk1v3j8zc1RxCzzQBzj6fXupezogPZfw,8248
 assignment_codeval/create_assignment.py,sha256=tUgCYWhk4zoPZf8p4wyqHYgbEmLcX8XnUNykAv0XEW0,12488
 assignment_codeval/evaluate.py,sha256=8ce59_fk13cp59hCAKywjojxAC1FdU6TKiF4t5eJKoY,42881
@@ -12,10 +12,10 @@ assignment_codeval/file_utils.py,sha256=vAFnPaA4p6BQabkn034SacBFhV_Mpib2sbZOxvk-
 assignment_codeval/github_connect.py,sha256=4Fc9UusgXTqwlvNW-ppVKCfNnQM0Gp17oXWkUK4OWiY,6659
 assignment_codeval/install_assignment.py,sha256=HsXzTex4G-U3t4tb-HyQ2AobBDBPcKeR6oAUDFqBP-A,4599
 assignment_codeval/recent_comments.py,sha256=WelZpODSvZ5hbRn2IofEpqMwrvHx8haOG4KZJCvHYKw,9415
-assignment_codeval/submissions.py,sha256=P-hNLOLKCBmWZVcYZi3FF9PHfoxghGufz64QHw98CDk,42330
+assignment_codeval/submissions.py,sha256=Kg2DBtSSFhN_C1ePUIKUn5VW5TIVw2_7Giu2PpLdSOA,46366
 assignment_codeval/test_template.html,sha256=c0e2lUurSalF4PpLIVWQCXirXeA8PvB4pzWe-kFS-9Y,3382
-assignment_codeval-0.0.32.dist-info/METADATA,sha256=zicpCFBA1Vp_ceEqJAGAcTfLQSOiuvPha2rTy9ERjJg,7757
-assignment_codeval-0.0.32.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
-assignment_codeval-0.0.32.dist-info/entry_points.txt,sha256=Pk0eAhsXBpCsgkv6HYLSHTRf5x_zUf-Lg8KK9KsK2B8,66
-assignment_codeval-0.0.32.dist-info/top_level.txt,sha256=a_P8W2IWjAELxKlTV2t4rLwWVoTxElxUMvWgWjR_1n4,19
-assignment_codeval-0.0.32.dist-info/RECORD,,
+assignment_codeval-0.0.34.dist-info/METADATA,sha256=y6OHiCYpxNb-8DEepajODCVbPQCTGlG-yG7WYDrGDuo,7757
+assignment_codeval-0.0.34.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+assignment_codeval-0.0.34.dist-info/entry_points.txt,sha256=Pk0eAhsXBpCsgkv6HYLSHTRf5x_zUf-Lg8KK9KsK2B8,66
+assignment_codeval-0.0.34.dist-info/top_level.txt,sha256=a_P8W2IWjAELxKlTV2t4rLwWVoTxElxUMvWgWjR_1n4,19
+assignment_codeval-0.0.34.dist-info/RECORD,,