Model for CourseRoster

lms/models/__init__.py

@@ -4,6 +4,7 @@
 from lms.models.assignment_grouping import AssignmentGrouping
 from lms.models.assignment_membership import AssignmentMembership
 from lms.models.course_groups_exported_from_h import CourseGroupsExportedFromH
+from lms.models.course_roster import CourseRoster
 from lms.models.dashboard_admin import DashboardAdmin
 from lms.models.event import Event, EventData, EventType, EventUser
 from lms.models.exceptions import ReusedConsumerKey

lms/models/course_roster.py

@@ -0,0 +1,30 @@
+from sqlalchemy import ForeignKey, UniqueConstraint
+from sqlalchemy.orm import Mapped, mapped_column, relationship
+
+from lms.db import Base
+from lms.models._mixins import CreatedUpdatedMixin
+
+
+class CourseRoster(Base, CreatedUpdatedMixin):
+    __tablename__ = "course_roster"
+
+    id: Mapped[int] = mapped_column(autoincrement=True, primary_key=True)
+
+    lms_course_id: Mapped[int] = mapped_column(
+        ForeignKey("lms_course.id", ondelete="cascade")
+    )
+    lms_course = relationship("LMSCourse")
+
+    lms_user_id: Mapped[int] = mapped_column(
+        ForeignKey("lms_user.id", ondelete="cascade")
+    )
+    lms_user = relationship("LMSUser")
+
+    lti_role_id: Mapped[int] = mapped_column(
+        ForeignKey("lti_role.id", ondelete="cascade")
+    )
+    lti_role = relationship("LTIRole")
+
+    active: Mapped[bool] = mapped_column()
+
+    __table_args__ = (UniqueConstraint("lms_course_id", "lms_user_id", "lti_role_id"),)

lms/models/lti_role.py

@@ -70,7 +70,7 @@ class LTIRole(Base):
 
     id = sa.Column(sa.Integer(), autoincrement=True, primary_key=True)
 
-    _value = sa.Column("value", sa.UnicodeText(), nullable=False, unique=True)
+    _value: Mapped[str] = mapped_column("value", sa.UnicodeText(), unique=True)
     """The raw string from LTI params."""
 
     type = varchar_enum(RoleType)
@@ -80,7 +80,7 @@ class LTIRole(Base):
     """Scope where this role applies"""
 
     @hybrid_property
-    def value(self):
+    def value(self) -> str:
         return self._value
 
     @value.inplace.setter

lms/models/lti_user.py

@@ -101,7 +101,9 @@ def is_admin(self):
         )
 
 
-def display_name(given_name, family_name, full_name, custom_display_name):
+def display_name(
+    given_name: str, family_name: str, full_name: str, custom_display_name: str
+):
     """
     Return an h-compatible display name the given name parts.
 

tests/factories/__init__.py

@@ -18,6 +18,7 @@
     TOOL_CONSUMER_INSTANCE_GUID,
     USER_ID,
 )
+from tests.factories.course_roster import CourseRoster
 from tests.factories.dashboard_admin import DashboardAdmin
 from tests.factories.event import Event
 from tests.factories.file import File

tests/factories/course_roster.py

@@ -0,0 +1,6 @@
+from factory import make_factory
+from factory.alchemy import SQLAlchemyModelFactory
+
+from lms import models
+
+CourseRoster = make_factory(models.CourseRoster, FACTORY_CLASS=SQLAlchemyModelFactory)