1
# IVLE - Informatics Virtual Learning Environment
2
# Copyright (C) 2007-2009 The University of Melbourne
4
# This program is free software; you can redistribute it and/or modify
5
# it under the terms of the GNU General Public License as published by
6
# the Free Software Foundation; either version 2 of the License, or
7
# (at your option) any later version.
9
# This program is distributed in the hope that it will be useful,
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
# GNU General Public License for more details.
14
# You should have received a copy of the GNU General Public License
15
# along with this program; if not, write to the Free Software
16
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
18
# Author: Matt Giuca, Will Grant
20
"""Database utilities and content classes.
22
This module provides all of the classes which map to database tables.
23
It also provides miscellaneous utility functions for database interaction.
29
from storm.locals import create_database, Store, Int, Unicode, DateTime, \
30
Reference, ReferenceSet, Bool, Storm, Desc
31
from storm.expr import Select, Max
32
from storm.exceptions import NotOneError, IntegrityError
34
from ivle.worksheet.rst import rst
36
__all__ = ['get_store',
38
'Subject', 'Semester', 'Offering', 'Enrolment',
39
'ProjectSet', 'Project', 'ProjectGroup', 'ProjectGroupMembership',
40
'Assessed', 'ProjectSubmission', 'ProjectExtension',
41
'Exercise', 'Worksheet', 'WorksheetExercise',
42
'ExerciseSave', 'ExerciseAttempt',
43
'TestCase', 'TestSuite', 'TestSuiteVar'
46
def _kwarg_init(self, **kwargs):
47
for k,v in kwargs.items():
48
if k.startswith('_') or not hasattr(self.__class__, k):
49
raise TypeError("%s got an unexpected keyword argument '%s'"
50
% (self.__class__.__name__, k))
53
def get_conn_string(config):
54
"""Create a Storm connection string to the IVLE database
56
@param config: The IVLE configuration.
60
if config['database']['username']:
61
clusterstr += config['database']['username']
62
if config['database']['password']:
63
clusterstr += ':' + config['database']['password']
66
host = config['database']['host'] or 'localhost'
67
port = config['database']['port'] or 5432
69
clusterstr += '%s:%d' % (host, port)
71
return "postgres://%s/%s" % (clusterstr, config['database']['name'])
73
def get_store(config):
74
"""Create a Storm store connected to the IVLE database.
76
@param config: The IVLE configuration.
78
return Store(create_database(get_conn_string(config)))
83
"""An IVLE user account."""
84
__storm_table__ = "login"
86
id = Int(primary=True, name="loginid")
95
last_login = DateTime()
102
__init__ = _kwarg_init
105
return "<%s '%s'>" % (type(self).__name__, self.login)
107
def authenticate(self, password):
108
"""Validate a given password against this user.
110
Returns True if the given password matches the password hash for this
111
User, False if it doesn't match, and None if there is no hash for the
114
if self.passhash is None:
116
return self.hash_password(password) == self.passhash
119
def display_name(self):
120
"""Returns the "nice name" of the user or group."""
124
def short_name(self):
125
"""Returns the database "identifier" name of the user or group."""
129
def password_expired(self):
130
fieldval = self.pass_exp
131
return fieldval is not None and datetime.datetime.now() > fieldval
134
def account_expired(self):
135
fieldval = self.acct_exp
136
return fieldval is not None and datetime.datetime.now() > fieldval
140
return self.state == 'enabled' and not self.account_expired
142
def _get_enrolments(self, justactive):
143
return Store.of(self).find(Enrolment,
144
Enrolment.user_id == self.id,
145
(Enrolment.active == True) if justactive else True,
146
Enrolment.offering_id == Offering.id,
147
Offering.semester_id == Semester.id,
148
Offering.subject_id == Subject.id).order_by(
150
Desc(Semester.semester),
154
def _set_password(self, password):
158
self.passhash = unicode(User.hash_password(password))
159
password = property(fset=_set_password)
163
return Store.of(self).find(Subject,
164
Enrolment.user_id == self.id,
165
Enrolment.active == True,
166
Offering.id == Enrolment.offering_id,
167
Subject.id == Offering.subject_id).config(distinct=True)
169
# TODO: Invitations should be listed too?
170
def get_groups(self, offering=None):
171
"""Get groups of which this user is a member.
173
@param offering: An optional offering to restrict the search to.
176
ProjectGroupMembership.user_id == self.id,
177
ProjectGroup.id == ProjectGroupMembership.project_group_id,
181
ProjectSet.offering_id == offering.id,
182
ProjectGroup.project_set_id == ProjectSet.id,
184
return Store.of(self).find(ProjectGroup, *preds)
188
return self.get_groups()
191
def active_enrolments(self):
192
'''A sanely ordered list of the user's active enrolments.'''
193
return self._get_enrolments(True)
196
def enrolments(self):
197
'''A sanely ordered list of all of the user's enrolments.'''
198
return self._get_enrolments(False)
200
def get_projects(self, offering=None, active_only=True):
201
"""Find projects that the user can submit.
203
This will include projects for offerings in which the user is
204
enrolled, as long as the project is not in a project set which has
205
groups (ie. if maximum number of group members is 0).
207
@param active_only: Whether to only search active offerings.
208
@param offering: An optional offering to restrict the search to.
210
return Store.of(self).find(Project,
211
Project.project_set_id == ProjectSet.id,
212
ProjectSet.max_students_per_group == None,
213
ProjectSet.offering_id == Offering.id,
214
(offering is None) or (Offering.id == offering.id),
215
Semester.id == Offering.semester_id,
216
(not active_only) or (Semester.state == u'current'),
217
Enrolment.offering_id == Offering.id,
218
Enrolment.user_id == self.id)
221
def hash_password(password):
222
"""Hash a password with MD5."""
223
return hashlib.md5(password).hexdigest()
226
def get_by_login(cls, store, login):
227
"""Find a user in a store by login name."""
228
return store.find(cls, cls.login == unicode(login)).one()
230
def get_permissions(self, user):
231
"""Determine privileges held by a user over this object.
233
If the user requesting privileges is this user or an admin,
234
they may do everything. Otherwise they may do nothing.
236
if user and user.admin or user is self:
237
return set(['view_public', 'view', 'edit', 'submit_project'])
239
return set(['view_public'])
241
# SUBJECTS AND ENROLMENTS #
243
class Subject(Storm):
244
"""A subject (or course) which is run in some semesters."""
246
__storm_table__ = "subject"
248
id = Int(primary=True, name="subjectid")
249
code = Unicode(name="subj_code")
250
name = Unicode(name="subj_name")
251
short_name = Unicode(name="subj_short_name")
254
offerings = ReferenceSet(id, 'Offering.subject_id')
256
__init__ = _kwarg_init
259
return "<%s '%s'>" % (type(self).__name__, self.short_name)
261
def get_permissions(self, user):
262
"""Determine privileges held by a user over this object.
264
If the user requesting privileges is an admin, they may edit.
265
Otherwise they may only read.
274
def active_offerings(self):
275
"""Find active offerings for this subject.
277
Return a sequence of currently active offerings for this subject
278
(offerings whose semester.state is "current"). There should be 0 or 1
279
elements in this sequence, but it's possible there are more.
281
return self.offerings.find(Offering.semester_id == Semester.id,
282
Semester.state == u'current')
284
def offering_for_semester(self, year, semester):
285
"""Get the offering for the given year/semester, or None.
287
@param year: A string representation of the year.
288
@param semester: A string representation of the semester.
290
return self.offerings.find(Offering.semester_id == Semester.id,
291
Semester.year == unicode(year),
292
Semester.semester == unicode(semester)).one()
294
class Semester(Storm):
295
"""A semester in which subjects can be run."""
297
__storm_table__ = "semester"
299
id = Int(primary=True, name="semesterid")
304
offerings = ReferenceSet(id, 'Offering.semester_id')
305
enrolments = ReferenceSet(id,
306
'Offering.semester_id',
308
'Enrolment.offering_id')
310
__init__ = _kwarg_init
313
return "<%s %s/%s>" % (type(self).__name__, self.year, self.semester)
315
class Offering(Storm):
316
"""An offering of a subject in a particular semester."""
318
__storm_table__ = "offering"
320
id = Int(primary=True, name="offeringid")
321
subject_id = Int(name="subject")
322
subject = Reference(subject_id, Subject.id)
323
semester_id = Int(name="semesterid")
324
semester = Reference(semester_id, Semester.id)
325
groups_student_permissions = Unicode()
327
enrolments = ReferenceSet(id, 'Enrolment.offering_id')
328
members = ReferenceSet(id,
329
'Enrolment.offering_id',
332
project_sets = ReferenceSet(id, 'ProjectSet.offering_id')
334
worksheets = ReferenceSet(id,
335
'Worksheet.offering_id',
339
__init__ = _kwarg_init
342
return "<%s %r in %r>" % (type(self).__name__, self.subject,
345
def enrol(self, user, role=u'student'):
346
"""Enrol a user in this offering.
348
Enrolments handle both the staff and student cases. The role controls
349
the privileges granted by this enrolment.
351
enrolment = Store.of(self).find(Enrolment,
352
Enrolment.user_id == user.id,
353
Enrolment.offering_id == self.id).one()
355
if enrolment is None:
356
enrolment = Enrolment(user=user, offering=self)
357
self.enrolments.add(enrolment)
359
enrolment.active = True
360
enrolment.role = role
362
def unenrol(self, user):
363
'''Unenrol a user from this offering.'''
364
enrolment = Store.of(self).find(Enrolment,
365
Enrolment.user_id == user.id,
366
Enrolment.offering_id == self.id).one()
367
Store.of(enrolment).remove(enrolment)
369
def get_permissions(self, user):
372
enrolment = self.get_enrolment(user)
373
if enrolment or user.admin:
375
if (enrolment and enrolment.role in (u'tutor', u'lecturer')) \
378
# XXX Bug #493945 -- should tutors have these permissions?
379
# Potentially move into the next category (lecturer & admin)
380
perms.add('enrol') # Can see enrolment screen at all
381
perms.add('enrol_student') # Can enrol students
382
if (enrolment and enrolment.role in (u'lecturer')) or user.admin:
383
perms.add('enrol_tutor') # Can enrol tutors
385
perms.add('enrol_lecturer') # Can enrol lecturers
388
def get_enrolment(self, user):
389
"""Find the user's enrolment in this offering."""
391
enrolment = self.enrolments.find(user=user).one()
397
def get_members_by_role(self, role):
398
return Store.of(self).find(User,
399
Enrolment.user_id == User.id,
400
Enrolment.offering_id == self.id,
401
Enrolment.role == role
402
).order_by(User.login)
406
return self.get_members_by_role(u'student')
408
class Enrolment(Storm):
409
"""An enrolment of a user in an offering.
411
This represents the roles of both staff and students.
414
__storm_table__ = "enrolment"
415
__storm_primary__ = "user_id", "offering_id"
417
user_id = Int(name="loginid")
418
user = Reference(user_id, User.id)
419
offering_id = Int(name="offeringid")
420
offering = Reference(offering_id, Offering.id)
427
return Store.of(self).find(ProjectGroup,
428
ProjectSet.offering_id == self.offering.id,
429
ProjectGroup.project_set_id == ProjectSet.id,
430
ProjectGroupMembership.project_group_id == ProjectGroup.id,
431
ProjectGroupMembership.user_id == self.user.id)
433
__init__ = _kwarg_init
436
return "<%s %r in %r>" % (type(self).__name__, self.user,
441
class ProjectSet(Storm):
442
"""A set of projects that share common groups.
444
Each student project group is attached to a project set. The group is
445
valid for all projects in the group's set.
448
__storm_table__ = "project_set"
450
id = Int(name="projectsetid", primary=True)
451
offering_id = Int(name="offeringid")
452
offering = Reference(offering_id, Offering.id)
453
max_students_per_group = Int()
455
projects = ReferenceSet(id, 'Project.project_set_id')
456
project_groups = ReferenceSet(id, 'ProjectGroup.project_set_id')
458
__init__ = _kwarg_init
461
return "<%s %d in %r>" % (type(self).__name__, self.id,
464
def get_permissions(self, user):
465
return self.offering.get_permissions(user)
469
return self.max_students_per_group is not None
473
"""Get the entities (groups or users) assigned to submit this project.
475
This will be a Storm ResultSet.
477
#If its a solo project, return everyone in offering
479
return self.project_groups
481
return self.offering.students
483
class Project(Storm):
484
"""A student project for which submissions can be made."""
486
__storm_table__ = "project"
488
id = Int(name="projectid", primary=True)
490
short_name = Unicode()
493
project_set_id = Int(name="projectsetid")
494
project_set = Reference(project_set_id, ProjectSet.id)
495
deadline = DateTime()
497
assesseds = ReferenceSet(id, 'Assessed.project_id')
498
submissions = ReferenceSet(id,
499
'Assessed.project_id',
501
'ProjectSubmission.assessed_id')
503
__init__ = _kwarg_init
506
return "<%s '%s' in %r>" % (type(self).__name__, self.short_name,
507
self.project_set.offering)
509
def can_submit(self, principal):
510
return (self in principal.get_projects() and
511
self.deadline > datetime.datetime.now())
513
def submit(self, principal, path, revision, who):
514
"""Submit a Subversion path and revision to a project.
516
@param principal: The owner of the Subversion repository, and the
517
entity on behalf of whom the submission is being made
518
@param path: A path within that repository to submit.
519
@param revision: The revision of that path to submit.
520
@param who: The user who is actually making the submission.
523
if not self.can_submit(principal):
524
raise Exception('cannot submit')
526
a = Assessed.get(Store.of(self), principal, self)
527
ps = ProjectSubmission()
529
ps.revision = revision
530
ps.date_submitted = datetime.datetime.now()
536
def get_permissions(self, user):
537
return self.project_set.offering.get_permissions(user)
540
def latest_submissions(self):
541
"""Return the latest submission for each Assessed."""
542
return Store.of(self).find(ProjectSubmission,
543
Assessed.project_id == self.id,
544
ProjectSubmission.assessed_id == Assessed.id,
545
ProjectSubmission.date_submitted == Select(
546
Max(ProjectSubmission.date_submitted),
547
ProjectSubmission.assessed_id == Assessed.id,
548
tables=ProjectSubmission
553
class ProjectGroup(Storm):
554
"""A group of students working together on a project."""
556
__storm_table__ = "project_group"
558
id = Int(name="groupid", primary=True)
559
name = Unicode(name="groupnm")
560
project_set_id = Int(name="projectsetid")
561
project_set = Reference(project_set_id, ProjectSet.id)
563
created_by_id = Int(name="createdby")
564
created_by = Reference(created_by_id, User.id)
567
members = ReferenceSet(id,
568
"ProjectGroupMembership.project_group_id",
569
"ProjectGroupMembership.user_id",
572
__init__ = _kwarg_init
575
return "<%s %s in %r>" % (type(self).__name__, self.name,
576
self.project_set.offering)
579
def display_name(self):
580
"""Returns the "nice name" of the user or group."""
584
def short_name(self):
585
"""Returns the database "identifier" name of the user or group."""
588
def get_projects(self, offering=None, active_only=True):
589
'''Find projects that the group can submit.
591
This will include projects in the project set which owns this group,
592
unless the project set disallows groups (in which case none will be
595
@param active_only: Whether to only search active offerings.
596
@param offering: An optional offering to restrict the search to.
598
return Store.of(self).find(Project,
599
Project.project_set_id == ProjectSet.id,
600
ProjectSet.id == self.project_set.id,
601
ProjectSet.max_students_per_group != None,
602
ProjectSet.offering_id == Offering.id,
603
(offering is None) or (Offering.id == offering.id),
604
Semester.id == Offering.semester_id,
605
(not active_only) or (Semester.state == u'current'))
608
def get_permissions(self, user):
609
if user.admin or user in self.members:
610
return set(['submit_project'])
614
class ProjectGroupMembership(Storm):
615
"""A student's membership in a project group."""
617
__storm_table__ = "group_member"
618
__storm_primary__ = "user_id", "project_group_id"
620
user_id = Int(name="loginid")
621
user = Reference(user_id, User.id)
622
project_group_id = Int(name="groupid")
623
project_group = Reference(project_group_id, ProjectGroup.id)
625
__init__ = _kwarg_init
628
return "<%s %r in %r>" % (type(self).__name__, self.user,
631
class Assessed(Storm):
632
"""A composite of a user or group combined with a project.
634
Each project submission and extension refers to an Assessed. It is the
635
sole specifier of the repository and project.
638
__storm_table__ = "assessed"
640
id = Int(name="assessedid", primary=True)
641
user_id = Int(name="loginid")
642
user = Reference(user_id, User.id)
643
project_group_id = Int(name="groupid")
644
project_group = Reference(project_group_id, ProjectGroup.id)
646
project_id = Int(name="projectid")
647
project = Reference(project_id, Project.id)
649
extensions = ReferenceSet(id, 'ProjectExtension.assessed_id')
650
submissions = ReferenceSet(id, 'ProjectSubmission.assessed_id')
653
return "<%s %r in %r>" % (type(self).__name__,
654
self.user or self.project_group, self.project)
658
"""True if the Assessed is a group, False if it is a user."""
659
return self.project_group is not None
663
return self.project_group or self.user
666
def get(cls, store, principal, project):
667
"""Find or create an Assessed for the given user or group and project.
669
@param principal: The user or group.
670
@param project: The project.
673
if t not in (User, ProjectGroup):
674
raise AssertionError('principal must be User or ProjectGroup')
677
(t is User) or (cls.project_group_id == principal.id),
678
(t is ProjectGroup) or (cls.user_id == principal.id),
679
Project.id == project.id).one()
686
a.project_group = principal
693
class ProjectExtension(Storm):
694
"""An extension granted to a user or group on a particular project.
696
The user or group and project are specified by the Assessed.
699
__storm_table__ = "project_extension"
701
id = Int(name="extensionid", primary=True)
702
assessed_id = Int(name="assessedid")
703
assessed = Reference(assessed_id, Assessed.id)
704
deadline = DateTime()
705
approver_id = Int(name="approver")
706
approver = Reference(approver_id, User.id)
709
class ProjectSubmission(Storm):
710
"""A submission from a user or group repository to a particular project.
712
The content of a submission is a single path and revision inside a
713
repository. The repository is that owned by the submission's user and
714
group, while the path and revision are explicit.
716
The user or group and project are specified by the Assessed.
719
__storm_table__ = "project_submission"
721
id = Int(name="submissionid", primary=True)
722
assessed_id = Int(name="assessedid")
723
assessed = Reference(assessed_id, Assessed.id)
726
submitter_id = Int(name="submitter")
727
submitter = Reference(submitter_id, User.id)
728
date_submitted = DateTime()
731
# WORKSHEETS AND EXERCISES #
733
class Exercise(Storm):
734
"""An exercise for students to complete in a worksheet.
736
An exercise may be present in any number of worksheets.
739
__storm_table__ = "exercise"
740
id = Unicode(primary=True, name="identifier")
742
description = Unicode()
748
worksheet_exercises = ReferenceSet(id,
749
'WorksheetExercise.exercise_id')
751
worksheets = ReferenceSet(id,
752
'WorksheetExercise.exercise_id',
753
'WorksheetExercise.worksheet_id',
757
test_suites = ReferenceSet(id,
758
'TestSuite.exercise_id',
761
__init__ = _kwarg_init
764
return "<%s %s>" % (type(self).__name__, self.name)
766
def get_permissions(self, user):
773
elif u'lecturer' in set((e.role for e in user.active_enrolments)):
776
elif u'tutor' in set((e.role for e in user.active_enrolments)):
782
def get_description(self):
783
"""Return the description interpreted as reStructuredText."""
784
return rst(self.description)
787
"""Deletes the exercise, providing it has no associated worksheets."""
788
if (self.worksheet_exercises.count() > 0):
789
raise IntegrityError()
790
for suite in self.test_suites:
792
Store.of(self).remove(self)
794
class Worksheet(Storm):
795
"""A worksheet with exercises for students to complete.
797
Worksheets are owned by offerings.
800
__storm_table__ = "worksheet"
802
id = Int(primary=True, name="worksheetid")
803
offering_id = Int(name="offeringid")
804
identifier = Unicode()
811
attempts = ReferenceSet(id, "ExerciseAttempt.worksheetid")
812
offering = Reference(offering_id, 'Offering.id')
814
all_worksheet_exercises = ReferenceSet(id,
815
'WorksheetExercise.worksheet_id')
817
# Use worksheet_exercises to get access to the *active* WorksheetExercise
818
# objects binding worksheets to exercises. This is required to access the
822
def worksheet_exercises(self):
823
return self.all_worksheet_exercises.find(active=True)
825
__init__ = _kwarg_init
828
return "<%s %s>" % (type(self).__name__, self.name)
830
def remove_all_exercises(self):
831
"""Remove all exercises from this worksheet.
833
This does not delete the exercises themselves. It just removes them
836
store = Store.of(self)
837
for ws_ex in self.all_worksheet_exercises:
838
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
839
raise IntegrityError()
840
store.find(WorksheetExercise,
841
WorksheetExercise.worksheet == self).remove()
843
def get_permissions(self, user):
844
return self.offering.get_permissions(user)
847
"""Returns the xml of this worksheet, converts from rst if required."""
848
if self.format == u'rst':
849
ws_xml = rst(self.data)
855
"""Deletes the worksheet, provided it has no attempts on any exercises.
857
Returns True if delete succeeded, or False if this worksheet has
858
attempts attached."""
859
for ws_ex in self.all_worksheet_exercises:
860
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
861
raise IntegrityError()
863
self.remove_all_exercises()
864
Store.of(self).remove(self)
866
class WorksheetExercise(Storm):
867
"""A link between a worksheet and one of its exercises.
869
These may be marked optional, in which case the exercise does not count
870
for marking purposes. The sequence number is used to order the worksheet
874
__storm_table__ = "worksheet_exercise"
876
id = Int(primary=True, name="ws_ex_id")
878
worksheet_id = Int(name="worksheetid")
879
worksheet = Reference(worksheet_id, Worksheet.id)
880
exercise_id = Unicode(name="exerciseid")
881
exercise = Reference(exercise_id, Exercise.id)
886
saves = ReferenceSet(id, "ExerciseSave.ws_ex_id")
887
attempts = ReferenceSet(id, "ExerciseAttempt.ws_ex_id")
889
__init__ = _kwarg_init
892
return "<%s %s in %s>" % (type(self).__name__, self.exercise.name,
893
self.worksheet.identifier)
895
def get_permissions(self, user):
896
return self.worksheet.get_permissions(user)
899
class ExerciseSave(Storm):
900
"""A potential exercise solution submitted by a user for storage.
902
This is not an actual tested attempt at an exercise, it's just a save of
906
__storm_table__ = "exercise_save"
907
__storm_primary__ = "ws_ex_id", "user_id"
909
ws_ex_id = Int(name="ws_ex_id")
910
worksheet_exercise = Reference(ws_ex_id, "WorksheetExercise.id")
912
user_id = Int(name="loginid")
913
user = Reference(user_id, User.id)
917
__init__ = _kwarg_init
920
return "<%s %s by %s at %s>" % (type(self).__name__,
921
self.exercise.name, self.user.login, self.date.strftime("%c"))
923
class ExerciseAttempt(ExerciseSave):
924
"""An attempt at solving an exercise.
926
This is a special case of ExerciseSave, used when the user submits a
927
candidate solution. Like an ExerciseSave, it constitutes exercise solution
930
In addition, it contains information about the result of the submission:
932
- complete - True if this submission was successful, rendering this
933
exercise complete for this user in this worksheet.
934
- active - True if this submission is "active" (usually true).
935
Submissions may be de-activated by privileged users for
936
special reasons, and then they won't count (either as a
937
penalty or success), but will still be stored.
940
__storm_table__ = "exercise_attempt"
941
__storm_primary__ = "ws_ex_id", "user_id", "date"
943
# The "text" field is the same but has a different name in the DB table
945
text = Unicode(name="attempt")
949
def get_permissions(self, user):
950
return set(['view']) if user is self.user else set()
952
class TestSuite(Storm):
953
"""A container to group an exercise's test cases.
955
The test suite contains some information on how to test. The function to
956
test, variables to set and stdin data are stored here.
959
__storm_table__ = "test_suite"
960
__storm_primary__ = "exercise_id", "suiteid"
963
exercise_id = Unicode(name="exerciseid")
964
description = Unicode()
968
exercise = Reference(exercise_id, Exercise.id)
969
test_cases = ReferenceSet(suiteid, 'TestCase.suiteid', order_by="seq_no")
970
variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid', order_by='arg_no')
973
"""Delete this suite, without asking questions."""
974
for vaariable in self.variables:
976
for test_case in self.test_cases:
978
Store.of(self).remove(self)
980
class TestCase(Storm):
981
"""A container for actual tests (see TestCasePart), inside a test suite.
983
It is the lowest level shown to students on their pass/fail status."""
985
__storm_table__ = "test_case"
986
__storm_primary__ = "testid", "suiteid"
990
suite = Reference(suiteid, "TestSuite.suiteid")
993
test_default = Unicode() # Currently unused - only used for file matching.
996
parts = ReferenceSet(testid, "TestCasePart.testid")
998
__init__ = _kwarg_init
1001
for part in self.parts:
1003
Store.of(self).remove(self)
1005
class TestSuiteVar(Storm):
1006
"""A variable used by an exercise test suite.
1008
This may represent a function argument or a normal variable.
1011
__storm_table__ = "suite_variable"
1012
__storm_primary__ = "varid"
1016
var_name = Unicode()
1017
var_value = Unicode()
1018
var_type = Unicode()
1021
suite = Reference(suiteid, "TestSuite.suiteid")
1023
__init__ = _kwarg_init
1026
Store.of(self).remove(self)
1028
class TestCasePart(Storm):
1029
"""An actual piece of code to test an exercise solution."""
1031
__storm_table__ = "test_case_part"
1032
__storm_primary__ = "partid"
1037
part_type = Unicode()
1038
test_type = Unicode()
1040
filename = Unicode()
1042
test = Reference(testid, "TestCase.testid")
1044
__init__ = _kwarg_init
1047
Store.of(self).remove(self)