Self testing

.github/workflows/ci.yml

@@ -465,6 +465,7 @@ jobs:
               echo "http://localhost"             # submitty url
               echo ""                             # vcs url
               echo ""                             # institution name
+              echo "y"                            # user create account
               echo ""                             # sysadmin email
               echo ""                             # where to report
               echo "1"                            # PamAuth
@@ -698,6 +699,17 @@ jobs:
           spec: cypress/e2e/Cypress-System/login.spec.js
           working-directory: ${{env.SUBMITTY_REPOSITORY}}/site
           browser: chrome
+      - name: Switch to CI mode
+        run: |
+          sudo sed -ie '/is_ci/c\ \"is_ci\" : true,' /usr/local/submitty/config/submitty.json
+
+      - name: Run self-account-creation tests.
+        uses: cypress-io/github-action@v6
+        with:
+          config: baseUrl=http://localhost
+          spec: cypress/e2e/Cypress-System/self_account_creation.spec.js
+          working-directory: ${{env.SUBMITTY_REPOSITORY}}/site
+          browser: chrome
 
       - name: Switch to LDAP auth
         run: sudo sed -ie "s/Database/Ldap/g" ${SUBMITTY_INSTALL_DIR}/config/authentication.json
@@ -746,12 +758,18 @@ jobs:
           http_ver=$(curl -ksI https://localhost -o/dev/null -w "%{http_version}\n")
           [ "$http_ver" = "2" ] && echo "Pass" || echo "::warning::Failed"
 
+      - uses: actions/upload-artifact@v4
+        if: failure()
+        with:
+          name: Submitty-JSON
+          path: ${{env.SUBMITTY_INSTALL_DIR}}/config/submitty.json
 
       - uses: actions/upload-artifact@v4
         if: failure()
         with:
           name: cypress-screenshots
           path: ${{env.SUBMITTY_REPOSITORY}}/site/cypress/screenshots
+
       - uses: actions/upload-artifact@v4
         if: failure()
         with:

.setup/CONFIGURE_SUBMITTY.py

@@ -185,6 +185,7 @@ def __call__(self, parser, namespace, values, option_string=None):
     'authentication_method': 0,
     'institution_name' : '',
     'institution_homepage' : '',
+    'user_create_account' : False,
     'timezone' : str(tzlocal.get_localzone()),
     'submitty_admin_username': '',
     'email_user': '',
@@ -309,7 +310,16 @@ def __call__(self, parser, namespace, values, option_string=None):
             INSTITUTION_HOMEPAGE = ''
         print()
 
-
+    while True:
+        user_create_account = get_input("Enable Create New Account feature? [y/n]", 'y')
+        if (user_create_account.lower() in ['yes', 'y']):
+            USER_CREATE_ACCOUNT = True
+            break
+        elif (user_create_account.lower() in ['no', 'n']):
+            USER_CREATE_ACCOUNT = False
+            break
+    print()
+
     SYS_ADMIN_EMAIL = get_input("What is the email for system administration?", defaults['sys_admin_email'])
     SYS_ADMIN_URL = get_input("Where to report problems with Submitty (url for help link)?", defaults['sys_admin_url'])
 
@@ -445,6 +455,7 @@ def __call__(self, parser, namespace, values, option_string=None):
 
     config['institution_name'] = INSTITUTION_NAME
     config['institution_homepage'] = INSTITUTION_HOMEPAGE
+    config['user_create_account'] = USER_CREATE_ACCOUNT
     config['debugging_enabled'] = DEBUGGING_ENABLED
 
 # site_log_path is a holdover name. This could more accurately be called the "log_path"
@@ -616,7 +627,28 @@ def write(x=''):
 
 ##############################################################################
 # Write submitty json
+user_id_requirements = {
+    "all": True,
+    "require_name": False,
+    "min_length": 6,
+    "max_length": 25,
+    "name_requirements": {
+        "given_first": False,
+        "given_name": 2,
+        "family_name": 4
+    },
+    "require_email": False,
+    "email_requirements": {
+        "whole_email": False,
+        "whole_prefix": False,
+        "prefix_count": 6
+    }
+}
 
+accepted_emails = {
+    "gmail.com": True,
+    "rpi.edu": True
+}
 config = submitty_config
 config['submitty_install_dir'] = SUBMITTY_INSTALL_DIR
 config['submitty_repository'] = SUBMITTY_REPOSITORY
@@ -638,6 +670,10 @@ def write(x=''):
     config['timezone'] = TIMEZONE
     config['default_locale'] = DEFAULT_LOCALE
     config['duck_special_effects'] = False
+    config['user_create_account'] = USER_CREATE_ACCOUNT
+    config['accepted_emails'] = accepted_emails
+    config['user_id_requirements'] = user_id_requirements
+    config['is_ci'] = False
 
 config['worker'] = True if args.worker == 1 else False
 

.setup/ansible/roles/submitty_install/defaults/main.yml

@@ -11,6 +11,7 @@ submitty_install_language: en_US
 submitty_install_submitty_url: localhost
 submitty_install_vcs_url: git.localhost
 submitty_install_institution_name: Example University
+submitty_install_self_account_creation: n
 submitty_install_sysadmin_email: sysadmin@localhost
 submitty_install_submitty_email: submitty@localhost
 submitty_install_institution_url: localhost

.setup/ansible/roles/submitty_install/tasks/main.yml

@@ -44,6 +44,7 @@
         {{ 'https' if submitty_install_ssl_enabled else 'http' }}://{{ submitty_install_submitty_url }}
         {{ submitty_install_vcs_url }}
         {{ submitty_install_institution_name }}
+        {{ submitty_install_self_account_creation }}
         {{ submitty_install_sysadmin_email }}
         {{ submitty_install_submitty_email }}
         {{ submitty_install_institution_url }}

.setup/install_system.sh

@@ -708,6 +708,7 @@ en_US
 ${SUBMISSION_URL}
 
 
+y
 sysadmin@example.com
 https://example.com
 1

.setup/testing/setup.sh

@@ -58,6 +58,7 @@ en_US
 http://localhost
 
 
+y
 sysadmin@example.com
 https://example.com
 1

autograder/tests/data/submitty_config.json

@@ -12,6 +12,7 @@
         "cgi_url": "https://submitty.test.com/cgi-bin",
         "websocket_port": 8443,
         "institution_name": "Test University",
+        "user_create_account": false,
         "institution_homepage": "https://test.com",
         "timezone": "America/Los_Angeles",
         "duck_special_effects": false,

migration/migrator/data/submitty_db.sql

@@ -646,6 +646,21 @@ CREATE TABLE public.terms (
 );
 
 
+--
+-- Name: unverified_users; Type: TABLE; Schema: public; Owner: -
+--
+
+CREATE TABLE public.unverified_users (
+    user_id character varying NOT NULL,
+    user_givenname character varying NOT NULL,
+    user_password character varying,
+    user_familyname character varying NOT NULL,
+    user_email character varying NOT NULL,
+    verification_code character varying(50) DEFAULT 'none'::character varying NOT NULL,
+    verification_expiration timestamp without time zone DEFAULT CURRENT_TIMESTAMP
+);
+
+
 --
 -- Name: users; Type: TABLE; Schema: public; Owner: -
 --

migration/migrator/migrations/master/20240805165505_user_verification_code.py

@@ -0,0 +1,35 @@
+"""Migration for the Submitty master database."""
+
+
+def up(config, database):
+    """
+    Run up migration.
+
+    :param config: Object holding configuration details about Submitty
+    :type config: migrator.config.Config
+    :param database: Object for interacting with given database for environment
+    :type database: migrator.db.Database
+    """
+
+    database.execute('''
+        CREATE TABLE if not exists public.unverified_users (
+            user_id character varying NOT NULL,
+            user_givenname character varying NOT NULL,
+            user_password character varying,
+            user_familyname character varying NOT NULL,
+            user_email character varying NOT NULL,
+            verification_code character varying(50) NOT NULL DEFAULT 'none',
+            verification_expiration timestamp DEFAULT current_timestamp
+        )
+    ''')
+
+def down(config, database):
+    """
+    Run down migration (rollback).
+
+    :param config: Object holding configuration details about Submitty
+    :type config: migrator.config.Config
+    :param database: Object for interacting with given database for environment
+    :type database: migrator.db.Database
+    """
+    pass

migration/migrator/migrations/system/20240814131600_self_account_creation.py

@@ -0,0 +1,51 @@
+"""Migration for the Submitty system."""
+import json
+user_id_requirements = {
+    "all": True,
+    "require_name": False,
+    "min_length": 6,
+    "max_length": 25,
+    "name_requirements": {
+        "given_first": False,
+        "given_name": 2,
+        "family_name": 4
+    },
+    "require_email": False,
+    "email_requirements": {
+        "whole_email": False,
+        "whole_prefix": False,
+        "prefix_count": 6
+    }
+}
+
+accepted_emails = {
+    "gmail.com": True,
+    "rpi.edu": True
+}
+
+def up(config):
+    """
+    Run up migration.
+
+    :param config: Object holding configuration details about Submitty
+    :type config: migrator.config.Config
+    """
+    edited_config = config.submitty
+    if ('user_create_account' not in edited_config):
+        edited_config['user_create_account'] = False
+    if ('user_id_requirements' not in edited_config):
+        edited_config['user_id_requirements'] = user_id_requirements
+    if ('accepted_emails' not in edited_config):
+        edited_config['accepted_emails'] = accepted_emails
+
+    with open(config.config_path / 'submitty.json', 'w') as file_path:
+        json.dump(edited_config, file_path, indent=4)
+
+def down(config):
+    """
+    Run down migration (rollback).
+
+    :param config: Object holding configuration details about Submitty
+    :type config: migrator.config.Config
+    """
+    pass

migration/migrator/migrations/system/20240828152944_ci_mode.py

@@ -0,0 +1,27 @@
+"""Migration for the Submitty system."""
+import json
+
+def up(config):
+    """
+    Run up migration.
+
+    :param config: Object holding configuration details about Submitty
+    :type config: migrator.config.Config
+    """
+    edited_config = config.submitty
+    if ('is_ci' not in edited_config):
+        edited_config['is_ci'] = False
+
+    with open(config.config_path / 'submitty.json', 'w') as file_path:
+        json.dump(edited_config, file_path, indent=4)
+
+
+
+def down(config):
+    """
+    Run down migration (rollback).
+
+    :param config: Object holding configuration details about Submitty
+    :type config: migrator.config.Config
+    """
+    pass