TU-Wien-dataLAB
diff --git a/‎.github/workflows/action_main.yml
Lines changed: 4 additions & 0 deletions b/‎.github/workflows/action_main.yml
Lines changed: 4 additions & 0 deletions
diff --git a/‎.github/workflows/build.yml
Lines changed: 1 addition & 1 deletion b/‎.github/workflows/build.yml
Lines changed: 1 addition & 1 deletion
diff --git a/‎.github/workflows/publish_helm.yml
Lines changed: 1 addition & 0 deletions b/‎.github/workflows/publish_helm.yml
Lines changed: 1 addition & 0 deletions
diff --git a/‎.github/workflows/publish_service.yml
Lines changed: 1 addition & 1 deletion b/‎.github/workflows/publish_service.yml
Lines changed: 1 addition & 1 deletion
diff --git a/‎README.rst
Lines changed: 108 additions & 1 deletion b/‎README.rst
Lines changed: 108 additions & 1 deletion
diff --git a/‎api-tests/api/lectures/l_id/submissions.bru
Lines changed: 16 additions & 0 deletions b/‎api-tests/api/lectures/l_id/submissions.bru
Lines changed: 16 additions & 0 deletions
diff --git a/‎api-tests/api/lectures/submissions.bru
Lines changed: 14 additions & 0 deletions b/‎api-tests/api/lectures/submissions.bru
Lines changed: 14 additions & 0 deletions
diff --git a/‎charts/grader-service/Chart.yaml
Lines changed: 2 additions & 2 deletions b/‎charts/grader-service/Chart.yaml
Lines changed: 2 additions & 2 deletions
diff --git a/‎charts/grader-service/pyproject.toml
Lines changed: 1 addition & 1 deletion b/‎charts/grader-service/pyproject.toml
Lines changed: 1 addition & 1 deletion
diff --git a/‎charts/grader-service/templates/configmap.yaml
Lines changed: 31 additions & 32 deletions b/‎charts/grader-service/templates/configmap.yaml
Lines changed: 31 additions & 32 deletions
@@ -1,6 +1,10 @@
 name: MAIN
 
 on:
+  pull_request:
+    branches:
+      - main
+      - release-*
   push:
     tags:
       - grader-service-* # for release_helm action
 
@@ -48,7 +48,7 @@ jobs:
 
     # Upload Artifacts
     - name: Archive service artifacts
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
         name: dist-service
         retention-days: 1
 
@@ -2,6 +2,7 @@ name: Release Charts
 
 on:
   workflow_call:
+  workflow_dispatch:
 
 jobs:
   release:
 
@@ -29,7 +29,7 @@ jobs:
         python -m pip install --upgrade pip
         pip install twine
     - name: Download a labextension artifact
-      uses: actions/download-artifact@v3
+      uses: actions/download-artifact@v4
       with:
         name: dist-service
         path: ./dist
 
@@ -103,8 +103,13 @@ This repository contains all the necessary packages for a full installation of t
     pip install grader-labextension
 
 
+Development Environment
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+Alternatively you can run the installation scripts in ``examples/dev_environment``.
+Follow the documentation there. The directory also contains the config files for a local installation.
 
-.. installation-end
+.. installation-from-soruce-end
 
 .. installation-from-soruce-start
 
@@ -141,3 +146,105 @@ Configuration
 ===============
 Check out the ``examples/dev_environment`` directory which contains configuration details or the (Administrator Guide)[https://grader-service.readthedocs.io/en/latest/admin/administrator.html].
 
+In order to use the grader service with an LMS like Moodle, the groups first have to be added to the JupyterHub so the grader service gets the necessary information from the hub.
+
+For this purpose, the `LTI 1.3 Authenticator <https://github.com/TU-Wien-dataLAB/lti13oauthenticator>`_ can be used so that users from the LMS can be added to the JupyterHub.
+
+To automatically add the groups for the grader service from the LTI authenticator, the following `post auth hook <https://jupyterhub.readthedocs.io/en/stable/api/auth.html#jupyterhub.auth.Authenticator.post_auth_hook>`_ can be used.
+
+.. code-block:: python
+
+    from jupyterhub import orm
+    import sqlalchemy
+
+    def post_auth_hook(authenticator, handler, authentication):
+        db: sqlalchemy.orm.session.Session = authenticator.db
+        log = authenticator.log
+
+        course_id = authentication["auth_state"]["course_id"].replace(" ","")
+        user_role = authentication["auth_state"]["user_role"]
+        user_name = authentication["name"]
+
+        # there are only Learner and Instructors
+        if user_role == "Learner":
+            user_role = "student"
+        elif user_role == "Instructor":
+            user_role = "instructor"
+        user_model: orm.User = orm.User.find(db, user_name)
+        if user_model is None:
+            user_model = orm.User()
+            user_model.name = user_name
+            db.add(user_model)
+            db.commit()
+
+        group_name = f"{course_id}:{user_role}"
+        group = orm.Group.find(db, group_name)
+        if group is None:
+            log.info(f"Creating group: '{group_name}'")
+            group = orm.Group()
+            group.name = group_name
+            db.add(group)
+            db.commit()
+
+        extra_grader_groups = [g for g in user_model.groups if g.name.startswith(f"{course_id}:") and g.name != group_name]
+        for g in extra_grader_groups:
+            log.info(f"Removing user from group: {g.name}")
+            g.users.remove(user_model)
+            db.commit()
+
+        if user_model not in group.users:
+            log.info(f"Adding user to group: {group.name}")
+            group.users.append(user_model)
+            db.commit()
+
+        return authentication
+
+
+Make sure that the ``course_id`` does not contain any spaces or special characters!
+
+Optional Configuration of JupyterLab >=3.4
+==========================================
+
+The grader labextension also uses the embedded cell toolbar of JupyterLab for further cell manipulation.
+These optional features include:
+
+* ``Run Cell``: This command simply run the current cell without advancing.
+
+* ``Revert Cell``: In the conversion process new metadata is set to allow students to revert every answer cell to their original state.
+
+* ``Show Hint``: Students can access a hint to a task if one is specified.
+
+To access these commands buttons have to be added to the JupyterLab cell toolbar by editing the `overrides.json file <https://jupyterlab.readthedocs.io/en/stable/user/directories.html#overridesjson>`_.
+We also recommend that all other built in cell toolbar buttons should be disabled in the config because they might enable unwanted cell manipulation by students.
+
+A sample overrides.json file could look like this:
+
+.. code-block:: json
+
+    {
+        "@jupyterlab/cell-toolbar-extension:plugin": {
+            "toolbar": [
+                {
+                    "args": {},
+                    "command": "notebookplugin:run-cell",
+                    "disabled": false,
+                    "rank": 501,
+                    "name": "run-cell"
+                },
+                {
+                    "args": {},
+                    "command": "notebookplugin:revert-cell",
+                    "disabled": false,
+                    "rank": 502,
+                    "name": "revert-cell"
+                },
+                {
+                    "args": {},
+                    "command": "notebookplugin:show-hint",
+                    "disabled": false,
+                    "rank": 503,
+                    "name": "show-hint"
+                }
+            ]
+        }
+    }
@@ -0,0 +1,16 @@
+meta {
+  name: submissions
+  type: http
+  seq: 4
+}
+
+get {
+  url: {{grader-base-url}}/api/lectures/1/submissions?filter=latest&format=json
+  body: none
+  auth: inherit
+}
+
+params:query {
+  filter: latest
+  format: json
+}
@@ -0,0 +1,14 @@
+meta {
+  name: submissions
+  type: http
+  seq: 4
+}
+get {
+  url: {{grader-base-url}}/api/lectures/1/submissions?filter=latest&format=json
+  body: none
+  auth: inherit
+}
+params:query {
+  filter: latest
+  format: json
+}
@@ -15,10 +15,10 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 0.6.4
+version: 0.7.3
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to
 # follow Semantic Versioning. They should reflect the version the application is using.
 # It is recommended to use it with quotes.
-appVersion: "0.6.3"
+appVersion: "0.7.3"
@@ -3,7 +3,7 @@
 github_url = "https://github.com/TU-Wien-dataLAB/grader-service"
 
 [tool.tbump.version]
-current = "0.6.4"
+current = "0.7.3"
 
 # Example of a semver regexp.
 # Make sure this matches current_version before
 
@@ -7,45 +7,43 @@ metadata:
     {{- include "grader-service.labels" . | nindent 4 }}
 data:
   grader_service_config.py: |
-{{ .Values.extraConfig | indent 4 }}
+    # Grader Service Config
+    ### Log Level
+    c.GraderService.log_level = "{{ .Values.logLevel }}"
 
-    {{ if eq .Values.autogradeExecutorClass "KubeAutogradeExecutor" }}
+    ### Autograde Executor
+{{- if eq .Values.autogradeExecutorClass "KubeAutogradeExecutor" }}
     from grader_service.autograding.kube.kube_grader import KubeAutogradeExecutor
     c.RequestHandlerConfig.autograde_executor_class = KubeAutogradeExecutor
-    {{ else }}
-    from grader_service.autograding.local_grader import LocalAutogradeExecutor
-    c.RequestHandlerConfig.autograde_executor_class = LocalAutogradeExecutor
-    {{ end }}
-
-
-    {{- if .Values.requestHandlerConfig }}
-    {{- if .Values.requestHandlerConfig.git_max_file_mb }}
-    c.RequestHandlerConfig.git_max_file_size_mb = {{ .Values.requestHandlerConfig.git_max_file_mb }}
-    {{- end }}
-    {{- end }}
-
     c.KubeAutogradeExecutor.kube_context = None
-
-    {{- if .Values.kubeAutogradeExecutor.namespace }}
+{{- if .Values.kubeAutogradeExecutor.namespace }}
     c.KubeAutogradeExecutor.namespace = {{ .Values.kubeAutogradeExecutor.namespace | quote }}
-    {{- end }}
-    {{- if .Values.kubeAutogradeExecutor.resolveImageName }}
-    c.KubeAutogradeExecutor.resolve_image_name = {{ .Values.kubeAutogradeExecutor.resolveImageName }}
-    {{- else }}
-
-    c.KubeAutogradeExecutor.resolve_image_name = lambda l, a: "{{ .Values.kubeAutogradeExecutor.image }}:{{ .Values.kubeAutogradeExecutor.tag | default .Chart.AppVersion }}"
-    {{- end }}
+{{- end }}
     c.KubeAutogradeExecutor.volume = {"name": "data", {{- if .Values.hostpath -}}"hostPath": {"path": "{{ .Values.hostpath }}", "type": "DirectoryOrCreate"} {{- else -}} "persistentVolumeClaim": {"claimName": "{{ include "grader-service.fullname" . }}"}{{- end -}} }
     c.KubeAutogradeExecutor.extra_volumes = {{ .Values.kubeAutogradeExecutor.extraVolumes | default "[]" }}
     c.KubeAutogradeExecutor.extra_volume_mounts = {{ .Values.kubeAutogradeExecutor.extraVolumeMounts | default "[]" }}
+    c.KubeAutogradeExecutor.labels = {{ .Values.kubeAutogradeExecutor.labels | toJson }}
+    c.KubeAutogradeExecutor.image_pull_secrets = {{ .Values.kubeAutogradeExecutor.imagePullSecrets | toJson }}
+    
+{{- else }}
+    from grader_service.autograding.local_grader import LocalAutogradeExecutor
+    c.RequestHandlerConfig.autograde_executor_class = LocalAutogradeExecutor
+{{- end }}
+
+{{- if .Values.requestHandlerConfig }}
+{{- if .Values.requestHandlerConfig.git_max_file_mb }}
+    c.RequestHandlerConfig.git_max_file_size_mb = {{ .Values.requestHandlerConfig.git_max_file_mb }}
+{{- end }}
+{{- end }}
 
+    ### Database
     c.GraderService.db_url = "{{ .Values.db.url }}"
     c.GraderService.max_buffer_size = {{ .Values.requestHandlerConfig.max_buffer_size | int }}
     c.GraderService.max_body_size = {{ .Values.requestHandlerConfig.max_body_size | int }}
 
+    ### RabbitMQ
     import os
     broker_url=f'amqp://{os.getenv("RABBITMQ_GRADER_SERVICE_USERNAME")}:{os.getenv("RABBITMQ_GRADER_SERVICE_PASSWORD")}@rabbitmq-grader-service.{{.Release.Namespace}}.svc.cluster.local'
-
     c.CeleryApp.conf = dict(
         broker_url=broker_url,
         result_backend='rpc://',
@@ -54,20 +52,21 @@ data:
         accept_content=['json'],
         broker_connection_retry_on_startup=True,
     )
-    {{- if .Values.ltiSyncGrades.enabled }}
+{{- if .Values.ltiSyncGrades.enabled }}
+    ### LTI Grade Sync Plugin 
     c.LTISyncGrades.enabled = True
-    {{- if .Values.ltiSyncGrades.sync_on_feedback }}
+{{- if .Values.ltiSyncGrades.sync_on_feedback }}
     c.LTISyncGrades.sync_on_feedback = True
-    {{- end }}
+{{- end }}
     c.LTISyncGrades.token_url = {{ .Values.ltiSyncGrades.token_url | quote }}
     c.LTISyncGrades.client_id = {{ .Values.ltiSyncGrades.client_id | quote }}
     c.LTISyncGrades.token_private_key = {{ .Values.ltiSyncGrades.token_private_key | quote }}
-    c.LTISyncGrades.resolve_lti_urls = {{ .Values.ltiSyncGrades.resolve_lti_urls }}
-    c.LTISyncGrades.username_match = {{ .Values.ltiSyncGrades.username_match | quote }}
-    {{- end }}
-
-    c.GraderService.log_level = "{{ .Values.logLevel }}"
+{{- end }}
 
+{{- if .Values.extraConfig }}
+    ### Extra Config
+{{ .Values.extraConfig | indent 4 }}
+{{- end }}
   .gitconfig: |
     [user]
       name = {{ .Values.gitConfig.gitUser }}