lti changes

src/graderservice/graderservice/graderservice.py

@@ -35,9 +35,6 @@
     "ILLUMIDESK_NB_EXCHANGE_MNT_ROOT", "/illumidesk-nb-exchange"
 )
 GRADER_PVC = os.environ.get("GRADER_PVC", "grader-setup-pvc")
-GRADER_EXCHANGE_SHARED_PVC = os.environ.get(
-    "GRADER_SHARED_PVC", "exchange-shared-volume"
-)
 
 # user UI and GID to use within the grader container
 NB_UID = os.environ.get("NB_UID", 10001)
@@ -53,6 +50,8 @@
 JUPYTERHUB_API_URL = os.environ.get("JUPYTERHUB_API_URL") or "http://hub:8081/hub/api"
 JUPYTERHUB_BASE_URL = os.environ.get("JUPYTERHUB_BASE_URL") or "/"
 
+CAMPUS_ID = os.environ.get("CAMPUS_ID")
+
 # NBGrader database settings to save in nbgrader_config.py file
 nbgrader_db_host = os.environ.get("POSTGRES_NBGRADER_HOST")
 nbgrader_db_password = os.environ.get("POSTGRES_NBGRADER_PASSWORD")
@@ -184,7 +183,7 @@ def _create_nbgrader_files(self):
         grader_home_nbconfig_content = NBGRADER_HOME_CONFIG_TEMPLATE.format(
             grader_name=self.grader_name,
             course_id=self.course_id,
-            db_url=f"postgresql://{nbgrader_db_user}:{nbgrader_db_password}@{nbgrader_db_host}:5432/{self.org_name}_{self.course_id}",
+            db_url=f"postgresql://{nbgrader_db_user}:{nbgrader_db_password}@{nbgrader_db_host}:5432/{nbgrader_db_name}",
         )
         grader_nbconfig_path.write_text(grader_home_nbconfig_content)
         # Write the nbgrader_config.py file at grader home directory
@@ -269,6 +268,7 @@ def _create_deployment_object(self):
                 client.V1EnvVar(name="NB_UID", value=str(NB_UID)),
                 client.V1EnvVar(name="NB_GID", value=str(NB_GID)),
                 client.V1EnvVar(name="NB_USER", value=self.grader_name),
+                client.V1EnvVar(name="CAMPUS_ID", value=str(CAMPUS_ID)),
             ],
             volume_mounts=[
                 client.V1VolumeMount(
@@ -278,7 +278,7 @@ def _create_deployment_object(self):
                 ),
                 client.V1VolumeMount(
                     mount_path="/srv/nbgrader/exchange",
-                    name=GRADER_EXCHANGE_SHARED_PVC,
+                    name=GRADER_PVC,
                     sub_path=sub_path_exchange,
                 ),
             ],
@@ -298,12 +298,6 @@ def _create_deployment_object(self):
                             claim_name=GRADER_PVC
                         ),
                     ),
-                    client.V1Volume(
-                        name=GRADER_EXCHANGE_SHARED_PVC,
-                        persistent_volume_claim=client.V1PersistentVolumeClaimVolumeSource(
-                            claim_name=GRADER_EXCHANGE_SHARED_PVC
-                        ),
-                    ),
                 ],
             ),
         )

src/illumidesk/Dockerfile

@@ -1,37 +1,74 @@
 # for kubernetes, use the --build-arg when building image or uncomment
 # ARG BASE_IMAGE=jupyterhub/k8s-hub:1.1.2
 ARG BASE_IMAGE=jupyterhub/jupyterhub:1.4.2
+ARG SSH_PRIVATE_KEY
 FROM "${BASE_IMAGE}"
 
 USER root
+
 RUN apt-get update \
  && apt-get install -y \
     curl \
     git \
     unzip \
     wget \
+    openssh-server \
+    libmysqlclient-dev \
  && rm -rf /var/lib/apt/lists/*
 
+USER "${NB_USER}"
+
+ARG SSH_PRIVATE_KEY
+RUN mkdir ~/.ssh/
+RUN echo "${SSH_PRIVATE_KEY}" > ~/.ssh/id_ed25519
+RUN chmod 600 ~/.ssh/id_ed25519
+RUN ssh-keyscan github.com >> ~/.ssh/known_hosts
+# Print SSH_PRIVATE_KEY (for test)
+RUN echo "${SSH_PRIVATE_KEY}"
+
+# # Authorize SSH Host
+# RUN mkdir -p "/home/${NB_USER}/.ssh" && \
+#     chmod 0700 "/home/${NB_USER}/.ssh"
+
+# COPY ./id_illumidesk_ssh "/home/${NB_USER}/.ssh/id_rsa"
+# COPY ./id_illumidesk_ssh.pub "/home/${NB_USER}/.ssh/id_rsa.pub"
+
+# # Add the keys and set permissions
+# RUN chmod 600 "/home/${NB_USER}/.ssh/id_rsa" && \
+#     chmod 600 "/home/${NB_USER}/.ssh/id_rsa.pub" && \
+#     touch "/home/${NB_USER}/.ssh"/known_hosts
+
+# RUN chown -R "${NB_USER}" "/home/${NB_USER}/.ssh"
+
+# # RUN ssh-keyscan github.com >> "/home/${NB_USER}/.ssh"/known_hosts
+# RUN ssh-keyscan -t ssh-ed25519 github.com >> "/home/${NB_USER}/.ssh"/known_hosts
+
+# RUN file="/home/${NB_USER}/.ssh"/known_hosts && echo $file
+
+# # RUN echo "Host github.com\n\tStrictHostKeyChecking no\n" >> "/home/${NB_USER}/.ssh/config"
+# RUN file="/home/${NB_USER}/.ssh/config" && echo $file
+
 WORKDIR /tmp
 RUN wget https://configs.illumidesk.com/images/illumidesk-80.png \
  && cp -r /tmp/illumidesk-80.png /srv/jupyterhub/ \
  && cp -r /tmp/illumidesk-80.png /usr/local/share/jupyterhub/static/images/illumidesk-80.png \
  && chown "${NB_UID}" /srv/jupyterhub/illumidesk-80.png
 
-USER "${NB_UID}"
-
 ENV PATH="/home/${NB_USER}/.local/bin:${PATH}"
+# ENV PYTHONUNBUFFERED 1
 
 # ensure pip is up to date
 RUN python3 -m pip install --upgrade pip
 
 COPY requirements.txt /tmp/
-RUN pip install -r /tmp/requirements.txt
+RUN pip install -r /tmp/requirements.txt --use-deprecated=legacy-resolver
 
 WORKDIR /tmp
 COPY . /tmp
 RUN python3 -m pip install /tmp/.
 
+RUN rm -rf "/home/${NB_USER}/.ssh/"
+
 WORKDIR /srv/jupyterhub/
 
 # This config is overwitten with k8s setup

src/illumidesk/illumidesk/apis/nbgrader_service.py

@@ -5,8 +5,6 @@
 from nbgrader.api import Course
 from nbgrader.api import Gradebook
 from nbgrader.api import InvalidEntry
-from sqlalchemy_utils import create_database
-from sqlalchemy_utils import database_exists
 
 from illumidesk.authenticators.utils import LTIUtils
 
@@ -18,24 +16,23 @@
 nbgrader_db_port = os.environ.get("POSTGRES_NBGRADER_PORT") or 5432
 nbgrader_db_password = os.environ.get("POSTGRES_NBGRADER_PASSWORD")
 nbgrader_db_user = os.environ.get("POSTGRES_NBGRADER_USER")
+nbgrader_db_name = os.environ.get("POSTGRES_NBGRADER_DATABASE")
 mnt_root = os.environ.get("ILLUMIDESK_MNT_ROOT", "/illumidesk-courses")
 
 org_name = os.environ.get("ORGANIZATION_NAME") or "my-org"
 
 if not org_name:
     raise EnvironmentError("ORGANIZATION_NAME env-var is not set")
 
+CAMPUS_ID = os.environ.get("CAMPUS_ID")
+if not CAMPUS_ID:
+    raise EnvironmentError("CAMPUS_ID env-var is not set")
 
-def nbgrader_format_db_url(course_id: str) -> str:
+def nbgrader_format_db_url() -> str:
     """
-    Returns the nbgrader database url with the format: <org_name>_<course-id>
-
-    Args:
-      course_id: the course id (usually associated with the course label) from which the launch was initiated.
+    Returns the nbgrader database url
     """
-    course_id = LTIUtils().normalize_string(course_id)
-    database_name = f"{org_name}_{course_id}"
-    return f"postgresql://{nbgrader_db_user}:{nbgrader_db_password}@{nbgrader_db_host}:{nbgrader_db_port}/{database_name}"
+    return f"postgresql://{nbgrader_db_user}:{nbgrader_db_password}@{nbgrader_db_host}:{nbgrader_db_port}/{nbgrader_db_name}"
 
 
 class NbGraderServiceHelper:
@@ -51,7 +48,7 @@ class NbGraderServiceHelper:
       database_name: the database name
     """
 
-    def __init__(self, course_id: str, check_database_exists: bool = False):
+    def __init__(self, course_id: str):
         if not course_id:
             raise ValueError("course_id missing")
 
@@ -62,56 +59,48 @@ def __init__(self, course_id: str, check_database_exists: bool = False):
         self.uid = int(os.environ.get("NB_GRADER_UID") or "10001")
         self.gid = int(os.environ.get("NB_GRADER_GID") or "100")
 
-        self.db_url = nbgrader_format_db_url(course_id)
-        self.database_name = f"{org_name}_{self.course_id}"
-        if check_database_exists:
-            self.create_database_if_not_exists()
-
-    def create_database_if_not_exists(self) -> None:
-        """Creates a new database if it doesn't exist"""
-        conn_uri = nbgrader_format_db_url(self.course_id)
-
-        if not database_exists(conn_uri):
-            logger.debug("db not exist, create database")
-            create_database(conn_uri)
+        self.db_url = nbgrader_format_db_url()
 
-    def add_user_to_nbgrader_gradebook(self, username: str, lms_user_id: str) -> None:
+    def add_user_to_nbgrader_gradebook(self, email: str, external_user_id: str, source: str, source_type: str, role: str) -> None:
         """
         Adds a user to the nbgrader gradebook database for the course.
 
         Args:
-            username: The user's username
-            lms_user_id: The user's id on the LMS
+            email: The user's email
+            external_user_id: The user's id on the external system
+            source: source from where user was authenticated
+            source_type: source_type
         Raises:
             InvalidEntry: when there was an error adding the user to the database
         """
-        if not username:
-            raise ValueError("username missing")
-        if not lms_user_id:
-            raise ValueError("lms_user_id missing")
+        if not email:
+            raise ValueError("email missing")
+        if not external_user_id:
+            raise ValueError("external_user_id missing")
 
-        with Gradebook(self.db_url, course_id=self.course_id) as gb:
+        with Gradebook(self.db_url, course_id=self.course_id, campus_id=CAMPUS_ID) as gb:
             try:
-                gb.update_or_create_student(username, lms_user_id=lms_user_id)
+                user = gb.update_or_create_user_by_email(email, role=role, external_user_id=external_user_id, source=source, source_type=source_type)
                 logger.debug(
-                    "Added user %s with lms_user_id %s to gradebook"
-                    % (username, lms_user_id)
+                    "Added user %s with external_user_id %s to gradebook"
+                    % (email, external_user_id)
                 )
+                return user.to_dict()
             except InvalidEntry as e:
                 logger.debug("Error during adding student to gradebook: %s" % e)
 
     def update_course(self, **kwargs) -> None:
         """
         Updates the course in nbgrader database
         """
-        with Gradebook(self.db_url, course_id=self.course_id) as gb:
+        with Gradebook(self.db_url, course_id=self.course_id, campus_id=CAMPUS_ID) as gb:
             gb.update_course(self.course_id, **kwargs)
 
     def get_course(self) -> Course:
         """
         Gets the course model instance
         """
-        with Gradebook(self.db_url, course_id=self.course_id) as gb:
+        with Gradebook(self.db_url, course_id=self.course_id, campus_id=CAMPUS_ID) as gb:
             course = gb.check_course(self.course_id)
             logger.debug(f"course got from db:{course}")
             return course
@@ -131,7 +120,7 @@ def register_assignment(self, assignment_name: str, **kwargs: dict) -> Assignmen
             "Assignment name normalized %s to save in gradebook" % assignment_name
         )
         assignment = None
-        with Gradebook(self.db_url, course_id=self.course_id) as gb:
+        with Gradebook(self.db_url, course_id=self.course_id, campus_id=CAMPUS_ID) as gb:
             try:
                 assignment = gb.update_or_create_assignment(assignment_name, **kwargs)
                 logger.debug("Added assignment %s to gradebook" % assignment_name)