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
33
from storm.exceptions import NotOneError, IntegrityError
35
from ivle.worksheet.rst import rst
35
37
__all__ = ['get_store',
37
39
'Subject', 'Semester', 'Offering', 'Enrolment',
38
40
'ProjectSet', 'Project', 'ProjectGroup', 'ProjectGroupMembership',
41
'Assessed', 'ProjectSubmission', 'ProjectExtension',
39
42
'Exercise', 'Worksheet', 'WorksheetExercise',
40
43
'ExerciseSave', 'ExerciseAttempt',
41
'AlreadyEnrolledError', 'TestCase', 'TestSuite', 'TestSuiteVar'
44
'TestCase', 'TestSuite', 'TestSuiteVar'
44
47
def _kwarg_init(self, **kwargs):
48
51
% (self.__class__.__name__, k))
49
52
setattr(self, k, v)
51
def get_conn_string():
53
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.
58
clusterstr += ivle.conf.db_user
59
if ivle.conf.db_password:
60
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']
63
host = ivle.conf.db_host or 'localhost'
64
port = ivle.conf.db_port or 5432
67
host = config['database']['host'] or 'localhost'
68
port = config['database']['port'] or 5432
66
70
clusterstr += '%s:%d' % (host, port)
68
return "postgres://%s/%s" % (clusterstr, ivle.conf.db_dbname)
72
Open a database connection and transaction. Return a storm.store.Store
73
instance connected to the configured IVLE database.
75
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)))
81
Represents an IVLE user.
84
"""An IVLE user account."""
83
85
__storm_table__ = "login"
85
87
id = Int(primary=True, name="loginid")
182
198
'''A sanely ordered list of all of the user's enrolments.'''
183
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)
186
223
def hash_password(password):
187
return md5.md5(password).hexdigest()
224
"""Hash a password with MD5."""
225
return hashlib.md5(password).hexdigest()
190
228
def get_by_login(cls, store, login):
192
Get the User from the db associated with a given store and
229
"""Find a user in a store by login name."""
195
230
return store.find(cls, cls.login == unicode(login)).one()
197
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.
198
238
if user and user.admin or user is self:
199
return set(['view', 'edit'])
239
return set(['view_public', 'view', 'edit', 'submit_project'])
241
return set(['view_public'])
203
243
# SUBJECTS AND ENROLMENTS #
205
245
class Subject(Storm):
246
"""A subject (or course) which is run in some semesters."""
206
248
__storm_table__ = "subject"
208
250
id = Int(primary=True, name="subjectid")
209
251
code = Unicode(name="subj_code")
210
252
name = Unicode(name="subj_name")
211
253
short_name = Unicode(name="subj_short_name")
214
255
offerings = ReferenceSet(id, 'Offering.subject_id')
269
351
return "<%s %r in %r>" % (type(self).__name__, self.subject,
272
def enrol(self, user):
273
'''Enrol a user in this offering.'''
274
# We'll get a horrible database constraint violation error if we try
275
# to add a second enrolment.
276
if Store.of(self).find(Enrolment,
277
Enrolment.user_id == user.id,
278
Enrolment.offering_id == self.id).count() == 1:
279
raise AlreadyEnrolledError()
281
e = Enrolment(user=user, offering=self, active=True)
282
self.enrolments.add(e)
284
def get_permissions(self, user):
354
def enrol(self, user, role=u'student'):
355
"""Enrol a user in this offering.
357
Enrolments handle both the staff and student cases. The role controls
358
the privileges granted by this enrolment.
360
enrolment = Store.of(self).find(Enrolment,
361
Enrolment.user_id == user.id,
362
Enrolment.offering_id == self.id).one()
364
if enrolment is None:
365
enrolment = Enrolment(user=user, offering=self)
366
self.enrolments.add(enrolment)
368
enrolment.active = True
369
enrolment.role = role
371
def unenrol(self, user):
372
'''Unenrol a user from this offering.'''
373
enrolment = Store.of(self).find(Enrolment,
374
Enrolment.user_id == user.id,
375
Enrolment.offering_id == self.id).one()
376
Store.of(enrolment).remove(enrolment)
378
def get_permissions(self, user, config):
286
380
if user is not None:
381
enrolment = self.get_enrolment(user)
382
if enrolment or user.admin:
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
407
def get_enrolment(self, user):
408
"""Find the user's enrolment in this offering."""
410
enrolment = self.enrolments.find(user=user).one()
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)
292
449
class Enrolment(Storm):
450
"""An enrolment of a user in an offering.
452
This represents the roles of both staff and students.
293
455
__storm_table__ = "enrolment"
294
456
__storm_primary__ = "user_id", "offering_id"
337
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"
340
570
class Project(Storm):
571
"""A student project for which submissions can be made."""
341
573
__storm_table__ = "project"
343
575
id = Int(name="projectid", primary=True)
577
short_name = Unicode()
344
578
synopsis = Unicode()
346
580
project_set_id = Int(name="projectsetid")
347
581
project_set = Reference(project_set_id, ProjectSet.id)
348
582
deadline = DateTime()
584
assesseds = ReferenceSet(id, 'Assessed.project_id')
585
submissions = ReferenceSet(id,
586
'Assessed.project_id',
588
'ProjectSubmission.assessed_id')
350
590
__init__ = _kwarg_init
352
592
def __repr__(self):
353
return "<%s '%s' in %r>" % (type(self).__name__, self.synopsis,
593
return "<%s '%s' in %r>" % (type(self).__name__, self.short_name,
354
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
356
654
class ProjectGroup(Storm):
655
"""A group of students working together on a project."""
357
657
__storm_table__ = "project_group"
359
659
id = Int(name="groupid", primary=True)
376
676
return "<%s %s in %r>" % (type(self).__name__, self.name,
377
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'])
379
715
class ProjectGroupMembership(Storm):
716
"""A student's membership in a project group."""
380
718
__storm_table__ = "group_member"
381
719
__storm_primary__ = "user_id", "project_group_id"
391
729
return "<%s %r in %r>" % (type(self).__name__, self.user,
392
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)
394
880
# WORKSHEETS AND EXERCISES #
396
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.
397
888
__storm_table__ = "exercise"
398
889
id = Unicode(primary=True, name="identifier")
400
891
description = Unicode()
892
_description_xhtml_cache = Unicode(name='description_xhtml_cache')
401
893
partial = Unicode()
402
894
solution = Unicode()
403
895
include = Unicode()
898
worksheet_exercises = ReferenceSet(id,
899
'WorksheetExercise.exercise_id')
406
901
worksheets = ReferenceSet(id,
407
902
'WorksheetExercise.exercise_id',
408
903
'WorksheetExercise.worksheet_id',
412
test_suites = ReferenceSet(id, 'TestSuite.exercise_id')
907
test_suites = ReferenceSet(id,
908
'TestSuite.exercise_id',
414
911
__init__ = _kwarg_init
416
913
def __repr__(self):
417
914
return "<%s %s>" % (type(self).__name__, self.name)
419
def get_permissions(self, user):
916
def get_permissions(self, user, config):
917
return self.global_permissions(user, config)
920
def global_permissions(user, config):
921
"""Gets the set of permissions this user has over *all* exercises.
922
This is used to determine who may view the exercises list, and create
421
926
if user is not None:
423
928
perms.add('edit')
424
929
perms.add('view')
930
elif u'lecturer' in set((e.role for e in user.active_enrolments)):
933
elif (config['policy']['tutors_can_edit_worksheets']
934
and u'tutor' in set((e.role for e in user.active_enrolments))):
935
# Site-specific policy on the role of tutors
941
def _cache_description_xhtml(self, invalidate=False):
942
# Don't regenerate an existing cache unless forced.
943
if self._description_xhtml_cache is not None and not invalidate:
947
self._description_xhtml_cache = rst(self.description)
949
self._description_xhtml_cache = None
952
def description_xhtml(self):
953
"""The XHTML exercise description, converted from reStructuredText."""
954
self._cache_description_xhtml()
955
return self._description_xhtml_cache
957
def set_description(self, description):
958
self.description = description
959
self._cache_description_xhtml(invalidate=True)
962
"""Deletes the exercise, providing it has no associated worksheets."""
963
if (self.worksheet_exercises.count() > 0):
964
raise IntegrityError()
965
for suite in self.test_suites:
967
Store.of(self).remove(self)
427
969
class Worksheet(Storm):
970
"""A worksheet with exercises for students to complete.
972
Worksheets are owned by offerings.
428
975
__storm_table__ = "worksheet"
430
977
id = Int(primary=True, name="worksheetid")
454
1004
def __repr__(self):
455
1005
return "<%s %s>" % (type(self).__name__, self.name)
457
# XXX Refactor this - make it an instance method of Subject rather than a
458
# class method of Worksheet. Can't do that now because Subject isn't
459
# linked referentially to the Worksheet.
461
def get_by_name(cls, store, subjectname, worksheetname):
463
Get the Worksheet from the db associated with a given store, subject
464
name and worksheet name.
466
return store.find(cls, cls.subject == unicode(subjectname),
467
cls.name == unicode(worksheetname)).one()
1007
def remove_all_exercises(self):
1008
"""Remove all exercises from this worksheet.
469
def remove_all_exercises(self, store):
471
Remove all exercises from this worksheet.
472
1010
This does not delete the exercises themselves. It just removes them
473
1011
from the worksheet.
1013
store = Store.of(self)
1014
for ws_ex in self.all_worksheet_exercises:
1015
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
1016
raise IntegrityError()
475
1017
store.find(WorksheetExercise,
476
1018
WorksheetExercise.worksheet == self).remove()
478
def get_permissions(self, user):
479
return self.offering.get_permissions(user)
1020
def get_permissions(self, user, config):
1021
offering_perms = self.offering.get_permissions(user, config)
1025
# Anybody who can view an offering can view a published
1027
if 'view' in offering_perms and self.published:
1030
# Any worksheet editors can both view and edit.
1031
if 'edit_worksheets' in offering_perms:
1037
def _cache_data_xhtml(self, invalidate=False):
1038
# Don't regenerate an existing cache unless forced.
1039
if self._data_xhtml_cache is not None and not invalidate:
1042
if self.format == u'rst':
1043
self._data_xhtml_cache = rst(self.data)
1045
self._data_xhtml_cache = None
1048
def data_xhtml(self):
1049
"""The XHTML of this worksheet, converted from rST if required."""
1050
# Update the rST -> XHTML cache, if required.
1051
self._cache_data_xhtml()
1053
if self.format == u'rst':
1054
return self._data_xhtml_cache
1058
def set_data(self, data):
1060
self._cache_data_xhtml(invalidate=True)
1063
"""Deletes the worksheet, provided it has no attempts on any exercises.
1065
Returns True if delete succeeded, or False if this worksheet has
1066
attempts attached."""
1067
for ws_ex in self.all_worksheet_exercises:
1068
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
1069
raise IntegrityError()
1071
self.remove_all_exercises()
1072
Store.of(self).remove(self)
481
1074
class WorksheetExercise(Storm):
1075
"""A link between a worksheet and one of its exercises.
1077
These may be marked optional, in which case the exercise does not count
1078
for marking purposes. The sequence number is used to order the worksheet
482
1082
__storm_table__ = "worksheet_exercise"
484
1084
id = Int(primary=True, name="ws_ex_id")
486
1086
worksheet_id = Int(name="worksheetid")
525
1127
def __repr__(self):
526
1128
return "<%s %s by %s at %s>" % (type(self).__name__,
527
self.exercise.name, self.user.login, self.date.strftime("%c"))
1129
self.worksheet_exercise.exercise.name, self.user.login,
1130
self.date.strftime("%c"))
529
1132
class ExerciseAttempt(ExerciseSave):
531
An ExerciseAttempt is a special case of an ExerciseSave. Like an
532
ExerciseSave, it constitutes exercise solution data that the user has
533
submitted to the server for storage.
534
In addition, it contains additional information about the submission.
535
complete - True if this submission was successful, rendering this exercise
536
complete for this user.
537
active - True if this submission is "active" (usually true). Submissions
538
may be de-activated by privileged users for special reasons, and then
539
they won't count (either as a penalty or success), but will still be
1133
"""An attempt at solving an exercise.
1135
This is a special case of ExerciseSave, used when the user submits a
1136
candidate solution. Like an ExerciseSave, it constitutes exercise solution
1139
In addition, it contains information about the result of the submission:
1141
- complete - True if this submission was successful, rendering this
1142
exercise complete for this user in this worksheet.
1143
- active - True if this submission is "active" (usually true).
1144
Submissions may be de-activated by privileged users for
1145
special reasons, and then they won't count (either as a
1146
penalty or success), but will still be stored.
542
1149
__storm_table__ = "exercise_attempt"
543
1150
__storm_primary__ = "ws_ex_id", "user_id", "date"
563
1175
function = Unicode()
564
1176
stdin = Unicode()
565
1177
exercise = Reference(exercise_id, Exercise.id)
566
test_cases = ReferenceSet(suiteid, 'TestCase.suiteid')
567
variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid')
1178
test_cases = ReferenceSet(suiteid, 'TestCase.suiteid', order_by="seq_no")
1179
variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid', order_by='arg_no')
1182
"""Delete this suite, without asking questions."""
1183
for variable in self.variables:
1185
for test_case in self.test_cases:
1187
Store.of(self).remove(self)
569
1189
class TestCase(Storm):
570
"""A TestCase is a member of a TestSuite.
572
It contains the data necessary to check if an exercise is correct"""
1190
"""A container for actual tests (see TestCasePart), inside a test suite.
1192
It is the lowest level shown to students on their pass/fail status."""
573
1194
__storm_table__ = "test_case"
574
1195
__storm_primary__ = "testid", "suiteid"
578
1199
suite = Reference(suiteid, "TestSuite.suiteid")
579
1200
passmsg = Unicode()
580
1201
failmsg = Unicode()
581
test_default = Unicode()
1202
test_default = Unicode() # Currently unused - only used for file matching.
584
1205
parts = ReferenceSet(testid, "TestCasePart.testid")
586
1207
__init__ = _kwarg_init
1210
for part in self.parts:
1212
Store.of(self).remove(self)
588
1214
class TestSuiteVar(Storm):
589
"""A container for the arguments of a Test Suite"""
1215
"""A variable used by an exercise test suite.
1217
This may represent a function argument or a normal variable.
590
1220
__storm_table__ = "suite_variable"
591
1221
__storm_primary__ = "varid"
595
1225
var_name = Unicode()
596
1226
var_value = Unicode()
597
1227
var_type = Unicode()
600
1230
suite = Reference(suiteid, "TestSuite.suiteid")
602
1232
__init__ = _kwarg_init
1235
Store.of(self).remove(self)
604
1237
class TestCasePart(Storm):
605
"""A container for the test elements of a Test Case"""
1238
"""An actual piece of code to test an exercise solution."""
606
1240
__storm_table__ = "test_case_part"
607
1241
__storm_primary__ = "partid"
612
1246
part_type = Unicode()
613
1247
test_type = Unicode()
614
1248
data = Unicode()
615
1249
filename = Unicode()
617
1251
test = Reference(testid, "TestCase.testid")
619
1253
__init__ = _kwarg_init
1256
Store.of(self).remove(self)
added
removed
ivle/database.py
