[Testing:Developer] Automated ShellCheck linting (Submitty#8269)

Co-authored-by: Viyerelu23333 <[email protected]>

Author: williamjallen

.github/workflows/submitty_ci.yml

@@ -236,6 +236,17 @@ jobs:
             flags: autograder
 
 
+    shellcheck:
+      name: ShellCheck
+      runs-on: ubuntu-20.04
+      steps:
+        - uses: actions/checkout@v2
+        - name: install ShellCheck
+          run: sudo apt-get install -y shellcheck
+        - name: Run ShellCheck
+          run: python3 run_shellcheck.py  # Uses the default Python installed with Ubuntu
+
+
     e2e:
         needs:
           - js-lint
@@ -245,6 +256,7 @@ jobs:
           - python-lint
           - python-unit
           - css-lint
+          - shellcheck
         runs-on: ubuntu-20.04
         services:
           postgres:

.shellcheckignore

@@ -0,0 +1,36 @@
+site/**/*.sh
+tests/**/*.sh
+.git/**/*.sh
+.setup/INSTALL_SUBMITTY_HELPER.sh
+.setup/bootstrap.sh
+.setup/common/common_env.sh
+.setup/testing/print_debug.sh
+.setup/testing/before_install.sh
+.setup/testing/autograder.sh
+.setup/testing/setup_test_suite.sh
+.setup/testing/setup_ldap.sh
+.setup/testing/setup.sh
+.setup/vagrant/db_users.sh
+.setup/install_submitty/install_bin.sh
+.setup/install_submitty/install_site.sh
+.setup/vagrant/setup_vagrant.sh
+.setup/vagrant/setup_ldap.sh
+.setup/update_system.sh
+.setup/bin/recreate_sample_courses.sh
+.setup/bin/update_googlefonts.sh
+.setup/bin/versions.sh
+.setup/bin/MatlabInstall.sh
+.setup/bin/update_repos.sh
+.setup/install_system.sh
+.setup/distro_setup/ubuntu/16.04/setup_distro.sh
+.setup/distro_setup/ubuntu/18.04/setup_distro.sh
+.setup/distro_setup/ubuntu/20.04/setup_distro.sh
+.setup/distro_setup/ubuntu/rpi.sh
+.setup/distro_setup/setup_distro.sh
+.setup/distro_setup/debian/8/setup_distro.sh
+sbin/create_term.sh
+sbin/killall_shippers_and_workers.sh
+sbin/create_course.sh
+sbin/replay_experiment_script.sh
+sbin/build_course.sh
+bin/build_homework_function.sh

run_shellcheck.py

@@ -0,0 +1,29 @@
+# This script serves as a wrapper around ShellCheck to run ShellCheck only
+# files listed in the .shellcheckignore script since ShellCheck does not support
+# this functionality by default
+
+from pathlib import Path
+import subprocess
+
+ignored_files = set()
+with open('.shellcheckignore', 'r') as ignore_file:
+    for line in map(str.strip, ignore_file.readlines()):
+        if '*' in line:
+            ignored_files.update(Path('.').rglob(line))
+        else:
+            ignored_files.add(Path('.') / line)
+
+all_shell_scripts = set(Path('.').rglob('*.sh'))
+
+shell_scripts_to_check = [str(x) for x in all_shell_scripts.difference(ignored_files)]
+
+return_code = 0
+for script in shell_scripts_to_check:
+    process = subprocess.run(['shellcheck', '-Calways', script], stdout=subprocess.PIPE)
+    out = process.stdout.decode("utf-8")
+    if out != '':
+        print(out)
+    if process.returncode != 0:
+        return_code = process.returncode
+
+exit(return_code)