10670571431

Committed 02 Sep 2024 04:33PM UTC coverage: 55.74% (+1.0%) from 54.79%

Build # 10670571431

Build Type

Pull #76

github

Committed by

web-flow

Commit Message

Merge 0350e7b4d into 401ca0a26

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

Run Details

421 of 910 branches covered (46.26%)

Branch coverage included in aggregate %.

62 of 68 new or added lines in 6 files covered. (91.18%)

138 existing lines in 2 files now uncovered.

1555 of 2635 relevant lines covered (59.01%)

0.59 hits per line

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

63.04

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

tjcsl / tin / 10670571431

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