~azzar1/unity/add-show-desktop-key
» Revision
1294.3.3
(compared to revision 1120)
: ivle/database.py
« back to all changes in this revision
Viewing changes to ivle/database.py
- browse files at revision 1294.3.3
- compare with another revision
- download diff
- download tarball
- view history from revision 1294.3.3
- Committer: William Grant
- Date: 2009-08-02 08:43:33 UTC
- mto: (1294.2.118 ui-the-third)
- mto: This revision was merged to the branch mainline in revision 1353.
- Revision ID: grantw@unimelb.edu.au-20090802084333-j733m80q8hkrluaz
req.router -> req.publisher
- files added:
- bin/ivle-fetchsubmissions
- ivle/webapp/admin/templates
- ivle/webapp/publisher
- ivle/webapp/submit
- ivle/worksheet
- files removed:
- ivle/webapp/admin/subject.html
- website
- website/images
- files renamed:
- bin/ivle-makeuser => bin/ivle-adduser
- ivle/conf/mimetypes.py => ivle/mimetypes.py
- ivle/webapp/tutorial/rst.py => ivle/worksheet/rst.py
- ivle/worksheet.py => ivle/worksheet/utils.py
- files modified:
- bin/ivle-addexercise
added
removed
ivle/database.py
17
17
18
18
# Author: Matt Giuca, Will Grant
19
19
20
"""
21
Database Classes and Utilities for Storm ORM
20
"""Database utilities and content classes.
22
21
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.
25
24
"""
26
25
27
import md5
26
import hashlib
28
27
import datetime
29
28
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
32
33
33
import ivle.conf
34
from ivle.worksheet.rst import rst
34
35
35
36
__all__ = ['get_store',
36
37
'User',
37
38
'Subject', 'Semester', 'Offering', 'Enrolment',
38
39
'ProjectSet', 'Project', 'ProjectGroup', 'ProjectGroupMembership',
40
'Assessed', 'ProjectSubmission', 'ProjectExtension',
39
41
'Exercise', 'Worksheet', 'WorksheetExercise',
40
42
'ExerciseSave', 'ExerciseAttempt',
41
43
'TestCase', 'TestSuite', 'TestSuiteVar'
48
50
% (self.__class__.__name__, k))
49
51
setattr(self, k, v)
50
52
51
def get_conn_string():
52
"""
53
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
55
56
@param config: The IVLE configuration.
54
57
"""
55
58
56
59
clusterstr = ''
57
if ivle.conf.db_user:
58
clusterstr += ivle.conf.db_user
59
if ivle.conf.db_password:
60
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']
61
64
clusterstr += '@'
62
65
63
host = ivle.conf.db_host or 'localhost'
64
port = ivle.conf.db_port or 5432
66
host = config['database']['host'] or 'localhost'
67
port = config['database']['port'] or 5432
65
68
66
69
clusterstr += '%s:%d' % (host, port)
67
70
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()))
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)))
76
79
77
80
# USERS #
78
81
79
82
class User(Storm):
80
"""
81
Represents an IVLE user.
82
"""
83
"""An IVLE user account."""
83
84
__storm_table__ = "login"
84
85
85
86
id = Int(primary=True, name="loginid")
115
116
return self.hash_password(password) == self.passhash
116
117
117
118
@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
118
129
def password_expired(self):
119
130
fieldval = self.pass_exp
120
131
return fieldval is not None and datetime.datetime.now() > fieldval
157
168
158
169
# TODO: Invitations should be listed too?
159
170
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
"""
160
175
preds = [
161
176
ProjectGroupMembership.user_id == self.id,
162
177
ProjectGroup.id == ProjectGroupMembership.project_group_id,
182
197
'''A sanely ordered list of all of the user's enrolments.'''
183
198
return self._get_enrolments(False)
184
199
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
185
220
@staticmethod
186
221
def hash_password(password):
187
return md5.md5(password).hexdigest()
222
"""Hash a password with MD5."""
223
return hashlib.md5(password).hexdigest()
188
224
189
225
@classmethod
190
226
def get_by_login(cls, store, login):
191
"""
192
Get the User from the db associated with a given store and
193
login.
194
"""
227
"""Find a user in a store by login name."""
195
228
return store.find(cls, cls.login == unicode(login)).one()
196
229
197
230
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
"""
198
236
if user and user.admin or user is self:
199
return set(['view', 'edit'])
237
return set(['view', 'edit', 'submit_project'])
200
238
else:
201
239
return set()
202
240
203
241
# SUBJECTS AND ENROLMENTS #
204
242
205
243
class Subject(Storm):
244
"""A subject (or course) which is run in some semesters."""
245
206
246
__storm_table__ = "subject"
207
247
208
248
id = Int(primary=True, name="subjectid")
219
259
return "<%s '%s'>" % (type(self).__name__, self.short_name)
220
260
221
261
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
"""
222
267
perms = set()
223
268
if user is not None:
224
269
perms.add('view')
226
271
perms.add('edit')
227
272
return perms
228
273
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
229
294
class Semester(Storm):
295
"""A semester in which subjects can be run."""
296
230
297
__storm_table__ = "semester"
231
298
232
299
id = Int(primary=True, name="semesterid")
235
302
state = Unicode()
236
303
237
304
offerings = ReferenceSet(id, 'Offering.semester_id')
305
enrolments = ReferenceSet(id,
306
'Offering.semester_id',
307
'Offering.id',
308
'Enrolment.offering_id')
238
309
239
310
__init__ = _kwarg_init
240
311
242
313
return "<%s %s/%s>" % (type(self).__name__, self.year, self.semester)
243
314
244
315
class Offering(Storm):
316
"""An offering of a subject in a particular semester."""
317
245
318
__storm_table__ = "offering"
246
319
247
320
id = Int(primary=True, name="offeringid")
260
333
261
334
worksheets = ReferenceSet(id,
262
335
'Worksheet.offering_id',
263
order_by="Worksheet.seq_no"
336
order_by="seq_no"
264
337
)
265
338
266
339
__init__ = _kwarg_init
270
343
self.semester)
271
344
272
345
def enrol(self, user, role=u'student'):
273
'''Enrol a user in this offering.'''
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
"""
274
351
enrolment = Store.of(self).find(Enrolment,
275
352
Enrolment.user_id == user.id,
276
353
Enrolment.offering_id == self.id).one()
282
359
enrolment.active = True
283
360
enrolment.role = role
284
361
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
285
369
def get_permissions(self, user):
286
370
perms = set()
287
371
if user is not None:
288
perms.add('view')
289
if user.admin:
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:
290
377
perms.add('edit')
291
378
return perms
292
379
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
293
400
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
294
406
__storm_table__ = "enrolment"
295
407
__storm_primary__ = "user_id", "offering_id"
296
408
319
431
# PROJECTS #
320
432
321
433
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
322
440
__storm_table__ = "project_set"
323
441
324
442
id = Int(name="projectsetid", primary=True)
335
453
return "<%s %d in %r>" % (type(self).__name__, self.id,
336
454
self.offering)
337
455
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
338
471
class Project(Storm):
472
"""A student project for which submissions can be made."""
473
339
474
__storm_table__ = "project"
340
475
341
476
id = Int(name="projectid", primary=True)
477
name = Unicode()
478
short_name = Unicode()
342
479
synopsis = Unicode()
343
480
url = Unicode()
344
481
project_set_id = Int(name="projectsetid")
345
482
project_set = Reference(project_set_id, ProjectSet.id)
346
483
deadline = DateTime()
347
484
485
assesseds = ReferenceSet(id, 'Assessed.project_id')
486
submissions = ReferenceSet(id,
487
'Assessed.project_id',
488
'Assessed.id',
489
'ProjectSubmission.assessed_id')
490
348
491
__init__ = _kwarg_init
349
492
350
493
def __repr__(self):
351
return "<%s '%s' in %r>" % (type(self).__name__, self.synopsis,
494
return "<%s '%s' in %r>" % (type(self).__name__, self.short_name,
352
495
self.project_set.offering)
353
496
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
354
541
class ProjectGroup(Storm):
542
"""A group of students working together on a project."""
543
355
544
__storm_table__ = "project_group"
356
545
357
546
id = Int(name="groupid", primary=True)
374
563
return "<%s %s in %r>" % (type(self).__name__, self.name,
375
564
self.project_set.offering)
376
565
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
377
602
class ProjectGroupMembership(Storm):
603
"""A student's membership in a project group."""
604
378
605
__storm_table__ = "group_member"
379
606
__storm_primary__ = "user_id", "project_group_id"
380
607
389
616
return "<%s %r in %r>" % (type(self).__name__, self.user,
390
617
self.project_group)
391
618
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
392
719
# WORKSHEETS AND EXERCISES #
393
720
394
721
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
395
727
__storm_table__ = "exercise"
396
728
id = Unicode(primary=True, name="identifier")
397
729
name = Unicode()
401
733
include = Unicode()
402
734
num_rows = Int()
403
735
736
worksheet_exercises = ReferenceSet(id,
737
'WorksheetExercise.exercise_id')
738
404
739
worksheets = ReferenceSet(id,
405
740
'WorksheetExercise.exercise_id',
406
741
'WorksheetExercise.worksheet_id',
407
742
'Worksheet.id'
408
743
)
409
410
test_suites = ReferenceSet(id, 'TestSuite.exercise_id')
744
745
test_suites = ReferenceSet(id,
746
'TestSuite.exercise_id',
747
order_by='seq_no')
411
748
412
749
__init__ = _kwarg_init
413
750
416
753
417
754
def get_permissions(self, user):
418
755
perms = set()
756
roles = set()
419
757
if user is not None:
420
758
if user.admin:
421
759
perms.add('edit')
422
760
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
423
768
return perms
424
769
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
425
782
class Worksheet(Storm):
783
"""A worksheet with exercises for students to complete.
784
785
Worksheets are owned by offerings.
786
"""
787
426
788
__storm_table__ = "worksheet"
427
789
428
790
id = Int(primary=True, name="worksheetid")
443
805
# Use worksheet_exercises to get access to the *active* WorksheetExercise
444
806
# objects binding worksheets to exercises. This is required to access the
445
807
# "optional" field.
808
446
809
@property
447
810
def worksheet_exercises(self):
448
811
return self.all_worksheet_exercises.find(active=True)
452
815
def __repr__(self):
453
816
return "<%s %s>" % (type(self).__name__, self.name)
454
817
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.
458
@classmethod
459
def get_by_name(cls, store, subjectname, worksheetname):
460
"""
461
Get the Worksheet from the db associated with a given store, subject
462
name and worksheet name.
463
"""
464
return store.find(cls, cls.subject == unicode(subjectname),
465
cls.name == unicode(worksheetname)).one()
818
def remove_all_exercises(self):
819
"""Remove all exercises from this worksheet.
466
820
467
def remove_all_exercises(self, store):
468
"""
469
Remove all exercises from this worksheet.
470
821
This does not delete the exercises themselves. It just removes them
471
822
from the worksheet.
472
823
"""
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()
473
828
store.find(WorksheetExercise,
474
829
WorksheetExercise.worksheet == self).remove()
475
830
476
831
def get_permissions(self, user):
477
832
return self.offering.get_permissions(user)
478
833
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
479
854
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
480
862
__storm_table__ = "worksheet_exercise"
481
863
482
864
id = Int(primary=True, name="ws_ex_id")
483
865
484
866
worksheet_id = Int(name="worksheetid")
488
870
optional = Bool()
489
871
active = Bool()
490
872
seq_no = Int()
491
873
492
874
saves = ReferenceSet(id, "ExerciseSave.ws_ex_id")
493
875
attempts = ReferenceSet(id, "ExerciseAttempt.ws_ex_id")
494
876
498
880
return "<%s %s in %s>" % (type(self).__name__, self.exercise.name,
499
881
self.worksheet.identifier)
500
882
883
def get_permissions(self, user):
884
return self.worksheet.get_permissions(user)
885
886
501
887
class ExerciseSave(Storm):
502
"""
503
Represents a potential solution to an exercise that a user has submitted
504
to the server for storage.
505
A basic ExerciseSave is just the current saved text for this exercise for
506
this user (doesn't count towards their attempts).
507
ExerciseSave may be extended with additional semantics (such as
508
ExerciseAttempt).
509
"""
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
510
894
__storm_table__ = "exercise_save"
511
895
__storm_primary__ = "ws_ex_id", "user_id"
512
896
525
909
self.exercise.name, self.user.login, self.date.strftime("%c"))
526
910
527
911
class ExerciseAttempt(ExerciseSave):
528
"""
529
An ExerciseAttempt is a special case of an ExerciseSave. Like an
530
ExerciseSave, it constitutes exercise solution data that the user has
531
submitted to the server for storage.
532
In addition, it contains additional information about the submission.
533
complete - True if this submission was successful, rendering this exercise
534
complete for this user.
535
active - True if this submission is "active" (usually true). Submissions
536
may be de-activated by privileged users for special reasons, and then
537
they won't count (either as a penalty or success), but will still be
538
stored.
539
"""
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
540
928
__storm_table__ = "exercise_attempt"
541
929
__storm_primary__ = "ws_ex_id", "user_id", "date"
542
930
545
933
text = Unicode(name="attempt")
546
934
complete = Bool()
547
935
active = Bool()
548
936
549
937
def get_permissions(self, user):
550
938
return set(['view']) if user is self.user else set()
551
939
552
940
class TestSuite(Storm):
553
"""A Testsuite acts as a container for the test cases of an exercise."""
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
554
947
__storm_table__ = "test_suite"
555
948
__storm_primary__ = "exercise_id", "suiteid"
556
949
557
950
suiteid = Int()
558
951
exercise_id = Unicode(name="exerciseid")
559
952
description = Unicode()
561
954
function = Unicode()
562
955
stdin = Unicode()
563
956
exercise = Reference(exercise_id, Exercise.id)
564
test_cases = ReferenceSet(suiteid, 'TestCase.suiteid')
565
variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid')
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)
566
967
567
968
class TestCase(Storm):
568
"""A TestCase is a member of a TestSuite.
569
570
It contains the data necessary to check if an exercise is correct"""
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
571
973
__storm_table__ = "test_case"
572
974
__storm_primary__ = "testid", "suiteid"
573
975
574
976
testid = Int()
575
977
suiteid = Int()
576
978
suite = Reference(suiteid, "TestSuite.suiteid")
578
980
failmsg = Unicode()
579
981
test_default = Unicode()
580
982
seq_no = Int()
581
983
582
984
parts = ReferenceSet(testid, "TestCasePart.testid")
583
985
584
986
__init__ = _kwarg_init
585
987
988
def delete(self):
989
for part in self.parts:
990
part.delete()
991
Store.of(self).remove(self)
992
586
993
class TestSuiteVar(Storm):
587
"""A container for the arguments of a Test Suite"""
994
"""A variable used by an exercise test suite.
995
996
This may represent a function argument or a normal variable.
997
"""
998
588
999
__storm_table__ = "suite_variable"
589
1000
__storm_primary__ = "varid"
590
1001
591
1002
varid = Int()
592
1003
suiteid = Int()
593
1004
var_name = Unicode()
594
1005
var_value = Unicode()
595
1006
var_type = Unicode()
596
1007
arg_no = Int()
597
1008
598
1009
suite = Reference(suiteid, "TestSuite.suiteid")
599
1010
600
1011
__init__ = _kwarg_init
601
1012
1013
def delete(self):
1014
Store.of(self).remove(self)
1015
602
1016
class TestCasePart(Storm):
603
"""A container for the test elements of a Test Case"""
1017
"""An actual piece of code to test an exercise solution."""
1018
604
1019
__storm_table__ = "test_case_part"
605
1020
__storm_primary__ = "partid"
606
1021
607
1022
partid = Int()
608
1023
testid = Int()
609
1024
610
1025
part_type = Unicode()
611
1026
test_type = Unicode()
612
1027
data = Unicode()
613
1028
filename = Unicode()
614
1029
615
1030
test = Reference(testid, "TestCase.testid")
616
1031
617
1032
__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