assignment-codeval 0.0.29__py3-none-any.whl → 0.0.30__py3-none-any.whl

assignment_codeval/canvas_utils.py

@@ -98,7 +98,7 @@ def get_assignment(course, assignment_name):
             error(fr"    {a.name}")
         sys.exit(2)
     elif len(assignments) > 1:
-        strict_name_assignments = [a for a in assignments if a.name == assignment_name]
+        strict_name_assignments = [a for a in assignments if despace(a.name) == assignment_name]
         if len(strict_name_assignments) == 1:
             assignments = strict_name_assignments
         else:

assignment_codeval/evaluate.py

@@ -38,11 +38,23 @@ num_failed = 0
 is_hidden_testcase = False
 is_verbose = False
 compilelog = []
+last_compile_command = ""
+temp_files = []
+_active_temp_files = []
 
 ###########################################################
 # Specification Tags to Function Mapping
 ###########################################################
 
+# Shell commands that likely indicate a missing CMD prefix when found untagged
+_BARE_SHELL_COMMANDS = {
+    'echo', 'rm', 'cp', 'mv', 'mkdir', 'rmdir', 'cat', 'ls', 'grep',
+    'sed', 'awk', 'find', 'chmod', 'chown', 'touch', 'ln', 'diff',
+    'sort', 'head', 'tail', 'cut', 'tr', 'wc', 'bash', 'sh', 'python',
+    'python3', 'make', 'export', 'source', 'kill', 'pkill', 'sleep',
+    'printf', 'read', 'unzip', 'tar', 'curl', 'wget',
+}
+
 
 def compile_code(compile_command):
     """Specifies the command to compile the submission code
@@ -53,6 +65,9 @@ def compile_code(compile_command):
     Returns:
         None
     """
+    global last_compile_command
+    last_compile_command = compile_command
+
     if test_case_count != 0:
         check_test()
 
@@ -112,6 +127,44 @@ def _find_compiled_artifact(source_file):
     return None
 
 
+def _extract_executable_from_compile(compile_command):
+    """Extract the output executable name from a compile command (looks for -o <name>).
+
+    Returns the executable name, or None if not found.
+    """
+    parts = compile_command.split()
+    for i, part in enumerate(parts):
+        if part == '-o' and i + 1 < len(parts):
+            return parts[i + 1]
+    return None
+
+
+def _extract_source_files_from_compile(compile_command):
+    """Extract source file arguments from a compile command.
+
+    Recognises common source file extensions (.c, .cpp, .cc, .cxx, .java, .py)
+    and skips option arguments that consume the following token as a value
+    (e.g. -o, -I, -L, -l, -include, -isystem, -MF, -MT, -MQ).
+
+    Returns a list of source file paths found in the command.
+    """
+    source_exts = ('.c', '.cpp', '.cc', '.cxx', '.java', '.py')
+    value_flags = {'-o', '-I', '-L', '-l', '-include', '-isystem', '-MF', '-MT', '-MQ'}
+    parts = compile_command.split()
+    files = []
+    skip_next = False
+    for part in parts:
+        if skip_next:
+            skip_next = False
+            continue
+        if part in value_flags:
+            skip_next = True
+            continue
+        if not part.startswith('-') and any(part.endswith(ext) for ext in source_exts):
+            files.append(part)
+    return files
+
+
 def _function_used_in_c_cpp(function_name, files):
     """Use objdump on compiled artifacts to detect C/C++ function usage.
 
@@ -209,14 +262,20 @@ def _function_used_regex(function_name, files):
     return result.returncode == 0
 
 
-def _is_function_used(function_name, files):
+def _is_function_used(function_name, files, allow_regex_fallback=True):
     """Detect whether function_name is used in the given files.
 
     Dispatches to the appropriate tool based on file language:
-      - C/C++:  objdump on compiled artifact (falls back to regex if none found)
-      - Java:   javap on .class file (falls back to regex if none found)
+      - C/C++:  objdump on compiled artifact (falls back to regex if none found
+                and allow_regex_fallback is True)
+      - Java:   javap on .class file (falls back to regex if none found
+                and allow_regex_fallback is True)
       - Python: ast module on source
-      - Other:  regex on source
+      - Other:  regex on source (only when allow_regex_fallback is True)
+
+    When allow_regex_fallback is False (used when no filename was given in the
+    CF tag), the function relies solely on compiled-artifact inspection and
+    returns False rather than falling back to regex.
     """
     lang = _detect_language(files)
     if lang == 'python':
@@ -224,36 +283,56 @@ def _is_function_used(function_name, files):
     if lang == 'java':
         result = _function_used_in_java(function_name, files)
         if result is None:
-            return _function_used_regex(function_name, files)
+            return _function_used_regex(function_name, files) if allow_regex_fallback else False
         return result
     if lang == 'c_cpp':
         result = _function_used_in_c_cpp(function_name, files)
         if result is None:
-            return _function_used_regex(function_name, files)
+            return _function_used_regex(function_name, files) if allow_regex_fallback else False
         return result
-    return _function_used_regex(function_name, files)
+    if allow_regex_fallback:
+        return _function_used_regex(function_name, files)
+    return False
 
 
 def check_function(args):
-    """Will be followed by a function name and a list of files to check to ensure that the function
-    is used by one of those files.
+    """Will be followed by a function name and an optional list of files to check to ensure that
+    the function is used by one of those files.
+
+    When no filename is provided (preferred usage), the source files are derived from the most
+    recent C (compile) tag.  The check then relies solely on compiled-artifact inspection
+    (objdump for C/C++, javap for Java, ast for Python) with no regex fallback.
+
+    When a filename is provided (legacy usage), the same compiled-artifact inspection is used
+    first, but a regex scan of the source file is available as a fallback when no compiled
+    artifact can be found.
 
     Arguments:
         function_name: the function name to check files for usage of
-        *files: the files to check for the function name
+        *files: (optional) the files to check for the function name.  If omitted, source
+                files are inferred from the most recent C tag.
 
     Returns:
         None
     """
     check_test()
-    args = args.split()
-    function_name = args[0]
-    files = args[1:]
-
-    if _is_function_used(function_name, files):
-        print(f"Used {function_name} PASSED")
+    args_list = args.split()
+    function_name = args_list[0]
+    files = args_list[1:]
+
+    if not files:
+        # No filename provided — derive source files from the compile command and
+        # disable the regex fallback (compiled-artifact check only).
+        files = _extract_source_files_from_compile(last_compile_command)
+        if _is_function_used(function_name, files, allow_regex_fallback=False):
+            print(f"Used {function_name} PASSED")
+        else:
+            print(f"Not using {function_name} FAILED")
     else:
-        print(f"Not using {function_name} FAILED")
+        if _is_function_used(function_name, files):
+            print(f"Used {function_name} PASSED")
+        else:
+            print(f"Not using {function_name} FAILED")
 
 def check_object(args):
     """Will be followed by an object and a list of files to ensure that the function is
@@ -352,22 +431,38 @@ def check_container(args):
     
 
 def check_not_function(args):
-    """Will be followed by a function name and a list of files to check to ensure that the function
-    is not used by any of those files.
+    """Will be followed by a function name and an optional list of files to check to ensure that
+    the function is not used by any of those files.
+
+    When no filename is provided (preferred usage), the source files are derived from the most
+    recent C (compile) tag.  The check relies solely on compiled-artifact inspection with no
+    regex fallback.
+
+    When a filename is provided (legacy usage), compiled-artifact inspection is used first with
+    a regex fallback when no compiled artifact is found.
 
     Arguments:
         function_name: the function name to check files for usage of
-        *files: the files to check for the function name
+        *files: (optional) the files to check for the function name.  If omitted, source
+                files are inferred from the most recent C tag.
 
     Returns:
         None
     """
     check_test()
-    args = args.split()
-    function_name = args[0]
-    files = args[1:]
+    args_list = args.split()
+    function_name = args_list[0]
+    files = args_list[1:]
+
+    if not files:
+        # No filename provided — derive source files from the compile command and
+        # disable the regex fallback (compiled-artifact check only).
+        files = _extract_source_files_from_compile(last_compile_command)
+        used = _is_function_used(function_name, files, allow_regex_fallback=False)
+    else:
+        used = _is_function_used(function_name, files)
 
-    if _is_function_used(function_name, files):
+    if used:
         print(f"Used {function_name} FAILED")
     else:
         print(f"Not using {function_name} PASSED")
@@ -412,6 +507,7 @@ def run_command_noerror(command):
         None
     """
     check_test()
+    _pre_test_temp_cleanup()
 
     # Run as test case
     global test_case_count
@@ -460,6 +556,7 @@ def test_case(test_case_command):
         None
     """
     check_test()
+    _pre_test_temp_cleanup()
 
     # Clear hint
     global test_case_hint
@@ -488,6 +585,7 @@ def test_case_hidden(test_case_command):
         None
     """
     check_test()
+    _pre_test_temp_cleanup()
 
     # Clear hint
     global test_case_hint
@@ -585,9 +683,10 @@ def check_output_file(output_file):
     Returns:
         None
     """
+    output_length(os.path.getsize(output_file)) 
     with open(output_file, "r") as infile:
         output_lines = infile.readlines()
-
+        
     with open(get_testing_path("expectedoutput"), "a") as outfile:
         outfile.writelines(output_lines)
 
@@ -631,6 +730,48 @@ def hint(hints):
     test_case_hint = hints
 
 
+def register_temp_file(filename):
+    """Registers a file to be deleted before and after the next T, HT, or TCMD test.
+
+    Arguments:
+        filename: the file to delete before and after the next test
+
+    Returns:
+        None
+    """
+    global temp_files
+    temp_files.append(filename.strip())
+
+
+def _cleanup_temp_files():
+    """Delete all registered temp files and reset the list."""
+    global temp_files
+    for f in temp_files:
+        try:
+            os.remove(f)
+        except FileNotFoundError:
+            pass
+    temp_files = []
+
+
+def _pre_test_temp_cleanup():
+    """Before a test: delete registered temp files and save the list for post-test cleanup."""
+    global temp_files, _active_temp_files
+    _active_temp_files = list(temp_files)
+    _cleanup_temp_files()
+
+
+def _post_test_temp_cleanup():
+    """After a test: delete the files that were registered when the test started."""
+    global _active_temp_files
+    for f in _active_temp_files:
+        try:
+            os.remove(f)
+        except FileNotFoundError:
+            pass
+    _active_temp_files = []
+
+
 def timeout(timeout_sec):
     """Specifies the time limit in seconds for a test case to run. Defaults to 20 seconds.
 
@@ -743,6 +884,7 @@ tag_func_map = {
     "OLEN": output_length,
     "X": exit_code,
     "SS": start_server,
+    "TEMP": register_temp_file,
 }
 
 
@@ -840,6 +982,13 @@ def parse_tags(tags: list[str]):
                     print(f"  {line_num}: {tag_line.rstrip()}")
                     print(f"  Valid tags are: {', '.join(sorted(valid_tags))}")
                     sys.exit(1)
+            else:
+                # Check if this looks like a bare shell command missing a CMD prefix
+                first_word = tag_line.split()[0] if tag_line.split() else ""
+                if first_word.lower() in _BARE_SHELL_COMMANDS:
+                    print(f"Warning on line {line_num}: bare shell command without CMD prefix, shell commands will be ignored")
+                    print(f"  {line_num}: {tag_line.rstrip()}")
+                    print(f"  Did you mean: CMD {tag_line.rstrip()}")
             continue
 
         tag = tag_match.group(1)
@@ -1138,10 +1287,14 @@ def check_test():
                                 if len(lines) > 22:
                                     print(f"    ... ({len(lines) - 22} more lines)")
 
+        _post_test_temp_cleanup()
+        cleanup()
+
         # Exit program after failed test case
         sys.exit(2)
 
     # reinitialize test variables and files here
+    _post_test_temp_cleanup()
     setup()
 
 

assignment_codeval/submissions.py

@@ -605,7 +605,8 @@ def get_submissions_by_id(assignment):
 
 @click.command()
 @click.argument("course_name", metavar="COURSE", required=False)
-def list_codeval_assignments(course_name):
+@click.option("--path", is_flag=True, help="Show the path to the codeval file")
+def list_codeval_assignments(course_name, path):
     """
     List all assignments that have corresponding codeval files.
 
@@ -646,10 +647,18 @@ def list_codeval_assignments(course_name):
             assignment_key = despace(assignment.name).lower()
             if assignment_key in codeval_files:
                 matched_codeval_keys.add(assignment_key)
-                info(f"{course.name}: {assignment.name}")
+                codeval_path = os.path.join(codeval_dir, f"{codeval_files[assignment_key]}.codeval")
+                if path:
+                    info(f"{course.name}: {assignment.name} [{codeval_path}]")
+                else:
+                    info(f"{course.name}: {assignment.name}")
             elif assignment_key in codeval_titles:
                 matched_codeval_keys.add(codeval_titles[assignment_key].lower())
-                info(f"{course.name}: {assignment.name}")
+                codeval_path = os.path.join(codeval_dir, f"{codeval_titles[assignment_key]}.codeval")
+                if path:
+                    info(f"{course.name}: {assignment.name} [{codeval_path}]")
+                else:
+                    info(f"{course.name}: {assignment.name}")
 
     # Report codeval files that don't match any assignment
     unmatched_keys = set(codeval_files.keys()) - matched_codeval_keys

{assignment_codeval-0.0.29.dist-info → assignment_codeval-0.0.30.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: assignment-codeval
-Version: 0.0.29
+Version: 0.0.30
 Summary: CodEval for evaluating programming assignments
 Requires-Python: >=3.12
 Description-Content-Type: text/markdown
@@ -69,7 +69,8 @@ Tags used in a spec file (\<course name>.codeval)
 | CTO | Compile Timeout | Timeout in seconds for the compile command to run |
 | RUN | Run Script | Specifies the script to use to evaluate the specification file. Defaults to evaluate.sh. |
 | Z | Download Zip | Will be followed by zip files to download from Canvas to use when running the test cases. |
-| CF | Check Function | Will be followed by a function name and a list of files to check to ensure that the function is used by one of those files. |
+| CF | Check Function | `CF <function_name> [filename]` — checks that the function is used. The filename is **optional** and omitting it (e.g. `CF strtol`) is the preferred usage; source files are inferred from the most recent `C` tag and the check uses compiled-artifact inspection only (objdump/javap/ast). Providing a filename (e.g. `CF strtol mycalc.c`) is supported for backwards compatibility and additionally enables a regex fallback when no compiled artifact is found. |
+| NCF | Check Not Function | `NCF <function_name> [filename]` — checks that the function is **not** used. The filename is **optional** (same behaviour as CF). |
 | CC | Check Container | Will be followed by a function name and a list of files to check to ensure that a container is used by one of those files. Primarily supports C++ containers such as std::vector |
 | CO | Check Object | Will be followed by a function name and a list of files to check to ensure that an object is used by one of those files. Primarily support C++ stream operations |
 | PRINT | Print Label | Prints a label/message to stdout. Cleaner alternative to `CMD echo "..."` for section labels. |
@@ -82,6 +83,7 @@ Tags used in a spec file (\<course name>.codeval)
 | TO | Timeout | Specifies the time limit in seconds for a test case to run. Defaults to 20 seconds. |
 | X | Exit Code | Specifies the expected exit code for a test case. Defaults to zero. |
 | SS | Start Server | Command containing timeout (wait until server starts), kill timeout (wait to kill the server), and the command to start a server |
+| TEMP | Temp File | Registers a file to be deleted before the next T, HT, or TCMD test runs (clean state) and again after it completes (cleanup). Only applies to the immediately following test — use a new TEMP tag for each test that needs it. |
 
 Refer to a sample spec file [here](samples/assignment-name.codeval)
 

{assignment_codeval-0.0.29.dist-info → assignment_codeval-0.0.30.dist-info}/RECORD

@@ -1,21 +1,21 @@
 assignment_codeval/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 assignment_codeval/ai_benchmark.py,sha256=ZGWWrBeUcaArkuQqS9wY42gxP8g7J2nivJMedYq9RFs,18045
-assignment_codeval/canvas_utils.py,sha256=MNtGXc93tHlqudEZsb_6r-5QzV9tSqf3AVxIVGEmk-U,5989
+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/convertMD2Html.py,sha256=cCfTWwxH-0SKZ7Br-Qn54OabPuEAhHpx3q4Aeqp_NAo,7682
 assignment_codeval/create_assignment.py,sha256=duGI8wZRpeEnmYPAAth_QXcFHWd185zkjkSJsaeH-GY,11999
-assignment_codeval/evaluate.py,sha256=yGkWYjYtXGiR0OF-7Y6Aou9B5TtXUf1pykDmmGCAS0k,36205
+assignment_codeval/evaluate.py,sha256=PlpWGD-aHi_OrZzKmmmDOHN14D1p1BN-9AwWt0YZ4ts,42362
 assignment_codeval/export_tests.py,sha256=IDAlGAp3zk-K5AFwLr85v4w9_WcYr6HXVF0joi4eYTg,5467
 assignment_codeval/file_utils.py,sha256=RDgAgmyIOLKvRlxbAr-zILz2A24zSr-r3--p-dxl4G8,2132
 assignment_codeval/github_connect.py,sha256=AP7mZPhzKKK8fxS-3JMfG6AQ-1wUutfsq-Bt-KG9WUs,4270
 assignment_codeval/install_assignment.py,sha256=HsXzTex4G-U3t4tb-HyQ2AobBDBPcKeR6oAUDFqBP-A,4599
 assignment_codeval/recent_comments.py,sha256=lmGjr5rcpdP6Q69AjG8kSsgOFQgdeyL8XcbNvwqGk-Q,9102
-assignment_codeval/submissions.py,sha256=Qn9YRbsid47azmg3Ev_aRJHprUOHHuL1I38vibgmfXY,29882
+assignment_codeval/submissions.py,sha256=93lLooN3eI0hTc3ZdUGoMwIQkWragjkuyePuvcU52tk,30431
 assignment_codeval/test_template.html,sha256=lgWsin5sYE_Pwjp3xqa7_UT-yZ4dWrVqAvNlSBBiNMI,2584
-assignment_codeval-0.0.29.dist-info/METADATA,sha256=I7x-a47l5flYi-8VN7jHkEsXM2ZL8Xv9fM7rMrEJYXs,15988
-assignment_codeval-0.0.29.dist-info/WHEEL,sha256=YCfwYGOYMi5Jhw2fU4yNgwErybb2IX5PEwBKV4ZbdBo,91
-assignment_codeval-0.0.29.dist-info/entry_points.txt,sha256=Pk0eAhsXBpCsgkv6HYLSHTRf5x_zUf-Lg8KK9KsK2B8,66
-assignment_codeval-0.0.29.dist-info/top_level.txt,sha256=a_P8W2IWjAELxKlTV2t4rLwWVoTxElxUMvWgWjR_1n4,19
-assignment_codeval-0.0.29.dist-info/RECORD,,
+assignment_codeval-0.0.30.dist-info/METADATA,sha256=GeGmxlA9BNfAo_s-4VnpfKKy90LKau0SRPAYIAjfzLY,16730
+assignment_codeval-0.0.30.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+assignment_codeval-0.0.30.dist-info/entry_points.txt,sha256=Pk0eAhsXBpCsgkv6HYLSHTRf5x_zUf-Lg8KK9KsK2B8,66
+assignment_codeval-0.0.30.dist-info/top_level.txt,sha256=a_P8W2IWjAELxKlTV2t4rLwWVoTxElxUMvWgWjR_1n4,19
+assignment_codeval-0.0.30.dist-info/RECORD,,

{assignment_codeval-0.0.29.dist-info → assignment_codeval-0.0.30.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (82.0.0)
+Generator: setuptools (82.0.1)
 Root-Is-Purelib: true
 Tag: py3-none-any