18
18
# Author: Matt Giuca, Will Grant
21
Database Classes and Utilities for Storm ORM
20
"""Database utilities and content classes.
23
22
This module provides all of the classes which map to database tables.
24
23
It also provides miscellaneous utility functions for database interaction.
30
30
from storm.locals import create_database, Store, Int, Unicode, DateTime, \
31
31
Reference, ReferenceSet, Bool, Storm, Desc
32
from storm.expr import Select, Max
32
33
from storm.exceptions import NotOneError, IntegrityError
35
35
from ivle.worksheet.rst import rst
37
37
__all__ = ['get_store',
51
51
% (self.__class__.__name__, k))
52
52
setattr(self, k, v)
54
def get_conn_string():
56
Returns the Storm connection string, generated from the conf file.
54
def get_conn_string(config):
55
"""Create a Storm connection string to the IVLE database
57
@param config: The IVLE configuration.
61
clusterstr += ivle.conf.db_user
62
if ivle.conf.db_password:
63
clusterstr += ':' + ivle.conf.db_password
61
if config['database']['username']:
62
clusterstr += config['database']['username']
63
if config['database']['password']:
64
clusterstr += ':' + config['database']['password']
66
host = ivle.conf.db_host or 'localhost'
67
port = ivle.conf.db_port or 5432
67
host = config['database']['host'] or 'localhost'
68
port = config['database']['port'] or 5432
69
70
clusterstr += '%s:%d' % (host, port)
71
return "postgres://%s/%s" % (clusterstr, ivle.conf.db_dbname)
75
Open a database connection and transaction. Return a storm.store.Store
76
instance connected to the configured IVLE database.
78
return Store(create_database(get_conn_string()))
72
return "postgres://%s/%s" % (clusterstr, config['database']['name'])
74
def get_store(config):
75
"""Create a Storm store connected to the IVLE database.
77
@param config: The IVLE configuration.
79
return Store(create_database(get_conn_string(config)))
84
Represents an IVLE user.
84
"""An IVLE user account."""
86
85
__storm_table__ = "login"
88
87
id = Int(primary=True, name="loginid")
165
170
# TODO: Invitations should be listed too?
166
171
def get_groups(self, offering=None):
172
"""Get groups of which this user is a member.
174
@param offering: An optional offering to restrict the search to.
168
177
ProjectGroupMembership.user_id == self.id,
169
178
ProjectGroup.id == ProjectGroupMembership.project_group_id,
190
199
return self._get_enrolments(False)
192
201
def get_projects(self, offering=None, active_only=True):
193
'''Return Projects that the user can submit.
202
"""Find projects that the user can submit.
195
204
This will include projects for offerings in which the user is
196
205
enrolled, as long as the project is not in a project set which has
197
206
groups (ie. if maximum number of group members is 0).
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.
208
@param active_only: Whether to only search active offerings.
209
@param offering: An optional offering to restrict the search to.
205
211
return Store.of(self).find(Project,
206
212
Project.project_set_id == ProjectSet.id,
207
213
ProjectSet.max_students_per_group == None,
210
216
Semester.id == Offering.semester_id,
211
217
(not active_only) or (Semester.state == u'current'),
212
218
Enrolment.offering_id == Offering.id,
213
Enrolment.user_id == self.id)
219
Enrolment.user_id == self.id,
220
Enrolment.active == True)
216
223
def hash_password(password):
224
"""Hash a password with MD5."""
217
225
return hashlib.md5(password).hexdigest()
220
228
def get_by_login(cls, store, login):
222
Get the User from the db associated with a given store and
229
"""Find a user in a store by login name."""
225
230
return store.find(cls, cls.login == unicode(login)).one()
227
def get_permissions(self, user):
232
def get_permissions(self, user, config):
233
"""Determine privileges held by a user over this object.
235
If the user requesting privileges is this user or an admin,
236
they may do everything. Otherwise they may do nothing.
228
238
if user and user.admin or user is self:
229
return set(['view', 'edit', 'submit_project'])
239
return set(['view_public', 'view', 'edit', 'submit_project'])
241
return set(['view_public'])
233
243
# SUBJECTS AND ENROLMENTS #
235
245
class Subject(Storm):
246
"""A subject (or course) which is run in some semesters."""
236
248
__storm_table__ = "subject"
238
250
id = Int(primary=True, name="subjectid")
239
251
code = Unicode(name="subj_code")
240
252
name = Unicode(name="subj_name")
241
253
short_name = Unicode(name="subj_short_name")
244
255
offerings = ReferenceSet(id, 'Offering.subject_id')
248
259
def __repr__(self):
249
260
return "<%s '%s'>" % (type(self).__name__, self.short_name)
251
def get_permissions(self, user):
262
def get_permissions(self, user, config):
263
"""Determine privileges held by a user over this object.
265
If the user requesting privileges is an admin, they may edit.
266
Otherwise they may only read.
253
269
if user is not None:
254
270
perms.add('view')
259
275
def active_offerings(self):
260
"""Return a sequence of currently active offerings for this subject
276
"""Find active offerings for this subject.
278
Return a sequence of currently active offerings for this subject
261
279
(offerings whose semester.state is "current"). There should be 0 or 1
262
280
elements in this sequence, but it's possible there are more.
265
283
Semester.state == u'current')
267
285
def offering_for_semester(self, year, semester):
268
"""Get the offering for the given year/semester, or None."""
286
"""Get the offering for the given year/semester, or None.
288
@param year: A string representation of the year.
289
@param semester: A string representation of the semester.
269
291
return self.offerings.find(Offering.semester_id == Semester.id,
270
292
Semester.year == unicode(year),
271
293
Semester.semester == unicode(semester)).one()
273
295
class Semester(Storm):
296
"""A semester in which subjects can be run."""
274
298
__storm_table__ = "semester"
276
300
id = Int(primary=True, name="semesterid")
290
314
return "<%s %s/%s>" % (type(self).__name__, self.year, self.semester)
292
316
class Offering(Storm):
317
"""An offering of a subject in a particular semester."""
293
319
__storm_table__ = "offering"
295
321
id = Int(primary=True, name="offeringid")
297
323
subject = Reference(subject_id, Subject.id)
298
324
semester_id = Int(name="semesterid")
299
325
semester = Reference(semester_id, Semester.id)
326
description = Unicode()
300
328
groups_student_permissions = Unicode()
302
330
enrolments = ReferenceSet(id, 'Enrolment.offering_id')
305
333
'Enrolment.user_id',
307
335
project_sets = ReferenceSet(id, 'ProjectSet.offering_id')
336
projects = ReferenceSet(id,
337
'ProjectSet.offering_id',
339
'Project.project_set_id')
309
341
worksheets = ReferenceSet(id,
310
342
'Worksheet.offering_id',
320
352
def enrol(self, user, role=u'student'):
321
'''Enrol a user in this offering.'''
353
"""Enrol a user in this offering.
355
Enrolments handle both the staff and student cases. The role controls
356
the privileges granted by this enrolment.
322
358
enrolment = Store.of(self).find(Enrolment,
323
359
Enrolment.user_id == user.id,
324
360
Enrolment.offering_id == self.id).one()
337
373
Enrolment.offering_id == self.id).one()
338
374
Store.of(enrolment).remove(enrolment)
340
def get_permissions(self, user):
376
def get_permissions(self, user, config):
342
378
if user is not None:
343
379
enrolment = self.get_enrolment(user)
344
380
if enrolment or user.admin:
345
381
perms.add('view')
346
if (enrolment and enrolment.role in (u'tutor', u'lecturer')) \
382
if enrolment and enrolment.role == u'tutor':
383
perms.add('view_project_submissions')
384
# Site-specific policy on the role of tutors
385
if config['policy']['tutors_can_enrol_students']:
387
perms.add('enrol_student')
388
if config['policy']['tutors_can_edit_worksheets']:
389
perms.add('edit_worksheets')
390
if config['policy']['tutors_can_admin_groups']:
391
perms.add('admin_groups')
392
if (enrolment and enrolment.role in (u'lecturer')) or user.admin:
393
perms.add('view_project_submissions')
394
perms.add('admin_groups')
395
perms.add('edit_worksheets')
396
perms.add('edit') # Can edit projects & details
397
perms.add('enrol') # Can see enrolment screen at all
398
perms.add('enrol_student') # Can enrol students
399
perms.add('enrol_tutor') # Can enrol tutors
401
perms.add('enrol_lecturer') # Can enrol lecturers
351
404
def get_enrolment(self, user):
405
"""Find the user's enrolment in this offering."""
353
407
enrolment = self.enrolments.find(user=user).one()
354
408
except NotOneError:
413
def get_members_by_role(self, role):
414
return Store.of(self).find(User,
415
Enrolment.user_id == User.id,
416
Enrolment.offering_id == self.id,
417
Enrolment.role == role
418
).order_by(User.login)
422
return self.get_members_by_role(u'student')
424
def get_open_projects_for_user(self, user):
425
"""Find all projects currently open to submissions by a user."""
426
# XXX: Respect extensions.
427
return self.projects.find(Project.deadline > datetime.datetime.now())
429
def clone_worksheets(self, source):
430
"""Clone all worksheets from the specified source to this offering."""
431
import ivle.worksheet.utils
432
for worksheet in source.worksheets:
434
newws.seq_no = worksheet.seq_no
435
newws.identifier = worksheet.identifier
436
newws.name = worksheet.name
437
newws.assessable = worksheet.assessable
438
newws.data = worksheet.data
439
newws.format = worksheet.format
440
newws.offering = self
441
Store.of(self).add(newws)
442
ivle.worksheet.utils.update_exerciselist(newws)
359
445
class Enrolment(Storm):
446
"""An enrolment of a user in an offering.
448
This represents the roles of both staff and students.
360
451
__storm_table__ = "enrolment"
361
452
__storm_primary__ = "user_id", "offering_id"
382
473
return "<%s %r in %r>" % (type(self).__name__, self.user,
476
def get_permissions(self, user, config):
477
# A user can edit any enrolment that they could have created.
479
if ('enrol_' + str(self.role)) in self.offering.get_permissions(
485
"""Delete this enrolment."""
486
Store.of(self).remove(self)
387
491
class ProjectSet(Storm):
492
"""A set of projects that share common groups.
494
Each student project group is attached to a project set. The group is
495
valid for all projects in the group's set.
388
498
__storm_table__ = "project_set"
390
500
id = Int(name="projectsetid", primary=True)
401
511
return "<%s %d in %r>" % (type(self).__name__, self.id,
514
def get_permissions(self, user, config):
515
return self.offering.get_permissions(user, config)
517
def get_groups_for_user(self, user):
518
"""List all groups in this offering of which the user is a member."""
520
return Store.of(self).find(
522
ProjectGroupMembership.user_id == user.id,
523
ProjectGroupMembership.project_group_id == ProjectGroup.id,
524
ProjectGroup.project_set_id == self.id)
526
def get_submission_principal(self, user):
527
"""Get the principal on behalf of which the user can submit.
529
If this is a solo project set, the given user is returned. If
530
the user is a member of exactly one group, all the group is
531
returned. Otherwise, None is returned.
534
groups = self.get_groups_for_user(user)
535
if groups.count() == 1:
544
return self.max_students_per_group is not None
548
"""Get the entities (groups or users) assigned to submit this project.
550
This will be a Storm ResultSet.
552
#If its a solo project, return everyone in offering
554
return self.project_groups
556
return self.offering.students
558
class DeadlinePassed(Exception):
559
"""An exception indicating that a project cannot be submitted because the
560
deadline has passed."""
564
return "The project deadline has passed"
404
566
class Project(Storm):
567
"""A student project for which submissions can be made."""
405
569
__storm_table__ = "project"
407
571
id = Int(name="projectid", primary=True)
425
589
return "<%s '%s' in %r>" % (type(self).__name__, self.short_name,
426
590
self.project_set.offering)
428
def can_submit(self, principal):
592
def can_submit(self, principal, user):
429
593
return (self in principal.get_projects() and
430
self.deadline > datetime.datetime.now())
594
not self.has_deadline_passed(user))
432
596
def submit(self, principal, path, revision, who):
433
597
"""Submit a Subversion path and revision to a project.
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.
599
@param principal: The owner of the Subversion repository, and the
600
entity on behalf of whom the submission is being made
601
@param path: A path within that repository to submit.
602
@param revision: The revision of that path to submit.
603
@param who: The user who is actually making the submission.
441
if not self.can_submit(principal):
442
raise Exception('cannot submit')
606
if not self.can_submit(principal, who):
607
raise DeadlinePassed()
444
609
a = Assessed.get(Store.of(self), principal, self)
445
610
ps = ProjectSubmission()
611
# Raise SubmissionError if the path is illegal
612
ps.path = ProjectSubmission.test_and_normalise_path(path)
447
613
ps.revision = revision
448
614
ps.date_submitted = datetime.datetime.now()
620
def get_permissions(self, user, config):
621
return self.project_set.offering.get_permissions(user, config)
624
def latest_submissions(self):
625
"""Return the latest submission for each Assessed."""
626
return Store.of(self).find(ProjectSubmission,
627
Assessed.project_id == self.id,
628
ProjectSubmission.assessed_id == Assessed.id,
629
ProjectSubmission.date_submitted == Select(
630
Max(ProjectSubmission.date_submitted),
631
ProjectSubmission.assessed_id == Assessed.id,
632
tables=ProjectSubmission
636
def has_deadline_passed(self, user):
637
"""Check whether the deadline has passed."""
638
# XXX: Need to respect extensions.
639
return self.deadline < datetime.datetime.now()
641
def get_submissions_for_principal(self, principal):
642
"""Fetch a ResultSet of all submissions by a particular principal."""
643
assessed = Assessed.get(Store.of(self), principal, self)
646
return assessed.submissions
455
650
class ProjectGroup(Storm):
651
"""A group of students working together on a project."""
456
653
__storm_table__ = "project_group"
458
655
id = Int(name="groupid", primary=True)
479
676
def display_name(self):
480
return '%s (%s)' % (self.nick, self.name)
677
"""Returns the "nice name" of the user or group."""
681
def short_name(self):
682
"""Returns the database "identifier" name of the user or group."""
482
685
def get_projects(self, offering=None, active_only=True):
483
'''Return Projects that the group can submit.
686
'''Find projects that the group can submit.
485
688
This will include projects in the project set which owns this group,
486
689
unless the project set disallows groups (in which case none will be
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
692
@param active_only: Whether to only search active offerings.
693
@param offering: An optional offering to restrict the search to.
495
695
return Store.of(self).find(Project,
496
696
Project.project_set_id == ProjectSet.id,
502
702
(not active_only) or (Semester.state == u'current'))
505
def get_permissions(self, user):
705
def get_permissions(self, user, config):
506
706
if user.admin or user in self.members:
507
707
return set(['submit_project'])
511
711
class ProjectGroupMembership(Storm):
712
"""A student's membership in a project group."""
512
714
__storm_table__ = "group_member"
513
715
__storm_primary__ = "user_id", "project_group_id"
524
726
self.project_group)
526
728
class Assessed(Storm):
729
"""A composite of a user or group combined with a project.
731
Each project submission and extension refers to an Assessed. It is the
732
sole specifier of the repository and project.
527
735
__storm_table__ = "assessed"
529
737
id = Int(name="assessedid", primary=True)
536
744
project = Reference(project_id, Project.id)
538
746
extensions = ReferenceSet(id, 'ProjectExtension.assessed_id')
539
submissions = ReferenceSet(id, 'ProjectSubmission.assessed_id')
747
submissions = ReferenceSet(
748
id, 'ProjectSubmission.assessed_id', order_by='date_submitted')
541
750
def __repr__(self):
542
751
return "<%s %r in %r>" % (type(self).__name__,
543
752
self.user or self.project_group, self.project)
756
"""True if the Assessed is a group, False if it is a user."""
757
return self.project_group is not None
761
return self.project_group or self.user
764
def checkout_location(self):
765
"""Returns the location of the Subversion workspace for this piece of
766
assessment, relative to each group member's home directory."""
767
subjectname = self.project.project_set.offering.subject.short_name
769
checkout_dir_name = self.principal.short_name
771
checkout_dir_name = "mywork"
772
return subjectname + "/" + checkout_dir_name
546
775
def get(cls, store, principal, project):
776
"""Find or create an Assessed for the given user or group and project.
778
@param principal: The user or group.
779
@param project: The project.
547
781
t = type(principal)
548
782
if t not in (User, ProjectGroup):
549
783
raise AssertionError('principal must be User or ProjectGroup')
551
785
a = store.find(cls,
552
786
(t is User) or (cls.project_group_id == principal.id),
553
787
(t is ProjectGroup) or (cls.user_id == principal.id),
554
Project.id == project.id).one()
788
cls.project_id == project.id).one()
568
802
class ProjectExtension(Storm):
803
"""An extension granted to a user or group on a particular project.
805
The user or group and project are specified by the Assessed.
569
808
__storm_table__ = "project_extension"
571
810
id = Int(name="extensionid", primary=True)
576
815
approver = Reference(approver_id, User.id)
577
816
notes = Unicode()
818
class SubmissionError(Exception):
819
"""Denotes a validation error during submission."""
579
822
class ProjectSubmission(Storm):
823
"""A submission from a user or group repository to a particular project.
825
The content of a submission is a single path and revision inside a
826
repository. The repository is that owned by the submission's user and
827
group, while the path and revision are explicit.
829
The user or group and project are specified by the Assessed.
580
832
__storm_table__ = "project_submission"
582
834
id = Int(name="submissionid", primary=True)
588
840
submitter = Reference(submitter_id, User.id)
589
841
date_submitted = DateTime()
843
def get_verify_url(self, user):
844
"""Get the URL for verifying this submission, within the account of
846
# If this is a solo project, then self.path will be prefixed with the
847
# subject name. Remove the first path segment.
848
submitpath = self.path[1:] if self.path[:1] == '/' else self.path
849
if not self.assessed.is_group:
850
if '/' in submitpath:
851
submitpath = submitpath.split('/', 1)[1]
854
return "/files/%s/%s/%s?r=%d" % (user.login,
855
self.assessed.checkout_location, submitpath, self.revision)
858
def test_and_normalise_path(path):
859
"""Test that path is valid, and normalise it. This prevents possible
860
injections using malicious paths.
861
Returns the updated path, if successful.
862
Raises SubmissionError if invalid.
864
# Ensure the path is absolute to prevent being tacked onto working
866
# Prevent '\n' because it will break all sorts of things.
867
# Prevent '[' and ']' because they can be used to inject into the
869
# Normalise to avoid resulting in ".." path segments.
870
if not os.path.isabs(path):
871
raise SubmissionError("Path is not absolute")
872
if any(c in path for c in "\n[]"):
873
raise SubmissionError("Path must not contain '\\n', '[' or ']'")
874
return os.path.normpath(path)
592
876
# WORKSHEETS AND EXERCISES #
594
878
class Exercise(Storm):
879
"""An exercise for students to complete in a worksheet.
881
An exercise may be present in any number of worksheets.
595
884
__storm_table__ = "exercise"
596
885
id = Unicode(primary=True, name="identifier")
619
908
def __repr__(self):
620
909
return "<%s %s>" % (type(self).__name__, self.name)
622
def get_permissions(self, user):
911
def get_permissions(self, user, config):
912
return self.global_permissions(user, config)
915
def global_permissions(user, config):
916
"""Gets the set of permissions this user has over *all* exercises.
917
This is used to determine who may view the exercises list, and create
625
921
if user is not None:
627
923
perms.add('edit')
628
924
perms.add('view')
629
elif 'lecturer' in set((e.role for e in user.active_enrolments)):
925
elif u'lecturer' in set((e.role for e in user.active_enrolments)):
928
elif (config['policy']['tutors_can_edit_worksheets']
929
and u'tutor' in set((e.role for e in user.active_enrolments))):
930
# Site-specific policy on the role of tutors
635
936
def get_description(self):
937
"""Return the description interpreted as reStructuredText."""
636
938
return rst(self.description)
638
940
def delete(self):
644
946
Store.of(self).remove(self)
646
948
class Worksheet(Storm):
949
"""A worksheet with exercises for students to complete.
951
Worksheets are owned by offerings.
647
954
__storm_table__ = "worksheet"
649
956
id = Int(primary=True, name="worksheetid")
675
982
return "<%s %s>" % (type(self).__name__, self.name)
677
984
def remove_all_exercises(self):
679
Remove all exercises from this worksheet.
985
"""Remove all exercises from this worksheet.
680
987
This does not delete the exercises themselves. It just removes them
681
988
from the worksheet.
686
993
raise IntegrityError()
687
994
store.find(WorksheetExercise,
688
995
WorksheetExercise.worksheet == self).remove()
690
def get_permissions(self, user):
691
return self.offering.get_permissions(user)
997
def get_permissions(self, user, config):
998
# Almost the same permissions as for the offering itself
999
perms = self.offering.get_permissions(user, config)
1000
# However, "edit" permission is derived from the "edit_worksheets"
1001
# permission of the offering
1002
if 'edit_worksheets' in perms:
1005
perms.discard('edit')
693
1008
def get_xml(self):
694
1009
"""Returns the xml of this worksheet, converts from rst if required."""
695
1010
if self.format == u'rst':
699
1014
return self.data
701
1016
def delete(self):
702
1017
"""Deletes the worksheet, provided it has no attempts on any exercises.
704
1019
Returns True if delete succeeded, or False if this worksheet has
705
1020
attempts attached."""
706
1021
for ws_ex in self.all_worksheet_exercises:
707
1022
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
708
1023
raise IntegrityError()
710
1025
self.remove_all_exercises()
711
1026
Store.of(self).remove(self)
713
1028
class WorksheetExercise(Storm):
1029
"""A link between a worksheet and one of its exercises.
1031
These may be marked optional, in which case the exercise does not count
1032
for marking purposes. The sequence number is used to order the worksheet
714
1036
__storm_table__ = "worksheet_exercise"
716
1038
id = Int(primary=True, name="ws_ex_id")
718
1040
worksheet_id = Int(name="worksheetid")
732
1054
return "<%s %s in %s>" % (type(self).__name__, self.exercise.name,
733
1055
self.worksheet.identifier)
735
def get_permissions(self, user):
736
return self.worksheet.get_permissions(user)
1057
def get_permissions(self, user, config):
1058
return self.worksheet.get_permissions(user, config)
739
1061
class ExerciseSave(Storm):
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
1062
"""A potential exercise solution submitted by a user for storage.
1064
This is not an actual tested attempt at an exercise, it's just a save of
1065
the editing session.
748
1068
__storm_table__ = "exercise_save"
749
1069
__storm_primary__ = "ws_ex_id", "user_id"
763
1083
self.exercise.name, self.user.login, self.date.strftime("%c"))
765
1085
class ExerciseAttempt(ExerciseSave):
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
1086
"""An attempt at solving an exercise.
1088
This is a special case of ExerciseSave, used when the user submits a
1089
candidate solution. Like an ExerciseSave, it constitutes exercise solution
1092
In addition, it contains information about the result of the submission:
1094
- complete - True if this submission was successful, rendering this
1095
exercise complete for this user in this worksheet.
1096
- active - True if this submission is "active" (usually true).
1097
Submissions may be de-activated by privileged users for
1098
special reasons, and then they won't count (either as a
1099
penalty or success), but will still be stored.
778
1102
__storm_table__ = "exercise_attempt"
779
1103
__storm_primary__ = "ws_ex_id", "user_id", "date"
783
1107
text = Unicode(name="attempt")
784
1108
complete = Bool()
787
def get_permissions(self, user):
1111
def get_permissions(self, user, config):
788
1112
return set(['view']) if user is self.user else set()
790
1114
class TestSuite(Storm):
791
"""A Testsuite acts as a container for the test cases of an exercise."""
1115
"""A container to group an exercise's test cases.
1117
The test suite contains some information on how to test. The function to
1118
test, variables to set and stdin data are stored here.
792
1121
__storm_table__ = "test_suite"
793
1122
__storm_primary__ = "exercise_id", "suiteid"
796
1125
exercise_id = Unicode(name="exerciseid")
797
1126
description = Unicode()
801
1130
exercise = Reference(exercise_id, Exercise.id)
802
1131
test_cases = ReferenceSet(suiteid, 'TestCase.suiteid', order_by="seq_no")
803
1132
variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid', order_by='arg_no')
805
1134
def delete(self):
806
1135
"""Delete this suite, without asking questions."""
807
for vaariable in self.variables:
1136
for variable in self.variables:
808
1137
variable.delete()
809
1138
for test_case in self.test_cases:
810
1139
test_case.delete()
811
1140
Store.of(self).remove(self)
813
1142
class TestCase(Storm):
814
"""A TestCase is a member of a TestSuite.
816
It contains the data necessary to check if an exercise is correct"""
1143
"""A container for actual tests (see TestCasePart), inside a test suite.
1145
It is the lowest level shown to students on their pass/fail status."""
817
1147
__storm_table__ = "test_case"
818
1148
__storm_primary__ = "testid", "suiteid"
822
1152
suite = Reference(suiteid, "TestSuite.suiteid")
823
1153
passmsg = Unicode()
824
1154
failmsg = Unicode()
825
test_default = Unicode()
1155
test_default = Unicode() # Currently unused - only used for file matching.
828
1158
parts = ReferenceSet(testid, "TestCasePart.testid")
830
1160
__init__ = _kwarg_init
832
1162
def delete(self):
833
1163
for part in self.parts:
835
1165
Store.of(self).remove(self)
837
1167
class TestSuiteVar(Storm):
838
"""A container for the arguments of a Test Suite"""
1168
"""A variable used by an exercise test suite.
1170
This may represent a function argument or a normal variable.
839
1173
__storm_table__ = "suite_variable"
840
1174
__storm_primary__ = "varid"
844
1178
var_name = Unicode()
845
1179
var_value = Unicode()
846
1180
var_type = Unicode()
849
1183
suite = Reference(suiteid, "TestSuite.suiteid")
851
1185
__init__ = _kwarg_init
853
1187
def delete(self):
854
1188
Store.of(self).remove(self)
856
1190
class TestCasePart(Storm):
857
"""A container for the test elements of a Test Case"""
1191
"""An actual piece of code to test an exercise solution."""
858
1193
__storm_table__ = "test_case_part"
859
1194
__storm_primary__ = "partid"
864
1199
part_type = Unicode()
865
1200
test_type = Unicode()
866
1201
data = Unicode()
867
1202
filename = Unicode()
869
1204
test = Reference(testid, "TestCase.testid")
871
1206
__init__ = _kwarg_init
873
1208
def delete(self):
874
1209
Store.of(self).remove(self)
added
removed
ivle/database.py
