diff --git a/README.md b/README.md index 835bafa..c1e5ea2 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,20 @@ # CodeGrader (CG) -This repository will provide the scripts and code for a running Grader. -This will be a web application with User Management and automatic Code Execution and evaluation. +This repository contains the source code for the CodeGrader. +The CodeGrader is an application with User Management and automatic Code Execution and evaluation. For more detailed information on how to setup this Project please visit the doc Folder. -This project is created as a Bachelor Thesis at the University of Bern. +This project is created as a Bachelor Thesis at the University of Bern in 2023/2024. + +## Installation / Deployment +For running the application you can find a detailed Guid in the doc folder for a complete guide. + +## Help +If you have any questions about the application, feel free to get in touch. \ +E-Mail: [michael.kaiser@emplabs.ch](mailto:michael.kaiser@emplabs.ch) + +## License +This application is avaible under the GNU AFFERO GENERAL PUBLIC LICENSE Version 3. diff --git a/codeGrader/backend/api/handlers/Base.py b/codeGrader/backend/api/handlers/Base.py index 726d641..e10821a 100644 --- a/codeGrader/backend/api/handlers/Base.py +++ b/codeGrader/backend/api/handlers/Base.py @@ -176,7 +176,10 @@ def get_all(self, arguments: dict={}) -> dict: objects = self.sql_session.get_all(self.dbClass) if len(objects) == 0: # no data found - return self.create_generic_response('GET', f"No Objects entries to display") + #return self.create_generic_response('GET', f"No Objects entries to display") + output = dict() + output[str(self.dbClass.__table__)] = [] + return output else: object_list = [] diff --git a/codeGrader/backend/config/Config.py b/codeGrader/backend/config/Config.py index f896a67..7d0af33 100644 --- a/codeGrader/backend/config/Config.py +++ b/codeGrader/backend/config/Config.py @@ -38,7 +38,7 @@ def __init__(self): """ self.system = platform.system() if self.system == 'Windows': - configFile = os.path.join(os.path.dirname(__file__), "config.conf") + configFile = os.path.join(os.path.dirname(__file__), "config.sec.conf") code = open(os.path.join(os.path.dirname(__file__), "codeLanguages.json")) elif self.system == 'Linux': configFile = "/etc/codeGrader/backendConfig.conf" diff --git a/codeGrader/backend/config/config.conf b/codeGrader/backend/config/config.conf index e10a51d..ecb9567 100644 --- a/codeGrader/backend/config/config.conf +++ b/codeGrader/backend/config/config.conf @@ -20,18 +20,18 @@ sender = [Database] Dialect = postgresql DBDriver = psycopg2 -Username = codeGrader -Password = codeGrader -Host = 10.101.10.80 +Username = +Password = +Host = 127.0.0.1 Port = 5432 -Database = codeGraderDB +Database = MetaDataColumnsCount = 3 ColumnIgnoreList = [id, creation_dts, updated_dts] [ExecutionService] -Host = 10.101.10.80 +Host = 127.0.0.1 Port = 8003 PathToExecutionFiles = /opt IP_Address_Whitelist = [127.0.0.1] @@ -39,7 +39,7 @@ LXC_Install_Command = -t download -- -r bullseye -a amd64 -d debian [EvaluationService] -Host = 10.101.10.80 +Host = 127.0.0.1 Port = 8002 IP_Address_Whitelist = [127.0.0.1] diff --git a/codeGrader/frontend/admin/app.py b/codeGrader/frontend/admin/app.py index 1e092fc..badeaff 100644 --- a/codeGrader/frontend/admin/app.py +++ b/codeGrader/frontend/admin/app.py @@ -37,7 +37,7 @@ AddTaskInstructionHandler, DeleteTaskInstructionHandler, TaskInstructionHandler, TaskAttachmentHandler, \ SubmissionFileHandler, TestCaseInputFileHandler, TestCaseOutputFileHandler, AddTestCaseHandler, \ DeleteTestCaseHandler, AddMembershipHandler, DeleteMembershipHandler, PasswordResetHandler, AddUserListHandler, \ - ErrorHandler + ErrorHandler, SettingsHandler, AdminPasswordResetHandler from gevent.pywsgi import WSGIServer import datetime @@ -153,6 +153,13 @@ def home() -> str: return HomeHandler(request).get() +@app.route("/settings", methods=['GET']) +@login_required +def settings(): + if request.method == 'GET': + return SettingsHandler(request).get() + + @app.route("/user/", methods=['GET', 'POST']) @login_required def user(id_) -> Union[Response, str]: @@ -231,6 +238,7 @@ def user_password_reset(id_: int) -> Union[Response, str]: return PasswordResetHandler(request).post(id_) + @app.route("/admin/", methods=['GET', 'POST']) @login_required def admin(id_) -> Union[Response, str]: @@ -283,6 +291,19 @@ def deleteAdmin(id_: int) -> Union[Response, str]: return DeleteAdminHandler(request).post(id_) +@app.route("/admin//passsword/reset", methods=['POST']) +@login_required +def admin_password_reset(id_: int) -> Union[Response, str]: + """ + Resetting the password for a admin defined by the id_ + @param id_: The identifier of the object + @type id_: int + @return: Redirect to another view. + """ + if request.method == 'POST': + return AdminPasswordResetHandler(request).post() + + @app.route("/profile/", methods=['GET', 'POST']) @login_required def profile(id_) -> Union[Response, str]: diff --git a/codeGrader/frontend/admin/handlers/PasswordReset.py b/codeGrader/frontend/admin/handlers/PasswordReset.py index 072cebd..361cb79 100644 --- a/codeGrader/frontend/admin/handlers/PasswordReset.py +++ b/codeGrader/frontend/admin/handlers/PasswordReset.py @@ -29,7 +29,7 @@ class PasswordResetHandler(BaseHandler): """ - Handler Class for the PasswordReset + Handler Class for the PasswordReset of a User """ def __init__(self, request: flask.Request) -> None: @@ -61,3 +61,60 @@ def post(self, id_) -> Union[str, Response]: self.flash("You are not allowed to update this user") return redirect(url_for("user", id_=id_)) + + +class AdminPasswordResetHandler(BaseHandler): + """ + Handler Class for the PasswordReset of an Admin User + """ + + def __init__(self, request: flask.Request) -> None: + """ + Constructor for the handler of a PasswordReset of the admin user + @param request: The request provided by the routes file + @type request: flask.Request + @return: Nothing + @rtype: None + """ + super().__init__(request) + + def post(self) -> Union[str, Response]: + """ + Post method to reset the password of the admin via an api call to the backend + @return: The rendered site or a redirect + @rtype: str|Response + """ + + user = self.admin + old_password = self.get_value("old-password") + new_password = self.get_value("new-password") + repeat_new_password = self.get_value("repeat-new-password") + + if new_password != repeat_new_password: + self.flash("The new passwords do not match!") + + elif new_password == repeat_new_password: + body = dict() + body["password"] = old_password + body["username"] = self.admin.username + response = self.api.post('/admin/login', body) + id_ = response["response"]["id"] # is None when the Authentication failed + if id_ is not None: # authentication successful + body["password"] = new_password + body["id"] = self.admin.id + # resetting the password + response = self.api.post(f"/admin/{self.admin.id}/password/update", body) + + if "password" in response.keys(): + # change was successful + self.flash("Password has been changed!") + + else: + # an error occured while changing the password + self.flash( + "An Error occurred in the process of changing the password. Please Contact your administrator!") + else: + self.flash("Your old password is not correct!") + + # finally redirect back to the settings page. + return redirect(url_for("settings")) diff --git a/codeGrader/frontend/admin/handlers/Settings.py b/codeGrader/frontend/admin/handlers/Settings.py new file mode 100644 index 0000000..40bdd2d --- /dev/null +++ b/codeGrader/frontend/admin/handlers/Settings.py @@ -0,0 +1,52 @@ +# CodeGrader - https://github.com/ooemperor/CodeGrader +# Copyright © 2023, 2024 Michael Kaiser +# +# This file is part of CodeGrader. +# +# CodeGrader is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# CodeGrader is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with CodeGrader. If not, see . + +""" +Handler Class for the Settings View of the admin frontend +""" + +import flask +from flask import request, render_template, redirect, url_for, flash, Response +from .Base import BaseHandler +from typing import Union + + +class SettingsHandler(BaseHandler): + """ + Handler Class for the Settings + """ + + def __init__(self, request: flask.Request) -> None: + """ + Constructor for the handler of a single Task + @param request: The request provided by the routes file + @type request: flask.Request + @return: Nothing + @rtype: None + """ + super().__init__(request) + + def get(self) -> Union[str, Response]: + """ + Get Method to render the settings view for the user that is logged in + @return: The rendered site or a redirect + @rtype: str|Response + """ + settings = self.api.get(f"/admin/{self.admin.id}") + + return render_template("settings.html", **settings) diff --git a/codeGrader/frontend/admin/handlers/__init__.py b/codeGrader/frontend/admin/handlers/__init__.py index 840e986..fb1264e 100644 --- a/codeGrader/frontend/admin/handlers/__init__.py +++ b/codeGrader/frontend/admin/handlers/__init__.py @@ -35,8 +35,9 @@ from .Submission import SubmissionFileHandler from .TestCase import TestCaseInputFileHandler, TestCaseOutputFileHandler, AddTestCaseHandler, DeleteTestCaseHandler from .Membership import AddMembershipHandler, DeleteMembershipHandler -from .PasswordReset import PasswordResetHandler +from .PasswordReset import PasswordResetHandler, AdminPasswordResetHandler from .Error import ErrorHandler +from .Settings import SettingsHandler __all__ = ["AdminUserLoginHandler", "AdminSessionHandler", "SessionAdmin", "UserListHandler", "UserHandler", "HomeHandler", "AdminHandler", "AdminListHandler", "ProfileListHandler", "ProfileHandler", @@ -48,4 +49,4 @@ "DeleteTaskInstructionHandler", "TaskInstructionHandler", "TaskAttachmentHandler", "SubmissionFileHandler", "TestCaseInputFileHandler", "TestCaseOutputFileHandler", "AddTestCaseHandler", "DeleteTestCaseHandler", "AddMembershipHandler", "DeleteMembershipHandler", "PasswordResetHandler", "AddUserListHandler", - "ErrorHandler"] + "ErrorHandler", "SettingsHandler", "AdminPasswordResetHandler"] diff --git a/codeGrader/frontend/admin/templates/base.html b/codeGrader/frontend/admin/templates/base.html index fcd052f..f556977 100644 --- a/codeGrader/frontend/admin/templates/base.html +++ b/codeGrader/frontend/admin/templates/base.html @@ -120,6 +120,15 @@

{{ appname }}

    +
  • + + + Settings + +
    • +
  • +
    +
  • diff --git a/codeGrader/frontend/admin/templates/profiles.html b/codeGrader/frontend/admin/templates/profiles.html index f320c55..08837ee 100644 --- a/codeGrader/frontend/admin/templates/profiles.html +++ b/codeGrader/frontend/admin/templates/profiles.html @@ -31,7 +31,8 @@

    Profile

    {% if this.admin.check_permission('w', create_object='profile') %}
    - +
    {% endif %} @@ -40,26 +41,29 @@

    Profile

    Profile

    - - - - - - - - - - {% for prof in profile | sort(attribute='name') %} - - - - - {% endfor %} - -
    NameTag
    - - {{ prof["name"] }} - - {{ prof["tag"] }}
    +
    + + + + + + + + + {% for prof in profile | sort(attribute='name') %} + + + + + {% endfor %} + +
    NameTag
    + + {{ prof["name"] }} + + {{ prof["tag"] }}
    +
    {% endblock core %} \ No newline at end of file diff --git a/codeGrader/frontend/admin/templates/settings.html b/codeGrader/frontend/admin/templates/settings.html new file mode 100644 index 0000000..eaf318d --- /dev/null +++ b/codeGrader/frontend/admin/templates/settings.html @@ -0,0 +1,150 @@ + +{% extends "base.html" %} + +{% block core %} + + +
    +
    +

    Settings

    +
    +
    +

    Administrator {{ username }}

    +
    + +
    + +
    + + + + + + + + + + + + + + + + + +
    Username + {{ username }} +
    First Name + {{ first_name }} +
    Last Name + {{ last_name }} +
    E-Mail + {{ email }} +
    +
    +
    +
    +
    +
    Password Reset
    +

    Your Password must contain at least 8 characters

    +
    +
    + + + + + + + + + + + + + +
    Old Password + + +
    New Password + + +
    Repeat New Password + + +
    +
    +
    + +
    +
    +
    +
    + +
    +{% endblock core %} \ No newline at end of file diff --git a/codeGrader/frontend/admin/templates/subjects.html b/codeGrader/frontend/admin/templates/subjects.html index 48cc6ee..0c32e09 100644 --- a/codeGrader/frontend/admin/templates/subjects.html +++ b/codeGrader/frontend/admin/templates/subjects.html @@ -32,7 +32,8 @@

    Subjects

    {% if this.admin.check_permission('w', create_object='subject') %}
    - +
    @@ -43,29 +44,32 @@

    Subjects

    Subjects

    +
    + + + + + + + + + + {% for sub in subject | sort(attribute='name') %} + + + + -
    NameProfileTag
    + + {{ sub["name"] }} + + {{ sub["profile"]["name"] }}{{ sub["tag"] }}
    - - - - - - - - - {% for sub in subject | sort(attribute='name') %} - - - - - - - {% endfor %} - -
    NameProfileTag
    - - {{ sub["name"] }} - - {{ sub["profile"]["name"] }}{{ sub["tag"] }}
    + + {% endfor %} + + +
    {% endblock core %} \ No newline at end of file diff --git a/codeGrader/frontend/config/Config.py b/codeGrader/frontend/config/Config.py index 3d02471..d6050b0 100644 --- a/codeGrader/frontend/config/Config.py +++ b/codeGrader/frontend/config/Config.py @@ -73,5 +73,6 @@ def __init__(self): self.good_gifs = self.config["GIFS"]["Good_GIFS"].split(',') self.bad_gifs = self.config["GIFS"]["Bad_GIFS"].split(',') self.medium_gifs = self.config["GIFS"]["Medium_GIFS"].split(',') + self.gif_loading = self.config["GIFS"]["Loading_GIF"] self.gif_404 = self.config["GIFS"]["404_GIF"] self.gif_500 = self.config["GIFS"]["500_GIF"] diff --git a/codeGrader/frontend/config/config.conf b/codeGrader/frontend/config/config.conf index 5b95bfa..36b59b7 100644 --- a/codeGrader/frontend/config/config.conf +++ b/codeGrader/frontend/config/config.conf @@ -28,6 +28,8 @@ Medium_GIFS = [ 500_GIF = Chicago Med Hannah Asher GIF - Chicago Med Hannah Asher Error GIFs +Loading_GIF = One Hundred Percent Sophie GIF - One Hundred Percent Sophie How I Met Your Father GIFs + [API] Name = CodeGrader diff --git a/codeGrader/frontend/user/handlers/Submission.py b/codeGrader/frontend/user/handlers/Submission.py index f43ce58..93318d2 100644 --- a/codeGrader/frontend/user/handlers/Submission.py +++ b/codeGrader/frontend/user/handlers/Submission.py @@ -56,7 +56,7 @@ def get_gamification(self, id_: int) -> str: score = float(submission["max_score"]) if state != "finished": - return 'Hi GIF - Hi GIFs' + return config.gif_loading else: # submission has finished in the backend, need to calculate the result base on the score. diff --git a/codeGrader/frontend/user/templates/subjects.html b/codeGrader/frontend/user/templates/subjects.html index c12579a..193f2ea 100644 --- a/codeGrader/frontend/user/templates/subjects.html +++ b/codeGrader/frontend/user/templates/subjects.html @@ -34,29 +34,32 @@

    Subjects

    Subjects

    +
    + + + + + + + + + + -
    NameProfileTag
    - - - - - - - - - - - {% for sub in subject | sort(attribute='name') %} - - - - - {% endfor %} - -
    NameProfileTag
    - - {{ sub["name"] }} - - {{ sub["tag"] }}
    + {% for sub in subject | sort(attribute='name') %} + + +     + {{ sub["name"] }} + + + {{ sub["tag"] }} + + {% endfor %} + + +
    {% endblock core %} \ No newline at end of file diff --git a/doc/Installation.md b/doc/Installation.md index 484c48d..c14427a 100644 --- a/doc/Installation.md +++ b/doc/Installation.md @@ -138,3 +138,25 @@ nohup cgExecutionService & nohup cgUserFrontend & nohup cgAdminFrontend & ``` + +## Services +If you want to run the 5 steps above as services under linux, please visit the services folder where you can finde the .service files. \ +\ +On debian you would need to copy these in the ```/etc/systemd/system``` \ +After moving the files in this directory complete the startup with the following commands: +``` +systemctl daemon-reload + +systemd enable cgApiBackend.service +systemd enable cgEvaluationService.service +systemd enable cgExecutionService.service +systemd enable cgUserFrontend.service +systemd enable cgAdminFrontend.service + +systemctl start cgApiBackend.service +systemctl start cgEvaluationService.service +systemctl start cgExecutionService.service +systemctl start cgUserFrontend.service +systemctl start cgAdminFrontend.service +``` + diff --git a/doc/Python 3.11 Installation.md b/doc/Python 3.11 Installation.md deleted file mode 100644 index fc73ccf..0000000 --- a/doc/Python 3.11 Installation.md +++ /dev/null @@ -1,18 +0,0 @@ -# Installation of Python 3.11 on Debian 11 - -Using the following statements Python 3.11 can be installed on Debian 11 Servers without losing the current 3.9 Installtion. - -Run as root user: -``` -wget https://www.python.org/ftp/python/3.11.3/Python-3.11.3.tgz \ -tar xzf Python-3.11.3.tgz \ -cd Python-3.11.3 -apt update -apt install build-essential zlib1g-dev libncurses5-dev libgdbm-dev libnss3-dev libssl-dev libreadline-dev libffi-dev -./configure --enable-optimizations -make -j `nproc` -make altinstall -``` - -Afterwards the installation can be verified by using python3.11 --version - diff --git a/doc/README.md b/doc/README.md index c0313b1..e7ae18e 100644 --- a/doc/README.md +++ b/doc/README.md @@ -2,4 +2,5 @@ Within this fodler you will find the documentation for the codeGrader. -This includes how to install, run and even more detailed information about the project. \ No newline at end of file +## Installation +The guide for the setup can be found in the Installation.md File diff --git a/doc/Requirements/Requirements.md b/doc/Requirements/Requirements.md index 62e531c..74c5cf1 100644 --- a/doc/Requirements/Requirements.md +++ b/doc/Requirements/Requirements.md @@ -7,6 +7,8 @@ All of the frontend requirements can be mapped to a backend requirement. The frontend requirements will be generalized and then transferred to the backend. +The requirements here are just a draft and are not to be taken as complete. + # Frontend ## Admin Site diff --git a/doc/backend/DataModel.md b/doc/backend/DataModel.md new file mode 100644 index 0000000..e3dbe15 --- /dev/null +++ b/doc/backend/DataModel.md @@ -0,0 +1,442 @@ +# Datamodel +In order to understand the datamodel of the CodeGrader a little bit faster you can find a listing and short description of all tables in the database (out of postgres psql) +![DataModel](images/DataModel.png) + +## Tables +``` + List of relations + Schema | Name | Type | Owner +--------+------------------+-------+------------ + public | admin_type | table | codeGrader + public | adminuser | table | codeGrader + public | attachment | table | codeGrader + public | evaluation_type | table | codeGrader + public | evaluationresult | table | codeGrader + public | executionresult | table | codeGrader + public | exercise | table | codeGrader + public | file | table | codeGrader + public | instruction | table | codeGrader + public | membership | table | codeGrader + public | profile | table | codeGrader + public | subject | table | codeGrader + public | submission | table | codeGrader + public | task | table | codeGrader + public | testcase | table | codeGrader + public | token | table | codeGrader + public | user | table | codeGrader +(17 rows) +``` + +In general all tables will include 3 metadata columns. +- id: Primary Key of the table and auto generated by the database +- creation_dts: DateTime stamp of the database when the object has last been created. +- updated_dts: DateTime stamp of the database when te object has last been updated. + + +## Admin Type +The admin type specifies the rights that an admin has within the admin frontend. +``` + Table "public.admin_type" + Column | Type | Collation | Nullable | Default +--------------+--------------------------+-----------+----------+---------------------------------------- + id | integer | | not null | nextval('admin_type_id_seq'::regclass) + creation_dts | timestamp with time zone | | not null | now() + updated_dts | timestamp with time zone | | not null | now() + name | character varying | | not null | + description | character varying | | | +Indexes: + "admin_type_pkey" PRIMARY KEY, btree (id) + "ix_admin_type_id" btree (id) + "ix_admin_type_name" UNIQUE, btree (name) +Referenced by: + TABLE "adminuser" CONSTRAINT "adminuser_admin_type_fkey" FOREIGN KEY (admin_type) REFERENCES admin_type(id) + +``` + +## Admin User +Stores the user Object of an Administrator User for the admin frontend. +``` + Table "public.adminuser" + Column | Type | Collation | Nullable | Default +--------------+--------------------------+-----------+----------+--------------------------------------- + id | integer | | not null | nextval('adminuser_id_seq'::regclass) + creation_dts | timestamp with time zone | | not null | now() + updated_dts | timestamp with time zone | | not null | now() + username | character varying | | not null | + first_name | character varying | | not null | + last_name | character varying | | not null | + email | character varying | | not null | + password | character varying | | not null | + tag | character varying | | | + admin_type | integer | | not null | + profile_id | integer | | | +Indexes: + "adminuser_pkey" PRIMARY KEY, btree (id) + "ix_adminuser_admin_type" btree (admin_type) + "ix_adminuser_id" btree (id) + "ix_adminuser_profile_id" btree (profile_id) + "ix_adminuser_username" UNIQUE, btree (username) +Foreign-key constraints: + "adminuser_admin_type_fkey" FOREIGN KEY (admin_type) REFERENCES admin_type(id) + "adminuser_profile_id_fkey" FOREIGN KEY (profile_id) REFERENCES profile(id) + +``` + +## Attachment +Table to store the properties of a file stored in the file table for additional files of a task. +``` + Table "public.attachment" + Column | Type | Collation | Nullable | Default +--------------+--------------------------+-----------+----------+---------------------------------------- + id | bigint | | not null | nextval('attachment_id_seq'::regclass) + creation_dts | timestamp with time zone | | not null | now() + updated_dts | timestamp with time zone | | not null | now() + task_id | bigint | | | + file_id | bigint | | | +Indexes: + "attachment_pkey" PRIMARY KEY, btree (id) + "ix_attachment_file_id" btree (file_id) + "ix_attachment_id" btree (id) + "ix_attachment_task_id" btree (task_id) +Foreign-key constraints: + "attachment_file_id_fkey" FOREIGN KEY (file_id) REFERENCES file(id) ON UPDATE CASCADE ON DELETE CASCADE + "attachment_task_id_fkey" FOREIGN KEY (task_id) REFERENCES task(id) ON UPDATE CASCADE + +``` + +## Evaluation Type +The type of evaluation entities used for the evaluation of a task. +``` + Table "public.evaluation_type" + Column | Type | Collation | Nullable | Default +--------------+--------------------------+-----------+----------+--------------------------------------------- + id | integer | | not null | nextval('evaluation_type_id_seq'::regclass) + creation_dts | timestamp with time zone | | not null | now() + updated_dts | timestamp with time zone | | not null | now() + name | character varying | | not null | + description | character varying | | | +Indexes: + "evaluation_type_pkey" PRIMARY KEY, btree (id) + "ix_evaluation_type_id" btree (id) + "ix_evaluation_type_name" UNIQUE, btree (name) + +``` + +## Evaluation Result +The result of an evaluation. One entry per Submission. +``` + Table "public.evaluationresult" + Column | Type | Collation | Nullable | Default +------------------+--------------------------+-----------+----------+---------------------------------------------- + id | integer | | not null | nextval('evaluationresult_id_seq'::regclass) + creation_dts | timestamp with time zone | | not null | now() + updated_dts | timestamp with time zone | | not null | now() + evaluation_score | double precision | | not null | + submission_id | integer | | | +Indexes: + "evaluationresult_pkey" PRIMARY KEY, btree (id) + "ix_evaluationresult_id" btree (id) + "ix_evaluationresult_submission_id" btree (submission_id) +Foreign-key constraints: + "evaluationresult_submission_id_fkey" FOREIGN KEY (submission_id) REFERENCES submission(id) ON UPDATE CASCADE + +``` + +## Execution Result +The output of an execution for one testcase of an Submission. +``` + Table "public.executionresult" + Column | Type | Collation | Nullable | Default +---------------------+--------------------------+-----------+----------+--------------------------------------------- + id | integer | | not null | nextval('executionresult_id_seq'::regclass) + creation_dts | timestamp with time zone | | not null | now() + updated_dts | timestamp with time zone | | not null | now() + execution_output | character varying | | not null | + execution_exit_code | integer | | not null | + execution_duration | double precision | | not null | + submission_id | integer | | | + testcase_id | integer | | | +Indexes: + "executionresult_pkey" PRIMARY KEY, btree (id) + "ix_executionresult_execution_duration" btree (execution_duration) + "ix_executionresult_execution_exit_code" btree (execution_exit_code) + "ix_executionresult_id" btree (id) + "ix_executionresult_submission_id" btree (submission_id) + "ix_executionresult_testcase_id" btree (testcase_id) +Foreign-key constraints: + "executionresult_submission_id_fkey" FOREIGN KEY (submission_id) REFERENCES submission(id) ON UPDATE CASCADE + "executionresult_testcase_id_fkey" FOREIGN KEY (testcase_id) REFERENCES testcase(id) ON UPDATE CASCADE + +``` + +## Exercise +Exercise is a logical Grouping for multiple Tasks with some additional informations. +``` + Table "public.exercise" + Column | Type | Collation | Nullable | Default +--------------+--------------------------+-----------+----------+-------------------------------------- + id | integer | | not null | nextval('exercise_id_seq'::regclass) + creation_dts | timestamp with time zone | | not null | now() + updated_dts | timestamp with time zone | | not null | now() + name | character varying | | not null | + tag | character varying | | | + subject_id | integer | | | + description | character varying | | | +Indexes: + "exercise_pkey" PRIMARY KEY, btree (id) + "ix_exercise_id" btree (id) + "ix_exercise_name" btree (name) + "ix_exercise_subject_id" btree (subject_id) +Foreign-key constraints: + "exercise_subject_id_fkey" FOREIGN KEY (subject_id) REFERENCES subject(id) ON UPDATE CASCADE +Referenced by: + TABLE "task" CONSTRAINT "task_exercise_id_fkey" FOREIGN KEY (exercise_id) REFERENCES exercise(id) ON UPDATE CASCADE ON DELETE CASCADE +``` + +## File +Table to store Binary Data in a database. +``` + Table "public.file" + Column | Type | Collation | Nullable | Default +---------------+--------------------------+-----------+----------+---------------------------------- + id | integer | | not null | nextval('file_id_seq'::regclass) + creation_dts | timestamp with time zone | | not null | now() + updated_dts | timestamp with time zone | | not null | now() + filename | character varying | | not null | + fileExtension | character varying | | not null | + file | bytea | | not null | +Indexes: + "file_pkey" PRIMARY KEY, btree (id) + "ix_file_filename" btree (filename) + "ix_file_id" btree (id) +Referenced by: + TABLE "attachment" CONSTRAINT "attachment_file_id_fkey" FOREIGN KEY (file_id) REFERENCES file(id) ON UPDATE CASCADE ON DELETE CASCADE + TABLE "instruction" CONSTRAINT "instruction_file_id_fkey" FOREIGN KEY (file_id) REFERENCES file(id) ON UPDATE CASCADE ON DELETE CASCADE + TABLE "submission" CONSTRAINT "submission_file_id_fkey" FOREIGN KEY (file_id) REFERENCES file(id) ON UPDATE CASCADE ON DELETE CASCADE + TABLE "testcase" CONSTRAINT "testcase_input_id_fkey" FOREIGN KEY (input_id) REFERENCES file(id) ON UPDATE CASCADE ON DELETE CASCADE + TABLE "testcase" CONSTRAINT "testcase_output_id_fkey" FOREIGN KEY (output_id) REFERENCES file(id) ON UPDATE CASCADE ON DELETE CASCADE + +``` + +## Instruction +The Instructions of how to solve the task. This is a file with the file stored in the file table. +``` + Table "public.instruction" + Column | Type | Collation | Nullable | Default +--------------+--------------------------+-----------+----------+----------------------------------------- + id | bigint | | not null | nextval('instruction_id_seq'::regclass) + creation_dts | timestamp with time zone | | not null | now() + updated_dts | timestamp with time zone | | not null | now() + task_id | bigint | | | + file_id | bigint | | | +Indexes: + "instruction_pkey" PRIMARY KEY, btree (id) + "ix_instruction_file_id" btree (file_id) + "ix_instruction_id" btree (id) + "ix_instruction_task_id" btree (task_id) +Foreign-key constraints: + "instruction_file_id_fkey" FOREIGN KEY (file_id) REFERENCES file(id) ON UPDATE CASCADE ON DELETE CASCADE + "instruction_task_id_fkey" FOREIGN KEY (task_id) REFERENCES task(id) ON UPDATE CASCADE + +``` + +## Membership +Membership shows which user can access which subject. In other words: which tasks, exercises and more he will be able to access. +``` + Table "public.membership" + Column | Type | Collation | Nullable | Default +--------------+--------------------------+-----------+----------+---------------------------------------- + id | integer | | not null | nextval('membership_id_seq'::regclass) + creation_dts | timestamp with time zone | | not null | now() + updated_dts | timestamp with time zone | | not null | now() + user_id | integer | | | + subject_id | integer | | | +Indexes: + "membership_pkey" PRIMARY KEY, btree (id) + "ix_membership_id" btree (id) + "ix_membership_subject_id" btree (subject_id) + "ix_membership_user_id" btree (user_id) + "membership_user_id_subject_id_key" UNIQUE CONSTRAINT, btree (user_id, subject_id) +Foreign-key constraints: + "membership_subject_id_fkey" FOREIGN KEY (subject_id) REFERENCES subject(id) ON UPDATE CASCADE + "membership_user_id_fkey" FOREIGN KEY (user_id) REFERENCES "user"(id) ON UPDATE CASCADE + +``` + +## Profile +The profile is a logical grouping of users and other objects. This is also the grouping used for the implemetation of the +multi-client-capability. +``` + Table "public.profile" + Column | Type | Collation | Nullable | Default +--------------+--------------------------+-----------+----------+------------------------------------- + id | integer | | not null | nextval('profile_id_seq'::regclass) + creation_dts | timestamp with time zone | | not null | now() + updated_dts | timestamp with time zone | | not null | now() + name | character varying | | not null | + tag | character varying | | | +Indexes: + "profile_pkey" PRIMARY KEY, btree (id) + "ix_profile_id" btree (id) + "ix_profile_name" UNIQUE, btree (name) +Referenced by: + TABLE "adminuser" CONSTRAINT "adminuser_profile_id_fkey" FOREIGN KEY (profile_id) REFERENCES profile(id) + TABLE "subject" CONSTRAINT "subject_profile_id_fkey" FOREIGN KEY (profile_id) REFERENCES profile(id) ON UPDATE CASCADE + TABLE ""user"" CONSTRAINT "user_profile_id_fkey" FOREIGN KEY (profile_id) REFERENCES profile(id) + +``` + +## Subject +the logical grouping of multiple exercises into a subject. Can also be looked as a Course in School. +``` + Table "public.subject" + Column | Type | Collation | Nullable | Default +--------------+--------------------------+-----------+----------+------------------------------------- + id | integer | | not null | nextval('subject_id_seq'::regclass) + creation_dts | timestamp with time zone | | not null | now() + updated_dts | timestamp with time zone | | not null | now() + name | character varying | | not null | + tag | character varying | | | + profile_id | integer | | | +Indexes: + "subject_pkey" PRIMARY KEY, btree (id) + "ix_subject_id" btree (id) + "ix_subject_name" btree (name) + "ix_subject_profile_id" btree (profile_id) +Foreign-key constraints: + "subject_profile_id_fkey" FOREIGN KEY (profile_id) REFERENCES profile(id) ON UPDATE CASCADE +Referenced by: + TABLE "exercise" CONSTRAINT "exercise_subject_id_fkey" FOREIGN KEY (subject_id) REFERENCES subject(id) ON UPDATE CASCADE + TABLE "membership" CONSTRAINT "membership_subject_id_fkey" FOREIGN KEY (subject_id) REFERENCES subject(id) ON UPDATE CASCADE + +``` + +## Submission +A submission made by a user for a specific task. The user did a submission for a given task. +This submission will be evaluated in the execution service and following. +``` + Table "public.submission" + Column | Type | Collation | Nullable | Default +--------------+--------------------------+-----------+----------+---------------------------------------- + id | integer | | not null | nextval('submission_id_seq'::regclass) + creation_dts | timestamp with time zone | | not null | now() + updated_dts | timestamp with time zone | | not null | now() + file_id | integer | | | + user_id | integer | | not null | + task_id | integer | | not null | +Indexes: + "submission_pkey" PRIMARY KEY, btree (id) + "ix_submission_file_id" btree (file_id) + "ix_submission_id" btree (id) + "ix_submission_user_id" btree (user_id) +Foreign-key constraints: + "submission_file_id_fkey" FOREIGN KEY (file_id) REFERENCES file(id) ON UPDATE CASCADE ON DELETE CASCADE + "submission_task_id_fkey" FOREIGN KEY (task_id) REFERENCES task(id) ON UPDATE CASCADE + "submission_user_id_fkey" FOREIGN KEY (user_id) REFERENCES "user"(id) ON UPDATE CASCADE +Referenced by: + TABLE "evaluationresult" CONSTRAINT "evaluationresult_submission_id_fkey" FOREIGN KEY (submission_id) REFERENCES submission(id) ON UPDATE CASCADE + TABLE "executionresult" CONSTRAINT "executionresult_submission_id_fkey" FOREIGN KEY (submission_id) REFERENCES submission(id) ON UPDATE CASCADE + +``` + +## Task +The Task is the entity of a Coding Challenge which has files attached to it such as Instructions, Attachments and more. +``` + Table "public.task" + Column | Type | Collation | Nullable | Default +--------------+--------------------------+-----------+----------+---------------------------------- + id | integer | | not null | nextval('task_id_seq'::regclass) + creation_dts | timestamp with time zone | | not null | now() + updated_dts | timestamp with time zone | | not null | now() + name | character varying | | not null | + tag | character varying | | | + exercise_id | integer | | | + description | character varying | | | +Indexes: + "task_pkey" PRIMARY KEY, btree (id) + "ix_task_exercise_id" btree (exercise_id) + "ix_task_id" btree (id) + "ix_task_name" btree (name) +Foreign-key constraints: + "task_exercise_id_fkey" FOREIGN KEY (exercise_id) REFERENCES exercise(id) ON UPDATE CASCADE ON DELETE CASCADE +Referenced by: + TABLE "attachment" CONSTRAINT "attachment_task_id_fkey" FOREIGN KEY (task_id) REFERENCES task(id) ON UPDATE CASCADE + TABLE "instruction" CONSTRAINT "instruction_task_id_fkey" FOREIGN KEY (task_id) REFERENCES task(id) ON UPDATE CASCADE + TABLE "submission" CONSTRAINT "submission_task_id_fkey" FOREIGN KEY (task_id) REFERENCES task(id) ON UPDATE CASCADE + TABLE "testcase" CONSTRAINT "testcase_task_id_fkey" FOREIGN KEY (task_id) REFERENCES task(id) ON UPDATE CASCADE ON DELETE CASCADE + +``` + +## Testcase +A Testcase is the definition of a input and correct output. The input will be used in the execution service while the +ouput is used in the evaluation service. +``` + Table "public.testcase" + Column | Type | Collation | Nullable | Default +--------------+--------------------------+-----------+----------+-------------------------------------- + id | integer | | not null | nextval('testcase_id_seq'::regclass) + creation_dts | timestamp with time zone | | not null | now() + updated_dts | timestamp with time zone | | not null | now() + input_id | integer | | | + output_id | integer | | | + task_id | integer | | not null | +Indexes: + "testcase_pkey" PRIMARY KEY, btree (id) + "ix_testcase_id" btree (id) + "ix_testcase_input_id" btree (input_id) + "ix_testcase_output_id" btree (output_id) +Foreign-key constraints: + "testcase_input_id_fkey" FOREIGN KEY (input_id) REFERENCES file(id) ON UPDATE CASCADE ON DELETE CASCADE + "testcase_output_id_fkey" FOREIGN KEY (output_id) REFERENCES file(id) ON UPDATE CASCADE ON DELETE CASCADE + "testcase_task_id_fkey" FOREIGN KEY (task_id) REFERENCES task(id) ON UPDATE CASCADE ON DELETE CASCADE +Referenced by: + TABLE "executionresult" CONSTRAINT "executionresult_testcase_id_fkey" FOREIGN KEY (testcase_id) REFERENCES testcase(id) ON UPDATE CASCADE + +``` + +## Token +The Token is used for authentication of the frontend to the backend api. (Bearer Token) +``` + Table "public.token" + Column | Type | Collation | Nullable | Default +--------------+--------------------------+-----------+----------+----------------------------------- + id | integer | | not null | nextval('token_id_seq'::regclass) + creation_dts | timestamp with time zone | | not null | now() + updated_dts | timestamp with time zone | | not null | now() + token | character varying | | not null | + description | character varying | | not null | +Indexes: + "token_pkey" PRIMARY KEY, btree (id) + "ix_token_id" btree (id) + "ix_token_token" btree (token) + +``` + +## User +A User for the user frontend of the codegrader with login data. +``` + Table "public.user" + Column | Type | Collation | Nullable | Default +--------------+--------------------------+-----------+----------+---------------------------------- + id | integer | | not null | nextval('user_id_seq'::regclass) + creation_dts | timestamp with time zone | | not null | now() + updated_dts | timestamp with time zone | | not null | now() + username | character varying | | not null | + first_name | character varying | | not null | + last_name | character varying | | not null | + email | character varying | | not null | + password | character varying | | not null | + tag | character varying | | | + profile_id | integer | | | +Indexes: + "user_pkey" PRIMARY KEY, btree (id) + "ix_user_id" btree (id) + "ix_user_profile_id" btree (profile_id) + "ix_user_username" UNIQUE, btree (username) +Foreign-key constraints: + "user_profile_id_fkey" FOREIGN KEY (profile_id) REFERENCES profile(id) +Referenced by: + TABLE "membership" CONSTRAINT "membership_user_id_fkey" FOREIGN KEY (user_id) REFERENCES "user"(id) ON UPDATE CASCADE + TABLE "submission" CONSTRAINT "submission_user_id_fkey" FOREIGN KEY (user_id) REFERENCES "user"(id) ON UPDATE CASCADE + +``` \ No newline at end of file diff --git a/doc/backend/Evaluation_Service_Sequence_Diagram.drawio b/doc/backend/Evaluation_Service_Sequence_Diagram.drawio deleted file mode 100644 index 1028cd9..0000000 --- a/doc/backend/Evaluation_Service_Sequence_Diagram.drawio +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/doc/Handlers.md b/doc/backend/Handlers.md similarity index 100% rename from doc/Handlers.md rename to doc/backend/Handlers.md diff --git a/doc/backend/API_Sequence Diagram.drawio b/doc/backend/drawio/API_Sequence Diagram.drawio similarity index 100% rename from doc/backend/API_Sequence Diagram.drawio rename to doc/backend/drawio/API_Sequence Diagram.drawio diff --git a/doc/backend/CachedRoutes.drawio b/doc/backend/drawio/CachedRoutes.drawio similarity index 100% rename from doc/backend/CachedRoutes.drawio rename to doc/backend/drawio/CachedRoutes.drawio diff --git a/doc/backend/DataModel.drawio b/doc/backend/drawio/DataModel.drawio similarity index 100% rename from doc/backend/DataModel.drawio rename to doc/backend/drawio/DataModel.drawio diff --git a/doc/backend/drawio/Evaluation_Service_Sequence_Diagram.drawio b/doc/backend/drawio/Evaluation_Service_Sequence_Diagram.drawio new file mode 100644 index 0000000..646aa92 --- /dev/null +++ b/doc/backend/drawio/Evaluation_Service_Sequence_Diagram.drawio @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/doc/backend/Execution_Service_Sequence_Diagram.drawio b/doc/backend/drawio/Execution_Service_Sequence_Diagram.drawio similarity index 100% rename from doc/backend/Execution_Service_Sequence_Diagram.drawio rename to doc/backend/drawio/Execution_Service_Sequence_Diagram.drawio diff --git a/doc/backend/images/DataModel.png b/doc/backend/images/DataModel.png new file mode 100644 index 0000000..671dc59 Binary files /dev/null and b/doc/backend/images/DataModel.png differ diff --git a/doc/frontend/admin/Call_Sequence Diagram.drawio b/doc/frontend/admin/Call_Sequence Diagram.drawio index d410dff..e1aa802 100644 --- a/doc/frontend/admin/Call_Sequence Diagram.drawio +++ b/doc/frontend/admin/Call_Sequence Diagram.drawio @@ -1 +1 @@ - \ No newline at end of file + \ No newline at end of file diff --git a/services/cgAdminFrontend.service b/services/cgAdminFrontend.service new file mode 100644 index 0000000..7f3b0b2 --- /dev/null +++ b/services/cgAdminFrontend.service @@ -0,0 +1,14 @@ +[Unit] +Description=Running the admin frontend of the CodeGrader +After=network.target + +[Service] +User=root +WorkingDirectory=/ +ExecStart=nohup cgAdminFrontend > /var/log/cgAdminFrontend.log & +# optional items below +Restart=always +RestartSec=3 + +[Install] +WantedBy=multi-user.target \ No newline at end of file diff --git a/services/cgApiBackend.service b/services/cgApiBackend.service new file mode 100644 index 0000000..8c5d7d2 --- /dev/null +++ b/services/cgApiBackend.service @@ -0,0 +1,14 @@ +[Unit] +Description=Running the API of the backend of the CodeGrader +After=network.target + +[Service] +User=root +WorkingDirectory=/ +ExecStart=nohup cgApiBackend > /var/log/cgApiBackend.log & +# optional items below +Restart=always +RestartSec=3 + +[Install] +WantedBy=multi-user.target \ No newline at end of file diff --git a/services/cgEvaluationService.service b/services/cgEvaluationService.service new file mode 100644 index 0000000..39fd480 --- /dev/null +++ b/services/cgEvaluationService.service @@ -0,0 +1,14 @@ +[Unit] +Description=Running the Evaluation Servie of the CodeGrader +After=network.target + +[Service] +User=root +WorkingDirectory=/ +ExecStart=nohup cgEvaluationService > /var/log/cgEvaluationService.log & +# optional items below +Restart=always +RestartSec=3 + +[Install] +WantedBy=multi-user.target \ No newline at end of file diff --git a/services/cgExecutionService.service b/services/cgExecutionService.service new file mode 100644 index 0000000..b419334 --- /dev/null +++ b/services/cgExecutionService.service @@ -0,0 +1,14 @@ +[Unit] +Description=Running the Execution Servie of the CodeGrader +After=network.target + +[Service] +User=root +WorkingDirectory=/ +ExecStart=nohup cgExecutionService > /var/log/cgExecutionService.log & +# optional items below +Restart=always +RestartSec=3 + +[Install] +WantedBy=multi-user.target \ No newline at end of file diff --git a/services/cgUserFrontend.service b/services/cgUserFrontend.service new file mode 100644 index 0000000..d4e62d5 --- /dev/null +++ b/services/cgUserFrontend.service @@ -0,0 +1,14 @@ +[Unit] +Description=Running the user frontend of the CodeGrader +After=network.target + +[Service] +User=root +WorkingDirectory=/ +ExecStart=nohup cgUserFrontend > /var/log/cgUserFrontend.log & +# optional items below +Restart=always +RestartSec=3 + +[Install] +WantedBy=multi-user.target \ No newline at end of file