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
32
from storm.locals import create_database, Store, Int, Unicode, DateTime, \
31
33
Reference, ReferenceSet, Bool, Storm, Desc
34
from storm.expr import Select, Max
32
35
from storm.exceptions import NotOneError, IntegrityError
35
37
from ivle.worksheet.rst import rst
37
39
__all__ = ['get_store',
39
41
'Subject', 'Semester', 'Offering', 'Enrolment',
40
42
'ProjectSet', 'Project', 'ProjectGroup', 'ProjectGroupMembership',
43
'Assessed', 'ProjectSubmission', 'ProjectExtension',
41
44
'Exercise', 'Worksheet', 'WorksheetExercise',
42
45
'ExerciseSave', 'ExerciseAttempt',
43
46
'TestCase', 'TestSuite', 'TestSuiteVar'
50
53
% (self.__class__.__name__, k))
51
54
setattr(self, k, v)
53
def get_conn_string():
55
Returns the Storm connection string, generated from the conf file.
56
def get_conn_string(config):
57
"""Create a Storm connection string to the IVLE database
59
@param config: The IVLE configuration.
60
clusterstr += ivle.conf.db_user
61
if ivle.conf.db_password:
62
clusterstr += ':' + ivle.conf.db_password
63
if config['database']['username']:
64
clusterstr += config['database']['username']
65
if config['database']['password']:
66
clusterstr += ':' + config['database']['password']
65
host = ivle.conf.db_host or 'localhost'
66
port = ivle.conf.db_port or 5432
69
host = config['database']['host'] or 'localhost'
70
port = config['database']['port'] or 5432
68
72
clusterstr += '%s:%d' % (host, port)
70
return "postgres://%s/%s" % (clusterstr, ivle.conf.db_dbname)
74
Open a database connection and transaction. Return a storm.store.Store
75
instance connected to the configured IVLE database.
77
return Store(create_database(get_conn_string()))
74
return "postgres://%s/%s" % (clusterstr, config['database']['name'])
76
def get_store(config):
77
"""Create a Storm store connected to the IVLE database.
79
@param config: The IVLE configuration.
81
return Store(create_database(get_conn_string(config)))
83
Represents an IVLE user.
86
"""An IVLE user account."""
85
87
__storm_table__ = "login"
87
89
id = Int(primary=True, name="loginid")
184
200
'''A sanely ordered list of all of the user's enrolments.'''
185
201
return self._get_enrolments(False)
203
def get_projects(self, offering=None, active_only=True):
204
"""Find projects that the user can submit.
206
This will include projects for offerings in which the user is
207
enrolled, as long as the project is not in a project set which has
208
groups (ie. if maximum number of group members is 0).
210
@param active_only: Whether to only search active offerings.
211
@param offering: An optional offering to restrict the search to.
213
return Store.of(self).find(Project,
214
Project.project_set_id == ProjectSet.id,
215
ProjectSet.max_students_per_group == None,
216
ProjectSet.offering_id == Offering.id,
217
(offering is None) or (Offering.id == offering.id),
218
Semester.id == Offering.semester_id,
219
(not active_only) or (Semester.state == u'current'),
220
Enrolment.offering_id == Offering.id,
221
Enrolment.user_id == self.id,
222
Enrolment.active == True)
188
225
def hash_password(password):
189
return md5.md5(password).hexdigest()
226
"""Hash a password with MD5."""
227
return hashlib.md5(password).hexdigest()
192
230
def get_by_login(cls, store, login):
194
Get the User from the db associated with a given store and
231
"""Find a user in a store by login name."""
197
232
return store.find(cls, cls.login == unicode(login)).one()
199
def get_permissions(self, user):
234
def get_svn_url(self, config):
235
"""Get the subversion repository URL for this user or group."""
236
url = config['urls']['svn_addr']
237
path = 'users/%s' % self.login
238
return urlparse.urljoin(url, path)
240
def get_permissions(self, user, config):
241
"""Determine privileges held by a user over this object.
243
If the user requesting privileges is this user or an admin,
244
they may do everything. Otherwise they may do nothing.
200
246
if user and user.admin or user is self:
201
return set(['view', 'edit'])
247
return set(['view_public', 'view', 'edit', 'submit_project'])
249
return set(['view_public'])
205
251
# SUBJECTS AND ENROLMENTS #
207
253
class Subject(Storm):
254
"""A subject (or course) which is run in some semesters."""
208
256
__storm_table__ = "subject"
210
258
id = Int(primary=True, name="subjectid")
211
259
code = Unicode(name="subj_code")
212
260
name = Unicode(name="subj_name")
213
261
short_name = Unicode(name="subj_short_name")
216
263
offerings = ReferenceSet(id, 'Offering.subject_id')
295
383
Enrolment.offering_id == self.id).one()
296
384
Store.of(enrolment).remove(enrolment)
298
def get_permissions(self, user):
386
def get_permissions(self, user, config):
300
388
if user is not None:
301
389
enrolment = self.get_enrolment(user)
302
390
if enrolment or user.admin:
303
391
perms.add('view')
304
if (enrolment and enrolment.role in (u'tutor', u'lecturer')) \
392
if enrolment and enrolment.role == u'tutor':
393
perms.add('view_project_submissions')
394
# Site-specific policy on the role of tutors
395
if config['policy']['tutors_can_enrol_students']:
397
perms.add('enrol_student')
398
if config['policy']['tutors_can_edit_worksheets']:
399
perms.add('edit_worksheets')
400
if config['policy']['tutors_can_admin_groups']:
401
perms.add('admin_groups')
402
if (enrolment and enrolment.role in (u'lecturer')) or user.admin:
403
perms.add('view_project_submissions')
404
perms.add('admin_groups')
405
perms.add('edit_worksheets')
406
perms.add('view_worksheet_marks')
407
perms.add('edit') # Can edit projects & details
408
perms.add('enrol') # Can see enrolment screen at all
409
perms.add('enrol_student') # Can enrol students
410
perms.add('enrol_tutor') # Can enrol tutors
412
perms.add('enrol_lecturer') # Can enrol lecturers
309
415
def get_enrolment(self, user):
416
"""Find the user's enrolment in this offering."""
311
418
enrolment = self.enrolments.find(user=user).one()
312
419
except NotOneError:
424
def get_members_by_role(self, role):
425
return Store.of(self).find(User,
426
Enrolment.user_id == User.id,
427
Enrolment.offering_id == self.id,
428
Enrolment.role == role
429
).order_by(User.login)
433
return self.get_members_by_role(u'student')
435
def get_open_projects_for_user(self, user):
436
"""Find all projects currently open to submissions by a user."""
437
# XXX: Respect extensions.
438
return self.projects.find(Project.deadline > datetime.datetime.now())
440
def has_worksheet_cutoff_passed(self, user):
441
"""Check whether the worksheet cutoff has passed.
442
A user is required, in case we support extensions.
444
if self.worksheet_cutoff is None:
447
return self.worksheet_cutoff < datetime.datetime.now()
449
def clone_worksheets(self, source):
450
"""Clone all worksheets from the specified source to this offering."""
451
import ivle.worksheet.utils
452
for worksheet in source.worksheets:
454
newws.seq_no = worksheet.seq_no
455
newws.identifier = worksheet.identifier
456
newws.name = worksheet.name
457
newws.assessable = worksheet.assessable
458
newws.published = worksheet.published
459
newws.data = worksheet.data
460
newws.format = worksheet.format
461
newws.offering = self
462
Store.of(self).add(newws)
463
ivle.worksheet.utils.update_exerciselist(newws)
317
466
class Enrolment(Storm):
467
"""An enrolment of a user in an offering.
469
This represents the roles of both staff and students.
318
472
__storm_table__ = "enrolment"
319
473
__storm_primary__ = "user_id", "offering_id"
359
532
return "<%s %d in %r>" % (type(self).__name__, self.id,
535
def get_permissions(self, user, config):
536
return self.offering.get_permissions(user, config)
538
def get_groups_for_user(self, user):
539
"""List all groups in this offering of which the user is a member."""
541
return Store.of(self).find(
543
ProjectGroupMembership.user_id == user.id,
544
ProjectGroupMembership.project_group_id == ProjectGroup.id,
545
ProjectGroup.project_set_id == self.id)
547
def get_submission_principal(self, user):
548
"""Get the principal on behalf of which the user can submit.
550
If this is a solo project set, the given user is returned. If
551
the user is a member of exactly one group, all the group is
552
returned. Otherwise, None is returned.
555
groups = self.get_groups_for_user(user)
556
if groups.count() == 1:
565
return self.max_students_per_group is not None
569
"""Get the entities (groups or users) assigned to submit this project.
571
This will be a Storm ResultSet.
573
#If its a solo project, return everyone in offering
575
return self.project_groups
577
return self.offering.students
579
class DeadlinePassed(Exception):
580
"""An exception indicating that a project cannot be submitted because the
581
deadline has passed."""
585
return "The project deadline has passed"
362
587
class Project(Storm):
588
"""A student project for which submissions can be made."""
363
590
__storm_table__ = "project"
365
592
id = Int(name="projectid", primary=True)
594
short_name = Unicode()
366
595
synopsis = Unicode()
368
597
project_set_id = Int(name="projectsetid")
369
598
project_set = Reference(project_set_id, ProjectSet.id)
370
599
deadline = DateTime()
601
assesseds = ReferenceSet(id, 'Assessed.project_id')
602
submissions = ReferenceSet(id,
603
'Assessed.project_id',
605
'ProjectSubmission.assessed_id')
372
607
__init__ = _kwarg_init
374
609
def __repr__(self):
375
return "<%s '%s' in %r>" % (type(self).__name__, self.synopsis,
610
return "<%s '%s' in %r>" % (type(self).__name__, self.short_name,
376
611
self.project_set.offering)
613
def can_submit(self, principal, user, late=False):
615
@param late: If True, does not take the deadline into account.
617
return (self in principal.get_projects() and
618
(late or not self.has_deadline_passed(user)))
620
def submit(self, principal, path, revision, who, late=False):
621
"""Submit a Subversion path and revision to a project.
623
@param principal: The owner of the Subversion repository, and the
624
entity on behalf of whom the submission is being made
625
@param path: A path within that repository to submit.
626
@param revision: The revision of that path to submit.
627
@param who: The user who is actually making the submission.
628
@param late: If True, will not raise a DeadlinePassed exception even
629
after the deadline. (Default False.)
632
if not self.can_submit(principal, who, late=late):
633
raise DeadlinePassed()
635
a = Assessed.get(Store.of(self), principal, self)
636
ps = ProjectSubmission()
637
# Raise SubmissionError if the path is illegal
638
ps.path = ProjectSubmission.test_and_normalise_path(path)
639
ps.revision = revision
640
ps.date_submitted = datetime.datetime.now()
646
def get_permissions(self, user, config):
647
return self.project_set.offering.get_permissions(user, config)
650
def latest_submissions(self):
651
"""Return the latest submission for each Assessed."""
652
return Store.of(self).find(ProjectSubmission,
653
Assessed.project_id == self.id,
654
ProjectSubmission.assessed_id == Assessed.id,
655
ProjectSubmission.date_submitted == Select(
656
Max(ProjectSubmission.date_submitted),
657
ProjectSubmission.assessed_id == Assessed.id,
658
tables=ProjectSubmission
662
def has_deadline_passed(self, user):
663
"""Check whether the deadline has passed."""
664
# XXX: Need to respect extensions.
665
return self.deadline < datetime.datetime.now()
667
def get_submissions_for_principal(self, principal):
668
"""Fetch a ResultSet of all submissions by a particular principal."""
669
assessed = Assessed.get(Store.of(self), principal, self)
672
return assessed.submissions
675
def can_delete(self):
676
"""Can only delete if there are no submissions."""
677
return self.submissions.count() == 0
680
"""Delete the project. Fails if can_delete is False."""
681
if not self.can_delete:
682
raise IntegrityError()
683
for assessed in self.assesseds:
685
Store.of(self).remove(self)
378
687
class ProjectGroup(Storm):
688
"""A group of students working together on a project."""
379
690
__storm_table__ = "project_group"
381
692
id = Int(name="groupid", primary=True)
398
709
return "<%s %s in %r>" % (type(self).__name__, self.name,
399
710
self.project_set.offering)
713
def display_name(self):
714
"""Returns the "nice name" of the user or group."""
718
def short_name(self):
719
"""Returns the database "identifier" name of the user or group."""
722
def get_projects(self, offering=None, active_only=True):
723
'''Find projects that the group can submit.
725
This will include projects in the project set which owns this group,
726
unless the project set disallows groups (in which case none will be
729
@param active_only: Whether to only search active offerings.
730
@param offering: An optional offering to restrict the search to.
732
return Store.of(self).find(Project,
733
Project.project_set_id == ProjectSet.id,
734
ProjectSet.id == self.project_set.id,
735
ProjectSet.max_students_per_group != None,
736
ProjectSet.offering_id == Offering.id,
737
(offering is None) or (Offering.id == offering.id),
738
Semester.id == Offering.semester_id,
739
(not active_only) or (Semester.state == u'current'))
741
def get_svn_url(self, config):
742
"""Get the subversion repository URL for this user or group."""
743
url = config['urls']['svn_addr']
744
path = 'groups/%s_%s_%s_%s' % (
745
self.project_set.offering.subject.short_name,
746
self.project_set.offering.semester.year,
747
self.project_set.offering.semester.semester,
750
return urlparse.urljoin(url, path)
752
def get_permissions(self, user, config):
753
if user.admin or user in self.members:
754
return set(['submit_project'])
401
758
class ProjectGroupMembership(Storm):
759
"""A student's membership in a project group."""
402
761
__storm_table__ = "group_member"
403
762
__storm_primary__ = "user_id", "project_group_id"
413
772
return "<%s %r in %r>" % (type(self).__name__, self.user,
414
773
self.project_group)
775
class Assessed(Storm):
776
"""A composite of a user or group combined with a project.
778
Each project submission and extension refers to an Assessed. It is the
779
sole specifier of the repository and project.
782
__storm_table__ = "assessed"
784
id = Int(name="assessedid", primary=True)
785
user_id = Int(name="loginid")
786
user = Reference(user_id, User.id)
787
project_group_id = Int(name="groupid")
788
project_group = Reference(project_group_id, ProjectGroup.id)
790
project_id = Int(name="projectid")
791
project = Reference(project_id, Project.id)
793
extensions = ReferenceSet(id, 'ProjectExtension.assessed_id')
794
submissions = ReferenceSet(
795
id, 'ProjectSubmission.assessed_id', order_by='date_submitted')
798
return "<%s %r in %r>" % (type(self).__name__,
799
self.user or self.project_group, self.project)
803
"""True if the Assessed is a group, False if it is a user."""
804
return self.project_group is not None
808
return self.project_group or self.user
811
def checkout_location(self):
812
"""Returns the location of the Subversion workspace for this piece of
813
assessment, relative to each group member's home directory."""
814
subjectname = self.project.project_set.offering.subject.short_name
816
checkout_dir_name = self.principal.short_name
818
checkout_dir_name = "mywork"
819
return subjectname + "/" + checkout_dir_name
822
def get(cls, store, principal, project):
823
"""Find or create an Assessed for the given user or group and project.
825
@param principal: The user or group.
826
@param project: The project.
829
if t not in (User, ProjectGroup):
830
raise AssertionError('principal must be User or ProjectGroup')
833
(t is User) or (cls.project_group_id == principal.id),
834
(t is ProjectGroup) or (cls.user_id == principal.id),
835
cls.project_id == project.id).one()
842
a.project_group = principal
849
"""Delete the assessed. Fails if there are any submissions. Deletes
851
if self.submissions.count() > 0:
852
raise IntegrityError()
853
for extension in self.extensions:
855
Store.of(self).remove(self)
857
class ProjectExtension(Storm):
858
"""An extension granted to a user or group on a particular project.
860
The user or group and project are specified by the Assessed.
863
__storm_table__ = "project_extension"
865
id = Int(name="extensionid", primary=True)
866
assessed_id = Int(name="assessedid")
867
assessed = Reference(assessed_id, Assessed.id)
868
deadline = DateTime()
869
approver_id = Int(name="approver")
870
approver = Reference(approver_id, User.id)
874
"""Delete the extension."""
875
Store.of(self).remove(self)
877
class SubmissionError(Exception):
878
"""Denotes a validation error during submission."""
881
class ProjectSubmission(Storm):
882
"""A submission from a user or group repository to a particular project.
884
The content of a submission is a single path and revision inside a
885
repository. The repository is that owned by the submission's user and
886
group, while the path and revision are explicit.
888
The user or group and project are specified by the Assessed.
891
__storm_table__ = "project_submission"
893
id = Int(name="submissionid", primary=True)
894
assessed_id = Int(name="assessedid")
895
assessed = Reference(assessed_id, Assessed.id)
898
submitter_id = Int(name="submitter")
899
submitter = Reference(submitter_id, User.id)
900
date_submitted = DateTime()
902
def get_verify_url(self, user):
903
"""Get the URL for verifying this submission, within the account of
905
# If this is a solo project, then self.path will be prefixed with the
906
# subject name. Remove the first path segment.
907
submitpath = self.path[1:] if self.path[:1] == '/' else self.path
908
if not self.assessed.is_group:
909
if '/' in submitpath:
910
submitpath = submitpath.split('/', 1)[1]
913
return "/files/%s/%s/%s?r=%d" % (user.login,
914
self.assessed.checkout_location, submitpath, self.revision)
916
def get_svn_url(self, config):
917
"""Get subversion URL for this submission"""
918
princ = self.assessed.principal
919
base = princ.get_svn_url(config)
920
if self.path.startswith(os.sep):
921
return os.path.join(base,
922
urllib.quote(self.path[1:].encode('utf-8')))
924
return os.path.join(base, urllib.quote(self.path.encode('utf-8')))
926
def get_svn_export_command(self, req):
927
"""Returns a Unix shell command to export a submission"""
928
svn_url = self.get_svn_url(req.config)
929
username = (req.user.login if req.user.login.isalnum() else
930
"'%s'"%req.user.login)
931
export_dir = self.assessed.principal.short_name
932
return "svn export --username %s -r%d '%s' %s"%(req.user.login,
933
self.revision, svn_url, export_dir)
936
def test_and_normalise_path(path):
937
"""Test that path is valid, and normalise it. This prevents possible
938
injections using malicious paths.
939
Returns the updated path, if successful.
940
Raises SubmissionError if invalid.
942
# Ensure the path is absolute to prevent being tacked onto working
944
# Prevent '\n' because it will break all sorts of things.
945
# Prevent '[' and ']' because they can be used to inject into the
947
# Normalise to avoid resulting in ".." path segments.
948
if not os.path.isabs(path):
949
raise SubmissionError("Path is not absolute")
950
if any(c in path for c in "\n[]"):
951
raise SubmissionError("Path must not contain '\\n', '[' or ']'")
952
return os.path.normpath(path)
956
"""True if the project was submitted late."""
957
return self.days_late > 0
961
"""The number of days the project was submitted late (rounded up), or
963
# XXX: Need to respect extensions.
965
(self.date_submitted - self.assessed.project.deadline).days + 1)
416
967
# WORKSHEETS AND EXERCISES #
418
969
class Exercise(Storm):
970
"""An exercise for students to complete in a worksheet.
972
An exercise may be present in any number of worksheets.
419
975
__storm_table__ = "exercise"
420
976
id = Unicode(primary=True, name="identifier")
422
978
description = Unicode()
979
_description_xhtml_cache = Unicode(name='description_xhtml_cache')
423
980
partial = Unicode()
424
981
solution = Unicode()
425
982
include = Unicode()
443
1000
def __repr__(self):
444
1001
return "<%s %s>" % (type(self).__name__, self.name)
446
def get_permissions(self, user):
1003
def get_permissions(self, user, config):
1004
return self.global_permissions(user, config)
1007
def global_permissions(user, config):
1008
"""Gets the set of permissions this user has over *all* exercises.
1009
This is used to determine who may view the exercises list, and create
449
1013
if user is not None:
451
1015
perms.add('edit')
452
1016
perms.add('view')
453
elif 'lecturer' in set((e.role for e in user.active_enrolments)):
1017
elif u'lecturer' in set((e.role for e in user.active_enrolments)):
1020
elif (config['policy']['tutors_can_edit_worksheets']
1021
and u'tutor' in set((e.role for e in user.active_enrolments))):
1022
# Site-specific policy on the role of tutors
459
def get_description(self):
460
return rst(self.description)
1028
def _cache_description_xhtml(self, invalidate=False):
1029
# Don't regenerate an existing cache unless forced.
1030
if self._description_xhtml_cache is not None and not invalidate:
1033
if self.description:
1034
self._description_xhtml_cache = rst(self.description)
1036
self._description_xhtml_cache = None
1039
def description_xhtml(self):
1040
"""The XHTML exercise description, converted from reStructuredText."""
1041
self._cache_description_xhtml()
1042
return self._description_xhtml_cache
1044
def set_description(self, description):
1045
self.description = description
1046
self._cache_description_xhtml(invalidate=True)
462
1048
def delete(self):
463
1049
"""Deletes the exercise, providing it has no associated worksheets."""
522
1103
raise IntegrityError()
523
1104
store.find(WorksheetExercise,
524
1105
WorksheetExercise.worksheet == self).remove()
526
def get_permissions(self, user):
527
return self.offering.get_permissions(user)
530
"""Returns the xml of this worksheet, converts from rst if required."""
531
if self.format == u'rst':
532
ws_xml = rst(self.data)
1107
def get_permissions(self, user, config):
1108
offering_perms = self.offering.get_permissions(user, config)
1112
# Anybody who can view an offering can view a published
1114
if 'view' in offering_perms and self.published:
1117
# Any worksheet editors can both view and edit.
1118
if 'edit_worksheets' in offering_perms:
1124
def _cache_data_xhtml(self, invalidate=False):
1125
# Don't regenerate an existing cache unless forced.
1126
if self._data_xhtml_cache is not None and not invalidate:
1129
if self.format == u'rst':
1130
self._data_xhtml_cache = rst(self.data)
1132
self._data_xhtml_cache = None
1135
def data_xhtml(self):
1136
"""The XHTML of this worksheet, converted from rST if required."""
1137
# Update the rST -> XHTML cache, if required.
1138
self._cache_data_xhtml()
1140
if self.format == u'rst':
1141
return self._data_xhtml_cache
535
1143
return self.data
1145
def set_data(self, data):
1147
self._cache_data_xhtml(invalidate=True)
537
1149
def delete(self):
538
1150
"""Deletes the worksheet, provided it has no attempts on any exercises.
540
1152
Returns True if delete succeeded, or False if this worksheet has
541
1153
attempts attached."""
542
1154
for ws_ex in self.all_worksheet_exercises:
543
1155
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
544
1156
raise IntegrityError()
546
1158
self.remove_all_exercises()
547
1159
Store.of(self).remove(self)
549
1161
class WorksheetExercise(Storm):
1162
"""A link between a worksheet and one of its exercises.
1164
These may be marked optional, in which case the exercise does not count
1165
for marking purposes. The sequence number is used to order the worksheet
550
1169
__storm_table__ = "worksheet_exercise"
552
1171
id = Int(primary=True, name="ws_ex_id")
554
1173
worksheet_id = Int(name="worksheetid")
597
1214
def __repr__(self):
598
1215
return "<%s %s by %s at %s>" % (type(self).__name__,
599
self.exercise.name, self.user.login, self.date.strftime("%c"))
1216
self.worksheet_exercise.exercise.name, self.user.login,
1217
self.date.strftime("%c"))
601
1219
class ExerciseAttempt(ExerciseSave):
603
An ExerciseAttempt is a special case of an ExerciseSave. Like an
604
ExerciseSave, it constitutes exercise solution data that the user has
605
submitted to the server for storage.
606
In addition, it contains additional information about the submission.
607
complete - True if this submission was successful, rendering this exercise
608
complete for this user.
609
active - True if this submission is "active" (usually true). Submissions
610
may be de-activated by privileged users for special reasons, and then
611
they won't count (either as a penalty or success), but will still be
1220
"""An attempt at solving an exercise.
1222
This is a special case of ExerciseSave, used when the user submits a
1223
candidate solution. Like an ExerciseSave, it constitutes exercise solution
1226
In addition, it contains information about the result of the submission:
1228
- complete - True if this submission was successful, rendering this
1229
exercise complete for this user in this worksheet.
1230
- active - True if this submission is "active" (usually true).
1231
Submissions may be de-activated by privileged users for
1232
special reasons, and then they won't count (either as a
1233
penalty or success), but will still be stored.
614
1236
__storm_table__ = "exercise_attempt"
615
1237
__storm_primary__ = "ws_ex_id", "user_id", "date"
637
1264
exercise = Reference(exercise_id, Exercise.id)
638
1265
test_cases = ReferenceSet(suiteid, 'TestCase.suiteid', order_by="seq_no")
639
1266
variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid', order_by='arg_no')
641
1268
def delete(self):
642
1269
"""Delete this suite, without asking questions."""
643
for vaariable in self.variables:
1270
for variable in self.variables:
644
1271
variable.delete()
645
1272
for test_case in self.test_cases:
646
1273
test_case.delete()
647
1274
Store.of(self).remove(self)
649
1276
class TestCase(Storm):
650
"""A TestCase is a member of a TestSuite.
652
It contains the data necessary to check if an exercise is correct"""
1277
"""A container for actual tests (see TestCasePart), inside a test suite.
1279
It is the lowest level shown to students on their pass/fail status."""
653
1281
__storm_table__ = "test_case"
654
1282
__storm_primary__ = "testid", "suiteid"
658
1286
suite = Reference(suiteid, "TestSuite.suiteid")
659
1287
passmsg = Unicode()
660
1288
failmsg = Unicode()
661
test_default = Unicode()
1289
test_default = Unicode() # Currently unused - only used for file matching.
664
1292
parts = ReferenceSet(testid, "TestCasePart.testid")
666
1294
__init__ = _kwarg_init
668
1296
def delete(self):
669
1297
for part in self.parts:
671
1299
Store.of(self).remove(self)
673
1301
class TestSuiteVar(Storm):
674
"""A container for the arguments of a Test Suite"""
1302
"""A variable used by an exercise test suite.
1304
This may represent a function argument or a normal variable.
675
1307
__storm_table__ = "suite_variable"
676
1308
__storm_primary__ = "varid"
680
1312
var_name = Unicode()
681
1313
var_value = Unicode()
682
1314
var_type = Unicode()
685
1317
suite = Reference(suiteid, "TestSuite.suiteid")
687
1319
__init__ = _kwarg_init
689
1321
def delete(self):
690
1322
Store.of(self).remove(self)
692
1324
class TestCasePart(Storm):
693
"""A container for the test elements of a Test Case"""
1325
"""An actual piece of code to test an exercise solution."""
694
1327
__storm_table__ = "test_case_part"
695
1328
__storm_primary__ = "partid"
700
1333
part_type = Unicode()
701
1334
test_type = Unicode()
702
1335
data = Unicode()
703
1336
filename = Unicode()
705
1338
test = Reference(testid, "TestCase.testid")
707
1340
__init__ = _kwarg_init
709
1342
def delete(self):
710
1343
Store.of(self).remove(self)
added
removed
ivle/database.py
