otter-service-stdalone 1.1.29__tar.gz → 1.1.31__tar.gz

{otter_service_stdalone-1.1.29 → otter_service_stdalone-1.1.31}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: otter_service_stdalone
-Version: 1.1.29
+Version: 1.1.31
 Summary: Grading Service for Instructors using Otter Grader
 Home-page: https://github.com/sean-morris/otter-service-stdalone
 Author: Sean Morris

otter_service_stdalone-1.1.31/src/otter_service_stdalone/__init__.py

@@ -0,0 +1 @@
+__version__ = "1.1.31"

{otter_service_stdalone-1.1.29 → otter_service_stdalone-1.1.31}/src/otter_service_stdalone/app.py

@@ -181,7 +181,7 @@ class Download(BaseHandler):
             m = "Download: Code Not Given!"
             log.write_logs(download_code, m, f"{download_code}", "debug", log_debug)
             msg = "Please enter the download code to see your result."
-            self.render("index.html",  download_message=msg)
+            self.render("index.html", download_message=msg)
         elif not os.path.exists(f"{directory}"):
             m = "Download: Directory for Code Not existing"
             log.write_logs(download_code, m, f"{download_code}", "debug", log_debug)
@@ -210,7 +210,7 @@ class Download(BaseHandler):
                         zipF.write(f"{file_path}", f_path, compress_type=ZIP_DEFLATED)
                 read_me = os.path.join(os.path.dirname(__file__), "static_files", "README_DO_NOT_DISTRIBUTE.txt")
                 zipF.write(read_me, "README_DO_NOT_DISTRIBUTE.txt", compress_type=ZIP_DEFLATED)
-            
+
             download_label = f"{'-'.join(download_code.split('-')[:-5])}-results.zip"
             self.set_header('Content-Type', 'application/octet-stream')
             self.set_header("Content-Description", "File Transfer")
@@ -272,7 +272,7 @@ class Upload(BaseHandler):
             if not os.path.exists(__UPLOADS__):
                 os.mkdir(__UPLOADS__)
             auto_p = f"{__UPLOADS__}/{autograder_name}"
-            
+
             notebooks_path = f"{__UPLOADS__}/{notebooks_name}"
             m = "Step 2a: Uploaded File Names Determined"
             log.write_logs(results_path, m, f"notebooks path: {notebooks_path}", "debug", log_debug)
@@ -302,6 +302,7 @@ class Upload(BaseHandler):
                 try:
                     session_queues[user_id][results_path] = Queue()
                     session_messages[user_id][results_path] = []
+
                     await g.grade(auto_p, notebooks_path, autograder_orig_name, results_path, session_queues[user_id].get(results_path))
                 except Exception as e:
                     log.write_logs(results_path, "Grading Problem", str(e), "error", log_error)
@@ -346,16 +347,16 @@ settings = {
 }
 
 application = tornado.web.Application([
-        (r"/", MainHandler),
-        (r"/login", LoginHandler),
-        (r"/upload", Upload),
-        (r"/download", Download),
-        (r"/update", WebSocketHandler),
-        (r"/remove/([a-zA-Z0-9\-]+)", RemoveProgressHandler),
-        (r"/oauth_callback", GitHubOAuthHandler),
-        (r"/otterhealth", HealthHandler),
-        (r"/scripts/(.*)", tornado.web.StaticFileHandler, {"path": os.path.join(os.path.dirname(__file__), "scripts")}),
-        ], **settings, debug=False)
+    (r"/", MainHandler),
+    (r"/login", LoginHandler),
+    (r"/upload", Upload),
+    (r"/download", Download),
+    (r"/update", WebSocketHandler),
+    (r"/remove/([a-zA-Z0-9\-]+)", RemoveProgressHandler),
+    (r"/oauth_callback", GitHubOAuthHandler),
+    (r"/otterhealth", HealthHandler),
+    (r"/scripts/(.*)", tornado.web.StaticFileHandler, {"path": os.path.join(os.path.dirname(__file__), "scripts")}),
+], **settings, debug=False)
 
 
 def main():

{otter_service_stdalone-1.1.29 → otter_service_stdalone-1.1.31}/src/otter_service_stdalone/grade_notebooks.py

@@ -6,6 +6,7 @@ from otter.grade import main as grade
 from otter import logging as loggers
 from multiprocessing import Process
 from tornado.ioloop import PeriodicCallback
+from .util import clean_directory
 
 log_debug = f'{os.environ.get("ENVIRONMENT")}-debug'
 log_count = f'{os.environ.get("ENVIRONMENT")}-count'
@@ -43,6 +44,10 @@ class GradeNotebooks():
         """
         try:
             notebook_folder = uh.handle_upload(notebooks_path, results_id)
+
+            # remove special characters from notebooks and remove hidden folders
+            clean_directory(notebook_folder)
+
             notebook_count = self.count_ipynb_files(notebook_folder, ".ipynb")
             log.write_logs(results_id, f"{notebook_count}",
                            "",

{otter_service_stdalone-1.1.29 → otter_service_stdalone-1.1.31}/src/otter_service_stdalone/util.py

@@ -2,6 +2,7 @@ import re
 import zipfile
 from packaging import version
 import os
+import shutil
 
 
 def is_version_6_or_greater(zip_ref, target_file, reg):
@@ -39,3 +40,37 @@ def otter_version_correct(autograder_path):
         otter_in_req = is_version_6_or_greater(zip_ref, req_target_file, requirements_regex)
         otter_in_env = is_version_6_or_greater(zip_ref, env_target_file, environment_regex)
         return otter_in_req or otter_in_env
+
+
+def sanitize_filename(filename: str) -> str:
+    """
+    Remove periods and commas from filename except the extension dot.
+    """
+    # Split name and extension
+    name, ext = os.path.splitext(filename)
+    # Remove periods and commas from the name part
+    clean_name = name.replace('.', '').replace(',', '')
+    return f"{clean_name}{ext}"
+
+
+def clean_directory(path: str):
+    """
+    Delete hidden folders like __MACOSX and sanitize all file names in the directory tree.
+    """
+    for root, dirs, files in os.walk(path, topdown=True):
+        # Remove hidden/system folders
+        for dir_name in list(dirs):
+            if dir_name.startswith('.') or dir_name == '__MACOSX':
+                dir_path = os.path.join(root, dir_name)
+                print(f"Deleting folder: {dir_path}")
+                shutil.rmtree(dir_path)
+                dirs.remove(dir_name)  # remove from list to avoid walking it
+
+        # Sanitize file names
+        for file_name in files:
+            old_path = os.path.join(root, file_name)
+            new_name = sanitize_filename(file_name)
+            new_path = os.path.join(root, new_name)
+            if old_path != new_path:
+                print(f"Renaming {old_path} -> {new_path}")
+                os.rename(old_path, new_path)

{otter_service_stdalone-1.1.29 → otter_service_stdalone-1.1.31}/src/otter_service_stdalone.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: otter_service_stdalone
-Version: 1.1.29
+Version: 1.1.31
 Summary: Grading Service for Instructors using Otter Grader
 Home-page: https://github.com/sean-morris/otter-service-stdalone
 Author: Sean Morris

otter_service_stdalone-1.1.31/tests/test_util.py

@@ -0,0 +1,32 @@
+import otter_service_stdalone.util as util
+import shutil
+import os
+import re
+
+
+def test_autograder_zip_version():
+    a1 = "tests/files/hw01-autograder_6_0_4.zip"
+    a2 = "tests/files/hw02-autograder_6_1_0.zip"
+    a3 = "tests/files/hw02-autograder_5_5_0.zip"
+    a4 = "tests/files/hw03-autograder_6_1_3.zip"
+    assert util.otter_version_correct(a1) is False
+    assert util.otter_version_correct(a2) is False
+    assert util.otter_version_correct(a3) is False
+    assert util.otter_version_correct(a4) is False
+
+
+def test_clean_directory():
+    clean_this_dir = "tests/files/clean_up_dir"
+    tmp_dir = clean_this_dir + "_tmp"
+    shutil.copytree(clean_this_dir, tmp_dir)
+    util.clean_directory(tmp_dir)
+    allowed_pattern = re.compile(r'^[\w\-]+(\.[\w\-]+)?$')
+    for root, dirs, files in os.walk(tmp_dir):
+        for d in dirs:
+            assert not d.startswith('.') and d != '__MACOSX', f"Hidden dir found: {d}"
+            assert allowed_pattern.match(d), f"Invalid characters in directory name: {d}"
+
+        for f in files:
+            assert not f.startswith('.'), f"Hidden file found: {f}"
+            assert allowed_pattern.match(f), f"Invalid characters in filename: {f}"
+    shutil.rmtree(tmp_dir)

otter_service_stdalone-1.1.29/src/otter_service_stdalone/__init__.py

@@ -1 +0,0 @@
-__version__ = "1.1.29"

otter_service_stdalone-1.1.29/tests/test_util.py

@@ -1,10 +0,0 @@
-import otter_service_stdalone.util as util
-
-
-def test_autograder_zip_version():
-    a1 = "tests/files/hw01-autograder_6_0_4.zip"
-    a2 = "tests/files/hw02-autograder_6_1_0.zip"
-    a3 = "tests/files/hw02-autograder_5_5_0.zip"
-    assert util.otter_version_correct(a1) is True
-    assert util.otter_version_correct(a2) is True
-    assert util.otter_version_correct(a3) is False