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.
56
return "postgres://%s:%s@%s:%d/%s" % (ivle.conf.db_user,
57
ivle.conf.db_password, ivle.conf.db_host, ivle.conf.db_port,
62
Open a database connection and transaction. Return a storm.store.Store
63
instance connected to the configured IVLE database.
65
return Store(create_database(get_conn_string()))
53
def get_conn_string(config):
54
"""Create a Storm connection string to the IVLE database
56
@param config: The IVLE configuration.
60
if config['database']['username']:
61
clusterstr += config['database']['username']
62
if config['database']['password']:
63
clusterstr += ':' + config['database']['password']
66
host = config['database']['host'] or 'localhost'
67
port = config['database']['port'] or 5432
69
clusterstr += '%s:%d' % (host, port)
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)))
71
Represents an IVLE user.
83
"""An IVLE user account."""
73
84
__storm_table__ = "login"
75
86
id = Int(primary=True, name="loginid")
77
88
passhash = Unicode()
82
93
pass_exp = DateTime()
188
197
'''A sanely ordered list of all of the user's enrolments.'''
189
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)
192
221
def hash_password(password):
193
return md5.md5(password).hexdigest()
222
"""Hash a password with MD5."""
223
return hashlib.md5(password).hexdigest()
196
226
def get_by_login(cls, store, login):
198
Get the User from the db associated with a given store and
227
"""Find a user in a store by login name."""
201
228
return store.find(cls, cls.login == unicode(login)).one()
203
230
def get_permissions(self, user):
204
if user and user.rolenm == 'admin' or user is self:
205
return set(['view', 'edit'])
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'])
209
241
# SUBJECTS AND ENROLMENTS #
211
243
class Subject(Storm):
244
"""A subject (or course) which is run in some semesters."""
212
246
__storm_table__ = "subject"
214
248
id = Int(primary=True, name="subjectid")
215
249
code = Unicode(name="subj_code")
216
250
name = Unicode(name="subj_name")
217
251
short_name = Unicode(name="subj_short_name")
220
253
offerings = ReferenceSet(id, 'Offering.subject_id')
225
258
return "<%s '%s'>" % (type(self).__name__, self.short_name)
227
260
def get_permissions(self, user):
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.
229
267
if user is not None:
230
268
perms.add('view')
231
if user.rolenm == 'admin':
232
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()
235
293
class Semester(Storm):
294
"""A semester in which subjects can be run."""
236
296
__storm_table__ = "semester"
238
298
id = Int(primary=True, name="semesterid")
240
300
semester = Unicode()
243
303
offerings = ReferenceSet(id, 'Offering.semester_id')
304
enrolments = ReferenceSet(id,
305
'Offering.semester_id',
307
'Enrolment.offering_id')
245
309
__init__ = _kwarg_init
272
347
return "<%s %r in %r>" % (type(self).__name__, self.subject,
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)
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)
287
374
def get_permissions(self, user):
289
376
if user is not None:
291
if user.rolenm == 'admin':
377
enrolment = self.get_enrolment(user)
378
if enrolment or user.admin:
380
if (enrolment and enrolment.role in (u'tutor', u'lecturer')) \
292
382
perms.add('edit')
383
# XXX Bug #493945 -- should tutors have these permissions?
384
# Potentially move into the next category (lecturer & admin)
385
perms.add('enrol') # Can see enrolment screen at all
386
perms.add('enrol_student') # Can enrol students
387
if (enrolment and enrolment.role in (u'lecturer')) or user.admin:
388
perms.add('enrol_tutor') # Can enrol tutors
390
perms.add('enrol_lecturer') # Can enrol lecturers
393
def get_enrolment(self, user):
394
"""Find the user's enrolment in this offering."""
396
enrolment = self.enrolments.find(user=user).one()
402
def get_members_by_role(self, role):
403
return Store.of(self).find(User,
404
Enrolment.user_id == User.id,
405
Enrolment.offering_id == self.id,
406
Enrolment.role == role
407
).order_by(User.login)
411
return self.get_members_by_role(u'student')
413
def get_open_projects_for_user(self, user):
414
"""Find all projects currently open to submissions by a user."""
415
# XXX: Respect extensions.
416
return self.projects.find(Project.deadline > datetime.datetime.now())
295
418
class Enrolment(Storm):
419
"""An enrolment of a user in an offering.
421
This represents the roles of both staff and students.
296
424
__storm_table__ = "enrolment"
297
425
__storm_primary__ = "user_id", "offering_id"
339
471
return "<%s %d in %r>" % (type(self).__name__, self.id,
474
def get_permissions(self, user):
475
return self.offering.get_permissions(user)
477
def get_groups_for_user(self, user):
478
"""List all groups in this offering of which the user is a member."""
480
return Store.of(self).find(
482
ProjectGroupMembership.user_id == user.id,
483
ProjectGroupMembership.project_group_id == ProjectGroup.id,
484
ProjectGroup.project_set_id == self.id)
486
def get_submission_principal(self, user):
487
"""Get the principal on behalf of which the user can submit.
489
If this is a solo project set, the given user is returned. If
490
the user is a member of exactly one group, all the group is
491
returned. Otherwise, None is returned.
494
groups = self.get_groups_for_user(user)
495
if groups.count() == 1:
504
return self.max_students_per_group is not None
508
"""Get the entities (groups or users) assigned to submit this project.
510
This will be a Storm ResultSet.
512
#If its a solo project, return everyone in offering
514
return self.project_groups
516
return self.offering.students
342
518
class Project(Storm):
519
"""A student project for which submissions can be made."""
343
521
__storm_table__ = "project"
345
523
id = Int(name="projectid", primary=True)
525
short_name = Unicode()
346
526
synopsis = Unicode()
348
528
project_set_id = Int(name="projectsetid")
349
529
project_set = Reference(project_set_id, ProjectSet.id)
350
530
deadline = DateTime()
532
assesseds = ReferenceSet(id, 'Assessed.project_id')
533
submissions = ReferenceSet(id,
534
'Assessed.project_id',
536
'ProjectSubmission.assessed_id')
352
538
__init__ = _kwarg_init
354
540
def __repr__(self):
355
return "<%s '%s' in %r>" % (type(self).__name__, self.synopsis,
541
return "<%s '%s' in %r>" % (type(self).__name__, self.short_name,
356
542
self.project_set.offering)
544
def can_submit(self, principal):
545
return (self in principal.get_projects() and
546
self.deadline > datetime.datetime.now())
548
def submit(self, principal, path, revision, who):
549
"""Submit a Subversion path and revision to a project.
551
@param principal: The owner of the Subversion repository, and the
552
entity on behalf of whom the submission is being made
553
@param path: A path within that repository to submit.
554
@param revision: The revision of that path to submit.
555
@param who: The user who is actually making the submission.
558
if not self.can_submit(principal):
559
raise Exception('cannot submit')
561
a = Assessed.get(Store.of(self), principal, self)
562
ps = ProjectSubmission()
564
ps.revision = revision
565
ps.date_submitted = datetime.datetime.now()
571
def get_permissions(self, user):
572
return self.project_set.offering.get_permissions(user)
575
def latest_submissions(self):
576
"""Return the latest submission for each Assessed."""
577
return Store.of(self).find(ProjectSubmission,
578
Assessed.project_id == self.id,
579
ProjectSubmission.assessed_id == Assessed.id,
580
ProjectSubmission.date_submitted == Select(
581
Max(ProjectSubmission.date_submitted),
582
ProjectSubmission.assessed_id == Assessed.id,
583
tables=ProjectSubmission
587
def has_deadline_passed(self, user):
588
"""Check whether the deadline has passed."""
589
# XXX: Need to respect extensions.
590
return self.deadline < datetime.datetime.now()
592
def get_submissions_for_principal(self, principal):
593
"""Fetch a ResultSet of all submissions by a particular principal."""
594
assessed = Assessed.get(Store.of(self), principal, self)
597
return assessed.submissions
358
601
class ProjectGroup(Storm):
602
"""A group of students working together on a project."""
359
604
__storm_table__ = "project_group"
361
606
id = Int(name="groupid", primary=True)
378
623
return "<%s %s in %r>" % (type(self).__name__, self.name,
379
624
self.project_set.offering)
627
def display_name(self):
628
"""Returns the "nice name" of the user or group."""
632
def short_name(self):
633
"""Returns the database "identifier" name of the user or group."""
636
def get_projects(self, offering=None, active_only=True):
637
'''Find projects that the group can submit.
639
This will include projects in the project set which owns this group,
640
unless the project set disallows groups (in which case none will be
643
@param active_only: Whether to only search active offerings.
644
@param offering: An optional offering to restrict the search to.
646
return Store.of(self).find(Project,
647
Project.project_set_id == ProjectSet.id,
648
ProjectSet.id == self.project_set.id,
649
ProjectSet.max_students_per_group != None,
650
ProjectSet.offering_id == Offering.id,
651
(offering is None) or (Offering.id == offering.id),
652
Semester.id == Offering.semester_id,
653
(not active_only) or (Semester.state == u'current'))
656
def get_permissions(self, user):
657
if user.admin or user in self.members:
658
return set(['submit_project'])
381
662
class ProjectGroupMembership(Storm):
663
"""A student's membership in a project group."""
382
665
__storm_table__ = "group_member"
383
666
__storm_primary__ = "user_id", "project_group_id"
393
676
return "<%s %r in %r>" % (type(self).__name__, self.user,
394
677
self.project_group)
679
class Assessed(Storm):
680
"""A composite of a user or group combined with a project.
682
Each project submission and extension refers to an Assessed. It is the
683
sole specifier of the repository and project.
686
__storm_table__ = "assessed"
688
id = Int(name="assessedid", primary=True)
689
user_id = Int(name="loginid")
690
user = Reference(user_id, User.id)
691
project_group_id = Int(name="groupid")
692
project_group = Reference(project_group_id, ProjectGroup.id)
694
project_id = Int(name="projectid")
695
project = Reference(project_id, Project.id)
697
extensions = ReferenceSet(id, 'ProjectExtension.assessed_id')
698
submissions = ReferenceSet(
699
id, 'ProjectSubmission.assessed_id', order_by='date_submitted')
702
return "<%s %r in %r>" % (type(self).__name__,
703
self.user or self.project_group, self.project)
707
"""True if the Assessed is a group, False if it is a user."""
708
return self.project_group is not None
712
return self.project_group or self.user
715
def get(cls, store, principal, project):
716
"""Find or create an Assessed for the given user or group and project.
718
@param principal: The user or group.
719
@param project: The project.
722
if t not in (User, ProjectGroup):
723
raise AssertionError('principal must be User or ProjectGroup')
726
(t is User) or (cls.project_group_id == principal.id),
727
(t is ProjectGroup) or (cls.user_id == principal.id),
728
cls.project_id == project.id).one()
735
a.project_group = principal
742
class ProjectExtension(Storm):
743
"""An extension granted to a user or group on a particular project.
745
The user or group and project are specified by the Assessed.
748
__storm_table__ = "project_extension"
750
id = Int(name="extensionid", primary=True)
751
assessed_id = Int(name="assessedid")
752
assessed = Reference(assessed_id, Assessed.id)
753
deadline = DateTime()
754
approver_id = Int(name="approver")
755
approver = Reference(approver_id, User.id)
758
class ProjectSubmission(Storm):
759
"""A submission from a user or group repository to a particular project.
761
The content of a submission is a single path and revision inside a
762
repository. The repository is that owned by the submission's user and
763
group, while the path and revision are explicit.
765
The user or group and project are specified by the Assessed.
768
__storm_table__ = "project_submission"
770
id = Int(name="submissionid", primary=True)
771
assessed_id = Int(name="assessedid")
772
assessed = Reference(assessed_id, Assessed.id)
775
submitter_id = Int(name="submitter")
776
submitter = Reference(submitter_id, User.id)
777
date_submitted = DateTime()
396
780
# WORKSHEETS AND EXERCISES #
398
782
class Exercise(Storm):
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
783
"""An exercise for students to complete in a worksheet.
785
An exercise may be present in any number of worksheets.
788
__storm_table__ = "exercise"
403
789
id = Unicode(primary=True, name="identifier")
405
791
description = Unicode()
408
794
include = Unicode()
797
worksheet_exercises = ReferenceSet(id,
798
'WorksheetExercise.exercise_id')
411
800
worksheets = ReferenceSet(id,
412
801
'WorksheetExercise.exercise_id',
413
802
'WorksheetExercise.worksheet_id',
417
test_suites = ReferenceSet(id, 'TestSuite.exercise_id')
806
test_suites = ReferenceSet(id,
807
'TestSuite.exercise_id',
419
810
__init__ = _kwarg_init
421
812
def __repr__(self):
422
813
return "<%s %s>" % (type(self).__name__, self.name)
425
# def get_by_name(cls, store, name):
427
# Get the Exercise from the db associated with a given store and name.
428
# If the exercise is not in the database, creates it and inserts it
431
# ex = store.find(cls, cls.name == unicode(name)).one()
434
# ex = Exercise(name=unicode(name))
815
def get_permissions(self, user):
822
elif u'lecturer' in set((e.role for e in user.active_enrolments)):
825
elif u'tutor' in set((e.role for e in user.active_enrolments)):
831
def get_description(self):
832
"""Return the description interpreted as reStructuredText."""
833
return rst(self.description)
836
"""Deletes the exercise, providing it has no associated worksheets."""
837
if (self.worksheet_exercises.count() > 0):
838
raise IntegrityError()
839
for suite in self.test_suites:
841
Store.of(self).remove(self)
439
843
class Worksheet(Storm):
844
"""A worksheet with exercises for students to complete.
846
Worksheets are owned by offerings.
440
849
__storm_table__ = "worksheet"
442
851
id = Int(primary=True, name="worksheetid")
443
# XXX subject is not linked to a Subject object. This is a property of
444
# the database, and will be refactored.
446
852
offering_id = Int(name="offeringid")
447
name = Unicode(name="identifier")
853
identifier = Unicode()
448
855
assessable = Bool()
451
860
attempts = ReferenceSet(id, "ExerciseAttempt.worksheetid")
452
861
offering = Reference(offering_id, 'Offering.id')
454
exercises = ReferenceSet(id,
455
'WorksheetExercise.worksheet_id',
456
'WorksheetExercise.exercise_id',
458
# Use worksheet_exercises to get access to the WorksheetExercise objects
459
# binding worksheets to exercises. This is required to access the
863
all_worksheet_exercises = ReferenceSet(id,
864
'WorksheetExercise.worksheet_id')
866
# Use worksheet_exercises to get access to the *active* WorksheetExercise
867
# objects binding worksheets to exercises. This is required to access the
460
868
# "optional" field.
461
worksheet_exercises = ReferenceSet(id,
462
'WorksheetExercise.worksheet_id')
871
def worksheet_exercises(self):
872
return self.all_worksheet_exercises.find(active=True)
465
874
__init__ = _kwarg_init
467
876
def __repr__(self):
468
877
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()
879
def remove_all_exercises(self):
880
"""Remove all exercises from this worksheet.
482
def remove_all_exercises(self, store):
484
Remove all exercises from this worksheet.
485
882
This does not delete the exercises themselves. It just removes them
486
883
from the worksheet.
885
store = Store.of(self)
886
for ws_ex in self.all_worksheet_exercises:
887
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
888
raise IntegrityError()
488
889
store.find(WorksheetExercise,
489
890
WorksheetExercise.worksheet == self).remove()
491
892
def get_permissions(self, user):
492
893
return self.offering.get_permissions(user)
896
"""Returns the xml of this worksheet, converts from rst if required."""
897
if self.format == u'rst':
898
ws_xml = rst(self.data)
904
"""Deletes the worksheet, provided it has no attempts on any exercises.
906
Returns True if delete succeeded, or False if this worksheet has
907
attempts attached."""
908
for ws_ex in self.all_worksheet_exercises:
909
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
910
raise IntegrityError()
912
self.remove_all_exercises()
913
Store.of(self).remove(self)
494
915
class WorksheetExercise(Storm):
495
__storm_table__ = "worksheet_problem"
496
__storm_primary__ = "worksheet_id", "exercise_id"
916
"""A link between a worksheet and one of its exercises.
918
These may be marked optional, in which case the exercise does not count
919
for marking purposes. The sequence number is used to order the worksheet
923
__storm_table__ = "worksheet_exercise"
925
id = Int(primary=True, name="ws_ex_id")
498
927
worksheet_id = Int(name="worksheetid")
499
928
worksheet = Reference(worksheet_id, Worksheet.id)
500
exercise_id = Unicode(name="problemid")
929
exercise_id = Unicode(name="exerciseid")
501
930
exercise = Reference(exercise_id, Exercise.id)
502
931
optional = Bool()
935
saves = ReferenceSet(id, "ExerciseSave.ws_ex_id")
936
attempts = ReferenceSet(id, "ExerciseAttempt.ws_ex_id")
504
938
__init__ = _kwarg_init
506
940
def __repr__(self):
507
941
return "<%s %s in %s>" % (type(self).__name__, self.exercise.name,
942
self.worksheet.identifier)
944
def get_permissions(self, user):
945
return self.worksheet.get_permissions(user)
510
948
class ExerciseSave(Storm):
512
Represents a potential solution to an exercise that a user has submitted
513
to the server for storage.
514
A basic ExerciseSave is just the current saved text for this exercise for
515
this user (doesn't count towards their attempts).
516
ExerciseSave may be extended with additional semantics (such as
519
__storm_table__ = "problem_save"
520
__storm_primary__ = "exercise_id", "user_id", "date"
522
exercise_id = Unicode(name="problemid")
523
exercise = Reference(exercise_id, Exercise.id)
949
"""A potential exercise solution submitted by a user for storage.
951
This is not an actual tested attempt at an exercise, it's just a save of
955
__storm_table__ = "exercise_save"
956
__storm_primary__ = "ws_ex_id", "user_id"
958
ws_ex_id = Int(name="ws_ex_id")
959
worksheet_exercise = Reference(ws_ex_id, "WorksheetExercise.id")
524
961
user_id = Int(name="loginid")
525
962
user = Reference(user_id, User.id)
526
963
date = DateTime()
529
worksheet = Reference(worksheetid, Worksheet.id)
531
966
__init__ = _kwarg_init
535
970
self.exercise.name, self.user.login, self.date.strftime("%c"))
537
972
class ExerciseAttempt(ExerciseSave):
539
An ExerciseAttempt is a special case of an ExerciseSave. Like an
540
ExerciseSave, it constitutes exercise solution data that the user has
541
submitted to the server for storage.
542
In addition, it contains additional information about the submission.
543
complete - True if this submission was successful, rendering this exercise
544
complete for this user.
545
active - True if this submission is "active" (usually true). Submissions
546
may be de-activated by privileged users for special reasons, and then
547
they won't count (either as a penalty or success), but will still be
550
__storm_table__ = "problem_attempt"
551
__storm_primary__ = "exercise_id", "user_id", "date"
973
"""An attempt at solving an exercise.
975
This is a special case of ExerciseSave, used when the user submits a
976
candidate solution. Like an ExerciseSave, it constitutes exercise solution
979
In addition, it contains information about the result of the submission:
981
- complete - True if this submission was successful, rendering this
982
exercise complete for this user in this worksheet.
983
- active - True if this submission is "active" (usually true).
984
Submissions may be de-activated by privileged users for
985
special reasons, and then they won't count (either as a
986
penalty or success), but will still be stored.
989
__storm_table__ = "exercise_attempt"
990
__storm_primary__ = "ws_ex_id", "user_id", "date"
553
992
# The "text" field is the same but has a different name in the DB table
554
993
# for some reason.
555
994
text = Unicode(name="attempt")
556
995
complete = Bool()
559
998
def get_permissions(self, user):
560
999
return set(['view']) if user is self.user else set()
562
1001
class TestSuite(Storm):
563
"""A Testsuite acts as a container for the test cases of an exercise."""
1002
"""A container to group an exercise's test cases.
1004
The test suite contains some information on how to test. The function to
1005
test, variables to set and stdin data are stored here.
564
1008
__storm_table__ = "test_suite"
565
1009
__storm_primary__ = "exercise_id", "suiteid"
568
exercise_id = Unicode(name="problemid")
1012
exercise_id = Unicode(name="exerciseid")
569
1013
description = Unicode()
571
1015
function = Unicode()
572
1016
stdin = Unicode()
573
1017
exercise = Reference(exercise_id, Exercise.id)
574
test_cases = ReferenceSet(suiteid, 'TestCase.suiteid')
575
variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid')
1018
test_cases = ReferenceSet(suiteid, 'TestCase.suiteid', order_by="seq_no")
1019
variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid', order_by='arg_no')
1022
"""Delete this suite, without asking questions."""
1023
for variable in self.variables:
1025
for test_case in self.test_cases:
1027
Store.of(self).remove(self)
577
1029
class TestCase(Storm):
578
"""A TestCase is a member of a TestSuite.
580
It contains the data necessary to check if an exercise is correct"""
1030
"""A container for actual tests (see TestCasePart), inside a test suite.
1032
It is the lowest level shown to students on their pass/fail status."""
581
1034
__storm_table__ = "test_case"
582
1035
__storm_primary__ = "testid", "suiteid"
586
1039
suite = Reference(suiteid, "TestSuite.suiteid")
587
1040
passmsg = Unicode()
588
1041
failmsg = Unicode()
589
test_default = Unicode()
1042
test_default = Unicode() # Currently unused - only used for file matching.
592
1045
parts = ReferenceSet(testid, "TestCasePart.testid")
594
1047
__init__ = _kwarg_init
1050
for part in self.parts:
1052
Store.of(self).remove(self)
596
1054
class TestSuiteVar(Storm):
597
"""A container for the arguments of a Test Suite"""
598
__storm_table__ = "suite_variables"
1055
"""A variable used by an exercise test suite.
1057
This may represent a function argument or a normal variable.
1060
__storm_table__ = "suite_variable"
599
1061
__storm_primary__ = "varid"
603
1065
var_name = Unicode()
604
1066
var_value = Unicode()
605
1067
var_type = Unicode()
608
1070
suite = Reference(suiteid, "TestSuite.suiteid")
610
1072
__init__ = _kwarg_init
1075
Store.of(self).remove(self)
612
1077
class TestCasePart(Storm):
613
"""A container for the test elements of a Test Case"""
614
__storm_table__ = "test_case_parts"
1078
"""An actual piece of code to test an exercise solution."""
1080
__storm_table__ = "test_case_part"
615
1081
__storm_primary__ = "partid"
620
1086
part_type = Unicode()
621
1087
test_type = Unicode()
622
1088
data = Unicode()
623
1089
filename = Unicode()
625
1091
test = Reference(testid, "TestCase.testid")
627
1093
__init__ = _kwarg_init
1096
Store.of(self).remove(self)
added
removed
ivle/database.py
