[Bugfix:System] Fix code spelling issues (Submitty#8583)

Co-authored-by: Cameron Peterson <[email protected]>
Co-authored-by: Preston Carman <[email protected]>

.github/workflows/submitty_ci.yml

@@ -543,7 +543,7 @@ jobs:
           - name: Switch to database auth
             run:  sudo sed -ie "s/Pam/Database/g" ${SUBMITTY_INSTALL_DIR}/config/authentication.json
 
-          - name: Run cypress e2e login tests with databse auth
+          - name: Run cypress e2e login tests with database auth
             uses: cypress-io/github-action@v4
             with:
               config: baseUrl=http://localhost

.setup/apache/submitty.conf

@@ -3,7 +3,7 @@
 <VirtualHost *:80>
     AddDefaultCharset utf-8
 
-    # Set the email address of your webmaster/sysadmin to be displayed incase
+    # Set the email address of your webmaster/sysadmin to be displayed in case
     # of 500 errors
     ServerAdmin [email protected]
 
@@ -30,7 +30,7 @@
 
     # Disables use of .htaccess for Submitty. While this is technically
     # the default for Apache (as of 2.3.9), we leave this here just
-    # to make sure we don't ever accidently start allowing .htaccess
+    # to make sure we don't ever accidentally start allowing .htaccess
     <Directory />
         AllowOverride None
     </Directory>

.setup/bin/reset_system.py

@@ -4,7 +4,7 @@
 Script to reset the vagrant box and the configurations that install_system does
 to set up the submitty system with regards to apache, postgresql, etc. This then
 allows for install_system.sh to run cleanly and not end up with duplicate lines
-in configuration files or pre-existing databses.
+in configuration files or pre-existing databases.
 """
 
 from __future__ import print_function

.setup/bin/reupload_old_assignments.py

@@ -41,7 +41,7 @@
 # 5) The optional argument --grade, which causes the uploaded assignments to be added to the grading queue.
 
 #NOTE: variables beginning with ARCHIVED_ are populated using the homework assignment being copied.
-#Varialbes beginning with CURRENT_ are populated using the destination/current semester's directories.
+#Variables beginning with CURRENT_ are populated using the destination/current semester's directories.
 def main():
     #In order to successfully re-upload the assignment, we need the directory of the assignment to be inflated,
     #and the semester, course name, and assignment name that it should be uploaded to.

.setup/bin/setup_sample_courses.py

@@ -66,7 +66,7 @@
 
 def main():
     """
-    Main program execution. This gets us our commandline arugments, reads in the data files,
+    Main program execution. This gets us our commandline arguments, reads in the data files,
     and then sets us up to run the create methods for the users and courses.
     """
     global DB_ONLY, NO_SUBMISSIONS, NO_GRADING
@@ -106,7 +106,7 @@ def main():
     # permission errors exist) which ends up with just having a ton of
     # build failures. Better to wait on grading any homeworks until
     # we've done all steps of setting up a course.
-    print("pausing the autograding and jobs hander daemons")
+    print("pausing the autograding and jobs handler daemons")
     os.system("systemctl stop submitty_autograding_shipper")
     os.system("systemctl stop submitty_autograding_worker")
     os.system("systemctl stop submitty_daemon_jobs_handler")
@@ -265,10 +265,10 @@ def get_random_text_from_file(filename):
     line = ""
     with open(os.path.join(SETUP_DATA_PATH, 'random', filename)) as comment:
         line = next(comment)
-        for num, aline in enumerate(comment):
+        for num, alternate_line in enumerate(comment):
             if random.randrange(num + 2):
                 continue
-            line = aline
+            line = alternate_line
     return line.strip()
 
 
@@ -552,8 +552,8 @@ def create_gradeable_submission(src, dst):
 
 def create_pdf_annotations(file_name, file_path, src, dst, grader_id):
     """
-    Specifically designed helper funtion that copys a annotation from the source to the destination.
-    The source annotation need to be modifed to reflect:
+    Specifically designed helper function that copies a annotation from the source to the destination.
+    The source annotation need to be modified to reflect:
         the file that the annotations belongs to
         the grader that is responsible for the annotation
 

.setup/data/courses/plagiarism.yml

@@ -341,7 +341,7 @@ gradeables:
 ########## LARGE -- 10+ submissions ############################################
 ########## stress-testing (probably challenging/impossible to debug) ###########
 - g_id: average_class_single_submission
-  g_title: Average Class Single Submission (Large) # 75 students, 1 submission per student, ~100-line files (3 codewars problems, seperate files, zipped into one file)
+  g_title: Average Class Single Submission (Large) # 75 students, 1 submission per student, ~100-line files (3 codewars problems, separate files, zipped into one file)
   gradeable_config: upload_only
   components:
   - gc_lower_clamp: 0

.setup/data/courses/sample.yml

@@ -1290,7 +1290,7 @@ gradeables:
   gradeable_config: upload_only
   g_bucket: homework
 
-# For no autograding, still need components, but also ned eg_use_ta_grading flag
+# For no autograding, still need components, but also need eg_use_ta_grading flag
 - g_id: grades_released_homework_onlyauto
   components:
   - gc_lower_clamp: 0

.setup/data/forum/posts.txt

@@ -11,7 +11,7 @@
   4 |  9 | aphacker | Thanks! | 2018-04-03 19:39:46.032541-04 | f | f | | f | 0 | f
   5 | -1 | kessll | Can anyone share few good links for `python` beginner? | 2018-05-23 10:55:22.192817-04 | f | f |  | f | 0 | f
   5 | 12 | renneh | Try this for quick overview\n[url=https://developers.google.com/edu/python/introduction]https://developers.google.com/edu/python/introduction[/url]\n | 2018-05-23 11:01:11.483217-04 | f | f |  | f | 0 | f
-  5 | 12 | rueckm | Offical documentation is better for methods specific search.\n[url=https://docs.python.org/3/contents.html]https://docs.python.org/3/contents.html[/url]\n | 2018-05-23 11:07:24.611849-04 | f | f |  | f | 0 | f
+  5 | 12 | rueckm | Official documentation is better for methods specific search.\n[url=https://docs.python.org/3/contents.html]https://docs.python.org/3/contents.html[/url]\n | 2018-05-23 11:07:24.611849-04 | f | f |  | f | 0 | f
   5 | 12 | vonruf | I tried [url=https://www.w3schools.com/python/]https://www.w3schools.com/python/[/url] | 2018-05-23 11:14:41.912376-04 | f | f |  | f | 0 | f
   6 | -1 | bitdiddle | Can someone share multithreading example snippets in C++ | 2018-05-23 11:45:24.049959-04 | f | f |  | f | 0 | f
   6 | 16 | baliss | Sample code snippet\n[code]\n#include <iostream>\n#include <thread>\nvoid foo(std::string msg)\n{\n    std::cout<<msg<<std::endl;\n}\nint main() {\n   std::thread t1(foo, "Test 1");\n   std::thread t2(foo, "Test 2");\n   t1.join();\n   t2.join();\n   return 0;\n}\n[/code]\n | 2018-05-23 11:46:14.864177-04 | f | f |  | f | 0 | f

.setup/php-fpm/pool.d/submitty.conf

@@ -133,7 +133,7 @@ pm.max_spare_servers = 6
 ;pm.max_requests = 500
 
 ; The URI to view the FPM status page. If this value is not set, no URI will be
-; recognized as a status page. It shows the following informations:
+; recognized as a status page. It shows the following information:
 ;   pool                 - the name of the pool;
 ;   process manager      - static, dynamic or ondemand;
 ;   start time           - the date and time FPM has started;
@@ -203,8 +203,8 @@ pm.max_spare_servers = 6
 ;                          it's always 0 if the process is not in Idle state
 ;                          because memory calculation is done when the request
 ;                          processing has terminated;
-; If the process is in Idle state, then informations are related to the
-; last request the process has served. Otherwise informations are related to
+; If the process is in Idle state, then information are related to the
+; last request the process has served. Otherwise information are related to
 ; the current request being served.
 ; Example output:
 ;   ************************
@@ -265,13 +265,13 @@ pm.max_spare_servers = 6
 ;  %d: time taken to serve the request
 ;      it can accept the following format:
 ;      - %{seconds}d (default)
-;      - %{miliseconds}d
+;      - %{milliseconds}d
 ;      - %{mili}d
 ;      - %{microseconds}d
 ;      - %{micro}d
 ;  %e: an environment variable (same as $_ENV or $_SERVER)
 ;      it must be associated with embraces to specify the name of the env
-;      variable. Some exemples:
+;      variable. Some examples:
 ;      - server specifics like: %{REQUEST_METHOD}e or %{SERVER_PROTOCOL}e
 ;      - HTTP headers like: %{HTTP_HOST}e or %{HTTP_USER_AGENT}e
 ;  %f: script filename
@@ -358,7 +358,7 @@ pm.max_spare_servers = 6
 
 ; Redirect worker stdout and stderr into main error log. If not set, stdout and
 ; stderr will be redirected to /dev/null according to FastCGI specs.
-; Note: on highloaded environement, this can cause some delay in the page
+; Note: on highloaded environment, this can cause some delay in the page
 ; process time (several ms).
 ; Default Value: no
 ;catch_workers_output = yes
@@ -375,7 +375,7 @@ pm.max_spare_servers = 6
 ; Limits the extensions of the main script FPM will allow to parse. This can
 ; prevent configuration mistakes on the web server side. You should only limit
 ; FPM to .php extensions to prevent malicious users to use other extensions to
-; exectute php code.
+; execute php code.
 ; Note: set an empty value to allow all extensions.
 ; Default Value: .php
 ;security.limit_extensions = .php .php3 .php4 .php5 .php7

LICENSE-THIRD-PARTY.md

@@ -2,7 +2,7 @@ Third Party Licenses
 ====================
 
 While Submitty is made available under the [BSD "3-Clause" License](https://github.com/Submitty/Submitty/blob/master/LICENSE.md) 
-we utilize several third-party libraries to help power various components. Below is a list of these components and their relavent copyrights, copied when the source was included/last updated within Submitty.
+we utilize several third-party libraries to help power various components. Below is a list of these components and their relevant copyrights, copied when the source was included/last updated within Submitty.
 
 
 | Component | Copyright | Url | License |

README_utm_arm.txt

@@ -141,7 +141,7 @@ On an M1 Mac laptop, we cannot use virtual box, so follow these instructions ins
 
    sudo apt install -y spice-vdagent spice-webdavd
    sudo apt install -y davfs2
-       * Answer the question "YES" and grant access to unpriviledged users *
+       * Answer the question "YES" and grant access to unprivileged users *
    sudo mkdir -p /usr/local/submitty/GIT_CHECKOUT
 
    NOTE: The command below must be re-run each time the guest machine

autograder/autograder/execution_environments/rlimit_utils.py

@@ -38,7 +38,7 @@
 
 
 def build_ulimit_argument(resource_limits, container_image):
-    """Build --ulimit arguemtns for a particular gradeable."""
+    """Build --ulimit arguments for a particular gradeable."""
     arguments = []
     client = docker.from_env()
 

autograder/autograder/grade_item.py

@@ -96,9 +96,9 @@ def killall(config, which_untrusted, log_file):
     log_file.flush()
 
 
-def run_compilation(testcases, config, which_untrusted, seperator, log_file):
+def run_compilation(testcases, config, which_untrusted, separator, log_file):
     # COMPILE THE SUBMITTED CODE
-    print(f"{seperator}COMPILATION STARTS", file=log_file)
+    print(f"{separator}COMPILATION STARTS", file=log_file)
     log_file.flush()
     for tc in testcases:
         if tc.type != 'Execution' and not os.path.exists(tc.secure_environment.directory):
@@ -110,9 +110,9 @@ def run_compilation(testcases, config, which_untrusted, seperator, log_file):
     log_file.flush()
 
 
-def generate_input(testcases, config, which_untrusted, seperator, log_file):
+def generate_input(testcases, config, which_untrusted, separator, log_file):
     # GENERATE INPUT
-    print(f"{seperator}INPUT GENERATION STARTS", file=log_file)
+    print(f"{separator}INPUT GENERATION STARTS", file=log_file)
     for tc in testcases:
         if tc.has_input_generator_commands:
             tc.generate_random_inputs()
@@ -122,9 +122,9 @@ def generate_input(testcases, config, which_untrusted, seperator, log_file):
     log_file.flush()
 
 
-def run_execution(testcases, config, which_untrusted, seperator, log_file):
+def run_execution(testcases, config, which_untrusted, separator, log_file):
     # RUN EXECUTION TESTCASES
-    print(f"{seperator}RUNNER STARTS", file=log_file)
+    print(f"{separator}RUNNER STARTS", file=log_file)
     log_file.flush()
     for tc in testcases:
         if tc.type == 'Execution' and not os.path.exists(tc.secure_environment.directory):
@@ -135,9 +135,9 @@ def run_execution(testcases, config, which_untrusted, seperator, log_file):
     log_file.flush()
 
 
-def generate_output(testcases, config, which_untrusted, seperator, log_file):
+def generate_output(testcases, config, which_untrusted, separator, log_file):
     # RANDOM OUTPUT GENERATION
-    print(f"{seperator}OUTPUT GENERATION STARTS", file=log_file)
+    print(f"{separator}OUTPUT GENERATION STARTS", file=log_file)
     for tc in testcases:
         if tc.has_solution_commands:
             tc.generate_random_outputs()
@@ -151,7 +151,7 @@ def run_validation(
     testcases,
     config,
     which_untrusted,
-    seperator,
+    separator,
     queue_obj,
     tmp_work,
     is_vcs,
@@ -163,7 +163,7 @@ def run_validation(
     generate_all_output
 ):
     # VALIDATE STUDENT OUTPUT
-    print(f"{seperator}VALIDATION STARTS", file=log_file)
+    print(f"{separator}VALIDATION STARTS", file=log_file)
     log_file.flush()
 
     # Create a jailed sandbox to run validation inside of.
@@ -240,11 +240,11 @@ def archive(
     item_name,
     complete_config_obj,
     gradeable_config_obj,
-    seperator,
+    separator,
     log_file
 ):
     # ARCHIVE STUDENT RESULTS
-    print(f"{seperator}ARCHIVING STARTS", file=log_file)
+    print(f"{separator}ARCHIVING STARTS", file=log_file)
     log_file.flush()
     for tc in testcases:
         # Removes test input files, makes details directory for the testcase.
@@ -313,7 +313,7 @@ def grade_from_zip(
     tmp_results = os.path.join(working_directory, "TMP_RESULTS")
 
     # Used to separate sections of printed messages
-    seperator = "====================================\n"
+    separator = "====================================\n"
 
     # Open the JSON and timestamp files needed to grade. Initialize needed variables.
     with open(os.path.join(tmp_submission, "queue_file.json"), 'r') as infile:
@@ -353,7 +353,7 @@ def grade_from_zip(
         with open(os.path.join(tmp_logs, "overall.txt"), 'a') as overall_log:
             os.chdir(tmp_work)
 
-            generate_output(testcases, config, which_untrusted, seperator, overall_log)
+            generate_output(testcases, config, which_untrusted, separator, overall_log)
 
             archive(
                 testcases,
@@ -364,7 +364,7 @@ def grade_from_zip(
                 item_name,
                 complete_config_obj,
                 gradeable_config_obj,
-                seperator,
+                separator,
                 overall_log
             )
     else:
@@ -412,15 +412,15 @@ def grade_from_zip(
         with open(os.path.join(tmp_logs, "overall.txt"), 'a') as overall_log:
             os.chdir(tmp_work)
 
-            run_compilation(testcases, config, which_untrusted, seperator, overall_log)
-            generate_input(testcases, config, which_untrusted, seperator, overall_log)
-            run_execution(testcases, config, which_untrusted, seperator, overall_log)
-            generate_output(testcases, config, which_untrusted, seperator, overall_log)
+            run_compilation(testcases, config, which_untrusted, separator, overall_log)
+            generate_input(testcases, config, which_untrusted, separator, overall_log)
+            run_execution(testcases, config, which_untrusted, separator, overall_log)
+            generate_output(testcases, config, which_untrusted, separator, overall_log)
             run_validation(
                 testcases,
                 config,
                 which_untrusted,
-                seperator,
+                separator,
                 queue_obj,
                 tmp_work,
                 is_vcs,
@@ -440,7 +440,7 @@ def grade_from_zip(
                 item_name,
                 complete_config_obj,
                 gradeable_config_obj,
-                seperator,
+                separator,
                 overall_log
             )
 

autograder/autograder/insert_database_version_data.py

@@ -216,7 +216,7 @@ def insert_into_database(config, semester, course, gradeable_id, user_id, team_i
 def get_testcases(config, semester, course, g_id, notebook_data):
     """
     Get all the testcases for a homework from its build json file. This should have a 1-to-1
-    correspondance with the testcases that come from the results.json file.
+    correspondence with the testcases that come from the results.json file.
 
     :param semester:
     :param course:

autograder/tests/data/complete_config_cpp_cats.json

@@ -202,7 +202,7 @@
                 }
             ],
             "timestamped_stdout": false,
-            "title": "Regular char by char comparision",
+            "title": "Regular char by char comparison",
             "use_router": false,
             "validation": [
                 {
@@ -448,7 +448,7 @@
                 }
             ],
             "timestamped_stdout": false,
-            "title": "Regular char by char comparision NO PARTIAL CREDIT",
+            "title": "Regular char by char comparison NO PARTIAL CREDIT",
             "use_router": false,
             "validation": [
                 {

bin/generate_repos.py

@@ -78,7 +78,7 @@ def create_new_repo(folder, which_branch):
     # note: --initial-branch option requires git 2.28.0 or greater
     subprocess.run(['git', 'init', '--bare', '--shared', f'--initial-branch={which_branch}'])
 
-    # unfortuantely, when an empty repo with no branches is cloned,
+    # unfortunately, when an empty repo with no branches is cloned,
     # the active branch and HEAD does NOT default to the specified branch
 
     # so let's manually specify the initial branch

grading/change.h

@@ -7,7 +7,7 @@
 
 #include <nlohmann/json.hpp>
 
-/* DESCRIPTION: Contains the differences in a block for a student's ouput
+/* DESCRIPTION: Contains the differences in a block for a student's output
  * and the expected output */
 class Change {
 public:

grading/main_validator.cpp

@@ -375,7 +375,7 @@ void ValidateATestCase(nlohmann::json config_json, const TestCase my_testcase,
       std::cout << "Grade: " << testcase_pts << std::endl;
     }
 
-    // UPDATE CUMMULATIVE POINTS
+    // UPDATE CUMULATIVE POINTS
     automated_points_awarded += testcase_pts;
     if (!my_testcase.getHidden()) {
       nonhidden_automated_points_awarded += testcase_pts;