360
272
return "<%s %r in %r>" % (type(self).__name__, self.subject,
363
def enrol(self, user, role=u'student'):
364
"""Enrol a user in this offering.
366
Enrolments handle both the staff and student cases. The role controls
367
the privileges granted by this enrolment.
369
enrolment = Store.of(self).find(Enrolment,
370
Enrolment.user_id == user.id,
371
Enrolment.offering_id == self.id).one()
373
if enrolment is None:
374
enrolment = Enrolment(user=user, offering=self)
375
self.enrolments.add(enrolment)
377
enrolment.active = True
378
enrolment.role = role
380
def unenrol(self, user):
381
'''Unenrol a user from this offering.'''
382
enrolment = Store.of(self).find(Enrolment,
383
Enrolment.user_id == user.id,
384
Enrolment.offering_id == self.id).one()
385
Store.of(enrolment).remove(enrolment)
387
def get_permissions(self, user, config):
275
def enrol(self, user):
276
'''Enrol a user in this offering.'''
277
# We'll get a horrible database constraint violation error if we try
278
# to add a second enrolment.
279
if Store.of(self).find(Enrolment,
280
Enrolment.user_id == user.id,
281
Enrolment.offering_id == self.id).count() == 1:
282
raise AlreadyEnrolledError()
284
e = Enrolment(user=user, offering=self, active=True)
285
self.enrolments.add(e)
287
def get_permissions(self, user):
389
289
if user is not None:
390
enrolment = self.get_enrolment(user)
391
if enrolment or user.admin:
393
if enrolment and enrolment.role == u'tutor':
394
perms.add('view_project_submissions')
395
# Site-specific policy on the role of tutors
396
if config['policy']['tutors_can_enrol_students']:
398
perms.add('enrol_student')
399
if config['policy']['tutors_can_edit_worksheets']:
400
perms.add('edit_worksheets')
401
if config['policy']['tutors_can_admin_groups']:
402
perms.add('admin_groups')
403
if (enrolment and enrolment.role in (u'lecturer')) or user.admin:
404
perms.add('view_project_submissions')
405
perms.add('admin_groups')
406
perms.add('edit_worksheets')
407
perms.add('view_worksheet_marks')
408
perms.add('edit') # Can edit projects & details
409
perms.add('enrol') # Can see enrolment screen at all
410
perms.add('enrol_student') # Can enrol students
411
perms.add('enrol_tutor') # Can enrol tutors
413
perms.add('enrol_lecturer') # Can enrol lecturers
291
if user.rolenm == 'admin':
416
def get_enrolment(self, user):
417
"""Find the user's enrolment in this offering."""
419
enrolment = self.enrolments.find(user=user).one()
425
def get_members_by_role(self, role):
426
return Store.of(self).find(User,
427
Enrolment.user_id == User.id,
428
Enrolment.offering_id == self.id,
429
Enrolment.role == role
430
).order_by(User.login)
434
return self.get_members_by_role(u'student')
436
def get_open_projects_for_user(self, user):
437
"""Find all projects currently open to submissions by a user."""
438
# XXX: Respect extensions.
439
return self.projects.find(Project.deadline > datetime.datetime.now())
441
def has_worksheet_cutoff_passed(self, user):
442
"""Check whether the worksheet cutoff has passed.
443
A user is required, in case we support extensions.
445
if self.worksheet_cutoff is None:
448
return self.worksheet_cutoff < datetime.datetime.now()
450
def clone_worksheets(self, source):
451
"""Clone all worksheets from the specified source to this offering."""
452
import ivle.worksheet.utils
453
for worksheet in source.worksheets:
455
newws.seq_no = worksheet.seq_no
456
newws.identifier = worksheet.identifier
457
newws.name = worksheet.name
458
newws.assessable = worksheet.assessable
459
newws.published = worksheet.published
460
newws.data = worksheet.data
461
newws.format = worksheet.format
462
newws.offering = self
463
Store.of(self).add(newws)
464
ivle.worksheet.utils.update_exerciselist(newws)
467
295
class Enrolment(Storm):
468
"""An enrolment of a user in an offering.
470
This represents the roles of both staff and students.
473
296
__storm_table__ = "enrolment"
474
297
__storm_primary__ = "user_id", "offering_id"
533
339
return "<%s %d in %r>" % (type(self).__name__, self.id,
536
def get_permissions(self, user, config):
537
return self.offering.get_permissions(user, config)
539
def get_groups_for_user(self, user):
540
"""List all groups in this offering of which the user is a member."""
542
return Store.of(self).find(
544
ProjectGroupMembership.user_id == user.id,
545
ProjectGroupMembership.project_group_id == ProjectGroup.id,
546
ProjectGroup.project_set_id == self.id)
548
def get_submission_principal(self, user):
549
"""Get the principal on behalf of which the user can submit.
551
If this is a solo project set, the given user is returned. If
552
the user is a member of exactly one group, all the group is
553
returned. Otherwise, None is returned.
556
groups = self.get_groups_for_user(user)
557
if groups.count() == 1:
566
return self.max_students_per_group is not None
570
"""Get the entities (groups or users) assigned to submit this project.
572
This will be a Storm ResultSet.
574
#If its a solo project, return everyone in offering
576
return self.project_groups
578
return self.offering.students
580
class DeadlinePassed(Exception):
581
"""An exception indicating that a project cannot be submitted because the
582
deadline has passed."""
586
return "The project deadline has passed"
588
342
class Project(Storm):
589
"""A student project for which submissions can be made."""
591
343
__storm_table__ = "project"
593
345
id = Int(name="projectid", primary=True)
595
short_name = Unicode()
596
346
synopsis = Unicode()
598
348
project_set_id = Int(name="projectsetid")
599
349
project_set = Reference(project_set_id, ProjectSet.id)
600
350
deadline = DateTime()
602
assesseds = ReferenceSet(id, 'Assessed.project_id')
603
submissions = ReferenceSet(id,
604
'Assessed.project_id',
606
'ProjectSubmission.assessed_id')
608
352
__init__ = _kwarg_init
610
354
def __repr__(self):
611
return "<%s '%s' in %r>" % (type(self).__name__, self.short_name,
355
return "<%s '%s' in %r>" % (type(self).__name__, self.synopsis,
612
356
self.project_set.offering)
614
def can_submit(self, principal, user):
615
return (self in principal.get_projects() and
616
not self.has_deadline_passed(user))
618
def submit(self, principal, path, revision, who):
619
"""Submit a Subversion path and revision to a project.
621
@param principal: The owner of the Subversion repository, and the
622
entity on behalf of whom the submission is being made
623
@param path: A path within that repository to submit.
624
@param revision: The revision of that path to submit.
625
@param who: The user who is actually making the submission.
628
if not self.can_submit(principal, who):
629
raise DeadlinePassed()
631
a = Assessed.get(Store.of(self), principal, self)
632
ps = ProjectSubmission()
633
# Raise SubmissionError if the path is illegal
634
ps.path = ProjectSubmission.test_and_normalise_path(path)
635
ps.revision = revision
636
ps.date_submitted = datetime.datetime.now()
642
def get_permissions(self, user, config):
643
return self.project_set.offering.get_permissions(user, config)
646
def latest_submissions(self):
647
"""Return the latest submission for each Assessed."""
648
return Store.of(self).find(ProjectSubmission,
649
Assessed.project_id == self.id,
650
ProjectSubmission.assessed_id == Assessed.id,
651
ProjectSubmission.date_submitted == Select(
652
Max(ProjectSubmission.date_submitted),
653
ProjectSubmission.assessed_id == Assessed.id,
654
tables=ProjectSubmission
658
def has_deadline_passed(self, user):
659
"""Check whether the deadline has passed."""
660
# XXX: Need to respect extensions.
661
return self.deadline < datetime.datetime.now()
663
def get_submissions_for_principal(self, principal):
664
"""Fetch a ResultSet of all submissions by a particular principal."""
665
assessed = Assessed.get(Store.of(self), principal, self)
668
return assessed.submissions
671
def can_delete(self):
672
"""Can only delete if there are no submissions."""
673
return self.submissions.count() == 0
676
"""Delete the project. Fails if can_delete is False."""
677
if not self.can_delete:
678
raise IntegrityError()
679
for assessed in self.assesseds:
681
Store.of(self).remove(self)
683
358
class ProjectGroup(Storm):
684
"""A group of students working together on a project."""
686
359
__storm_table__ = "project_group"
688
361
id = Int(name="groupid", primary=True)
770
393
return "<%s %r in %r>" % (type(self).__name__, self.user,
771
394
self.project_group)
773
class Assessed(Storm):
774
"""A composite of a user or group combined with a project.
776
Each project submission and extension refers to an Assessed. It is the
777
sole specifier of the repository and project.
780
__storm_table__ = "assessed"
782
id = Int(name="assessedid", primary=True)
783
user_id = Int(name="loginid")
784
user = Reference(user_id, User.id)
785
project_group_id = Int(name="groupid")
786
project_group = Reference(project_group_id, ProjectGroup.id)
788
project_id = Int(name="projectid")
789
project = Reference(project_id, Project.id)
791
extensions = ReferenceSet(id, 'ProjectExtension.assessed_id')
792
submissions = ReferenceSet(
793
id, 'ProjectSubmission.assessed_id', order_by='date_submitted')
796
return "<%s %r in %r>" % (type(self).__name__,
797
self.user or self.project_group, self.project)
801
"""True if the Assessed is a group, False if it is a user."""
802
return self.project_group is not None
806
return self.project_group or self.user
809
def checkout_location(self):
810
"""Returns the location of the Subversion workspace for this piece of
811
assessment, relative to each group member's home directory."""
812
subjectname = self.project.project_set.offering.subject.short_name
814
checkout_dir_name = self.principal.short_name
816
checkout_dir_name = "mywork"
817
return subjectname + "/" + checkout_dir_name
820
def get(cls, store, principal, project):
821
"""Find or create an Assessed for the given user or group and project.
823
@param principal: The user or group.
824
@param project: The project.
827
if t not in (User, ProjectGroup):
828
raise AssertionError('principal must be User or ProjectGroup')
831
(t is User) or (cls.project_group_id == principal.id),
832
(t is ProjectGroup) or (cls.user_id == principal.id),
833
cls.project_id == project.id).one()
840
a.project_group = principal
847
"""Delete the assessed. Fails if there are any submissions. Deletes
849
if self.submissions.count() > 0:
850
raise IntegrityError()
851
for extension in self.extensions:
853
Store.of(self).remove(self)
855
class ProjectExtension(Storm):
856
"""An extension granted to a user or group on a particular project.
858
The user or group and project are specified by the Assessed.
861
__storm_table__ = "project_extension"
863
id = Int(name="extensionid", primary=True)
864
assessed_id = Int(name="assessedid")
865
assessed = Reference(assessed_id, Assessed.id)
866
deadline = DateTime()
867
approver_id = Int(name="approver")
868
approver = Reference(approver_id, User.id)
872
"""Delete the extension."""
873
Store.of(self).remove(self)
875
class SubmissionError(Exception):
876
"""Denotes a validation error during submission."""
879
class ProjectSubmission(Storm):
880
"""A submission from a user or group repository to a particular project.
882
The content of a submission is a single path and revision inside a
883
repository. The repository is that owned by the submission's user and
884
group, while the path and revision are explicit.
886
The user or group and project are specified by the Assessed.
889
__storm_table__ = "project_submission"
891
id = Int(name="submissionid", primary=True)
892
assessed_id = Int(name="assessedid")
893
assessed = Reference(assessed_id, Assessed.id)
896
submitter_id = Int(name="submitter")
897
submitter = Reference(submitter_id, User.id)
898
date_submitted = DateTime()
900
def get_verify_url(self, user):
901
"""Get the URL for verifying this submission, within the account of
903
# If this is a solo project, then self.path will be prefixed with the
904
# subject name. Remove the first path segment.
905
submitpath = self.path[1:] if self.path[:1] == '/' else self.path
906
if not self.assessed.is_group:
907
if '/' in submitpath:
908
submitpath = submitpath.split('/', 1)[1]
911
return "/files/%s/%s/%s?r=%d" % (user.login,
912
self.assessed.checkout_location, submitpath, self.revision)
915
def test_and_normalise_path(path):
916
"""Test that path is valid, and normalise it. This prevents possible
917
injections using malicious paths.
918
Returns the updated path, if successful.
919
Raises SubmissionError if invalid.
921
# Ensure the path is absolute to prevent being tacked onto working
923
# Prevent '\n' because it will break all sorts of things.
924
# Prevent '[' and ']' because they can be used to inject into the
926
# Normalise to avoid resulting in ".." path segments.
927
if not os.path.isabs(path):
928
raise SubmissionError("Path is not absolute")
929
if any(c in path for c in "\n[]"):
930
raise SubmissionError("Path must not contain '\\n', '[' or ']'")
931
return os.path.normpath(path)
933
396
# WORKSHEETS AND EXERCISES #
935
398
class Exercise(Storm):
936
"""An exercise for students to complete in a worksheet.
938
An exercise may be present in any number of worksheets.
941
__storm_table__ = "exercise"
399
# Note: Table "problem" is called "Exercise" in the Object layer, since
400
# it's called that everywhere else.
401
__storm_table__ = "problem"
402
#TODO: Add in a field for the user-friendly identifier
942
403
id = Unicode(primary=True, name="identifier")
944
405
description = Unicode()
945
_description_xhtml_cache = Unicode(name='description_xhtml_cache')
946
406
partial = Unicode()
947
407
solution = Unicode()
948
408
include = Unicode()
951
worksheet_exercises = ReferenceSet(id,
952
'WorksheetExercise.exercise_id')
954
411
worksheets = ReferenceSet(id,
955
412
'WorksheetExercise.exercise_id',
956
413
'WorksheetExercise.worksheet_id',
960
test_suites = ReferenceSet(id,
961
'TestSuite.exercise_id',
417
test_suites = ReferenceSet(id, 'TestSuite.exercise_id')
964
419
__init__ = _kwarg_init
966
421
def __repr__(self):
967
422
return "<%s %s>" % (type(self).__name__, self.name)
969
def get_permissions(self, user, config):
970
return self.global_permissions(user, config)
973
def global_permissions(user, config):
974
"""Gets the set of permissions this user has over *all* exercises.
975
This is used to determine who may view the exercises list, and create
983
elif u'lecturer' in set((e.role for e in user.active_enrolments)):
986
elif (config['policy']['tutors_can_edit_worksheets']
987
and u'tutor' in set((e.role for e in user.active_enrolments))):
988
# Site-specific policy on the role of tutors
994
def _cache_description_xhtml(self, invalidate=False):
995
# Don't regenerate an existing cache unless forced.
996
if self._description_xhtml_cache is not None and not invalidate:
1000
self._description_xhtml_cache = rst(self.description)
1002
self._description_xhtml_cache = None
1005
def description_xhtml(self):
1006
"""The XHTML exercise description, converted from reStructuredText."""
1007
self._cache_description_xhtml()
1008
return self._description_xhtml_cache
1010
def set_description(self, description):
1011
self.description = description
1012
self._cache_description_xhtml(invalidate=True)
1015
"""Deletes the exercise, providing it has no associated worksheets."""
1016
if (self.worksheet_exercises.count() > 0):
1017
raise IntegrityError()
1018
for suite in self.test_suites:
1020
Store.of(self).remove(self)
1022
425
class Worksheet(Storm):
1023
"""A worksheet with exercises for students to complete.
1025
Worksheets are owned by offerings.
1028
426
__storm_table__ = "worksheet"
1030
428
id = Int(primary=True, name="worksheetid")
429
# XXX subject is not linked to a Subject object. This is a property of
430
# the database, and will be refactored.
1031
431
offering_id = Int(name="offeringid")
1032
identifier = Unicode()
432
name = Unicode(name="identifier")
1034
433
assessable = Bool()
1037
_data_xhtml_cache = Unicode(name='data_xhtml_cache')
1041
436
attempts = ReferenceSet(id, "ExerciseAttempt.worksheetid")
1042
437
offering = Reference(offering_id, 'Offering.id')
1044
all_worksheet_exercises = ReferenceSet(id,
439
exercises = ReferenceSet(id,
440
'WorksheetExercise.worksheet_id',
441
'WorksheetExercise.exercise_id',
443
# Use worksheet_exercises to get access to the WorksheetExercise objects
444
# binding worksheets to exercises. This is required to access the
446
worksheet_exercises = ReferenceSet(id,
1045
447
'WorksheetExercise.worksheet_id')
1047
# Use worksheet_exercises to get access to the *active* WorksheetExercise
1048
# objects binding worksheets to exercises. This is required to access the
1052
def worksheet_exercises(self):
1053
return self.all_worksheet_exercises.find(active=True)
1055
450
__init__ = _kwarg_init
1057
452
def __repr__(self):
1058
453
return "<%s %s>" % (type(self).__name__, self.name)
1060
def remove_all_exercises(self):
1061
"""Remove all exercises from this worksheet.
455
# XXX Refactor this - make it an instance method of Subject rather than a
456
# class method of Worksheet. Can't do that now because Subject isn't
457
# linked referentially to the Worksheet.
459
def get_by_name(cls, store, subjectname, worksheetname):
461
Get the Worksheet from the db associated with a given store, subject
462
name and worksheet name.
464
return store.find(cls, cls.subject == unicode(subjectname),
465
cls.name == unicode(worksheetname)).one()
467
def remove_all_exercises(self, store):
469
Remove all exercises from this worksheet.
1063
470
This does not delete the exercises themselves. It just removes them
1064
471
from the worksheet.
1066
store = Store.of(self)
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()
1070
473
store.find(WorksheetExercise,
1071
474
WorksheetExercise.worksheet == self).remove()
1073
def get_permissions(self, user, config):
1074
offering_perms = self.offering.get_permissions(user, config)
1078
# Anybody who can view an offering can view a published
1080
if 'view' in offering_perms and self.published:
1083
# Any worksheet editors can both view and edit.
1084
if 'edit_worksheets' in offering_perms:
1090
def _cache_data_xhtml(self, invalidate=False):
1091
# Don't regenerate an existing cache unless forced.
1092
if self._data_xhtml_cache is not None and not invalidate:
1095
if self.format == u'rst':
1096
self._data_xhtml_cache = rst(self.data)
1098
self._data_xhtml_cache = None
1101
def data_xhtml(self):
1102
"""The XHTML of this worksheet, converted from rST if required."""
1103
# Update the rST -> XHTML cache, if required.
1104
self._cache_data_xhtml()
1106
if self.format == u'rst':
1107
return self._data_xhtml_cache
1111
def set_data(self, data):
1113
self._cache_data_xhtml(invalidate=True)
1116
"""Deletes the worksheet, provided it has no attempts on any exercises.
1118
Returns True if delete succeeded, or False if this worksheet has
1119
attempts attached."""
1120
for ws_ex in self.all_worksheet_exercises:
1121
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
1122
raise IntegrityError()
1124
self.remove_all_exercises()
1125
Store.of(self).remove(self)
476
def get_permissions(self, user):
477
return self.offering.get_permissions(user)
1127
479
class WorksheetExercise(Storm):
1128
"""A link between a worksheet and one of its exercises.
1130
These may be marked optional, in which case the exercise does not count
1131
for marking purposes. The sequence number is used to order the worksheet
1135
__storm_table__ = "worksheet_exercise"
1137
id = Int(primary=True, name="ws_ex_id")
480
__storm_table__ = "worksheet_problem"
481
__storm_primary__ = "worksheet_id", "exercise_id"
1139
483
worksheet_id = Int(name="worksheetid")
1140
484
worksheet = Reference(worksheet_id, Worksheet.id)
1141
exercise_id = Unicode(name="exerciseid")
485
exercise_id = Unicode(name="problemid")
1142
486
exercise = Reference(exercise_id, Exercise.id)
1143
487
optional = Bool()
1147
saves = ReferenceSet(id, "ExerciseSave.ws_ex_id")
1148
attempts = ReferenceSet(id, "ExerciseAttempt.ws_ex_id")
1150
489
__init__ = _kwarg_init
1152
491
def __repr__(self):
1153
492
return "<%s %s in %s>" % (type(self).__name__, self.exercise.name,
1154
self.worksheet.identifier)
1156
def get_permissions(self, user, config):
1157
return self.worksheet.get_permissions(user, config)
1160
495
class ExerciseSave(Storm):
1161
"""A potential exercise solution submitted by a user for storage.
1163
This is not an actual tested attempt at an exercise, it's just a save of
1164
the editing session.
1167
__storm_table__ = "exercise_save"
1168
__storm_primary__ = "ws_ex_id", "user_id"
1170
ws_ex_id = Int(name="ws_ex_id")
1171
worksheet_exercise = Reference(ws_ex_id, "WorksheetExercise.id")
497
Represents a potential solution to an exercise that a user has submitted
498
to the server for storage.
499
A basic ExerciseSave is just the current saved text for this exercise for
500
this user (doesn't count towards their attempts).
501
ExerciseSave may be extended with additional semantics (such as
504
__storm_table__ = "problem_save"
505
__storm_primary__ = "exercise_id", "user_id", "date"
507
exercise_id = Unicode(name="problemid")
508
exercise = Reference(exercise_id, Exercise.id)
1173
509
user_id = Int(name="loginid")
1174
510
user = Reference(user_id, User.id)
1175
511
date = DateTime()
1176
512
text = Unicode()
514
worksheet = Reference(worksheetid, Worksheet.id)
1178
516
__init__ = _kwarg_init
1180
518
def __repr__(self):
1181
519
return "<%s %s by %s at %s>" % (type(self).__name__,
1182
self.worksheet_exercise.exercise.name, self.user.login,
1183
self.date.strftime("%c"))
520
self.exercise.name, self.user.login, self.date.strftime("%c"))
1185
522
class ExerciseAttempt(ExerciseSave):
1186
"""An attempt at solving an exercise.
1188
This is a special case of ExerciseSave, used when the user submits a
1189
candidate solution. Like an ExerciseSave, it constitutes exercise solution
1192
In addition, it contains information about the result of the submission:
1194
- complete - True if this submission was successful, rendering this
1195
exercise complete for this user in this worksheet.
1196
- active - True if this submission is "active" (usually true).
1197
Submissions may be de-activated by privileged users for
1198
special reasons, and then they won't count (either as a
1199
penalty or success), but will still be stored.
1202
__storm_table__ = "exercise_attempt"
1203
__storm_primary__ = "ws_ex_id", "user_id", "date"
524
An ExerciseAttempt is a special case of an ExerciseSave. Like an
525
ExerciseSave, it constitutes exercise solution data that the user has
526
submitted to the server for storage.
527
In addition, it contains additional information about the submission.
528
complete - True if this submission was successful, rendering this exercise
529
complete for this user.
530
active - True if this submission is "active" (usually true). Submissions
531
may be de-activated by privileged users for special reasons, and then
532
they won't count (either as a penalty or success), but will still be
535
__storm_table__ = "problem_attempt"
536
__storm_primary__ = "exercise_id", "user_id", "date"
1205
538
# The "text" field is the same but has a different name in the DB table
1206
539
# for some reason.
1207
540
text = Unicode(name="attempt")
1208
541
complete = Bool()
1211
def get_permissions(self, user, config):
544
def get_permissions(self, user):
1212
545
return set(['view']) if user is self.user else set()
1214
547
class TestSuite(Storm):
1215
"""A container to group an exercise's test cases.
1217
The test suite contains some information on how to test. The function to
1218
test, variables to set and stdin data are stored here.
548
"""A Testsuite acts as a container for the test cases of an exercise."""
1221
549
__storm_table__ = "test_suite"
1222
550
__storm_primary__ = "exercise_id", "suiteid"
1225
exercise_id = Unicode(name="exerciseid")
553
exercise_id = Unicode(name="problemid")
1226
554
description = Unicode()
1228
556
function = Unicode()
1229
557
stdin = Unicode()
1230
558
exercise = Reference(exercise_id, Exercise.id)
1231
test_cases = ReferenceSet(suiteid, 'TestCase.suiteid', order_by="seq_no")
1232
variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid', order_by='arg_no')
1235
"""Delete this suite, without asking questions."""
1236
for variable in self.variables:
1238
for test_case in self.test_cases:
1240
Store.of(self).remove(self)
559
test_cases = ReferenceSet(suiteid, 'TestCase.suiteid')
560
variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid')
1242
562
class TestCase(Storm):
1243
"""A container for actual tests (see TestCasePart), inside a test suite.
1245
It is the lowest level shown to students on their pass/fail status."""
563
"""A TestCase is a member of a TestSuite.
565
It contains the data necessary to check if an exercise is correct"""
1247
566
__storm_table__ = "test_case"
1248
567
__storm_primary__ = "testid", "suiteid"
1252
571
suite = Reference(suiteid, "TestSuite.suiteid")
1253
572
passmsg = Unicode()
1254
573
failmsg = Unicode()
1255
test_default = Unicode() # Currently unused - only used for file matching.
574
test_default = Unicode()
1258
577
parts = ReferenceSet(testid, "TestCasePart.testid")
1260
579
__init__ = _kwarg_init
1263
for part in self.parts:
1265
Store.of(self).remove(self)
1267
581
class TestSuiteVar(Storm):
1268
"""A variable used by an exercise test suite.
1270
This may represent a function argument or a normal variable.
1273
__storm_table__ = "suite_variable"
582
"""A container for the arguments of a Test Suite"""
583
__storm_table__ = "suite_variables"
1274
584
__storm_primary__ = "varid"
1278
588
var_name = Unicode()
1279
589
var_value = Unicode()
1280
590
var_type = Unicode()
1283
593
suite = Reference(suiteid, "TestSuite.suiteid")
1285
595
__init__ = _kwarg_init
1288
Store.of(self).remove(self)
1290
597
class TestCasePart(Storm):
1291
"""An actual piece of code to test an exercise solution."""
1293
__storm_table__ = "test_case_part"
598
"""A container for the test elements of a Test Case"""
599
__storm_table__ = "test_case_parts"
1294
600
__storm_primary__ = "partid"
1299
605
part_type = Unicode()
1300
606
test_type = Unicode()
1301
607
data = Unicode()
1302
608
filename = Unicode()
1304
610
test = Reference(testid, "TestCase.testid")
1306
612
__init__ = _kwarg_init
1309
Store.of(self).remove(self)