« back to all changes in this revision
Viewing changes to ivle/database.py
- browse files at revision 1127
- compare with another revision
- download diff
- download tarball
- view history from revision 1127
- Committer: William Grant
- Date: 2009-02-26 02:08:28 UTC
- Revision ID: grantw@unimelb.edu.au-20090226020828-0qrhe3llq9r5olmr
ivle-showenrolment: Swap year and semester, and show the role.
- files added:
- ivle/webapp/admin/subject.html
- website
- website/images
- files removed:
- bin/ivle-fetchsubmissions
- ivle/webapp/admin/templates
- ivle/webapp/submit
- ivle/worksheet
- files renamed:
- ivle/mimetypes.py => ivle/conf/mimetypes.py
- ivle/worksheet/rst.py => ivle/webapp/tutorial/rst.py
- ivle/worksheet/utils.py => ivle/worksheet.py
- files modified:
- bin/ivle-addexercise
added
removed
ivle/database.py
17
17
18
18
# Author: Matt Giuca, Will Grant
19
19
20
"""Database utilities and content classes.
20
"""
21
Database Classes and Utilities for Storm ORM
21
22
22
23
This module provides all of the classes which map to database tables.
23
24
It also provides miscellaneous utility functions for database interaction.
24
25
"""
25
26
26
import hashlib
27
import md5
27
28
import datetime
28
29
29
30
from storm.locals import create_database, Store, Int, Unicode, DateTime, \
30
31
Reference, ReferenceSet, Bool, Storm, Desc
31
from storm.expr import Select, Max
32
from storm.exceptions import NotOneError, IntegrityError
33
32
34
from ivle.worksheet.rst import rst
33
import ivle.conf
35
34
36
35
__all__ = ['get_store',
37
36
'User',
38
37
'Subject', 'Semester', 'Offering', 'Enrolment',
39
38
'ProjectSet', 'Project', 'ProjectGroup', 'ProjectGroupMembership',
40
'Assessed', 'ProjectSubmission', 'ProjectExtension',
41
39
'Exercise', 'Worksheet', 'WorksheetExercise',
42
40
'ExerciseSave', 'ExerciseAttempt',
43
41
'TestCase', 'TestSuite', 'TestSuiteVar'
50
48
% (self.__class__.__name__, k))
51
49
setattr(self, k, v)
52
50
53
def get_conn_string(config):
54
"""Create a Storm connection string to the IVLE database
55
56
@param config: The IVLE configuration.
51
def get_conn_string():
52
"""
53
Returns the Storm connection string, generated from the conf file.
57
54
"""
58
55
59
56
clusterstr = ''
60
if config['database']['username']:
61
clusterstr += config['database']['username']
62
if config['database']['password']:
63
clusterstr += ':' + config['database']['password']
57
if ivle.conf.db_user:
58
clusterstr += ivle.conf.db_user
59
if ivle.conf.db_password:
60
clusterstr += ':' + ivle.conf.db_password
64
61
clusterstr += '@'
65
62
66
host = config['database']['host'] or 'localhost'
67
port = config['database']['port'] or 5432
63
host = ivle.conf.db_host or 'localhost'
64
port = ivle.conf.db_port or 5432
68
65
69
66
clusterstr += '%s:%d' % (host, port)
70
67
71
return "postgres://%s/%s" % (clusterstr, config['database']['name'])
72
73
def get_store(config):
74
"""Create a Storm store connected to the IVLE database.
75
76
@param config: The IVLE configuration.
77
"""
78
return Store(create_database(get_conn_string(config)))
68
return "postgres://%s/%s" % (clusterstr, ivle.conf.db_dbname)
69
70
def get_store():
71
"""
72
Open a database connection and transaction. Return a storm.store.Store
73
instance connected to the configured IVLE database.
74
"""
75
return Store(create_database(get_conn_string()))
79
76
80
77
# USERS #
81
78
82
79
class User(Storm):
83
"""An IVLE user account."""
80
"""
81
Represents an IVLE user.
82
"""
84
83
__storm_table__ = "login"
85
84
86
85
id = Int(primary=True, name="loginid")
116
115
return self.hash_password(password) == self.passhash
117
116
118
117
@property
119
def display_name(self):
120
"""Returns the "nice name" of the user or group."""
121
return self.fullname
122
123
@property
124
def short_name(self):
125
"""Returns the database "identifier" name of the user or group."""
126
return self.login
127
128
@property
129
118
def password_expired(self):
130
119
fieldval = self.pass_exp
131
120
return fieldval is not None and datetime.datetime.now() > fieldval
168
157
169
158
# TODO: Invitations should be listed too?
170
159
def get_groups(self, offering=None):
171
"""Get groups of which this user is a member.
172
173
@param offering: An optional offering to restrict the search to.
174
"""
175
160
preds = [
176
161
ProjectGroupMembership.user_id == self.id,
177
162
ProjectGroup.id == ProjectGroupMembership.project_group_id,
197
182
'''A sanely ordered list of all of the user's enrolments.'''
198
183
return self._get_enrolments(False)
199
184
200
def get_projects(self, offering=None, active_only=True):
201
"""Find projects that the user can submit.
202
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).
206
207
@param active_only: Whether to only search active offerings.
208
@param offering: An optional offering to restrict the search to.
209
"""
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)
219
220
185
@staticmethod
221
186
def hash_password(password):
222
"""Hash a password with MD5."""
223
return hashlib.md5(password).hexdigest()
187
return md5.md5(password).hexdigest()
224
188
225
189
@classmethod
226
190
def get_by_login(cls, store, login):
227
"""Find a user in a store by login name."""
191
"""
192
Get the User from the db associated with a given store and
193
login.
194
"""
228
195
return store.find(cls, cls.login == unicode(login)).one()
229
196
230
197
def get_permissions(self, user):
231
"""Determine privileges held by a user over this object.
232
233
If the user requesting privileges is this user or an admin,
234
they may do everything. Otherwise they may do nothing.
235
"""
236
198
if user and user.admin or user is self:
237
return set(['view', 'edit', 'submit_project'])
199
return set(['view', 'edit'])
238
200
else:
239
201
return set()
240
202
241
203
# SUBJECTS AND ENROLMENTS #
242
204
243
205
class Subject(Storm):
244
"""A subject (or course) which is run in some semesters."""
245
246
206
__storm_table__ = "subject"
247
207
248
208
id = Int(primary=True, name="subjectid")
259
219
return "<%s '%s'>" % (type(self).__name__, self.short_name)
260
220
261
221
def get_permissions(self, user):
262
"""Determine privileges held by a user over this object.
263
264
If the user requesting privileges is an admin, they may edit.
265
Otherwise they may only read.
266
"""
267
222
perms = set()
268
223
if user is not None:
269
224
perms.add('view')
271
226
perms.add('edit')
272
227
return perms
273
228
274
def active_offerings(self):
275
"""Find active offerings for this subject.
276
277
Return a sequence of currently active offerings for this subject
278
(offerings whose semester.state is "current"). There should be 0 or 1
279
elements in this sequence, but it's possible there are more.
280
"""
281
return self.offerings.find(Offering.semester_id == Semester.id,
282
Semester.state == u'current')
283
284
def offering_for_semester(self, year, semester):
285
"""Get the offering for the given year/semester, or None.
286
287
@param year: A string representation of the year.
288
@param semester: A string representation of the semester.
289
"""
290
return self.offerings.find(Offering.semester_id == Semester.id,
291
Semester.year == unicode(year),
292
Semester.semester == unicode(semester)).one()
293
294
229
class Semester(Storm):
295
"""A semester in which subjects can be run."""
296
297
230
__storm_table__ = "semester"
298
231
299
232
id = Int(primary=True, name="semesterid")
313
246
return "<%s %s/%s>" % (type(self).__name__, self.year, self.semester)
314
247
315
248
class Offering(Storm):
316
"""An offering of a subject in a particular semester."""
317
318
249
__storm_table__ = "offering"
319
250
320
251
id = Int(primary=True, name="offeringid")
333
264
334
265
worksheets = ReferenceSet(id,
335
266
'Worksheet.offering_id',
336
order_by="seq_no"
267
order_by="Worksheet.seq_no"
337
268
)
338
269
339
270
__init__ = _kwarg_init
343
274
self.semester)
344
275
345
276
def enrol(self, user, role=u'student'):
346
"""Enrol a user in this offering.
347
348
Enrolments handle both the staff and student cases. The role controls
349
the privileges granted by this enrolment.
350
"""
277
'''Enrol a user in this offering.'''
351
278
enrolment = Store.of(self).find(Enrolment,
352
279
Enrolment.user_id == user.id,
353
280
Enrolment.offering_id == self.id).one()
359
286
enrolment.active = True
360
287
enrolment.role = role
361
288
362
def unenrol(self, user):
363
'''Unenrol a user from this offering.'''
364
enrolment = Store.of(self).find(Enrolment,
365
Enrolment.user_id == user.id,
366
Enrolment.offering_id == self.id).one()
367
Store.of(enrolment).remove(enrolment)
368
369
289
def get_permissions(self, user):
370
290
perms = set()
371
291
if user is not None:
372
enrolment = self.get_enrolment(user)
373
if enrolment or user.admin:
374
perms.add('view')
375
if (enrolment and enrolment.role in (u'tutor', u'lecturer')) \
376
or user.admin:
292
perms.add('view')
293
if user.admin:
377
294
perms.add('edit')
378
295
return perms
379
296
380
def get_enrolment(self, user):
381
"""Find the user's enrolment in this offering."""
382
try:
383
enrolment = self.enrolments.find(user=user).one()
384
except NotOneError:
385
enrolment = None
386
387
return enrolment
388
389
def get_members_by_role(self, role):
390
return Store.of(self).find(User,
391
Enrolment.user_id == User.id,
392
Enrolment.offering_id == self.id,
393
Enrolment.role == role
394
)
395
396
@property
397
def students(self):
398
return self.get_members_by_role(u'student')
399
400
297
class Enrolment(Storm):
401
"""An enrolment of a user in an offering.
402
403
This represents the roles of both staff and students.
404
"""
405
406
298
__storm_table__ = "enrolment"
407
299
__storm_primary__ = "user_id", "offering_id"
408
300
431
323
# PROJECTS #
432
324
433
325
class ProjectSet(Storm):
434
"""A set of projects that share common groups.
435
436
Each student project group is attached to a project set. The group is
437
valid for all projects in the group's set.
438
"""
439
440
326
__storm_table__ = "project_set"
441
327
442
328
id = Int(name="projectsetid", primary=True)
453
339
return "<%s %d in %r>" % (type(self).__name__, self.id,
454
340
self.offering)
455
341
456
def get_permissions(self, user):
457
return self.offering.get_permissions(user)
458
459
@property
460
def assigned(self):
461
"""Get the entities (groups or users) assigned to submit this project.
462
463
This will be a Storm ResultSet.
464
"""
465
#If its a solo project, return everyone in offering
466
if self.max_students_per_group is None:
467
return self.offering.students
468
else:
469
return self.project_groups
470
471
342
class Project(Storm):
472
"""A student project for which submissions can be made."""
473
474
343
__storm_table__ = "project"
475
344
476
345
id = Int(name="projectid", primary=True)
477
name = Unicode()
478
short_name = Unicode()
479
346
synopsis = Unicode()
480
347
url = Unicode()
481
348
project_set_id = Int(name="projectsetid")
482
349
project_set = Reference(project_set_id, ProjectSet.id)
483
350
deadline = DateTime()
484
351
485
assesseds = ReferenceSet(id, 'Assessed.project_id')
486
submissions = ReferenceSet(id,
487
'Assessed.project_id',
488
'Assessed.id',
489
'ProjectSubmission.assessed_id')
490
491
352
__init__ = _kwarg_init
492
353
493
354
def __repr__(self):
494
return "<%s '%s' in %r>" % (type(self).__name__, self.short_name,
355
return "<%s '%s' in %r>" % (type(self).__name__, self.synopsis,
495
356
self.project_set.offering)
496
357
497
def can_submit(self, principal):
498
return (self in principal.get_projects() and
499
self.deadline > datetime.datetime.now())
500
501
def submit(self, principal, path, revision, who):
502
"""Submit a Subversion path and revision to a project.
503
504
@param principal: The owner of the Subversion repository, and the
505
entity on behalf of whom the submission is being made
506
@param path: A path within that repository to submit.
507
@param revision: The revision of that path to submit.
508
@param who: The user who is actually making the submission.
509
"""
510
511
if not self.can_submit(principal):
512
raise Exception('cannot submit')
513
514
a = Assessed.get(Store.of(self), principal, self)
515
ps = ProjectSubmission()
516
ps.path = path
517
ps.revision = revision
518
ps.date_submitted = datetime.datetime.now()
519
ps.assessed = a
520
ps.submitter = who
521
522
return ps
523
524
def get_permissions(self, user):
525
return self.project_set.offering.get_permissions(user)
526
527
@property
528
def latest_submissions(self):
529
"""Return the latest submission for each Assessed."""
530
return Store.of(self).find(ProjectSubmission,
531
Assessed.project_id == self.id,
532
ProjectSubmission.assessed_id == Assessed.id,
533
ProjectSubmission.date_submitted == Select(
534
Max(ProjectSubmission.date_submitted),
535
ProjectSubmission.assessed_id == Assessed.id,
536
tables=ProjectSubmission
537
)
538
)
539
540
541
358
class ProjectGroup(Storm):
542
"""A group of students working together on a project."""
543
544
359
__storm_table__ = "project_group"
545
360
546
361
id = Int(name="groupid", primary=True)
563
378
return "<%s %s in %r>" % (type(self).__name__, self.name,
564
379
self.project_set.offering)
565
380
566
@property
567
def display_name(self):
568
"""Returns the "nice name" of the user or group."""
569
return self.nick
570
571
@property
572
def short_name(self):
573
"""Returns the database "identifier" name of the user or group."""
574
return self.name
575
576
def get_projects(self, offering=None, active_only=True):
577
'''Find projects that the group can submit.
578
579
This will include projects in the project set which owns this group,
580
unless the project set disallows groups (in which case none will be
581
returned).
582
583
@param active_only: Whether to only search active offerings.
584
@param offering: An optional offering to restrict the search to.
585
'''
586
return Store.of(self).find(Project,
587
Project.project_set_id == ProjectSet.id,
588
ProjectSet.id == self.project_set.id,
589
ProjectSet.max_students_per_group != None,
590
ProjectSet.offering_id == Offering.id,
591
(offering is None) or (Offering.id == offering.id),
592
Semester.id == Offering.semester_id,
593
(not active_only) or (Semester.state == u'current'))
594
595
596
def get_permissions(self, user):
597
if user.admin or user in self.members:
598
return set(['submit_project'])
599
else:
600
return set()
601
602
381
class ProjectGroupMembership(Storm):
603
"""A student's membership in a project group."""
604
605
382
__storm_table__ = "group_member"
606
383
__storm_primary__ = "user_id", "project_group_id"
607
384
616
393
return "<%s %r in %r>" % (type(self).__name__, self.user,
617
394
self.project_group)
618
395
619
class Assessed(Storm):
620
"""A composite of a user or group combined with a project.
621
622
Each project submission and extension refers to an Assessed. It is the
623
sole specifier of the repository and project.
624
"""
625
626
__storm_table__ = "assessed"
627
628
id = Int(name="assessedid", primary=True)
629
user_id = Int(name="loginid")
630
user = Reference(user_id, User.id)
631
project_group_id = Int(name="groupid")
632
project_group = Reference(project_group_id, ProjectGroup.id)
633
634
project_id = Int(name="projectid")
635
project = Reference(project_id, Project.id)
636
637
extensions = ReferenceSet(id, 'ProjectExtension.assessed_id')
638
submissions = ReferenceSet(id, 'ProjectSubmission.assessed_id')
639
640
def __repr__(self):
641
return "<%s %r in %r>" % (type(self).__name__,
642
self.user or self.project_group, self.project)
643
644
@property
645
def is_group(self):
646
"""True if the Assessed is a group, False if it is a user."""
647
return self.project_group is not None
648
649
@property
650
def principal(self):
651
return self.project_group or self.user
652
653
@classmethod
654
def get(cls, store, principal, project):
655
"""Find or create an Assessed for the given user or group and project.
656
657
@param principal: The user or group.
658
@param project: The project.
659
"""
660
t = type(principal)
661
if t not in (User, ProjectGroup):
662
raise AssertionError('principal must be User or ProjectGroup')
663
664
a = store.find(cls,
665
(t is User) or (cls.project_group_id == principal.id),
666
(t is ProjectGroup) or (cls.user_id == principal.id),
667
Project.id == project.id).one()
668
669
if a is None:
670
a = cls()
671
if t is User:
672
a.user = principal
673
else:
674
a.project_group = principal
675
a.project = project
676
store.add(a)
677
678
return a
679
680
681
class ProjectExtension(Storm):
682
"""An extension granted to a user or group on a particular project.
683
684
The user or group and project are specified by the Assessed.
685
"""
686
687
__storm_table__ = "project_extension"
688
689
id = Int(name="extensionid", primary=True)
690
assessed_id = Int(name="assessedid")
691
assessed = Reference(assessed_id, Assessed.id)
692
deadline = DateTime()
693
approver_id = Int(name="approver")
694
approver = Reference(approver_id, User.id)
695
notes = Unicode()
696
697
class ProjectSubmission(Storm):
698
"""A submission from a user or group repository to a particular project.
699
700
The content of a submission is a single path and revision inside a
701
repository. The repository is that owned by the submission's user and
702
group, while the path and revision are explicit.
703
704
The user or group and project are specified by the Assessed.
705
"""
706
707
__storm_table__ = "project_submission"
708
709
id = Int(name="submissionid", primary=True)
710
assessed_id = Int(name="assessedid")
711
assessed = Reference(assessed_id, Assessed.id)
712
path = Unicode()
713
revision = Int()
714
submitter_id = Int(name="submitter")
715
submitter = Reference(submitter_id, User.id)
716
date_submitted = DateTime()
717
718
719
396
# WORKSHEETS AND EXERCISES #
720
397
721
398
class Exercise(Storm):
722
"""An exercise for students to complete in a worksheet.
723
724
An exercise may be present in any number of worksheets.
725
"""
726
727
399
__storm_table__ = "exercise"
728
400
id = Unicode(primary=True, name="identifier")
729
401
name = Unicode()
733
405
include = Unicode()
734
406
num_rows = Int()
735
407
736
worksheet_exercises = ReferenceSet(id,
737
'WorksheetExercise.exercise_id')
738
739
408
worksheets = ReferenceSet(id,
740
409
'WorksheetExercise.exercise_id',
741
410
'WorksheetExercise.worksheet_id',
742
411
'Worksheet.id'
743
412
)
744
745
test_suites = ReferenceSet(id,
746
'TestSuite.exercise_id',
747
order_by='seq_no')
413
414
test_suites = ReferenceSet(id, 'TestSuite.exercise_id')
748
415
749
416
__init__ = _kwarg_init
750
417
753
420
754
421
def get_permissions(self, user):
755
422
perms = set()
756
roles = set()
757
423
if user is not None:
758
424
if user.admin:
759
425
perms.add('edit')
760
426
perms.add('view')
761
elif u'lecturer' in set((e.role for e in user.active_enrolments)):
762
perms.add('edit')
763
perms.add('view')
764
elif u'tutor' in set((e.role for e in user.active_enrolments)):
765
perms.add('edit')
766
perms.add('view')
767
768
427
return perms
769
428
770
def get_description(self):
771
"""Return the description interpreted as reStructuredText."""
772
return rst(self.description)
773
774
def delete(self):
775
"""Deletes the exercise, providing it has no associated worksheets."""
776
if (self.worksheet_exercises.count() > 0):
777
raise IntegrityError()
778
for suite in self.test_suites:
779
suite.delete()
780
Store.of(self).remove(self)
781
782
429
class Worksheet(Storm):
783
"""A worksheet with exercises for students to complete.
784
785
Worksheets are owned by offerings.
786
"""
787
788
430
__storm_table__ = "worksheet"
789
431
790
432
id = Int(primary=True, name="worksheetid")
805
447
# Use worksheet_exercises to get access to the *active* WorksheetExercise
806
448
# objects binding worksheets to exercises. This is required to access the
807
449
# "optional" field.
808
809
450
@property
810
451
def worksheet_exercises(self):
811
452
return self.all_worksheet_exercises.find(active=True)
815
456
def __repr__(self):
816
457
return "<%s %s>" % (type(self).__name__, self.name)
817
458
818
def remove_all_exercises(self):
819
"""Remove all exercises from this worksheet.
459
# XXX Refactor this - make it an instance method of Subject rather than a
460
# class method of Worksheet. Can't do that now because Subject isn't
461
# linked referentially to the Worksheet.
462
@classmethod
463
def get_by_name(cls, store, subjectname, worksheetname):
464
"""
465
Get the Worksheet from the db associated with a given store, subject
466
name and worksheet name.
467
"""
468
return store.find(cls, cls.subject == unicode(subjectname),
469
cls.name == unicode(worksheetname)).one()
820
470
471
def remove_all_exercises(self, store):
472
"""
473
Remove all exercises from this worksheet.
821
474
This does not delete the exercises themselves. It just removes them
822
475
from the worksheet.
823
476
"""
824
store = Store.of(self)
825
for ws_ex in self.all_worksheet_exercises:
826
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
827
raise IntegrityError()
828
477
store.find(WorksheetExercise,
829
478
WorksheetExercise.worksheet == self).remove()
830
479
831
480
def get_permissions(self, user):
832
481
return self.offering.get_permissions(user)
833
482
834
def get_xml(self):
835
"""Returns the xml of this worksheet, converts from rst if required."""
836
if self.format == u'rst':
837
ws_xml = rst(self.data)
838
return ws_xml
839
else:
840
return self.data
841
842
def delete(self):
843
"""Deletes the worksheet, provided it has no attempts on any exercises.
844
845
Returns True if delete succeeded, or False if this worksheet has
846
attempts attached."""
847
for ws_ex in self.all_worksheet_exercises:
848
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
849
raise IntegrityError()
850
851
self.remove_all_exercises()
852
Store.of(self).remove(self)
853
854
483
class WorksheetExercise(Storm):
855
"""A link between a worksheet and one of its exercises.
856
857
These may be marked optional, in which case the exercise does not count
858
for marking purposes. The sequence number is used to order the worksheet
859
ToC.
860
"""
861
862
484
__storm_table__ = "worksheet_exercise"
863
485
864
486
id = Int(primary=True, name="ws_ex_id")
865
487
866
488
worksheet_id = Int(name="worksheetid")
870
492
optional = Bool()
871
493
active = Bool()
872
494
seq_no = Int()
873
495
874
496
saves = ReferenceSet(id, "ExerciseSave.ws_ex_id")
875
497
attempts = ReferenceSet(id, "ExerciseAttempt.ws_ex_id")
876
498
880
502
return "<%s %s in %s>" % (type(self).__name__, self.exercise.name,
881
503
self.worksheet.identifier)
882
504
883
def get_permissions(self, user):
884
return self.worksheet.get_permissions(user)
885
886
887
505
class ExerciseSave(Storm):
888
"""A potential exercise solution submitted by a user for storage.
889
890
This is not an actual tested attempt at an exercise, it's just a save of
891
the editing session.
892
"""
893
506
"""
507
Represents a potential solution to an exercise that a user has submitted
508
to the server for storage.
509
A basic ExerciseSave is just the current saved text for this exercise for
510
this user (doesn't count towards their attempts).
511
ExerciseSave may be extended with additional semantics (such as
512
ExerciseAttempt).
513
"""
894
514
__storm_table__ = "exercise_save"
895
515
__storm_primary__ = "ws_ex_id", "user_id"
896
516
909
529
self.exercise.name, self.user.login, self.date.strftime("%c"))
910
530
911
531
class ExerciseAttempt(ExerciseSave):
912
"""An attempt at solving an exercise.
913
914
This is a special case of ExerciseSave, used when the user submits a
915
candidate solution. Like an ExerciseSave, it constitutes exercise solution
916
data.
917
918
In addition, it contains information about the result of the submission:
919
920
- complete - True if this submission was successful, rendering this
921
exercise complete for this user in this worksheet.
922
- active - True if this submission is "active" (usually true).
923
Submissions may be de-activated by privileged users for
924
special reasons, and then they won't count (either as a
925
penalty or success), but will still be stored.
926
"""
927
532
"""
533
An ExerciseAttempt is a special case of an ExerciseSave. Like an
534
ExerciseSave, it constitutes exercise solution data that the user has
535
submitted to the server for storage.
536
In addition, it contains additional information about the submission.
537
complete - True if this submission was successful, rendering this exercise
538
complete for this user.
539
active - True if this submission is "active" (usually true). Submissions
540
may be de-activated by privileged users for special reasons, and then
541
they won't count (either as a penalty or success), but will still be
542
stored.
543
"""
928
544
__storm_table__ = "exercise_attempt"
929
545
__storm_primary__ = "ws_ex_id", "user_id", "date"
930
546
933
549
text = Unicode(name="attempt")
934
550
complete = Bool()
935
551
active = Bool()
936
552
937
553
def get_permissions(self, user):
938
554
return set(['view']) if user is self.user else set()
939
555
940
556
class TestSuite(Storm):
941
"""A container to group an exercise's test cases.
942
943
The test suite contains some information on how to test. The function to
944
test, variables to set and stdin data are stored here.
945
"""
946
557
"""A Testsuite acts as a container for the test cases of an exercise."""
947
558
__storm_table__ = "test_suite"
948
559
__storm_primary__ = "exercise_id", "suiteid"
949
560
950
561
suiteid = Int()
951
562
exercise_id = Unicode(name="exerciseid")
952
563
description = Unicode()
954
565
function = Unicode()
955
566
stdin = Unicode()
956
567
exercise = Reference(exercise_id, Exercise.id)
957
test_cases = ReferenceSet(suiteid, 'TestCase.suiteid', order_by="seq_no")
958
variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid', order_by='arg_no')
959
960
def delete(self):
961
"""Delete this suite, without asking questions."""
962
for vaariable in self.variables:
963
variable.delete()
964
for test_case in self.test_cases:
965
test_case.delete()
966
Store.of(self).remove(self)
568
test_cases = ReferenceSet(suiteid, 'TestCase.suiteid')
569
variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid')
967
570
968
571
class TestCase(Storm):
969
"""A container for actual tests (see TestCasePart), inside a test suite.
970
971
It is the lowest level shown to students on their pass/fail status."""
972
572
"""A TestCase is a member of a TestSuite.
573
574
It contains the data necessary to check if an exercise is correct"""
973
575
__storm_table__ = "test_case"
974
576
__storm_primary__ = "testid", "suiteid"
975
577
976
578
testid = Int()
977
579
suiteid = Int()
978
580
suite = Reference(suiteid, "TestSuite.suiteid")
980
582
failmsg = Unicode()
981
583
test_default = Unicode()
982
584
seq_no = Int()
983
585
984
586
parts = ReferenceSet(testid, "TestCasePart.testid")
985
587
986
588
__init__ = _kwarg_init
987
589
988
def delete(self):
989
for part in self.parts:
990
part.delete()
991
Store.of(self).remove(self)
992
993
590
class TestSuiteVar(Storm):
994
"""A variable used by an exercise test suite.
995
996
This may represent a function argument or a normal variable.
997
"""
998
591
"""A container for the arguments of a Test Suite"""
999
592
__storm_table__ = "suite_variable"
1000
593
__storm_primary__ = "varid"
1001
594
1002
595
varid = Int()
1003
596
suiteid = Int()
1004
597
var_name = Unicode()
1005
598
var_value = Unicode()
1006
599
var_type = Unicode()
1007
600
arg_no = Int()
1008
601
1009
602
suite = Reference(suiteid, "TestSuite.suiteid")
1010
603
1011
604
__init__ = _kwarg_init
1012
1013
def delete(self):
1014
Store.of(self).remove(self)
1015
605
1016
606
class TestCasePart(Storm):
1017
"""An actual piece of code to test an exercise solution."""
1018
607
"""A container for the test elements of a Test Case"""
1019
608
__storm_table__ = "test_case_part"
1020
609
__storm_primary__ = "partid"
1021
610
1022
611
partid = Int()
1023
612
testid = Int()
1024
613
1025
614
part_type = Unicode()
1026
615
test_type = Unicode()
1027
616
data = Unicode()
1028
617
filename = Unicode()
1029
618
1030
619
test = Reference(testid, "TestCase.testid")
1031
620
1032
621
__init__ = _kwarg_init
1033
1034
def delete(self):
1035
Store.of(self).remove(self)
Loggerhead is a web-based interface for Breezy
Version: 2.0.1