32
30
from storm.locals import create_database, Store, Int, Unicode, DateTime, \
33
31
Reference, ReferenceSet, Bool, Storm, Desc
34
from storm.expr import Select, Max
35
32
from storm.exceptions import NotOneError, IntegrityError
37
34
from ivle.worksheet.rst import rst
201
190
return self._get_enrolments(False)
203
192
def get_projects(self, offering=None, active_only=True):
204
"""Find projects that the user can submit.
193
'''Return Projects that the user can submit.
206
195
This will include projects for offerings in which the user is
207
196
enrolled, as long as the project is not in a project set which has
208
197
groups (ie. if maximum number of group members is 0).
210
@param active_only: Whether to only search active offerings.
211
@param offering: An optional offering to restrict the search to.
199
Unless active_only is False, only projects for active offerings will
202
If an offering is specified, returned projects will be limited to
203
those for that offering.
213
205
return Store.of(self).find(Project,
214
206
Project.project_set_id == ProjectSet.id,
215
207
ProjectSet.max_students_per_group == None,
218
210
Semester.id == Offering.semester_id,
219
211
(not active_only) or (Semester.state == u'current'),
220
212
Enrolment.offering_id == Offering.id,
221
Enrolment.user_id == self.id,
222
Enrolment.active == True)
213
Enrolment.user_id == self.id)
225
216
def hash_password(password):
226
"""Hash a password with MD5."""
227
217
return hashlib.md5(password).hexdigest()
230
220
def get_by_login(cls, store, login):
231
"""Find a user in a store by login name."""
222
Get the User from the db associated with a given store and
232
225
return store.find(cls, cls.login == unicode(login)).one()
234
def get_svn_url(self, config):
235
"""Get the subversion repository URL for this user or group."""
236
url = config['urls']['svn_addr']
237
path = 'users/%s' % self.login
238
return urlparse.urljoin(url, path)
240
def get_permissions(self, user, config):
241
"""Determine privileges held by a user over this object.
243
If the user requesting privileges is this user or an admin,
244
they may do everything. Otherwise they may do nothing.
227
def get_permissions(self, user):
246
228
if user and user.admin or user is self:
247
return set(['view_public', 'view', 'edit', 'submit_project'])
229
return set(['view', 'edit', 'submit_project'])
249
return set(['view_public'])
251
233
# SUBJECTS AND ENROLMENTS #
253
235
class Subject(Storm):
254
"""A subject (or course) which is run in some semesters."""
256
236
__storm_table__ = "subject"
258
238
id = Int(primary=True, name="subjectid")
259
239
code = Unicode(name="subj_code")
260
240
name = Unicode(name="subj_name")
261
241
short_name = Unicode(name="subj_short_name")
263
244
offerings = ReferenceSet(id, 'Offering.subject_id')
291
265
Semester.state == u'current')
293
267
def offering_for_semester(self, year, semester):
294
"""Get the offering for the given year/semester, or None.
296
@param year: A string representation of the year.
297
@param semester: A string representation of the semester.
268
"""Get the offering for the given year/semester, or None."""
299
269
return self.offerings.find(Offering.semester_id == Semester.id,
300
270
Semester.year == unicode(year),
301
Semester.url_name == unicode(semester)).one()
271
Semester.semester == unicode(semester)).one()
303
273
class Semester(Storm):
304
"""A semester in which subjects can be run."""
306
274
__storm_table__ = "semester"
308
276
id = Int(primary=True, name="semesterid")
312
display_name = Unicode()
313
279
state = Unicode()
315
281
offerings = ReferenceSet(id, 'Offering.semester_id')
364
320
def enrol(self, user, role=u'student'):
365
"""Enrol a user in this offering.
367
Enrolments handle both the staff and student cases. The role controls
368
the privileges granted by this enrolment.
321
'''Enrol a user in this offering.'''
370
322
enrolment = Store.of(self).find(Enrolment,
371
323
Enrolment.user_id == user.id,
372
324
Enrolment.offering_id == self.id).one()
385
337
Enrolment.offering_id == self.id).one()
386
338
Store.of(enrolment).remove(enrolment)
388
def get_permissions(self, user, config):
340
def get_permissions(self, user):
390
342
if user is not None:
391
343
enrolment = self.get_enrolment(user)
392
344
if enrolment or user.admin:
393
345
perms.add('view')
394
if enrolment and enrolment.role == u'tutor':
395
perms.add('view_project_submissions')
396
# Site-specific policy on the role of tutors
397
if config['policy']['tutors_can_enrol_students']:
399
perms.add('enrol_student')
400
if config['policy']['tutors_can_edit_worksheets']:
401
perms.add('edit_worksheets')
402
if config['policy']['tutors_can_admin_groups']:
403
perms.add('admin_groups')
404
if (enrolment and enrolment.role in (u'lecturer')) or user.admin:
405
perms.add('view_project_submissions')
406
perms.add('admin_groups')
407
perms.add('edit_worksheets')
408
perms.add('view_worksheet_marks')
409
perms.add('edit') # Can edit projects & details
410
perms.add('enrol') # Can see enrolment screen at all
411
perms.add('enrol_student') # Can enrol students
412
perms.add('enrol_tutor') # Can enrol tutors
414
perms.add('enrol_lecturer') # Can enrol lecturers
346
if (enrolment and enrolment.role in (u'tutor', u'lecturer')) \
417
351
def get_enrolment(self, user):
418
"""Find the user's enrolment in this offering."""
420
353
enrolment = self.enrolments.find(user=user).one()
421
354
except NotOneError:
426
def get_members_by_role(self, role):
427
return Store.of(self).find(User,
428
Enrolment.user_id == User.id,
429
Enrolment.offering_id == self.id,
430
Enrolment.role == role
431
).order_by(User.login)
435
return self.get_members_by_role(u'student')
437
def get_open_projects_for_user(self, user):
438
"""Find all projects currently open to submissions by a user."""
439
# XXX: Respect extensions.
440
return self.projects.find(Project.deadline > datetime.datetime.now())
442
def has_worksheet_cutoff_passed(self, user):
443
"""Check whether the worksheet cutoff has passed.
444
A user is required, in case we support extensions.
446
if self.worksheet_cutoff is None:
449
return self.worksheet_cutoff < datetime.datetime.now()
451
def clone_worksheets(self, source):
452
"""Clone all worksheets from the specified source to this offering."""
453
import ivle.worksheet.utils
454
for worksheet in source.worksheets:
456
newws.seq_no = worksheet.seq_no
457
newws.identifier = worksheet.identifier
458
newws.name = worksheet.name
459
newws.assessable = worksheet.assessable
460
newws.published = worksheet.published
461
newws.data = worksheet.data
462
newws.format = worksheet.format
463
newws.offering = self
464
Store.of(self).add(newws)
465
ivle.worksheet.utils.update_exerciselist(newws)
468
359
class Enrolment(Storm):
469
"""An enrolment of a user in an offering.
471
This represents the roles of both staff and students.
474
360
__storm_table__ = "enrolment"
475
361
__storm_primary__ = "user_id", "offering_id"
496
382
return "<%s %r in %r>" % (type(self).__name__, self.user,
499
def get_permissions(self, user, config):
500
# A user can edit any enrolment that they could have created.
502
if ('enrol_' + str(self.role)) in self.offering.get_permissions(
508
"""Delete this enrolment."""
509
Store.of(self).remove(self)
514
387
class ProjectSet(Storm):
515
"""A set of projects that share common groups.
517
Each student project group is attached to a project set. The group is
518
valid for all projects in the group's set.
521
388
__storm_table__ = "project_set"
523
390
id = Int(name="projectsetid", primary=True)
534
401
return "<%s %d in %r>" % (type(self).__name__, self.id,
537
def get_permissions(self, user, config):
538
return self.offering.get_permissions(user, config)
540
def get_groups_for_user(self, user):
541
"""List all groups in this offering of which the user is a member."""
543
return Store.of(self).find(
545
ProjectGroupMembership.user_id == user.id,
546
ProjectGroupMembership.project_group_id == ProjectGroup.id,
547
ProjectGroup.project_set_id == self.id)
549
def get_submission_principal(self, user):
550
"""Get the principal on behalf of which the user can submit.
552
If this is a solo project set, the given user is returned. If
553
the user is a member of exactly one group, all the group is
554
returned. Otherwise, None is returned.
557
groups = self.get_groups_for_user(user)
558
if groups.count() == 1:
567
return self.max_students_per_group is not None
571
"""Get the entities (groups or users) assigned to submit this project.
573
This will be a Storm ResultSet.
575
#If its a solo project, return everyone in offering
577
return self.project_groups
579
return self.offering.students
581
class DeadlinePassed(Exception):
582
"""An exception indicating that a project cannot be submitted because the
583
deadline has passed."""
587
return "The project deadline has passed"
589
404
class Project(Storm):
590
"""A student project for which submissions can be made."""
592
405
__storm_table__ = "project"
594
407
id = Int(name="projectid", primary=True)
612
425
return "<%s '%s' in %r>" % (type(self).__name__, self.short_name,
613
426
self.project_set.offering)
615
def can_submit(self, principal, user, late=False):
617
@param late: If True, does not take the deadline into account.
428
def can_submit(self, principal):
619
429
return (self in principal.get_projects() and
620
(late or not self.has_deadline_passed(user)))
430
self.deadline > datetime.datetime.now())
622
def submit(self, principal, path, revision, who, late=False):
432
def submit(self, principal, path, revision, who):
623
433
"""Submit a Subversion path and revision to a project.
625
@param principal: The owner of the Subversion repository, and the
626
entity on behalf of whom the submission is being made
627
@param path: A path within that repository to submit.
628
@param revision: The revision of that path to submit.
629
@param who: The user who is actually making the submission.
630
@param late: If True, will not raise a DeadlinePassed exception even
631
after the deadline. (Default False.)
435
'principal' is the owner of the Subversion repository, and the
436
entity on behalf of whom the submission is being made. 'path' is
437
a path within that repository, and 'revision' specifies which
438
revision of that path. 'who' is the person making the submission.
634
if not self.can_submit(principal, who, late=late):
635
raise DeadlinePassed()
441
if not self.can_submit(principal):
442
raise Exception('cannot submit')
637
444
a = Assessed.get(Store.of(self), principal, self)
638
445
ps = ProjectSubmission()
639
# Raise SubmissionError if the path is illegal
640
ps.path = ProjectSubmission.test_and_normalise_path(path)
641
447
ps.revision = revision
642
448
ps.date_submitted = datetime.datetime.now()
648
def get_permissions(self, user, config):
649
return self.project_set.offering.get_permissions(user, config)
652
def latest_submissions(self):
653
"""Return the latest submission for each Assessed."""
654
return Store.of(self).find(ProjectSubmission,
655
Assessed.project_id == self.id,
656
ProjectSubmission.assessed_id == Assessed.id,
657
ProjectSubmission.date_submitted == Select(
658
Max(ProjectSubmission.date_submitted),
659
ProjectSubmission.assessed_id == Assessed.id,
660
tables=ProjectSubmission
664
def has_deadline_passed(self, user):
665
"""Check whether the deadline has passed."""
666
# XXX: Need to respect extensions.
667
return self.deadline < datetime.datetime.now()
669
def get_submissions_for_principal(self, principal):
670
"""Fetch a ResultSet of all submissions by a particular principal."""
671
assessed = Assessed.get(Store.of(self), principal, self)
674
return assessed.submissions
677
def can_delete(self):
678
"""Can only delete if there are no submissions."""
679
return self.submissions.count() == 0
682
"""Delete the project. Fails if can_delete is False."""
683
if not self.can_delete:
684
raise IntegrityError()
685
for assessed in self.assesseds:
687
Store.of(self).remove(self)
689
455
class ProjectGroup(Storm):
690
"""A group of students working together on a project."""
692
456
__storm_table__ = "project_group"
694
458
id = Int(name="groupid", primary=True)
715
479
def display_name(self):
716
"""Returns the "nice name" of the user or group."""
720
def short_name(self):
721
"""Returns the database "identifier" name of the user or group."""
480
return '%s (%s)' % (self.nick, self.name)
724
482
def get_projects(self, offering=None, active_only=True):
725
'''Find projects that the group can submit.
483
'''Return Projects that the group can submit.
727
485
This will include projects in the project set which owns this group,
728
486
unless the project set disallows groups (in which case none will be
731
@param active_only: Whether to only search active offerings.
732
@param offering: An optional offering to restrict the search to.
489
Unless active_only is False, projects will only be returned if the
490
group's offering is active.
492
If an offering is specified, projects will only be returned if it
734
495
return Store.of(self).find(Project,
735
496
Project.project_set_id == ProjectSet.id,
740
501
Semester.id == Offering.semester_id,
741
502
(not active_only) or (Semester.state == u'current'))
743
def get_svn_url(self, config):
744
"""Get the subversion repository URL for this user or group."""
745
url = config['urls']['svn_addr']
746
path = 'groups/%s_%s_%s_%s' % (
747
self.project_set.offering.subject.short_name,
748
self.project_set.offering.semester.year,
749
self.project_set.offering.semester.url_name,
752
return urlparse.urljoin(url, path)
754
def get_permissions(self, user, config):
505
def get_permissions(self, user):
755
506
if user.admin or user in self.members:
756
507
return set(['submit_project'])
760
511
class ProjectGroupMembership(Storm):
761
"""A student's membership in a project group."""
763
512
__storm_table__ = "group_member"
764
513
__storm_primary__ = "user_id", "project_group_id"
793
536
project = Reference(project_id, Project.id)
795
538
extensions = ReferenceSet(id, 'ProjectExtension.assessed_id')
796
submissions = ReferenceSet(
797
id, 'ProjectSubmission.assessed_id', order_by='date_submitted')
539
submissions = ReferenceSet(id, 'ProjectSubmission.assessed_id')
799
541
def __repr__(self):
800
542
return "<%s %r in %r>" % (type(self).__name__,
801
543
self.user or self.project_group, self.project)
805
"""True if the Assessed is a group, False if it is a user."""
806
return self.project_group is not None
810
return self.project_group or self.user
813
def checkout_location(self):
814
"""Returns the location of the Subversion workspace for this piece of
815
assessment, relative to each group member's home directory."""
816
subjectname = self.project.project_set.offering.subject.short_name
818
checkout_dir_name = self.principal.short_name
820
checkout_dir_name = "mywork"
821
return subjectname + "/" + checkout_dir_name
824
546
def get(cls, store, principal, project):
825
"""Find or create an Assessed for the given user or group and project.
827
@param principal: The user or group.
828
@param project: The project.
830
547
t = type(principal)
831
548
if t not in (User, ProjectGroup):
832
549
raise AssertionError('principal must be User or ProjectGroup')
851
"""Delete the assessed. Fails if there are any submissions. Deletes
853
if self.submissions.count() > 0:
854
raise IntegrityError()
855
for extension in self.extensions:
857
Store.of(self).remove(self)
859
568
class ProjectExtension(Storm):
860
"""An extension granted to a user or group on a particular project.
862
The user or group and project are specified by the Assessed.
865
569
__storm_table__ = "project_extension"
867
571
id = Int(name="extensionid", primary=True)
868
572
assessed_id = Int(name="assessedid")
869
573
assessed = Reference(assessed_id, Assessed.id)
574
deadline = DateTime()
871
575
approver_id = Int(name="approver")
872
576
approver = Reference(approver_id, User.id)
873
577
notes = Unicode()
876
"""Delete the extension."""
877
Store.of(self).remove(self)
879
class SubmissionError(Exception):
880
"""Denotes a validation error during submission."""
883
579
class ProjectSubmission(Storm):
884
"""A submission from a user or group repository to a particular project.
886
The content of a submission is a single path and revision inside a
887
repository. The repository is that owned by the submission's user and
888
group, while the path and revision are explicit.
890
The user or group and project are specified by the Assessed.
893
580
__storm_table__ = "project_submission"
895
582
id = Int(name="submissionid", primary=True)
901
588
submitter = Reference(submitter_id, User.id)
902
589
date_submitted = DateTime()
904
def get_verify_url(self, user):
905
"""Get the URL for verifying this submission, within the account of
907
# If this is a solo project, then self.path will be prefixed with the
908
# subject name. Remove the first path segment.
909
submitpath = self.path[1:] if self.path[:1] == '/' else self.path
910
if not self.assessed.is_group:
911
if '/' in submitpath:
912
submitpath = submitpath.split('/', 1)[1]
915
return "/files/%s/%s/%s?r=%d" % (user.login,
916
self.assessed.checkout_location, submitpath, self.revision)
918
def get_svn_url(self, config):
919
"""Get subversion URL for this submission"""
920
princ = self.assessed.principal
921
base = princ.get_svn_url(config)
922
if self.path.startswith(os.sep):
923
return os.path.join(base,
924
urllib.quote(self.path[1:].encode('utf-8')))
926
return os.path.join(base, urllib.quote(self.path.encode('utf-8')))
928
def get_svn_export_command(self, req):
929
"""Returns a Unix shell command to export a submission"""
930
svn_url = self.get_svn_url(req.config)
931
_, ext = os.path.splitext(svn_url)
932
username = (req.user.login if req.user.login.isalnum() else
933
"'%s'"%req.user.login)
934
# Export to a file or directory relative to the current directory,
935
# with the student's login name, appended with the submitted file's
937
export_path = self.assessed.principal.short_name + ext
938
return "svn export --username %s -r%d '%s' %s"%(req.user.login,
939
self.revision, svn_url, export_path)
942
def test_and_normalise_path(path):
943
"""Test that path is valid, and normalise it. This prevents possible
944
injections using malicious paths.
945
Returns the updated path, if successful.
946
Raises SubmissionError if invalid.
948
# Ensure the path is absolute to prevent being tacked onto working
950
# Prevent '\n' because it will break all sorts of things.
951
# Prevent '[' and ']' because they can be used to inject into the
953
# Normalise to avoid resulting in ".." path segments.
954
if not os.path.isabs(path):
955
raise SubmissionError("Path is not absolute")
956
if any(c in path for c in "\n[]"):
957
raise SubmissionError("Path must not contain '\\n', '[' or ']'")
958
return os.path.normpath(path)
962
"""True if the project was submitted late."""
963
return self.days_late > 0
967
"""The number of days the project was submitted late (rounded up), or
969
# XXX: Need to respect extensions.
971
(self.date_submitted - self.assessed.project.deadline).days + 1)
973
592
# WORKSHEETS AND EXERCISES #
975
594
class Exercise(Storm):
976
"""An exercise for students to complete in a worksheet.
978
An exercise may be present in any number of worksheets.
981
595
__storm_table__ = "exercise"
982
596
id = Unicode(primary=True, name="identifier")
984
598
description = Unicode()
985
_description_xhtml_cache = Unicode(name='description_xhtml_cache')
986
599
partial = Unicode()
987
600
solution = Unicode()
988
601
include = Unicode()
1006
619
def __repr__(self):
1007
620
return "<%s %s>" % (type(self).__name__, self.name)
1009
def get_permissions(self, user, config):
1010
return self.global_permissions(user, config)
1013
def global_permissions(user, config):
1014
"""Gets the set of permissions this user has over *all* exercises.
1015
This is used to determine who may view the exercises list, and create
622
def get_permissions(self, user):
1019
625
if user is not None:
1021
627
perms.add('edit')
1022
628
perms.add('view')
1023
elif u'lecturer' in set((e.role for e in user.active_enrolments)):
1026
elif (config['policy']['tutors_can_edit_worksheets']
1027
and u'tutor' in set((e.role for e in user.active_enrolments))):
1028
# Site-specific policy on the role of tutors
629
elif 'lecturer' in set((e.role for e in user.active_enrolments)):
1034
def _cache_description_xhtml(self, invalidate=False):
1035
# Don't regenerate an existing cache unless forced.
1036
if self._description_xhtml_cache is not None and not invalidate:
1039
if self.description:
1040
self._description_xhtml_cache = rst(self.description)
1042
self._description_xhtml_cache = None
1045
def description_xhtml(self):
1046
"""The XHTML exercise description, converted from reStructuredText."""
1047
self._cache_description_xhtml()
1048
return self._description_xhtml_cache
1050
def set_description(self, description):
1051
self.description = description
1052
self._cache_description_xhtml(invalidate=True)
635
def get_description(self):
636
return rst(self.description)
1054
638
def delete(self):
1055
639
"""Deletes the exercise, providing it has no associated worksheets."""
1109
686
raise IntegrityError()
1110
687
store.find(WorksheetExercise,
1111
688
WorksheetExercise.worksheet == self).remove()
1113
def get_permissions(self, user, config):
1114
offering_perms = self.offering.get_permissions(user, config)
1118
# Anybody who can view an offering can view a published
1120
if 'view' in offering_perms and self.published:
1123
# Any worksheet editors can both view and edit.
1124
if 'edit_worksheets' in offering_perms:
1130
def _cache_data_xhtml(self, invalidate=False):
1131
# Don't regenerate an existing cache unless forced.
1132
if self._data_xhtml_cache is not None and not invalidate:
1135
if self.format == u'rst':
1136
self._data_xhtml_cache = rst(self.data)
1138
self._data_xhtml_cache = None
1141
def data_xhtml(self):
1142
"""The XHTML of this worksheet, converted from rST if required."""
1143
# Update the rST -> XHTML cache, if required.
1144
self._cache_data_xhtml()
1146
if self.format == u'rst':
1147
return self._data_xhtml_cache
690
def get_permissions(self, user):
691
return self.offering.get_permissions(user)
694
"""Returns the xml of this worksheet, converts from rst if required."""
695
if self.format == u'rst':
696
ws_xml = rst(self.data)
1149
699
return self.data
1151
def set_data(self, data):
1153
self._cache_data_xhtml(invalidate=True)
1155
701
def delete(self):
1156
702
"""Deletes the worksheet, provided it has no attempts on any exercises.
1158
704
Returns True if delete succeeded, or False if this worksheet has
1159
705
attempts attached."""
1160
706
for ws_ex in self.all_worksheet_exercises:
1161
707
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
1162
708
raise IntegrityError()
1164
710
self.remove_all_exercises()
1165
711
Store.of(self).remove(self)
1167
713
class WorksheetExercise(Storm):
1168
"""A link between a worksheet and one of its exercises.
1170
These may be marked optional, in which case the exercise does not count
1171
for marking purposes. The sequence number is used to order the worksheet
1175
714
__storm_table__ = "worksheet_exercise"
1177
716
id = Int(primary=True, name="ws_ex_id")
1179
718
worksheet_id = Int(name="worksheetid")
1193
732
return "<%s %s in %s>" % (type(self).__name__, self.exercise.name,
1194
733
self.worksheet.identifier)
1196
def get_permissions(self, user, config):
1197
return self.worksheet.get_permissions(user, config)
735
def get_permissions(self, user):
736
return self.worksheet.get_permissions(user)
1200
739
class ExerciseSave(Storm):
1201
"""A potential exercise solution submitted by a user for storage.
1203
This is not an actual tested attempt at an exercise, it's just a save of
1204
the editing session.
741
Represents a potential solution to an exercise that a user has submitted
742
to the server for storage.
743
A basic ExerciseSave is just the current saved text for this exercise for
744
this user (doesn't count towards their attempts).
745
ExerciseSave may be extended with additional semantics (such as
1207
748
__storm_table__ = "exercise_save"
1208
749
__storm_primary__ = "ws_ex_id", "user_id"
1220
761
def __repr__(self):
1221
762
return "<%s %s by %s at %s>" % (type(self).__name__,
1222
self.worksheet_exercise.exercise.name, self.user.login,
1223
self.date.strftime("%c"))
763
self.exercise.name, self.user.login, self.date.strftime("%c"))
1225
765
class ExerciseAttempt(ExerciseSave):
1226
"""An attempt at solving an exercise.
1228
This is a special case of ExerciseSave, used when the user submits a
1229
candidate solution. Like an ExerciseSave, it constitutes exercise solution
1232
In addition, it contains information about the result of the submission:
1234
- complete - True if this submission was successful, rendering this
1235
exercise complete for this user in this worksheet.
1236
- active - True if this submission is "active" (usually true).
1237
Submissions may be de-activated by privileged users for
1238
special reasons, and then they won't count (either as a
1239
penalty or success), but will still be stored.
767
An ExerciseAttempt is a special case of an ExerciseSave. Like an
768
ExerciseSave, it constitutes exercise solution data that the user has
769
submitted to the server for storage.
770
In addition, it contains additional information about the submission.
771
complete - True if this submission was successful, rendering this exercise
772
complete for this user.
773
active - True if this submission is "active" (usually true). Submissions
774
may be de-activated by privileged users for special reasons, and then
775
they won't count (either as a penalty or success), but will still be
1242
778
__storm_table__ = "exercise_attempt"
1243
779
__storm_primary__ = "ws_ex_id", "user_id", "date"
1247
783
text = Unicode(name="attempt")
1248
784
complete = Bool()
1251
def get_permissions(self, user, config):
787
def get_permissions(self, user):
1252
788
return set(['view']) if user is self.user else set()
1254
790
class TestSuite(Storm):
1255
"""A container to group an exercise's test cases.
1257
The test suite contains some information on how to test. The function to
1258
test, variables to set and stdin data are stored here.
791
"""A Testsuite acts as a container for the test cases of an exercise."""
1261
792
__storm_table__ = "test_suite"
1262
793
__storm_primary__ = "exercise_id", "suiteid"
1265
796
exercise_id = Unicode(name="exerciseid")
1266
797
description = Unicode()
1270
801
exercise = Reference(exercise_id, Exercise.id)
1271
802
test_cases = ReferenceSet(suiteid, 'TestCase.suiteid', order_by="seq_no")
1272
803
variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid', order_by='arg_no')
1274
805
def delete(self):
1275
806
"""Delete this suite, without asking questions."""
1276
for variable in self.variables:
807
for vaariable in self.variables:
1277
808
variable.delete()
1278
809
for test_case in self.test_cases:
1279
810
test_case.delete()
1280
811
Store.of(self).remove(self)
1282
813
class TestCase(Storm):
1283
"""A container for actual tests (see TestCasePart), inside a test suite.
1285
It is the lowest level shown to students on their pass/fail status."""
814
"""A TestCase is a member of a TestSuite.
816
It contains the data necessary to check if an exercise is correct"""
1287
817
__storm_table__ = "test_case"
1288
818
__storm_primary__ = "testid", "suiteid"
1292
822
suite = Reference(suiteid, "TestSuite.suiteid")
1293
823
passmsg = Unicode()
1294
824
failmsg = Unicode()
1295
test_default = Unicode() # Currently unused - only used for file matching.
825
test_default = Unicode()
1298
828
parts = ReferenceSet(testid, "TestCasePart.testid")
1300
830
__init__ = _kwarg_init
1302
832
def delete(self):
1303
833
for part in self.parts:
1305
835
Store.of(self).remove(self)
1307
837
class TestSuiteVar(Storm):
1308
"""A variable used by an exercise test suite.
1310
This may represent a function argument or a normal variable.
838
"""A container for the arguments of a Test Suite"""
1313
839
__storm_table__ = "suite_variable"
1314
840
__storm_primary__ = "varid"
1318
844
var_name = Unicode()
1319
845
var_value = Unicode()
1320
846
var_type = Unicode()
1323
849
suite = Reference(suiteid, "TestSuite.suiteid")
1325
851
__init__ = _kwarg_init
1327
853
def delete(self):
1328
854
Store.of(self).remove(self)
1330
856
class TestCasePart(Storm):
1331
"""An actual piece of code to test an exercise solution."""
857
"""A container for the test elements of a Test Case"""
1333
858
__storm_table__ = "test_case_part"
1334
859
__storm_primary__ = "partid"
1339
864
part_type = Unicode()
1340
865
test_type = Unicode()
1341
866
data = Unicode()
1342
867
filename = Unicode()
1344
869
test = Reference(testid, "TestCase.testid")
1346
871
__init__ = _kwarg_init
1348
873
def delete(self):
1349
874
Store.of(self).remove(self)
added
removed
ivle/database.py
