[Feature:Plagiarism] compare with prior term gradeables (#42)

* Initial rewrite of process_all.sh

* Update process_all.sh

* Make modifications to file paths and add timers

* Overhaul concatenate_all.py

* Implement all versions/active version feature

* Fix python errors

* Progress: everything through tokenization finished

* Everything works

* Add timers

* remove unnecessary code

* little python changes

* William made an oopsie (forgot to deal with provided code)

* Fix minor bugs

Fix process_all.sh script plus fix spelling issue and prevent hash_all.py from breaking when empty tokenized files are written

* Fix permissions issue with provided code editing

* Remove typo

* Remove unnecessary print statement

* Modify compare_hashes

* Add support for other gradeables to concatenate_all.py

* Add support for other gradeables to tokenize_all.py; check permissions in concatenate_all.py

* Implement hash ally

* Fix python error

* Fix another python error...

* Bug fixes

* Bug fixes + progress

* Fix individual ranking files

* Clarify console message when compare_hashes complete

* Change annoying separator

* tiny formatting

Co-authored-by: sbelsk <shellybelsky02@gmail.com>

Author: williamjallen

bin/concatenate_all.py

@@ -10,6 +10,7 @@
 import sys
 import time
 import fnmatch
+from pathlib import Path
 
 IGNORED_FILES = [
     ".submit.timestamp"
@@ -35,7 +36,7 @@ def getConcatFilesInDir(input_dir, regex_patterns):
             absolute_path = os.path.join(my_dir, my_file)
             # print a separator & filename
             with open(absolute_path, encoding='ISO-8859-1') as tmp:
-                result += f"=============== {my_file} ===============\n"
+                result += f"==== {my_file} ====\n"
                 # append the contents of the file
                 result += tmp.read() + "\n"
     return result
@@ -70,6 +71,7 @@ def main():
     users_to_ignore = config["ignore_submissions"]
     regex_patterns = config["regex"].split(',')
     regex_dirs = config["regex_dirs"]
+    prior_term_gradeables = config["prior_term_gradeables"]
 
     # ==========================================================================
     # Error checking
@@ -80,6 +82,22 @@ def main():
             print('ERROR! Invalid path component ".." in regex')
             exit(1)
 
+    for ptg in prior_term_gradeables:
+        for field in ptg:
+            if ".." in field:
+                print('ERROR! Invalid path component ".." in prior_term_gradeable field')
+                exit(1)
+
+    # check permissions to make sure we have access to the prior term gradeables
+    my_course_group_perms = Path(args.basepath).group()
+    for ptg in prior_term_gradeables:
+        if Path(args.datapath, ptg["prior_semester"], ptg["prior_course"]).group()\
+           != my_course_group_perms:
+            print(f"Error: Invalid permissions to access course {ptg['prior_semester']}"
+                  f"/{ptg['prior_course']}")
+            exit(1)
+
+    # make sure the regex directory is one of the acceptable directories
     for dir in regex_dirs:
         if dir not in ["submissions", "results", "checkout"]:
             print("ERROR! ", dir, " is not a valid input directory for Lichen")
@@ -124,6 +142,50 @@ def main():
                     concatenated_contents = getConcatFilesInDir(version_path, regex_patterns)
                     output_file.write(concatenated_contents)
 
+    # ==========================================================================
+    # loop over all of the other prior term gradeables and concatenate their submissions
+    for other_gradeable in prior_term_gradeables:
+        for dir in regex_dirs:
+            other_gradeable_path = os.path.join(args.datapath,
+                                                other_gradeable["prior_semester"],
+                                                other_gradeable["prior_course"],
+                                                dir,
+                                                other_gradeable["prior_gradeable"])
+            # loop over each user
+            for other_user in sorted(os.listdir(other_gradeable_path)):
+                other_user_path = os.path.join(other_gradeable_path, other_user)
+                if not os.path.isdir(other_user_path):
+                    continue
+
+                if version_mode == "active_version":
+                    # get the user's active version from their settings file
+                    other_submissions_details_path = os.path.join(other_user_path,
+                                                                  'user_assignment_settings.json')
+
+                    with open(other_submissions_details_path) as other_details_file:
+                        other_details_json = json.load(other_details_file)
+                        my_active_version = int(other_details_json["active_version"])
+
+                # loop over each version
+                for other_version in sorted(os.listdir(other_user_path)):
+                    other_version_path = os.path.join(other_user_path, other_version)
+                    if not os.path.isdir(other_version_path):
+                        continue
+
+                    other_output_file_path = os.path.join(args.basepath, "other_gradeables",
+                                                          f"{other_gradeable['prior_semester']}__{other_gradeable['prior_course']}__{other_gradeable['prior_gradeable']}",  # noqa: E501
+                                                          other_user, other_version,
+                                                          "submission.concatenated")
+
+                    if not os.path.exists(os.path.dirname(other_output_file_path)):
+                        os.makedirs(os.path.dirname(other_output_file_path))
+
+                    # append to concatenated file
+                    with open(other_output_file_path, "a") as other_output_file:
+                        other_concatenated_contents = getConcatFilesInDir(other_version_path,
+                                                                          regex_patterns)
+                        other_output_file.write(other_concatenated_contents)
+
     # ==========================================================================
     # iterate over all of the created submissions, checking to see if they are empty
     # and adding a message to the top if so (to differentiate empty files from errors in the UI)
@@ -136,6 +198,21 @@ def main():
                 if my_cf.read() == "":
                     my_cf.write("Error: No files matched provided regex in selected directories")
 
+    # do the same for the other gradeables
+    for other_gradeable in prior_term_gradeables:
+        other_gradeable_dir_name = f"{other_gradeable['prior_semester']}__{other_gradeable['prior_course']}__{other_gradeable['prior_gradeable']}"  # noqa: E501
+        for other_user in os.listdir(os.path.join(args.basepath, "other_gradeables",
+                                                  other_gradeable_dir_name)):
+            other_user_path = os.path.join(args.basepath, "other_gradeables",
+                                           other_gradeable_dir_name, other_user)
+            for other_version in os.listdir(other_user_path):
+                other_version_path = os.path.join(other_user_path, other_version)
+                my_concatenated_file = os.path.join(other_version_path, "submission.concatenated")
+                with open(my_concatenated_file, "r+") as my_cf:
+                    if my_cf.read() == "":
+                        my_cf.write("Error: No files matched provided regex in"
+                                    "selected directories")
+
     # ==========================================================================
     # concatenate provided code
     with open(os.path.join(args.basepath, "provided_code",

bin/hash_all.py

@@ -60,8 +60,8 @@ def main():
     sys.stdout.write("HASH ALL...")
     sys.stdout.flush()
 
-    # =========================================================================
-    # walk the subdirectories
+    # ==========================================================================
+    # walk the subdirectories of this gradeable
     users_dir = os.path.join(args.basepath, "users")
     if not os.path.isdir(users_dir):
         print("Error: Unable to find users directory")
@@ -81,7 +81,34 @@ def main():
             my_hashes_file = os.path.join(my_dir, "hashes.txt")
             hasher(lichen_config_data, my_tokenized_file, my_hashes_file)
 
-    # ===========================================================================
+    # ==========================================================================
+    # walk the subdirectories of the other gradeables
+
+    other_gradeables_dir = os.path.join(args.basepath, "other_gradeables")
+    if not os.path.isdir(other_gradeables_dir):
+        print("Error: Unable to find other gradeables directory")
+        exit(1)
+
+    for other_gradeable in sorted(os.listdir(other_gradeables_dir)):
+        other_gradeable_dir = os.path.join(other_gradeables_dir, other_gradeable)
+        if not os.path.isdir(other_gradeable_dir):
+            continue
+
+        for other_user in sorted(os.listdir(other_gradeable_dir)):
+            other_user_dir = os.path.join(other_gradeable_dir, other_user)
+            if not os.path.isdir(other_user_dir):
+                continue
+
+            for other_version in sorted(os.listdir(other_user_dir)):
+                other_version_dir = os.path.join(other_user_dir, other_version)
+                if not os.path.isdir(other_version_dir):
+                    continue
+
+                other_tokenized_file = os.path.join(other_version_dir, "tokens.json")
+                other_hashes_file = os.path.join(other_version_dir, "hashes.txt")
+                hasher(lichen_config_data, other_tokenized_file, other_hashes_file)
+
+    # ==========================================================================
     # hash the provided code
     provided_code_tokenized = os.path.join(args.basepath, "provided_code", "tokens.json")
     provided_code_hashed = os.path.join(args.basepath, "provided_code", "hashes.txt")

bin/tokenize_all.py

@@ -53,7 +53,7 @@ def main():
         lichen_config_data = json.load(lichen_config)
 
     # ===========================================================================
-    # walk the subdirectories
+    # walk the subdirectories to tokenize this gradeable's submissions
     users_dir = os.path.join(args.basepath, "users")
     if not os.path.isdir(users_dir):
         print("Error: Unable to find users directory")
@@ -73,6 +73,32 @@ def main():
             my_tokenized_file = os.path.join(my_dir, "tokens.json")
             tokenize(lichen_config_data, my_concatenated_file, my_tokenized_file)
 
+    # ===========================================================================
+    # tokenize the other prior term gradeables' submissions
+    other_gradeables_dir = os.path.join(args.basepath, "other_gradeables")
+    if not os.path.isdir(other_gradeables_dir):
+        print("Error: Unable to find other gradeables directory")
+        exit(1)
+
+    for other_gradeable in sorted(os.listdir(other_gradeables_dir)):
+        other_gradeable_dir = os.path.join(other_gradeables_dir, other_gradeable)
+        if not os.path.isdir(other_gradeable_dir):
+            continue
+
+        for other_user in sorted(os.listdir(other_gradeable_dir)):
+            other_user_dir = os.path.join(other_gradeable_dir, other_user)
+            if not os.path.isdir(other_user_dir):
+                continue
+
+            for other_version in sorted(os.listdir(other_user_dir)):
+                other_version_dir = os.path.join(other_user_dir, other_version)
+                if not os.path.isdir(other_version_dir):
+                    continue
+
+                other_concatenated_file = os.path.join(other_version_dir, "submission.concatenated")
+                other_tokenized_file = os.path.join(other_version_dir, "tokens.json")
+                tokenize(lichen_config_data, other_concatenated_file, other_tokenized_file)
+
     # ===========================================================================
     # tokenize the provided code
     provided_code_concat = os.path.join(args.basepath, "provided_code", "submission.concatenated")