11871397980

Committed 16 Nov 2024 03:55PM UTC coverage: 55.134% (+0.3%) from 54.79%

Build # 11871397980

Build Type

Pull #92

github

Committed by

web-flow

Commit Message

Merge 403c0bf11 into 6a43c847c

Pull Request Pull Request #92: Allow choosing custom versions of python for graders

Run Details

407 of 901 branches covered (45.17%)

Branch coverage included in aggregate %.

61 of 79 new or added lines in 12 files covered. (77.22%)

51 existing lines in 3 files now uncovered.

1542 of 2634 relevant lines covered (58.54%)

0.59 hits per line

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

60.47

/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 django.db.models import Q

from ..submissions.models import Submission
from .models import Assignment, Folder, Language, 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)

        instance = getattr(self, "instance", None)
        if instance and instance.pk:
            # allow them to change from a deprecated language to a non-deprecated one
            # but it must be the same (e.g. python -> python, or java -> java)
            self.fields["language_details"].queryset = Language.objects.filter(
                Q(is_deprecated=False) & Q(language=instance.language_details.language)
                # just nicer UI to show the deprecated language choice
                | Q(id=instance.language_details.id)
            )

        self.fields["language_details"].queryset = Language.objects.filter(is_deprecated=False)
        self.fields["language_details"].help_text = (
            "Keep in mind you cannot swap between languages after "
            "the assignment has been created."
        )

        # 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_details",
            "filename",
            "venv",
            "points_possible",
            "due",
            "hidden",
            "enable_grader_timeout",
            "grader_timeout",
            "grader_has_network_access",
            "has_network_access",
            "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?",
            "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?",
            "language_details": "Grader language",
        }
        sections = (
            {
                "name": "",
                "fields": (
                    "name",
                    "description",
                    "markdown",
                    "due",
                    "points_possible",
                    "hidden",
                ),
            },
            {
                "name": "Environment Setup",
                "description": "",
                "fields": (
                    "folder",
                    "language_details",
                    "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",
                ),
                "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.",
            "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."}

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	from django.db.models import Q	1✔
9
10	from ..submissions.models import Submission	1✔
11	from .models import Assignment, Folder, Language, MossResult	1✔
12
13	logger = getLogger(__name__)	1✔
14
15
16	class AssignmentForm(forms.ModelForm):	1✔
17	due = forms.DateTimeInput()	1✔
18
19	def __init__(self, course, args, *kwargs):	1✔
20	super().__init__(args, *kwargs)	1✔
21	self.fields["folder"].queryset = Folder.objects.filter(course=course)	1✔
22
23	instance = getattr(self, "instance", None)	1✔
24	if instance and instance.pk:	1!
25	# allow them to change from a deprecated language to a non-deprecated one
26	# but it must be the same (e.g. python -> python, or java -> java)
NEW 27	self.fields["language_details"].queryset = Language.objects.filter(	×
28	Q(is_deprecated=False) & Q(language=instance.language_details.language)
29	# just nicer UI to show the deprecated language choice
30	\| Q(id=instance.language_details.id)
31	)
32
33	self.fields["language_details"].queryset = Language.objects.filter(is_deprecated=False)	1✔
34	self.fields["language_details"].help_text = (	1✔
35	"Keep in mind you cannot swap between languages after "
36	"the assignment has been created."
37	)
38
39	# prevent description from getting too big
40	self.fields["description"].widget.attrs.update({"id": "description"})	1✔
41
42	def get_sections(self) -> Iterable[dict[str, str \| tuple[str, ...] \| bool]]:	1✔
43	"""This is used in templates to find which fields should be in a dropdown div."""
44	for section in self.Meta.sections:	×
45	if section["name"]:	×
46	# operate on copy so errors on refresh don't happen
47	new_section = section.copy()	×
48	new_section["fields"] = tuple(self[field] for field in new_section["fields"])	×
49	yield new_section	×
50
51	def get_main_section(self) -> dict[str, str \| tuple[str, ...]]:	1✔
52	"""This is the section that is NOT in a dropdown"""
53	for section in self.Meta.sections:	×
54	if section["name"] == "":	×
55	new_section = section.copy()	×
56	new_section["fields"] = tuple(self[field] for field in new_section["fields"])	×
57	return new_section	×
58	logger.error(f"Could not find main section for assignment {self}")	×
59	return {"fields": ()}	×
60
61	class Meta:	1✔
62	model = Assignment	1✔
63	fields = [	1✔
64	"name",
65	"description",
66	"markdown",
67	"folder",
68	"language_details",
69	"filename",
70	"venv",
71	"points_possible",
72	"due",
73	"hidden",
74	"enable_grader_timeout",
75	"grader_timeout",
76	"grader_has_network_access",
77	"has_network_access",
78	"submission_limit_count",
79	"submission_limit_interval",
80	"submission_limit_cooldown",
81	"is_quiz",
82	"quiz_action",
83	"quiz_autocomplete_enabled",
84	"quiz_description",
85	"quiz_description_markdown",
86	]
87	labels = {	1✔
88	"markdown": "Use markdown?",
89	"venv": "Virtual environment",
90	"hidden": "Hide assignment from students?",
91	"enable_grader_timeout": "Set a timeout for the grader?",
92	"grader_timeout": "Grader timeout (seconds):",
93	"grader_has_network_access": "Give the grader internet access?",
94	"has_network_access": "Give submissions internet access?",
95	"submission_limit_count": "Rate limit count",
96	"submission_limit_interval": "Rate limit interval (minutes)",
97	"submission_limit_cooldown": "Rate limit cooldown period (minutes)",
98	"is_quiz": "Is this a quiz?",
99	"quiz_autocomplete_enabled": "Enable code autocompletion?",
100	"quiz_description_markdown": "Use markdown?",
101	"language_details": "Grader language",
102	}
103	sections = (	1✔
104	{
105	"name": "",
106	"fields": (
107	"name",
108	"description",
109	"markdown",
110	"due",
111	"points_possible",
112	"hidden",
113	),
114	},
115	{
116	"name": "Environment Setup",
117	"description": "",
118	"fields": (
119	"folder",
120	"language_details",
121	"filename",
122	"venv",
123	),
124	"collapsed": False,
125	},
126	{
127	"name": "Quiz Options",
128	"description": "",
129	"fields": (
130	"is_quiz",
131	"quiz_action",
132	"quiz_autocomplete_enabled",
133	"quiz_description",
134	"quiz_description_markdown",
135	),
136	"collapsed": False,
137	},
138	{
139	"name": "Other Settings",
140	"description": "",
141	"fields": (
142	"enable_grader_timeout",
143	"grader_timeout",
144	"has_network_access",
145	"grader_has_network_access",
146	"submission_limit_count",
147	"submission_limit_interval",
148	"submission_limit_cooldown",
149	),
150	"collapsed": True,
151	},
152	)
153	help_texts = {	1✔
154	"filename": "Clarify which file students need to upload (including the file "
155	"extension). For Java assignments, this also sets the name of the "
156	"saved submission file.",
157	"markdown": "This allows adding images, code blocks, or hyperlinks to the assignment description.",
158	"venv": "If set, Tin will run the student's code in this virtual environment.",
159	"grader_has_network_access": 'If unset, this effectively disables "Give submissions '
160	'internet access" below. If set, it increases the amount '
161	"of time it takes to start up the grader (to about 1.5 "
162	"seconds). This is not recommended unless necessary.",
163	"submission_limit_count": "",
164	"submission_limit_interval": "Tin sets rate limits on submissions. If a student tries "
165	"to submit too many submissions in a given interval, "
166	"Tin will block further submissions until a cooldown "
167	"period has elapsed since the time of the last "
168	"submission.",
169	"submission_limit_cooldown": 'This sets the length of the "cooldown" period after a '
170	"student exceeds the rate limit for submissions.",
171	"folder": "If blank, assignment will show on the main classroom page.",
172	"is_quiz": "This forces students to submit through a page that monitors their actions. The below options "
173	"have no effect if this is unset.",
174	"quiz_action": "Tin will take the selected action if a student clicks off of the "
175	"quiz page.",
176	"quiz_autocomplete_enabled": "This gives students basic code completion in the quiz editor, including "
177	"variable names, built-in functions, and keywords. It's recommended for quizzes that focus on code logic "
178	"and not syntax.",
179	"quiz_description": "Unlike the assignment description (left) which shows up on the assignment page, the "
180	"quiz description only appears once the student has started the quiz. This is useful for quiz "
181	"instructions that need to be hidden until the student enters the monitored quiz environment.",
182	"quiz_description_markdown": "This allows adding images, code blocks, or hyperlinks to the quiz "
183	"description.",
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✔
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✔
230	super().__init__(args, *kwargs)	×
231	self.fields["period"].queryset = assignment.course.period_set.all()	×
232	if period:	×
233	self.fields["period"].initial = period	×
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✔

tjcsl / tin / 11871397980

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