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
29
from storm.locals import create_database, Store, Int, Unicode, DateTime, \
31
30
Reference, ReferenceSet, Bool, Storm, Desc
31
from storm.expr import Select, Max
32
from storm.exceptions import NotOneError, IntegrityError
34
from ivle.worksheet.rst import rst
36
36
__all__ = ['get_store',
38
38
'Subject', 'Semester', 'Offering', 'Enrolment',
39
39
'ProjectSet', 'Project', 'ProjectGroup', 'ProjectGroupMembership',
40
'Assessed', 'ProjectSubmission', 'ProjectExtension',
40
41
'Exercise', 'Worksheet', 'WorksheetExercise',
41
42
'ExerciseSave', 'ExerciseAttempt',
42
'AlreadyEnrolledError', 'TestCase', 'TestSuite', 'TestSuiteVar'
43
'TestCase', 'TestSuite', 'TestSuiteVar'
45
46
def _kwarg_init(self, **kwargs):
49
50
% (self.__class__.__name__, k))
50
51
setattr(self, k, v)
52
def get_conn_string():
54
Returns the Storm connection string, generated from the conf file.
53
def get_conn_string(config):
54
"""Create a Storm connection string to the IVLE database
56
@param config: The IVLE configuration.
59
clusterstr += ivle.conf.db_user
60
if ivle.conf.db_password:
61
clusterstr += ':' + ivle.conf.db_password
60
if config['database']['username']:
61
clusterstr += config['database']['username']
62
if config['database']['password']:
63
clusterstr += ':' + config['database']['password']
64
host = ivle.conf.db_host or 'localhost'
65
port = ivle.conf.db_port or 5432
66
host = config['database']['host'] or 'localhost'
67
port = config['database']['port'] or 5432
67
69
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()))
71
return "postgres://%s/%s" % (clusterstr, config['database']['name'])
73
def get_store(config):
74
"""Create a Storm store connected to the IVLE database.
76
@param config: The IVLE configuration.
78
return Store(create_database(get_conn_string(config)))
82
Represents an IVLE user.
83
"""An IVLE user account."""
84
84
__storm_table__ = "login"
86
86
id = Int(primary=True, name="loginid")
88
88
passhash = Unicode()
93
93
pass_exp = DateTime()
199
197
'''A sanely ordered list of all of the user's enrolments.'''
200
198
return self._get_enrolments(False)
200
def get_projects(self, offering=None, active_only=True):
201
"""Find projects that the user can submit.
203
This will include projects for offerings in which the user is
204
enrolled, as long as the project is not in a project set which has
205
groups (ie. if maximum number of group members is 0).
207
@param active_only: Whether to only search active offerings.
208
@param offering: An optional offering to restrict the search to.
210
return Store.of(self).find(Project,
211
Project.project_set_id == ProjectSet.id,
212
ProjectSet.max_students_per_group == None,
213
ProjectSet.offering_id == Offering.id,
214
(offering is None) or (Offering.id == offering.id),
215
Semester.id == Offering.semester_id,
216
(not active_only) or (Semester.state == u'current'),
217
Enrolment.offering_id == Offering.id,
218
Enrolment.user_id == self.id)
203
221
def hash_password(password):
204
return md5.md5(password).hexdigest()
222
"""Hash a password with MD5."""
223
return hashlib.md5(password).hexdigest()
207
226
def get_by_login(cls, store, login):
209
Get the User from the db associated with a given store and
227
"""Find a user in a store by login name."""
212
228
return store.find(cls, cls.login == unicode(login)).one()
214
def get_permissions(self, user):
215
if user and user.rolenm == 'admin' or user is self:
216
return set(['view', 'edit'])
230
def get_permissions(self, user, config):
231
"""Determine privileges held by a user over this object.
233
If the user requesting privileges is this user or an admin,
234
they may do everything. Otherwise they may do nothing.
236
if user and user.admin or user is self:
237
return set(['view_public', 'view', 'edit', 'submit_project'])
239
return set(['view_public'])
220
241
# SUBJECTS AND ENROLMENTS #
222
243
class Subject(Storm):
244
"""A subject (or course) which is run in some semesters."""
223
246
__storm_table__ = "subject"
225
248
id = Int(primary=True, name="subjectid")
226
249
code = Unicode(name="subj_code")
227
250
name = Unicode(name="subj_name")
228
251
short_name = Unicode(name="subj_short_name")
231
253
offerings = ReferenceSet(id, 'Offering.subject_id')
235
257
def __repr__(self):
236
258
return "<%s '%s'>" % (type(self).__name__, self.short_name)
238
def get_permissions(self, user):
260
def get_permissions(self, user, config):
261
"""Determine privileges held by a user over this object.
263
If the user requesting privileges is an admin, they may edit.
264
Otherwise they may only read.
240
267
if user is not None:
241
268
perms.add('view')
242
if user.rolenm == 'admin':
243
270
perms.add('edit')
273
def active_offerings(self):
274
"""Find active offerings for this subject.
276
Return a sequence of currently active offerings for this subject
277
(offerings whose semester.state is "current"). There should be 0 or 1
278
elements in this sequence, but it's possible there are more.
280
return self.offerings.find(Offering.semester_id == Semester.id,
281
Semester.state == u'current')
283
def offering_for_semester(self, year, semester):
284
"""Get the offering for the given year/semester, or None.
286
@param year: A string representation of the year.
287
@param semester: A string representation of the semester.
289
return self.offerings.find(Offering.semester_id == Semester.id,
290
Semester.year == unicode(year),
291
Semester.semester == unicode(semester)).one()
246
293
class Semester(Storm):
294
"""A semester in which subjects can be run."""
247
296
__storm_table__ = "semester"
249
298
id = Int(primary=True, name="semesterid")
251
300
semester = Unicode()
254
303
offerings = ReferenceSet(id, 'Offering.semester_id')
304
enrolments = ReferenceSet(id,
305
'Offering.semester_id',
307
'Enrolment.offering_id')
256
309
__init__ = _kwarg_init
286
347
return "<%s %r in %r>" % (type(self).__name__, self.subject,
289
def enrol(self, user):
290
'''Enrol a user in this offering.'''
291
# We'll get a horrible database constraint violation error if we try
292
# to add a second enrolment.
293
if Store.of(self).find(Enrolment,
294
Enrolment.user_id == user.id,
295
Enrolment.offering_id == self.id).count() == 1:
296
raise AlreadyEnrolledError()
298
e = Enrolment(user=user, offering=self, active=True)
299
self.enrolments.add(e)
301
def get_permissions(self, user):
350
def enrol(self, user, role=u'student'):
351
"""Enrol a user in this offering.
353
Enrolments handle both the staff and student cases. The role controls
354
the privileges granted by this enrolment.
356
enrolment = Store.of(self).find(Enrolment,
357
Enrolment.user_id == user.id,
358
Enrolment.offering_id == self.id).one()
360
if enrolment is None:
361
enrolment = Enrolment(user=user, offering=self)
362
self.enrolments.add(enrolment)
364
enrolment.active = True
365
enrolment.role = role
367
def unenrol(self, user):
368
'''Unenrol a user from this offering.'''
369
enrolment = Store.of(self).find(Enrolment,
370
Enrolment.user_id == user.id,
371
Enrolment.offering_id == self.id).one()
372
Store.of(enrolment).remove(enrolment)
374
def get_permissions(self, user, config):
303
376
if user is not None:
305
if user.rolenm in ('admin', 'lecturer'):
377
enrolment = self.get_enrolment(user)
378
if enrolment or user.admin:
380
if enrolment and enrolment.role == u'tutor':
381
perms.add('view_project_submissions')
382
# Site-specific policy on the role of tutors
383
if config['policy']['tutors_can_enrol_students']:
385
perms.add('enrol_student')
386
if config['policy']['tutors_can_edit_worksheets']:
387
perms.add('edit_worksheets')
388
if config['policy']['tutors_can_admin_groups']:
389
perms.add('admin_groups')
390
if (enrolment and enrolment.role in (u'lecturer')) or user.admin:
391
perms.add('view_project_submissions')
392
perms.add('admin_groups')
393
perms.add('edit_worksheets')
394
perms.add('edit') # Can edit projects & details
395
perms.add('enrol') # Can see enrolment screen at all
396
perms.add('enrol_student') # Can enrol students
397
perms.add('enrol_tutor') # Can enrol tutors
399
perms.add('enrol_lecturer') # Can enrol lecturers
402
def get_enrolment(self, user):
403
"""Find the user's enrolment in this offering."""
405
enrolment = self.enrolments.find(user=user).one()
411
def get_members_by_role(self, role):
412
return Store.of(self).find(User,
413
Enrolment.user_id == User.id,
414
Enrolment.offering_id == self.id,
415
Enrolment.role == role
416
).order_by(User.login)
420
return self.get_members_by_role(u'student')
422
def get_open_projects_for_user(self, user):
423
"""Find all projects currently open to submissions by a user."""
424
# XXX: Respect extensions.
425
return self.projects.find(Project.deadline > datetime.datetime.now())
309
427
class Enrolment(Storm):
428
"""An enrolment of a user in an offering.
430
This represents the roles of both staff and students.
310
433
__storm_table__ = "enrolment"
311
434
__storm_primary__ = "user_id", "offering_id"
353
480
return "<%s %d in %r>" % (type(self).__name__, self.id,
483
def get_permissions(self, user, config):
484
return self.offering.get_permissions(user, config)
486
def get_groups_for_user(self, user):
487
"""List all groups in this offering of which the user is a member."""
489
return Store.of(self).find(
491
ProjectGroupMembership.user_id == user.id,
492
ProjectGroupMembership.project_group_id == ProjectGroup.id,
493
ProjectGroup.project_set_id == self.id)
495
def get_submission_principal(self, user):
496
"""Get the principal on behalf of which the user can submit.
498
If this is a solo project set, the given user is returned. If
499
the user is a member of exactly one group, all the group is
500
returned. Otherwise, None is returned.
503
groups = self.get_groups_for_user(user)
504
if groups.count() == 1:
513
return self.max_students_per_group is not None
517
"""Get the entities (groups or users) assigned to submit this project.
519
This will be a Storm ResultSet.
521
#If its a solo project, return everyone in offering
523
return self.project_groups
525
return self.offering.students
527
class DeadlinePassed(Exception):
528
"""An exception indicating that a project cannot be submitted because the
529
deadline has passed."""
533
return "The project deadline has passed"
356
535
class Project(Storm):
536
"""A student project for which submissions can be made."""
357
538
__storm_table__ = "project"
359
540
id = Int(name="projectid", primary=True)
542
short_name = Unicode()
360
543
synopsis = Unicode()
362
545
project_set_id = Int(name="projectsetid")
363
546
project_set = Reference(project_set_id, ProjectSet.id)
364
547
deadline = DateTime()
549
assesseds = ReferenceSet(id, 'Assessed.project_id')
550
submissions = ReferenceSet(id,
551
'Assessed.project_id',
553
'ProjectSubmission.assessed_id')
366
555
__init__ = _kwarg_init
368
557
def __repr__(self):
369
return "<%s '%s' in %r>" % (type(self).__name__, self.synopsis,
558
return "<%s '%s' in %r>" % (type(self).__name__, self.short_name,
370
559
self.project_set.offering)
561
def can_submit(self, principal, user):
562
return (self in principal.get_projects() and
563
not self.has_deadline_passed(user))
565
def submit(self, principal, path, revision, who):
566
"""Submit a Subversion path and revision to a project.
568
@param principal: The owner of the Subversion repository, and the
569
entity on behalf of whom the submission is being made
570
@param path: A path within that repository to submit.
571
@param revision: The revision of that path to submit.
572
@param who: The user who is actually making the submission.
575
if not self.can_submit(principal, who):
576
raise DeadlinePassed()
578
a = Assessed.get(Store.of(self), principal, self)
579
ps = ProjectSubmission()
581
ps.revision = revision
582
ps.date_submitted = datetime.datetime.now()
588
def get_permissions(self, user, config):
589
return self.project_set.offering.get_permissions(user, config)
592
def latest_submissions(self):
593
"""Return the latest submission for each Assessed."""
594
return Store.of(self).find(ProjectSubmission,
595
Assessed.project_id == self.id,
596
ProjectSubmission.assessed_id == Assessed.id,
597
ProjectSubmission.date_submitted == Select(
598
Max(ProjectSubmission.date_submitted),
599
ProjectSubmission.assessed_id == Assessed.id,
600
tables=ProjectSubmission
604
def has_deadline_passed(self, user):
605
"""Check whether the deadline has passed."""
606
# XXX: Need to respect extensions.
607
return self.deadline < datetime.datetime.now()
609
def get_submissions_for_principal(self, principal):
610
"""Fetch a ResultSet of all submissions by a particular principal."""
611
assessed = Assessed.get(Store.of(self), principal, self)
614
return assessed.submissions
372
618
class ProjectGroup(Storm):
619
"""A group of students working together on a project."""
373
621
__storm_table__ = "project_group"
375
623
id = Int(name="groupid", primary=True)
392
640
return "<%s %s in %r>" % (type(self).__name__, self.name,
393
641
self.project_set.offering)
644
def display_name(self):
645
"""Returns the "nice name" of the user or group."""
649
def short_name(self):
650
"""Returns the database "identifier" name of the user or group."""
653
def get_projects(self, offering=None, active_only=True):
654
'''Find projects that the group can submit.
656
This will include projects in the project set which owns this group,
657
unless the project set disallows groups (in which case none will be
660
@param active_only: Whether to only search active offerings.
661
@param offering: An optional offering to restrict the search to.
663
return Store.of(self).find(Project,
664
Project.project_set_id == ProjectSet.id,
665
ProjectSet.id == self.project_set.id,
666
ProjectSet.max_students_per_group != None,
667
ProjectSet.offering_id == Offering.id,
668
(offering is None) or (Offering.id == offering.id),
669
Semester.id == Offering.semester_id,
670
(not active_only) or (Semester.state == u'current'))
673
def get_permissions(self, user, config):
674
if user.admin or user in self.members:
675
return set(['submit_project'])
395
679
class ProjectGroupMembership(Storm):
680
"""A student's membership in a project group."""
396
682
__storm_table__ = "group_member"
397
683
__storm_primary__ = "user_id", "project_group_id"
407
693
return "<%s %r in %r>" % (type(self).__name__, self.user,
408
694
self.project_group)
696
class Assessed(Storm):
697
"""A composite of a user or group combined with a project.
699
Each project submission and extension refers to an Assessed. It is the
700
sole specifier of the repository and project.
703
__storm_table__ = "assessed"
705
id = Int(name="assessedid", primary=True)
706
user_id = Int(name="loginid")
707
user = Reference(user_id, User.id)
708
project_group_id = Int(name="groupid")
709
project_group = Reference(project_group_id, ProjectGroup.id)
711
project_id = Int(name="projectid")
712
project = Reference(project_id, Project.id)
714
extensions = ReferenceSet(id, 'ProjectExtension.assessed_id')
715
submissions = ReferenceSet(
716
id, 'ProjectSubmission.assessed_id', order_by='date_submitted')
719
return "<%s %r in %r>" % (type(self).__name__,
720
self.user or self.project_group, self.project)
724
"""True if the Assessed is a group, False if it is a user."""
725
return self.project_group is not None
729
return self.project_group or self.user
732
def checkout_location(self):
733
"""Returns the location of the Subversion workspace for this piece of
734
assessment, relative to each group member's home directory."""
735
subjectname = self.project.project_set.offering.subject.short_name
737
checkout_dir_name = self.principal.short_name
739
checkout_dir_name = "mywork"
740
return subjectname + "/" + checkout_dir_name
743
def get(cls, store, principal, project):
744
"""Find or create an Assessed for the given user or group and project.
746
@param principal: The user or group.
747
@param project: The project.
750
if t not in (User, ProjectGroup):
751
raise AssertionError('principal must be User or ProjectGroup')
754
(t is User) or (cls.project_group_id == principal.id),
755
(t is ProjectGroup) or (cls.user_id == principal.id),
756
cls.project_id == project.id).one()
763
a.project_group = principal
770
class ProjectExtension(Storm):
771
"""An extension granted to a user or group on a particular project.
773
The user or group and project are specified by the Assessed.
776
__storm_table__ = "project_extension"
778
id = Int(name="extensionid", primary=True)
779
assessed_id = Int(name="assessedid")
780
assessed = Reference(assessed_id, Assessed.id)
781
deadline = DateTime()
782
approver_id = Int(name="approver")
783
approver = Reference(approver_id, User.id)
786
class ProjectSubmission(Storm):
787
"""A submission from a user or group repository to a particular project.
789
The content of a submission is a single path and revision inside a
790
repository. The repository is that owned by the submission's user and
791
group, while the path and revision are explicit.
793
The user or group and project are specified by the Assessed.
796
__storm_table__ = "project_submission"
798
id = Int(name="submissionid", primary=True)
799
assessed_id = Int(name="assessedid")
800
assessed = Reference(assessed_id, Assessed.id)
803
submitter_id = Int(name="submitter")
804
submitter = Reference(submitter_id, User.id)
805
date_submitted = DateTime()
807
def get_verify_url(self, user):
808
"""Get the URL for verifying this submission, within the account of
810
# If this is a solo project, then self.path will be prefixed with the
811
# subject name. Remove the first path segment.
812
submitpath = self.path[1:] if self.path[:1] == '/' else self.path
813
if not self.assessed.is_group:
814
if '/' in submitpath:
815
submitpath = submitpath.split('/', 1)[1]
818
return "/files/%s/%s/%s?r=%d" % (user.login,
819
self.assessed.checkout_location, submitpath, self.revision)
410
821
# WORKSHEETS AND EXERCISES #
412
823
class Exercise(Storm):
824
"""An exercise for students to complete in a worksheet.
826
An exercise may be present in any number of worksheets.
413
829
__storm_table__ = "exercise"
414
830
id = Unicode(primary=True, name="identifier")
419
835
include = Unicode()
838
worksheet_exercises = ReferenceSet(id,
839
'WorksheetExercise.exercise_id')
422
841
worksheets = ReferenceSet(id,
423
842
'WorksheetExercise.exercise_id',
424
843
'WorksheetExercise.worksheet_id',
428
test_suites = ReferenceSet(id, 'TestSuite.exercise_id')
847
test_suites = ReferenceSet(id,
848
'TestSuite.exercise_id',
430
851
__init__ = _kwarg_init
432
853
def __repr__(self):
433
854
return "<%s %s>" % (type(self).__name__, self.name)
435
def get_permissions(self, user):
856
def get_permissions(self, user, config):
857
return self.global_permissions(user, config)
860
def global_permissions(user, config):
861
"""Gets the set of permissions this user has over *all* exercises.
862
This is used to determine who may view the exercises list, and create
437
866
if user is not None:
438
if user.rolenm in ('admin', 'lecturer'):
870
elif u'lecturer' in set((e.role for e in user.active_enrolments)):
873
elif (config['policy']['tutors_can_edit_worksheets']
874
and u'tutor' in set((e.role for e in user.active_enrolments))):
875
# Site-specific policy on the role of tutors
881
def get_description(self):
882
"""Return the description interpreted as reStructuredText."""
883
return rst(self.description)
886
"""Deletes the exercise, providing it has no associated worksheets."""
887
if (self.worksheet_exercises.count() > 0):
888
raise IntegrityError()
889
for suite in self.test_suites:
891
Store.of(self).remove(self)
443
893
class Worksheet(Storm):
894
"""A worksheet with exercises for students to complete.
896
Worksheets are owned by offerings.
444
899
__storm_table__ = "worksheet"
446
901
id = Int(primary=True, name="worksheetid")
455
910
attempts = ReferenceSet(id, "ExerciseAttempt.worksheetid")
456
911
offering = Reference(offering_id, 'Offering.id')
458
# Use worksheet_exercises to get access to the WorksheetExercise objects
459
# binding worksheets to exercises. This is required to access the
913
all_worksheet_exercises = ReferenceSet(id,
914
'WorksheetExercise.worksheet_id')
916
# Use worksheet_exercises to get access to the *active* WorksheetExercise
917
# objects binding worksheets to exercises. This is required to access the
460
918
# "optional" field.
461
worksheet_exercises = ReferenceSet(id,
462
'WorksheetExercise.worksheet_id')
921
def worksheet_exercises(self):
922
return self.all_worksheet_exercises.find(active=True)
465
924
__init__ = _kwarg_init
467
926
def __repr__(self):
468
927
return "<%s %s>" % (type(self).__name__, self.name)
470
# XXX Refactor this - make it an instance method of Subject rather than a
471
# class method of Worksheet. Can't do that now because Subject isn't
472
# linked referentially to the Worksheet.
474
def get_by_name(cls, store, subjectname, worksheetname):
476
Get the Worksheet from the db associated with a given store, subject
477
name and worksheet name.
479
return store.find(cls, cls.subject == unicode(subjectname),
480
cls.name == unicode(worksheetname)).one()
929
def remove_all_exercises(self):
930
"""Remove all exercises from this worksheet.
482
def remove_all_exercises(self, store):
484
Remove all exercises from this worksheet.
485
932
This does not delete the exercises themselves. It just removes them
486
933
from the worksheet.
935
store = Store.of(self)
936
for ws_ex in self.all_worksheet_exercises:
937
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
938
raise IntegrityError()
488
939
store.find(WorksheetExercise,
489
940
WorksheetExercise.worksheet == self).remove()
491
def get_permissions(self, user):
492
return self.offering.get_permissions(user)
942
def get_permissions(self, user, config):
943
# Almost the same permissions as for the offering itself
944
perms = self.offering.get_permissions(user, config)
945
# However, "edit" permission is derived from the "edit_worksheets"
946
# permission of the offering
947
if 'edit_worksheets' in perms:
950
perms.discard('edit')
954
"""Returns the xml of this worksheet, converts from rst if required."""
955
if self.format == u'rst':
956
ws_xml = rst(self.data)
962
"""Deletes the worksheet, provided it has no attempts on any exercises.
964
Returns True if delete succeeded, or False if this worksheet has
965
attempts attached."""
966
for ws_ex in self.all_worksheet_exercises:
967
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
968
raise IntegrityError()
970
self.remove_all_exercises()
971
Store.of(self).remove(self)
494
973
class WorksheetExercise(Storm):
974
"""A link between a worksheet and one of its exercises.
976
These may be marked optional, in which case the exercise does not count
977
for marking purposes. The sequence number is used to order the worksheet
495
981
__storm_table__ = "worksheet_exercise"
497
983
id = Int(primary=True, name="ws_ex_id")
499
985
worksheet_id = Int(name="worksheetid")
513
999
return "<%s %s in %s>" % (type(self).__name__, self.exercise.name,
514
1000
self.worksheet.identifier)
1002
def get_permissions(self, user, config):
1003
return self.worksheet.get_permissions(user, config)
516
1006
class ExerciseSave(Storm):
518
Represents a potential solution to an exercise that a user has submitted
519
to the server for storage.
520
A basic ExerciseSave is just the current saved text for this exercise for
521
this user (doesn't count towards their attempts).
522
ExerciseSave may be extended with additional semantics (such as
1007
"""A potential exercise solution submitted by a user for storage.
1009
This is not an actual tested attempt at an exercise, it's just a save of
1010
the editing session.
525
1013
__storm_table__ = "exercise_save"
526
1014
__storm_primary__ = "ws_ex_id", "user_id"
540
1028
self.exercise.name, self.user.login, self.date.strftime("%c"))
542
1030
class ExerciseAttempt(ExerciseSave):
544
An ExerciseAttempt is a special case of an ExerciseSave. Like an
545
ExerciseSave, it constitutes exercise solution data that the user has
546
submitted to the server for storage.
547
In addition, it contains additional information about the submission.
548
complete - True if this submission was successful, rendering this exercise
549
complete for this user.
550
active - True if this submission is "active" (usually true). Submissions
551
may be de-activated by privileged users for special reasons, and then
552
they won't count (either as a penalty or success), but will still be
1031
"""An attempt at solving an exercise.
1033
This is a special case of ExerciseSave, used when the user submits a
1034
candidate solution. Like an ExerciseSave, it constitutes exercise solution
1037
In addition, it contains information about the result of the submission:
1039
- complete - True if this submission was successful, rendering this
1040
exercise complete for this user in this worksheet.
1041
- active - True if this submission is "active" (usually true).
1042
Submissions may be de-activated by privileged users for
1043
special reasons, and then they won't count (either as a
1044
penalty or success), but will still be stored.
555
1047
__storm_table__ = "exercise_attempt"
556
1048
__storm_primary__ = "ws_ex_id", "user_id", "date"
576
1073
function = Unicode()
577
1074
stdin = Unicode()
578
1075
exercise = Reference(exercise_id, Exercise.id)
579
test_cases = ReferenceSet(suiteid, 'TestCase.suiteid')
580
variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid')
1076
test_cases = ReferenceSet(suiteid, 'TestCase.suiteid', order_by="seq_no")
1077
variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid', order_by='arg_no')
1080
"""Delete this suite, without asking questions."""
1081
for variable in self.variables:
1083
for test_case in self.test_cases:
1085
Store.of(self).remove(self)
582
1087
class TestCase(Storm):
583
"""A TestCase is a member of a TestSuite.
585
It contains the data necessary to check if an exercise is correct"""
1088
"""A container for actual tests (see TestCasePart), inside a test suite.
1090
It is the lowest level shown to students on their pass/fail status."""
586
1092
__storm_table__ = "test_case"
587
1093
__storm_primary__ = "testid", "suiteid"
591
1097
suite = Reference(suiteid, "TestSuite.suiteid")
592
1098
passmsg = Unicode()
593
1099
failmsg = Unicode()
594
test_default = Unicode()
1100
test_default = Unicode() # Currently unused - only used for file matching.
597
1103
parts = ReferenceSet(testid, "TestCasePart.testid")
599
1105
__init__ = _kwarg_init
1108
for part in self.parts:
1110
Store.of(self).remove(self)
601
1112
class TestSuiteVar(Storm):
602
"""A container for the arguments of a Test Suite"""
1113
"""A variable used by an exercise test suite.
1115
This may represent a function argument or a normal variable.
603
1118
__storm_table__ = "suite_variable"
604
1119
__storm_primary__ = "varid"
608
1123
var_name = Unicode()
609
1124
var_value = Unicode()
610
1125
var_type = Unicode()
613
1128
suite = Reference(suiteid, "TestSuite.suiteid")
615
1130
__init__ = _kwarg_init
1133
Store.of(self).remove(self)
617
1135
class TestCasePart(Storm):
618
"""A container for the test elements of a Test Case"""
1136
"""An actual piece of code to test an exercise solution."""
619
1138
__storm_table__ = "test_case_part"
620
1139
__storm_primary__ = "partid"
625
1144
part_type = Unicode()
626
1145
test_type = Unicode()
627
1146
data = Unicode()
628
1147
filename = Unicode()
630
1149
test = Reference(testid, "TestCase.testid")
632
1151
__init__ = _kwarg_init
1154
Store.of(self).remove(self)