10793401837

Committed 10 Sep 2024 01:23PM UTC coverage: 55.759% (+1.0%) from 54.79%

Build # 10793401837

Build Type

Pull #76

github

Committed by

web-flow

Commit Message

Merge 00d781fd8 into dcbc61ca2

Pull Request Pull Request #76: Quiz submission limit and Per Student Overrides

Run Details

421 of 911 branches covered (46.21%)

Branch coverage included in aggregate %.

66 of 73 new or added lines in 6 files covered. (90.41%)

108 existing lines in 1 file now uncovered.

1559 of 2640 relevant lines covered (59.05%)

0.59 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

63.11

/tin/apps/assignments/forms.py

from __future__ import annotations

from collections.abc import Iterable
from logging import getLogger

from django import forms
from django.conf import settings

from ..submissions.models import Submission
from .models import Assignment, AssignmentOverride, Folder, MossResult

logger = getLogger(__name__)


class AssignmentForm(forms.ModelForm):
    due = forms.DateTimeInput()

    def __init__(self, course, *args, **kwargs):
        super().__init__(*args, **kwargs)
        self.fields["folder"].queryset = Folder.objects.filter(course=course)

        # Prevent changing the language of an assignment after it has been created
        instance = getattr(self, "instance", None)
        if instance and instance.pk:
            self.fields["language"].help_text = (
                "Changing this after uploading a grader script is not recommended and will cause "
                "issues."
            )

        # prevent description from getting too big
        self.fields["description"].widget.attrs.update({"id": "description"})

        # these fields aren't required
        for field in ("submission_cap", "submission_cap_after_due"):
            self.fields[field].required = False

    def clean(self) -> dict:
        super().clean()
        if self.cleaned_data["submission_cap"] is None and self.cleaned_data["use_submission_cap"]:
            self.add_error(
                "submission_cap", "this field is required if use submission cap is enabled."
            )
        elif self.cleaned_data["submission_cap_after_due"] is None:
            self.cleaned_data["submission_cap_after_due"] = self.cleaned_data["submission_cap"]
        return self.cleaned_data

    def get_sections(self) -> Iterable[dict[str, str | tuple[str, ...] | bool]]:
        """This is used in templates to find which fields should be in a dropdown div."""
        for section in self.Meta.sections:
            if section["name"]:
                # operate on copy so errors on refresh don't happen
                new_section = section.copy()
                new_section["fields"] = tuple(self[field] for field in new_section["fields"])
                yield new_section

    def get_main_section(self) -> dict[str, str | tuple[str, ...]]:
        """This is the section that is NOT in a dropdown"""
        for section in self.Meta.sections:
            if section["name"] == "":
                new_section = section.copy()
                new_section["fields"] = tuple(self[field] for field in new_section["fields"])
                return new_section
        logger.error(f"Could not find main section for assignment {self}")
        return {"fields": ()}

    class Meta:
        model = Assignment
        fields = [
            "name",
            "description",
            "markdown",
            "folder",
            "language",
            "filename",
            "venv",
            "points_possible",
            "due",
            "hidden",
            "enable_grader_timeout",
            "grader_timeout",
            "grader_has_network_access",
            "has_network_access",
            "use_submission_cap",
            "submission_cap",
            "submission_cap_after_due",
            "submission_limit_count",
            "submission_limit_interval",
            "submission_limit_cooldown",
            "is_quiz",
            "quiz_action",
            "quiz_autocomplete_enabled",
            "quiz_description",
            "quiz_description_markdown",
        ]
        labels = {
            "markdown": "Use markdown?",
            "venv": "Virtual environment",
            "hidden": "Hide assignment from students?",
            "enable_grader_timeout": "Set a timeout for the grader?",
            "grader_timeout": "Grader timeout (seconds):",
            "grader_has_network_access": "Give the grader internet access?",
            "has_network_access": "Give submissions internet access?",
            "use_submission_cap": "Cap submissions?",
            "submission_limit_count": "Rate limit count",
            "submission_limit_interval": "Rate limit interval (minutes)",
            "submission_limit_cooldown": "Rate limit cooldown period (minutes)",
            "is_quiz": "Is this a quiz?",
            "quiz_autocomplete_enabled": "Enable code autocompletion?",
            "quiz_description_markdown": "Use markdown?",
        }
        sections = (
            {
                "name": "",
                "fields": (
                    "name",
                    "description",
                    "markdown",
                    "due",
                    "points_possible",
                    "hidden",
                ),
            },
            {
                "name": "Environment Setup",
                "description": "",
                "fields": (
                    "folder",
                    "language",
                    "filename",
                    "venv",
                ),
                "collapsed": False,
            },
            {
                "name": "Quiz Options",
                "description": "",
                "fields": (
                    "is_quiz",
                    "quiz_action",
                    "quiz_autocomplete_enabled",
                    "quiz_description",
                    "quiz_description_markdown",
                ),
                "collapsed": False,
            },
            {
                "name": "Other Settings",
                "description": "",
                "fields": (
                    "enable_grader_timeout",
                    "grader_timeout",
                    "has_network_access",
                    "grader_has_network_access",
                    "submission_limit_count",
                    "submission_limit_interval",
                    "submission_limit_cooldown",
                    "use_submission_cap",
                    "submission_cap",
                    "submission_cap_after_due",
                ),
                "collapsed": True,
            },
        )
        help_texts = {
            "filename": "Clarify which file students need to upload (including the file "
            "extension). For Java assignments, this also sets the name of the "
            "saved submission file.",
            "markdown": "This allows adding images, code blocks, or hyperlinks to the assignment description.",
            "venv": "If set, Tin will run the student's code in this virtual environment.",
            "grader_has_network_access": 'If unset, this effectively disables "Give submissions '
            'internet access" below. If set, it increases the amount '
            "of time it takes to start up the grader (to about 1.5 "
            "seconds). This is not recommended unless necessary.",
            "use_submission_cap": "This enables setting a limit on the number of submissions that can be made on assignments."
            "It has no effect on quizzes",
            "submission_cap": "The maximum number of submissions that can be made. It can be overridden on a per-student basis.",
            "submission_limit_count": "",
            "submission_limit_interval": "Tin sets rate limits on submissions. If a student tries "
            "to submit too many submissions in a given interval, "
            "Tin will block further submissions until a cooldown "
            "period has elapsed since the time of the last "
            "submission.",
            "submission_limit_cooldown": 'This sets the length of the "cooldown" period after a '
            "student exceeds the rate limit for submissions.",
            "folder": "If blank, assignment will show on the main classroom page.",
            "is_quiz": "This forces students to submit through a page that monitors their actions. The below options "
            "have no effect if this is unset.",
            "quiz_action": "Tin will take the selected action if a student clicks off of the "
            "quiz page.",
            "quiz_autocomplete_enabled": "This gives students basic code completion in the quiz editor, including "
            "variable names, built-in functions, and keywords. It's recommended for quizzes that focus on code logic "
            "and not syntax.",
            "quiz_description": "Unlike the assignment description (left) which shows up on the assignment page, the "
            "quiz description only appears once the student has started the quiz. This is useful for quiz "
            "instructions that need to be hidden until the student enters the monitored quiz environment.",
            "quiz_description_markdown": "This allows adding images, code blocks, or hyperlinks to the quiz "
            "description.",
        }
        widgets = {
            "description": forms.Textarea(attrs={"cols": 30, "rows": 8}),
            "quiz_description": forms.Textarea(attrs={"cols": 30, "rows": 6}),
        }

    def __str__(self) -> str:
        return f"AssignmentForm(\"{self['name'].value()}\")"


class GraderScriptUploadForm(forms.Form):
    grader_file = forms.FileField(
        label="Upload grader",
        max_length=settings.SUBMISSION_SIZE_LIMIT,
        allow_empty_file=False,
        help_text="Size limit is 1MB.",
    )


class FileUploadForm(forms.Form):
    upload_file = forms.FileField(
        max_length=settings.SUBMISSION_SIZE_LIMIT,
        allow_empty_file=False,
        help_text="Size limit is 1MB.",
    )


class FileSubmissionForm(forms.Form):
    file = forms.FileField(
        label="",
        max_length=settings.SUBMISSION_SIZE_LIMIT,
        allow_empty_file=False,
        help_text="You can also drag files onto this page to submit them. Size limit is 1MB.",
    )


class TextSubmissionForm(forms.ModelForm):
    text = forms.CharField(label="", widget=forms.Textarea(attrs={"cols": 130, "rows": 20}))

    class Meta:
        model = Submission
        fields = []


class MossForm(forms.ModelForm):
    def __init__(self, assignment, period, *args, **kwargs):
        super().__init__(*args, **kwargs)
        self.fields["period"].queryset = assignment.course.period_set.all()
        if period:
            self.fields["period"].initial = period
        self.fields["language"].initial = (
            "java" if assignment.filename.endswith(".java") else "python"
        )

    class Meta:
        model = MossResult
        fields = ["period", "language", "base_file", "user_id"]
        help_texts = {
            "period": "Leave blank to run Moss on all students in the course.",
            "base_file": "The assignment's shell code (optional).",
        }


class FolderForm(forms.ModelForm):
    class Meta:
        model = Folder
        fields = [
            "name",
        ]
        help_texts = {"name": "Note: Folders are ordered alphabetically."}


class AssignmentOverrideForm(forms.ModelForm):
    class Meta:
        model = AssignmentOverride
        fields = [
            "submission_cap",
        ]
        help_texts = {"submission_cap": "The maximum number of submissions that can be made."}

1	from __future__ import annotations	1✔
2
3	from collections.abc import Iterable	1✔
4	from logging import getLogger	1✔
5
6	from django import forms	1✔
7	from django.conf import settings	1✔
8
9	from ..submissions.models import Submission	1✔
10	from .models import Assignment, AssignmentOverride, Folder, MossResult	1✔
11
12	logger = getLogger(__name__)	1✔
13
14
15	class AssignmentForm(forms.ModelForm):	1✔
16	due = forms.DateTimeInput()	1✔
17
18	def __init__(self, course, args, *kwargs):	1✔
19	super().__init__(args, *kwargs)	1✔
20	self.fields["folder"].queryset = Folder.objects.filter(course=course)	1✔
21
22	# Prevent changing the language of an assignment after it has been created
23	instance = getattr(self, "instance", None)	1✔
24	if instance and instance.pk:	1!
25	self.fields["language"].help_text = (	×
26	"Changing this after uploading a grader script is not recommended and will cause "
27	"issues."
28	)
29
30	# prevent description from getting too big
31	self.fields["description"].widget.attrs.update({"id": "description"})	1✔
32
33	# these fields aren't required
34	for field in ("submission_cap", "submission_cap_after_due"):	1✔
35	self.fields[field].required = False	1✔
36
37	def clean(self) -> dict:	1✔
38	super().clean()	1✔
39	if self.cleaned_data["submission_cap"] is None and self.cleaned_data["use_submission_cap"]:	1!
NEW 40	self.add_error(	×
41	"submission_cap", "this field is required if use submission cap is enabled."
42	)
43	elif self.cleaned_data["submission_cap_after_due"] is None:	1!
NEW 44	self.cleaned_data["submission_cap_after_due"] = self.cleaned_data["submission_cap"]	×
45	return self.cleaned_data	1✔
46
47	def get_sections(self) -> Iterable[dict[str, str \| tuple[str, ...] \| bool]]:	1✔
48	"""This is used in templates to find which fields should be in a dropdown div."""
49	for section in self.Meta.sections:	×
50	if section["name"]:	×
51	# operate on copy so errors on refresh don't happen
52	new_section = section.copy()	×
53	new_section["fields"] = tuple(self[field] for field in new_section["fields"])	×
54	yield new_section	×
55
56	def get_main_section(self) -> dict[str, str \| tuple[str, ...]]:	1✔
57	"""This is the section that is NOT in a dropdown"""
58	for section in self.Meta.sections:	×
59	if section["name"] == "":	×
60	new_section = section.copy()	×
61	new_section["fields"] = tuple(self[field] for field in new_section["fields"])	×
62	return new_section	×
63	logger.error(f"Could not find main section for assignment {self}")	×
64	return {"fields": ()}	×
65
66	class Meta:	1✔
67	model = Assignment	1✔
68	fields = [	1✔
69	"name",
70	"description",
71	"markdown",
72	"folder",
73	"language",
74	"filename",
75	"venv",
76	"points_possible",
77	"due",
78	"hidden",
79	"enable_grader_timeout",
80	"grader_timeout",
81	"grader_has_network_access",
82	"has_network_access",
83	"use_submission_cap",
84	"submission_cap",
85	"submission_cap_after_due",
86	"submission_limit_count",
87	"submission_limit_interval",
88	"submission_limit_cooldown",
89	"is_quiz",
90	"quiz_action",
91	"quiz_autocomplete_enabled",
92	"quiz_description",
93	"quiz_description_markdown",
94	]
95	labels = {	1✔
96	"markdown": "Use markdown?",
97	"venv": "Virtual environment",
98	"hidden": "Hide assignment from students?",
99	"enable_grader_timeout": "Set a timeout for the grader?",
100	"grader_timeout": "Grader timeout (seconds):",
101	"grader_has_network_access": "Give the grader internet access?",
102	"has_network_access": "Give submissions internet access?",
103	"use_submission_cap": "Cap submissions?",
104	"submission_limit_count": "Rate limit count",
105	"submission_limit_interval": "Rate limit interval (minutes)",
106	"submission_limit_cooldown": "Rate limit cooldown period (minutes)",
107	"is_quiz": "Is this a quiz?",
108	"quiz_autocomplete_enabled": "Enable code autocompletion?",
109	"quiz_description_markdown": "Use markdown?",
110	}
111	sections = (	1✔
112	{
113	"name": "",
114	"fields": (
115	"name",
116	"description",
117	"markdown",
118	"due",
119	"points_possible",
120	"hidden",
121	),
122	},
123	{
124	"name": "Environment Setup",
125	"description": "",
126	"fields": (
127	"folder",
128	"language",
129	"filename",
130	"venv",
131	),
132	"collapsed": False,
133	},
134	{
135	"name": "Quiz Options",
136	"description": "",
137	"fields": (
138	"is_quiz",
139	"quiz_action",
140	"quiz_autocomplete_enabled",
141	"quiz_description",
142	"quiz_description_markdown",
143	),
144	"collapsed": False,
145	},
146	{
147	"name": "Other Settings",
148	"description": "",
149	"fields": (
150	"enable_grader_timeout",
151	"grader_timeout",
152	"has_network_access",
153	"grader_has_network_access",
154	"submission_limit_count",
155	"submission_limit_interval",
156	"submission_limit_cooldown",
157	"use_submission_cap",
158	"submission_cap",
159	"submission_cap_after_due",
160	),
161	"collapsed": True,
162	},
163	)
164	help_texts = {	1✔
165	"filename": "Clarify which file students need to upload (including the file "
166	"extension). For Java assignments, this also sets the name of the "
167	"saved submission file.",
168	"markdown": "This allows adding images, code blocks, or hyperlinks to the assignment description.",
169	"venv": "If set, Tin will run the student's code in this virtual environment.",
170	"grader_has_network_access": 'If unset, this effectively disables "Give submissions '
171	'internet access" below. If set, it increases the amount '
172	"of time it takes to start up the grader (to about 1.5 "
173	"seconds). This is not recommended unless necessary.",
174	"use_submission_cap": "This enables setting a limit on the number of submissions that can be made on assignments."
175	"It has no effect on quizzes",
176	"submission_cap": "The maximum number of submissions that can be made. It can be overridden on a per-student basis.",
177	"submission_limit_count": "",
178	"submission_limit_interval": "Tin sets rate limits on submissions. If a student tries "
179	"to submit too many submissions in a given interval, "
180	"Tin will block further submissions until a cooldown "
181	"period has elapsed since the time of the last "
182	"submission.",
183	"submission_limit_cooldown": 'This sets the length of the "cooldown" period after a '
184	"student exceeds the rate limit for submissions.",
185	"folder": "If blank, assignment will show on the main classroom page.",
186	"is_quiz": "This forces students to submit through a page that monitors their actions. The below options "
187	"have no effect if this is unset.",
188	"quiz_action": "Tin will take the selected action if a student clicks off of the "
189	"quiz page.",
190	"quiz_autocomplete_enabled": "This gives students basic code completion in the quiz editor, including "
191	"variable names, built-in functions, and keywords. It's recommended for quizzes that focus on code logic "
192	"and not syntax.",
193	"quiz_description": "Unlike the assignment description (left) which shows up on the assignment page, the "
194	"quiz description only appears once the student has started the quiz. This is useful for quiz "
195	"instructions that need to be hidden until the student enters the monitored quiz environment.",
196	"quiz_description_markdown": "This allows adding images, code blocks, or hyperlinks to the quiz "
197	"description.",
198	}
199	widgets = {	1✔
200	"description": forms.Textarea(attrs={"cols": 30, "rows": 8}),
201	"quiz_description": forms.Textarea(attrs={"cols": 30, "rows": 6}),
202	}
203
204	def __str__(self) -> str:	1✔
205	return f"AssignmentForm(\"{self['name'].value()}\")"	×
206
207
208	class GraderScriptUploadForm(forms.Form):	1✔
209	grader_file = forms.FileField(	1✔
210	label="Upload grader",
211	max_length=settings.SUBMISSION_SIZE_LIMIT,
212	allow_empty_file=False,
213	help_text="Size limit is 1MB.",
214	)
215
216
217	class FileUploadForm(forms.Form):	1✔
218	upload_file = forms.FileField(	1✔
219	max_length=settings.SUBMISSION_SIZE_LIMIT,
220	allow_empty_file=False,
221	help_text="Size limit is 1MB.",
222	)
223
224
225	class FileSubmissionForm(forms.Form):	1✔
226	file = forms.FileField(	1✔
227	label="",
228	max_length=settings.SUBMISSION_SIZE_LIMIT,
229	allow_empty_file=False,
230	help_text="You can also drag files onto this page to submit them. Size limit is 1MB.",
231	)
232
233
234	class TextSubmissionForm(forms.ModelForm):	1✔
235	text = forms.CharField(label="", widget=forms.Textarea(attrs={"cols": 130, "rows": 20}))	1✔
236
237	class Meta:	1✔
238	model = Submission	1✔
239	fields = []	1✔
240
241
242	class MossForm(forms.ModelForm):	1✔
243	def __init__(self, assignment, period, args, *kwargs):	1✔
244	super().__init__(args, *kwargs)	×
245	self.fields["period"].queryset = assignment.course.period_set.all()	×
246	if period:	×
247	self.fields["period"].initial = period	×
248	self.fields["language"].initial = (	×
249	"java" if assignment.filename.endswith(".java") else "python"
250	)
251
252	class Meta:	1✔
253	model = MossResult	1✔
254	fields = ["period", "language", "base_file", "user_id"]	1✔
255	help_texts = {	1✔
256	"period": "Leave blank to run Moss on all students in the course.",
257	"base_file": "The assignment's shell code (optional).",
258	}
259
260
261	class FolderForm(forms.ModelForm):	1✔
262	class Meta:	1✔
263	model = Folder	1✔
264	fields = [	1✔
265	"name",
266	]
267	help_texts = {"name": "Note: Folders are ordered alphabetically."}	1✔
268
269
270	class AssignmentOverrideForm(forms.ModelForm):	1✔
271	class Meta:	1✔
272	model = AssignmentOverride	1✔
273	fields = [	1✔
274	"submission_cap",
275	]
276	help_texts = {"submission_cap": "The maximum number of submissions that can be made."}	1✔

tjcsl / tin / 10793401837

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous