Merge remote-tracking branch 'origin/csm' into nrs

Author: spragunr

jmu_pytest_utils/audit.py

@@ -144,6 +144,8 @@ def error(message):
         print(f"{path}:{node.lineno}:{node.col_offset+1} {message}")
     # parse each source file
     for path in paths:
+        if not path.endswith(".py"):
+            continue
         with open(path, encoding="utf-8") as file:
             source = file.read()
         tree = ast.parse(source, path)

jmu_pytest_utils/builder.py

@@ -22,12 +22,13 @@
 
 def init_cfg():
     """Initialize global variables with default values."""
-    global SUBMISSION_FILES, AUTOGRADER_TESTS, ADDITIONAL_FILES
+    global SUBMISSION_FILES, AUTOGRADER_TESTS, ADDITIONAL_FILES, REQUIREMENTS_TXT
     global SUBMISSION_LIMIT, FUNCTION_TIMEOUT, SCHOOL_TIME_ZONE, INSTALL_PYTHON_V
 
     SUBMISSION_FILES = []
     AUTOGRADER_TESTS = []
     ADDITIONAL_FILES = []
+    REQUIREMENTS_TXT = []
     SUBMISSION_LIMIT = os.getenv("SUBMISSION_LIMIT", -1)
     FUNCTION_TIMEOUT = os.getenv("FUNCTION_TIMEOUT", 5)
     SCHOOL_TIME_ZONE = os.getenv("SCHOOL_TIME_ZONE", "US/Eastern")
@@ -107,8 +108,8 @@ def make_cfg():
     for filename in test_files:
         module_name = filename[:-3].replace(os.path.sep, ".")
         module = importlib.import_module(module_name)
-        for name in ["SUBMISSION_FILES", "AUTOGRADER_TESTS", "ADDITIONAL_FILES",
-                     "SUBMISSION_LIMIT", "FUNCTION_TIMEOUT", "SCHOOL_TIME_ZONE"]:
+        for name in ["SUBMISSION_FILES", "AUTOGRADER_TESTS", "ADDITIONAL_FILES", "REQUIREMENTS_TXT",
+                     "SUBMISSION_LIMIT", "FUNCTION_TIMEOUT", "SCHOOL_TIME_ZONE", "INSTALL_PYTHON_V"]:
             if hasattr(module, name):
                 globals()[name] = getattr(module, name)
 
@@ -139,6 +140,7 @@ def make_cfg():
         " ".join(SUBMISSION_FILES).replace("\\", "/"),
         " ".join(AUTOGRADER_TESTS).replace("\\", "/"),
         " ".join(ADDITIONAL_FILES).replace("\\", "/"),
+        " ".join(REQUIREMENTS_TXT).replace("\\", "/"),
         SUBMISSION_LIMIT,
         FUNCTION_TIMEOUT,
         SCHOOL_TIME_ZONE,
@@ -165,6 +167,7 @@ def build_cmd(setup=False):
     print("  SUBMISSION_FILES =", SUBMISSION_FILES)
     print("  AUTOGRADER_TESTS =", AUTOGRADER_TESTS)
     print("  ADDITIONAL_FILES =", ADDITIONAL_FILES)
+    print("  REQUIREMENTS_TXT =", REQUIREMENTS_TXT)
     print("  SUBMISSION_LIMIT =", SUBMISSION_LIMIT)
     print("  FUNCTION_TIMEOUT =", FUNCTION_TIMEOUT)
     print("  SCHOOL_TIME_ZONE =", SCHOOL_TIME_ZONE)
@@ -181,6 +184,16 @@ def build_cmd(setup=False):
                 points += getattr(function, "weight", 0)
     print(f"\033[1;34mAutograder Points: {points}\033[0m")
 
+    # Generate requirements.txt file if needed
+    if REQUIREMENTS_TXT:
+        if not os.path.exists("requirements.txt"):
+            print("Creating requirements.txt")
+            with open("requirements.txt", "w") as file:
+                for line in REQUIREMENTS_TXT:
+                    file.write(line + "\n")
+        else:
+            print("\033[1;31mIgnoring REQUIREMENTS_TXT (requirements.txt exists)\033[0m")
+
     # Copy template files if not already exist
     if setup:
         for filename in CONFIG_FILES:
@@ -251,6 +264,13 @@ def clean_cmd():
     for dirname in CACHE_DIRS:
         shutil.rmtree(dirname, True)
 
+    # Delete requirements.txt if auto generated
+    if "REQUIREMENTS_TXT" in globals() and REQUIREMENTS_TXT:
+        with open("requirements.txt") as file:
+            lines = [line.rstrip() for line in file]
+        if lines == REQUIREMENTS_TXT:
+            delete_file("requirements.txt", "auto generated")
+
     # Delete template files (if not modified)
     for filename in CONFIG_FILES + SCRIPT_FILES:
         if os.path.exists(filename):

jmu_pytest_utils/common.py

@@ -1,6 +1,7 @@
 """Common test functions used in many autograders."""
 
 import inspect
+import json
 import os
 import pytest
 import subprocess
@@ -20,6 +21,23 @@ def chdir_test():
             break
 
 
+def get_username(default="username"):
+    """Get the student's username from the submission metadata.
+
+    Args:
+        default (str): Value to return if metadata not found.
+
+    Returns:
+        str: The student's email address up to the @ symbol.
+    """
+    try:
+        with open("/autograder/submission_metadata.json") as file:
+            metadata = json.load(file)
+            return metadata["users"][0]["email"].split("@")[0]
+    except FileNotFoundError:
+        return default
+
+
 def _get_cfg(filename):
     """Get the path of an optional configuration file.
 

jmu_pytest_utils/template/config.sh

@@ -17,18 +17,23 @@ export AUTOGRADER_TESTS="{1}"
 # Default: blank
 export ADDITIONAL_FILES="{2}"
 
+# Packages to install with pip
+# Example: "beautifulsoup4 requests"
+# Default: blank
+export REQUIREMENTS_TXT="{3}"
+
 # Max submissions that can run
 # Default: -1
-export SUBMISSION_LIMIT="{3}"
+export SUBMISSION_LIMIT="{4}"
 
 # Max seconds per test function
 # Default: 5
-export FUNCTION_TIMEOUT="{4}"
+export FUNCTION_TIMEOUT="{5}"
 
 # Time zone for submissions
 # Default: US/Eastern
-export SCHOOL_TIME_ZONE="{5}"
+export SCHOOL_TIME_ZONE="{6}"
 
 # Python version to install
 # Default: 3.12
-export INSTALL_PYTHON_V="{6}"
+export INSTALL_PYTHON_V="{7}"

jmu_pytest_utils/template/setup.sh

@@ -15,7 +15,7 @@ source .venv/bin/activate
 pip install --upgrade pip
 
 # Install libraries
-pip install git+https://github.com/JMU-CS/jmu_pytest_utils.git
+pip install git+https://github.com/JMU-CS/jmu_pytest_utils.git@csm
 if [ -f "requirements.txt" ]; then
     pip install -r requirements.txt
 fi