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.exceptions import NotOneError
32
from storm.expr import Select, Max
33
from storm.exceptions import NotOneError, IntegrityError
35
from ivle.worksheet.rst import rst
36
37
__all__ = ['get_store',
38
39
'Subject', 'Semester', 'Offering', 'Enrolment',
39
40
'ProjectSet', 'Project', 'ProjectGroup', 'ProjectGroupMembership',
41
'Assessed', 'ProjectSubmission', 'ProjectExtension',
40
42
'Exercise', 'Worksheet', 'WorksheetExercise',
41
43
'ExerciseSave', 'ExerciseAttempt',
42
44
'TestCase', 'TestSuite', 'TestSuiteVar'
49
51
% (self.__class__.__name__, k))
50
52
setattr(self, k, v)
52
def get_conn_string():
54
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.
59
clusterstr += ivle.conf.db_user
60
if ivle.conf.db_password:
61
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']
64
host = ivle.conf.db_host or 'localhost'
65
port = ivle.conf.db_port or 5432
67
host = config['database']['host'] or 'localhost'
68
port = config['database']['port'] or 5432
67
70
clusterstr += '%s:%d' % (host, port)
69
return "postgres://%s/%s" % (clusterstr, ivle.conf.db_dbname)
73
Open a database connection and transaction. Return a storm.store.Store
74
instance connected to the configured IVLE database.
76
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)))
82
Represents an IVLE user.
84
"""An IVLE user account."""
84
85
__storm_table__ = "login"
86
87
id = Int(primary=True, name="loginid")
183
198
'''A sanely ordered list of all of the user's enrolments.'''
184
199
return self._get_enrolments(False)
201
def get_projects(self, offering=None, active_only=True):
202
"""Find projects that the user can submit.
204
This will include projects for offerings in which the user is
205
enrolled, as long as the project is not in a project set which has
206
groups (ie. if maximum number of group members is 0).
208
@param active_only: Whether to only search active offerings.
209
@param offering: An optional offering to restrict the search to.
211
return Store.of(self).find(Project,
212
Project.project_set_id == ProjectSet.id,
213
ProjectSet.max_students_per_group == None,
214
ProjectSet.offering_id == Offering.id,
215
(offering is None) or (Offering.id == offering.id),
216
Semester.id == Offering.semester_id,
217
(not active_only) or (Semester.state == u'current'),
218
Enrolment.offering_id == Offering.id,
219
Enrolment.user_id == self.id,
220
Enrolment.active == True)
187
223
def hash_password(password):
188
return md5.md5(password).hexdigest()
224
"""Hash a password with MD5."""
225
return hashlib.md5(password).hexdigest()
191
228
def get_by_login(cls, store, login):
193
Get the User from the db associated with a given store and
229
"""Find a user in a store by login name."""
196
230
return store.find(cls, cls.login == unicode(login)).one()
198
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.
199
238
if user and user.admin or user is self:
200
return set(['view', 'edit'])
239
return set(['view_public', 'view', 'edit', 'submit_project'])
241
return set(['view_public'])
204
243
# SUBJECTS AND ENROLMENTS #
206
245
class Subject(Storm):
246
"""A subject (or course) which is run in some semesters."""
207
248
__storm_table__ = "subject"
209
250
id = Int(primary=True, name="subjectid")
210
251
code = Unicode(name="subj_code")
211
252
name = Unicode(name="subj_name")
212
253
short_name = Unicode(name="subj_short_name")
215
255
offerings = ReferenceSet(id, 'Offering.subject_id')
227
272
perms.add('edit')
275
def active_offerings(self):
276
"""Find active offerings for this subject.
278
Return a sequence of currently active offerings for this subject
279
(offerings whose semester.state is "current"). There should be 0 or 1
280
elements in this sequence, but it's possible there are more.
282
return self.offerings.find(Offering.semester_id == Semester.id,
283
Semester.state == u'current')
285
def offering_for_semester(self, year, semester):
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.
291
return self.offerings.find(Offering.semester_id == Semester.id,
292
Semester.year == unicode(year),
293
Semester.semester == unicode(semester)).one()
230
295
class Semester(Storm):
296
"""A semester in which subjects can be run."""
231
298
__storm_table__ = "semester"
233
300
id = Int(primary=True, name="semesterid")
294
375
Enrolment.offering_id == self.id).one()
295
376
Store.of(enrolment).remove(enrolment)
297
def get_permissions(self, user):
378
def get_permissions(self, user, config):
299
380
if user is not None:
300
381
enrolment = self.get_enrolment(user)
301
382
if enrolment or user.admin:
302
383
perms.add('view')
303
if (enrolment and enrolment.role in (u'tutor', u'lecturer')) \
384
if enrolment and enrolment.role == u'tutor':
385
perms.add('view_project_submissions')
386
# Site-specific policy on the role of tutors
387
if config['policy']['tutors_can_enrol_students']:
389
perms.add('enrol_student')
390
if config['policy']['tutors_can_edit_worksheets']:
391
perms.add('edit_worksheets')
392
if config['policy']['tutors_can_admin_groups']:
393
perms.add('admin_groups')
394
if (enrolment and enrolment.role in (u'lecturer')) or user.admin:
395
perms.add('view_project_submissions')
396
perms.add('admin_groups')
397
perms.add('edit_worksheets')
398
perms.add('view_worksheet_marks')
399
perms.add('edit') # Can edit projects & details
400
perms.add('enrol') # Can see enrolment screen at all
401
perms.add('enrol_student') # Can enrol students
402
perms.add('enrol_tutor') # Can enrol tutors
404
perms.add('enrol_lecturer') # Can enrol lecturers
308
407
def get_enrolment(self, user):
408
"""Find the user's enrolment in this offering."""
310
410
enrolment = self.enrolments.find(user=user).one()
311
411
except NotOneError:
416
def get_members_by_role(self, role):
417
return Store.of(self).find(User,
418
Enrolment.user_id == User.id,
419
Enrolment.offering_id == self.id,
420
Enrolment.role == role
421
).order_by(User.login)
425
return self.get_members_by_role(u'student')
427
def get_open_projects_for_user(self, user):
428
"""Find all projects currently open to submissions by a user."""
429
# XXX: Respect extensions.
430
return self.projects.find(Project.deadline > datetime.datetime.now())
432
def clone_worksheets(self, source):
433
"""Clone all worksheets from the specified source to this offering."""
434
import ivle.worksheet.utils
435
for worksheet in source.worksheets:
437
newws.seq_no = worksheet.seq_no
438
newws.identifier = worksheet.identifier
439
newws.name = worksheet.name
440
newws.assessable = worksheet.assessable
441
newws.published = worksheet.published
442
newws.data = worksheet.data
443
newws.format = worksheet.format
444
newws.offering = self
445
Store.of(self).add(newws)
446
ivle.worksheet.utils.update_exerciselist(newws)
316
449
class Enrolment(Storm):
450
"""An enrolment of a user in an offering.
452
This represents the roles of both staff and students.
317
455
__storm_table__ = "enrolment"
318
456
__storm_primary__ = "user_id", "offering_id"
358
515
return "<%s %d in %r>" % (type(self).__name__, self.id,
518
def get_permissions(self, user, config):
519
return self.offering.get_permissions(user, config)
521
def get_groups_for_user(self, user):
522
"""List all groups in this offering of which the user is a member."""
524
return Store.of(self).find(
526
ProjectGroupMembership.user_id == user.id,
527
ProjectGroupMembership.project_group_id == ProjectGroup.id,
528
ProjectGroup.project_set_id == self.id)
530
def get_submission_principal(self, user):
531
"""Get the principal on behalf of which the user can submit.
533
If this is a solo project set, the given user is returned. If
534
the user is a member of exactly one group, all the group is
535
returned. Otherwise, None is returned.
538
groups = self.get_groups_for_user(user)
539
if groups.count() == 1:
548
return self.max_students_per_group is not None
552
"""Get the entities (groups or users) assigned to submit this project.
554
This will be a Storm ResultSet.
556
#If its a solo project, return everyone in offering
558
return self.project_groups
560
return self.offering.students
562
class DeadlinePassed(Exception):
563
"""An exception indicating that a project cannot be submitted because the
564
deadline has passed."""
568
return "The project deadline has passed"
361
570
class Project(Storm):
571
"""A student project for which submissions can be made."""
362
573
__storm_table__ = "project"
364
575
id = Int(name="projectid", primary=True)
577
short_name = Unicode()
365
578
synopsis = Unicode()
367
580
project_set_id = Int(name="projectsetid")
368
581
project_set = Reference(project_set_id, ProjectSet.id)
369
582
deadline = DateTime()
584
assesseds = ReferenceSet(id, 'Assessed.project_id')
585
submissions = ReferenceSet(id,
586
'Assessed.project_id',
588
'ProjectSubmission.assessed_id')
371
590
__init__ = _kwarg_init
373
592
def __repr__(self):
374
return "<%s '%s' in %r>" % (type(self).__name__, self.synopsis,
593
return "<%s '%s' in %r>" % (type(self).__name__, self.short_name,
375
594
self.project_set.offering)
596
def can_submit(self, principal, user):
597
return (self in principal.get_projects() and
598
not self.has_deadline_passed(user))
600
def submit(self, principal, path, revision, who):
601
"""Submit a Subversion path and revision to a project.
603
@param principal: The owner of the Subversion repository, and the
604
entity on behalf of whom the submission is being made
605
@param path: A path within that repository to submit.
606
@param revision: The revision of that path to submit.
607
@param who: The user who is actually making the submission.
610
if not self.can_submit(principal, who):
611
raise DeadlinePassed()
613
a = Assessed.get(Store.of(self), principal, self)
614
ps = ProjectSubmission()
615
# Raise SubmissionError if the path is illegal
616
ps.path = ProjectSubmission.test_and_normalise_path(path)
617
ps.revision = revision
618
ps.date_submitted = datetime.datetime.now()
624
def get_permissions(self, user, config):
625
return self.project_set.offering.get_permissions(user, config)
628
def latest_submissions(self):
629
"""Return the latest submission for each Assessed."""
630
return Store.of(self).find(ProjectSubmission,
631
Assessed.project_id == self.id,
632
ProjectSubmission.assessed_id == Assessed.id,
633
ProjectSubmission.date_submitted == Select(
634
Max(ProjectSubmission.date_submitted),
635
ProjectSubmission.assessed_id == Assessed.id,
636
tables=ProjectSubmission
640
def has_deadline_passed(self, user):
641
"""Check whether the deadline has passed."""
642
# XXX: Need to respect extensions.
643
return self.deadline < datetime.datetime.now()
645
def get_submissions_for_principal(self, principal):
646
"""Fetch a ResultSet of all submissions by a particular principal."""
647
assessed = Assessed.get(Store.of(self), principal, self)
650
return assessed.submissions
377
654
class ProjectGroup(Storm):
655
"""A group of students working together on a project."""
378
657
__storm_table__ = "project_group"
380
659
id = Int(name="groupid", primary=True)
397
676
return "<%s %s in %r>" % (type(self).__name__, self.name,
398
677
self.project_set.offering)
680
def display_name(self):
681
"""Returns the "nice name" of the user or group."""
685
def short_name(self):
686
"""Returns the database "identifier" name of the user or group."""
689
def get_projects(self, offering=None, active_only=True):
690
'''Find projects that the group can submit.
692
This will include projects in the project set which owns this group,
693
unless the project set disallows groups (in which case none will be
696
@param active_only: Whether to only search active offerings.
697
@param offering: An optional offering to restrict the search to.
699
return Store.of(self).find(Project,
700
Project.project_set_id == ProjectSet.id,
701
ProjectSet.id == self.project_set.id,
702
ProjectSet.max_students_per_group != None,
703
ProjectSet.offering_id == Offering.id,
704
(offering is None) or (Offering.id == offering.id),
705
Semester.id == Offering.semester_id,
706
(not active_only) or (Semester.state == u'current'))
709
def get_permissions(self, user, config):
710
if user.admin or user in self.members:
711
return set(['submit_project'])
400
715
class ProjectGroupMembership(Storm):
716
"""A student's membership in a project group."""
401
718
__storm_table__ = "group_member"
402
719
__storm_primary__ = "user_id", "project_group_id"
412
729
return "<%s %r in %r>" % (type(self).__name__, self.user,
413
730
self.project_group)
732
class Assessed(Storm):
733
"""A composite of a user or group combined with a project.
735
Each project submission and extension refers to an Assessed. It is the
736
sole specifier of the repository and project.
739
__storm_table__ = "assessed"
741
id = Int(name="assessedid", primary=True)
742
user_id = Int(name="loginid")
743
user = Reference(user_id, User.id)
744
project_group_id = Int(name="groupid")
745
project_group = Reference(project_group_id, ProjectGroup.id)
747
project_id = Int(name="projectid")
748
project = Reference(project_id, Project.id)
750
extensions = ReferenceSet(id, 'ProjectExtension.assessed_id')
751
submissions = ReferenceSet(
752
id, 'ProjectSubmission.assessed_id', order_by='date_submitted')
755
return "<%s %r in %r>" % (type(self).__name__,
756
self.user or self.project_group, self.project)
760
"""True if the Assessed is a group, False if it is a user."""
761
return self.project_group is not None
765
return self.project_group or self.user
768
def checkout_location(self):
769
"""Returns the location of the Subversion workspace for this piece of
770
assessment, relative to each group member's home directory."""
771
subjectname = self.project.project_set.offering.subject.short_name
773
checkout_dir_name = self.principal.short_name
775
checkout_dir_name = "mywork"
776
return subjectname + "/" + checkout_dir_name
779
def get(cls, store, principal, project):
780
"""Find or create an Assessed for the given user or group and project.
782
@param principal: The user or group.
783
@param project: The project.
786
if t not in (User, ProjectGroup):
787
raise AssertionError('principal must be User or ProjectGroup')
790
(t is User) or (cls.project_group_id == principal.id),
791
(t is ProjectGroup) or (cls.user_id == principal.id),
792
cls.project_id == project.id).one()
799
a.project_group = principal
806
class ProjectExtension(Storm):
807
"""An extension granted to a user or group on a particular project.
809
The user or group and project are specified by the Assessed.
812
__storm_table__ = "project_extension"
814
id = Int(name="extensionid", primary=True)
815
assessed_id = Int(name="assessedid")
816
assessed = Reference(assessed_id, Assessed.id)
817
deadline = DateTime()
818
approver_id = Int(name="approver")
819
approver = Reference(approver_id, User.id)
822
class SubmissionError(Exception):
823
"""Denotes a validation error during submission."""
826
class ProjectSubmission(Storm):
827
"""A submission from a user or group repository to a particular project.
829
The content of a submission is a single path and revision inside a
830
repository. The repository is that owned by the submission's user and
831
group, while the path and revision are explicit.
833
The user or group and project are specified by the Assessed.
836
__storm_table__ = "project_submission"
838
id = Int(name="submissionid", primary=True)
839
assessed_id = Int(name="assessedid")
840
assessed = Reference(assessed_id, Assessed.id)
843
submitter_id = Int(name="submitter")
844
submitter = Reference(submitter_id, User.id)
845
date_submitted = DateTime()
847
def get_verify_url(self, user):
848
"""Get the URL for verifying this submission, within the account of
850
# If this is a solo project, then self.path will be prefixed with the
851
# subject name. Remove the first path segment.
852
submitpath = self.path[1:] if self.path[:1] == '/' else self.path
853
if not self.assessed.is_group:
854
if '/' in submitpath:
855
submitpath = submitpath.split('/', 1)[1]
858
return "/files/%s/%s/%s?r=%d" % (user.login,
859
self.assessed.checkout_location, submitpath, self.revision)
862
def test_and_normalise_path(path):
863
"""Test that path is valid, and normalise it. This prevents possible
864
injections using malicious paths.
865
Returns the updated path, if successful.
866
Raises SubmissionError if invalid.
868
# Ensure the path is absolute to prevent being tacked onto working
870
# Prevent '\n' because it will break all sorts of things.
871
# Prevent '[' and ']' because they can be used to inject into the
873
# Normalise to avoid resulting in ".." path segments.
874
if not os.path.isabs(path):
875
raise SubmissionError("Path is not absolute")
876
if any(c in path for c in "\n[]"):
877
raise SubmissionError("Path must not contain '\\n', '[' or ']'")
878
return os.path.normpath(path)
415
880
# WORKSHEETS AND EXERCISES #
417
882
class Exercise(Storm):
883
"""An exercise for students to complete in a worksheet.
885
An exercise may be present in any number of worksheets.
418
888
__storm_table__ = "exercise"
419
889
id = Unicode(primary=True, name="identifier")
424
894
include = Unicode()
897
worksheet_exercises = ReferenceSet(id,
898
'WorksheetExercise.exercise_id')
427
900
worksheets = ReferenceSet(id,
428
901
'WorksheetExercise.exercise_id',
429
902
'WorksheetExercise.worksheet_id',
433
test_suites = ReferenceSet(id, 'TestSuite.exercise_id')
906
test_suites = ReferenceSet(id,
907
'TestSuite.exercise_id',
435
910
__init__ = _kwarg_init
437
912
def __repr__(self):
438
913
return "<%s %s>" % (type(self).__name__, self.name)
440
def get_permissions(self, user):
915
def get_permissions(self, user, config):
916
return self.global_permissions(user, config)
919
def global_permissions(user, config):
920
"""Gets the set of permissions this user has over *all* exercises.
921
This is used to determine who may view the exercises list, and create
442
925
if user is not None:
444
927
perms.add('edit')
445
928
perms.add('view')
929
elif u'lecturer' in set((e.role for e in user.active_enrolments)):
932
elif (config['policy']['tutors_can_edit_worksheets']
933
and u'tutor' in set((e.role for e in user.active_enrolments))):
934
# Site-specific policy on the role of tutors
940
def get_description(self):
941
"""Return the description interpreted as reStructuredText."""
942
return rst(self.description)
945
"""Deletes the exercise, providing it has no associated worksheets."""
946
if (self.worksheet_exercises.count() > 0):
947
raise IntegrityError()
948
for suite in self.test_suites:
950
Store.of(self).remove(self)
448
952
class Worksheet(Storm):
953
"""A worksheet with exercises for students to complete.
955
Worksheets are owned by offerings.
449
958
__storm_table__ = "worksheet"
451
960
id = Int(primary=True, name="worksheetid")
475
986
def __repr__(self):
476
987
return "<%s %s>" % (type(self).__name__, self.name)
478
# XXX Refactor this - make it an instance method of Subject rather than a
479
# class method of Worksheet. Can't do that now because Subject isn't
480
# linked referentially to the Worksheet.
482
def get_by_name(cls, store, subjectname, worksheetname):
484
Get the Worksheet from the db associated with a given store, subject
485
name and worksheet name.
487
return store.find(cls, cls.subject == unicode(subjectname),
488
cls.name == unicode(worksheetname)).one()
989
def remove_all_exercises(self):
990
"""Remove all exercises from this worksheet.
490
def remove_all_exercises(self, store):
492
Remove all exercises from this worksheet.
493
992
This does not delete the exercises themselves. It just removes them
494
993
from the worksheet.
995
store = Store.of(self)
996
for ws_ex in self.all_worksheet_exercises:
997
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
998
raise IntegrityError()
496
999
store.find(WorksheetExercise,
497
1000
WorksheetExercise.worksheet == self).remove()
499
def get_permissions(self, user):
500
return self.offering.get_permissions(user)
1002
def get_permissions(self, user, config):
1003
offering_perms = self.offering.get_permissions(user, config)
1007
# Anybody who can view an offering can view a published
1009
if 'view' in offering_perms and self.published:
1012
# Any worksheet editors can both view and edit.
1013
if 'edit_worksheets' in offering_perms:
1020
"""Returns the xml of this worksheet, converts from rst if required."""
1021
if self.format == u'rst':
1022
ws_xml = rst(self.data)
1028
"""Deletes the worksheet, provided it has no attempts on any exercises.
1030
Returns True if delete succeeded, or False if this worksheet has
1031
attempts attached."""
1032
for ws_ex in self.all_worksheet_exercises:
1033
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
1034
raise IntegrityError()
1036
self.remove_all_exercises()
1037
Store.of(self).remove(self)
502
1039
class WorksheetExercise(Storm):
1040
"""A link between a worksheet and one of its exercises.
1042
These may be marked optional, in which case the exercise does not count
1043
for marking purposes. The sequence number is used to order the worksheet
503
1047
__storm_table__ = "worksheet_exercise"
505
1049
id = Int(primary=True, name="ws_ex_id")
507
1051
worksheet_id = Int(name="worksheetid")
521
1065
return "<%s %s in %s>" % (type(self).__name__, self.exercise.name,
522
1066
self.worksheet.identifier)
524
def get_permissions(self, user):
525
return self.worksheet.get_permissions(user)
1068
def get_permissions(self, user, config):
1069
return self.worksheet.get_permissions(user, config)
527
1072
class ExerciseSave(Storm):
529
Represents a potential solution to an exercise that a user has submitted
530
to the server for storage.
531
A basic ExerciseSave is just the current saved text for this exercise for
532
this user (doesn't count towards their attempts).
533
ExerciseSave may be extended with additional semantics (such as
1073
"""A potential exercise solution submitted by a user for storage.
1075
This is not an actual tested attempt at an exercise, it's just a save of
1076
the editing session.
536
1079
__storm_table__ = "exercise_save"
537
1080
__storm_primary__ = "ws_ex_id", "user_id"
549
1092
def __repr__(self):
550
1093
return "<%s %s by %s at %s>" % (type(self).__name__,
551
self.exercise.name, self.user.login, self.date.strftime("%c"))
1094
self.worksheet_exercise.exercise.name, self.user.login,
1095
self.date.strftime("%c"))
553
1097
class ExerciseAttempt(ExerciseSave):
555
An ExerciseAttempt is a special case of an ExerciseSave. Like an
556
ExerciseSave, it constitutes exercise solution data that the user has
557
submitted to the server for storage.
558
In addition, it contains additional information about the submission.
559
complete - True if this submission was successful, rendering this exercise
560
complete for this user.
561
active - True if this submission is "active" (usually true). Submissions
562
may be de-activated by privileged users for special reasons, and then
563
they won't count (either as a penalty or success), but will still be
1098
"""An attempt at solving an exercise.
1100
This is a special case of ExerciseSave, used when the user submits a
1101
candidate solution. Like an ExerciseSave, it constitutes exercise solution
1104
In addition, it contains information about the result of the submission:
1106
- complete - True if this submission was successful, rendering this
1107
exercise complete for this user in this worksheet.
1108
- active - True if this submission is "active" (usually true).
1109
Submissions may be de-activated by privileged users for
1110
special reasons, and then they won't count (either as a
1111
penalty or success), but will still be stored.
566
1114
__storm_table__ = "exercise_attempt"
567
1115
__storm_primary__ = "ws_ex_id", "user_id", "date"
587
1140
function = Unicode()
588
1141
stdin = Unicode()
589
1142
exercise = Reference(exercise_id, Exercise.id)
590
test_cases = ReferenceSet(suiteid, 'TestCase.suiteid')
591
variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid')
1143
test_cases = ReferenceSet(suiteid, 'TestCase.suiteid', order_by="seq_no")
1144
variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid', order_by='arg_no')
1147
"""Delete this suite, without asking questions."""
1148
for variable in self.variables:
1150
for test_case in self.test_cases:
1152
Store.of(self).remove(self)
593
1154
class TestCase(Storm):
594
"""A TestCase is a member of a TestSuite.
596
It contains the data necessary to check if an exercise is correct"""
1155
"""A container for actual tests (see TestCasePart), inside a test suite.
1157
It is the lowest level shown to students on their pass/fail status."""
597
1159
__storm_table__ = "test_case"
598
1160
__storm_primary__ = "testid", "suiteid"
602
1164
suite = Reference(suiteid, "TestSuite.suiteid")
603
1165
passmsg = Unicode()
604
1166
failmsg = Unicode()
605
test_default = Unicode()
1167
test_default = Unicode() # Currently unused - only used for file matching.
608
1170
parts = ReferenceSet(testid, "TestCasePart.testid")
610
1172
__init__ = _kwarg_init
1175
for part in self.parts:
1177
Store.of(self).remove(self)
612
1179
class TestSuiteVar(Storm):
613
"""A container for the arguments of a Test Suite"""
1180
"""A variable used by an exercise test suite.
1182
This may represent a function argument or a normal variable.
614
1185
__storm_table__ = "suite_variable"
615
1186
__storm_primary__ = "varid"
619
1190
var_name = Unicode()
620
1191
var_value = Unicode()
621
1192
var_type = Unicode()
624
1195
suite = Reference(suiteid, "TestSuite.suiteid")
626
1197
__init__ = _kwarg_init
1200
Store.of(self).remove(self)
628
1202
class TestCasePart(Storm):
629
"""A container for the test elements of a Test Case"""
1203
"""An actual piece of code to test an exercise solution."""
630
1205
__storm_table__ = "test_case_part"
631
1206
__storm_primary__ = "partid"
636
1211
part_type = Unicode()
637
1212
test_type = Unicode()
638
1213
data = Unicode()
639
1214
filename = Unicode()
641
1216
test = Reference(testid, "TestCase.testid")
643
1218
__init__ = _kwarg_init
1221
Store.of(self).remove(self)
added
removed
ivle/database.py
