10669586638

Committed 02 Sep 2024 03:10PM UTC coverage: 55.543% (+0.8%) from 54.79%

Build # 10669586638

Build Type

Pull #76

github

Committed by

web-flow

Commit Message

Merge 758f7821d into 401ca0a26

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

Run Details

416 of 904 branches covered (46.02%)

Branch coverage included in aggregate %.

50 of 56 new or added lines in 6 files covered. (89.29%)

222 existing lines in 3 files now uncovered.

1543 of 2623 relevant lines covered (58.83%)

0.59 hits per line

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

61.36

/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"})

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

tjcsl / tin / 10669586638

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