~azzar1/unity/add-show-desktop-key

« back to all changes in this revision

Viewing changes to ivle/database.py

  • Committer: Matt Giuca
  • Date: 2010-02-25 08:36:59 UTC
  • Revision ID: matt.giuca@gmail.com-20100225083659-2s8vdrfhx3bhvcmp
DateTimeValidator: Removed some debugging code. Oops.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
 
28
import os
29
29
 
30
30
from storm.locals import create_database, Store, Int, Unicode, DateTime, \
31
31
                         Reference, ReferenceSet, Bool, Storm, Desc
 
32
from storm.expr import Select, Max
 
33
from storm.exceptions import NotOneError, IntegrityError
32
34
 
33
 
import ivle.conf
34
 
import ivle.caps
 
35
from ivle.worksheet.rst import rst
35
36
 
36
37
__all__ = ['get_store',
37
38
            'User',
38
39
            'Subject', 'Semester', 'Offering', 'Enrolment',
39
40
            'ProjectSet', 'Project', 'ProjectGroup', 'ProjectGroupMembership',
 
41
            'Assessed', 'ProjectSubmission', 'ProjectExtension',
40
42
            'Exercise', 'Worksheet', 'WorksheetExercise',
41
43
            'ExerciseSave', 'ExerciseAttempt',
42
 
            'AlreadyEnrolledError', 'TestCase', 'TestSuite', 'TestSuiteVar'
 
44
            'TestCase', 'TestSuite', 'TestSuiteVar'
43
45
        ]
44
46
 
45
47
def _kwarg_init(self, **kwargs):
49
51
                % (self.__class__.__name__, k))
50
52
        setattr(self, k, v)
51
53
 
52
 
def get_conn_string():
53
 
    """
54
 
    Returns the Storm connection string, generated from the conf file.
55
 
    """
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,
58
 
        ivle.conf.db_dbname)
59
 
 
60
 
def get_store():
61
 
    """
62
 
    Open a database connection and transaction. Return a storm.store.Store
63
 
    instance connected to the configured IVLE database.
64
 
    """
65
 
    return Store(create_database(get_conn_string()))
 
54
def get_conn_string(config):
 
55
    """Create a Storm connection string to the IVLE database
 
56
 
 
57
    @param config: The IVLE configuration.
 
58
    """
 
59
 
 
60
    clusterstr = ''
 
61
    if config['database']['username']:
 
62
        clusterstr += config['database']['username']
 
63
        if config['database']['password']:
 
64
            clusterstr += ':' + config['database']['password']
 
65
        clusterstr += '@'
 
66
 
 
67
    host = config['database']['host'] or 'localhost'
 
68
    port = config['database']['port'] or 5432
 
69
 
 
70
    clusterstr += '%s:%d' % (host, port)
 
71
 
 
72
    return "postgres://%s/%s" % (clusterstr, config['database']['name'])
 
73
 
 
74
def get_store(config):
 
75
    """Create a Storm store connected to the IVLE database.
 
76
 
 
77
    @param config: The IVLE configuration.
 
78
    """
 
79
    return Store(create_database(get_conn_string(config)))
66
80
 
67
81
# USERS #
68
82
 
69
83
class User(Storm):
70
 
    """
71
 
    Represents an IVLE user.
72
 
    """
 
84
    """An IVLE user account."""
73
85
    __storm_table__ = "login"
74
86
 
75
87
    id = Int(primary=True, name="loginid")
76
88
    login = Unicode()
77
89
    passhash = Unicode()
78
90
    state = Unicode()
79
 
    rolenm = Unicode()
 
91
    admin = Bool()
80
92
    unixid = Int()
81
93
    nick = Unicode()
82
94
    pass_exp = DateTime()
88
100
    studentid = Unicode()
89
101
    settings = Unicode()
90
102
 
91
 
    def _get_role(self):
92
 
        if self.rolenm is None:
93
 
            return None
94
 
        return ivle.caps.Role(self.rolenm)
95
 
    def _set_role(self, value):
96
 
        if not isinstance(value, ivle.caps.Role):
97
 
            raise TypeError("role must be an ivle.caps.Role")
98
 
        self.rolenm = unicode(value)
99
 
    role = property(_get_role, _set_role)
100
 
 
101
103
    __init__ = _kwarg_init
102
104
 
103
105
    def __repr__(self):
114
116
            return None
115
117
        return self.hash_password(password) == self.passhash
116
118
 
117
 
    def hasCap(self, capability):
118
 
        """Given a capability (which is a Role object), returns True if this
119
 
        User has that capability, False otherwise.
120
 
        """
121
 
        return self.role.hasCap(capability)
 
119
    @property
 
120
    def display_name(self):
 
121
        """Returns the "nice name" of the user or group."""
 
122
        return self.fullname
 
123
 
 
124
    @property
 
125
    def short_name(self):
 
126
        """Returns the database "identifier" name of the user or group."""
 
127
        return self.login
122
128
 
123
129
    @property
124
130
    def password_expired(self):
163
169
 
164
170
    # TODO: Invitations should be listed too?
165
171
    def get_groups(self, offering=None):
 
172
        """Get groups of which this user is a member.
 
173
 
 
174
        @param offering: An optional offering to restrict the search to.
 
175
        """
166
176
        preds = [
167
177
            ProjectGroupMembership.user_id == self.id,
168
178
            ProjectGroup.id == ProjectGroupMembership.project_group_id,
188
198
        '''A sanely ordered list of all of the user's enrolments.'''
189
199
        return self._get_enrolments(False) 
190
200
 
 
201
    def get_projects(self, offering=None, active_only=True):
 
202
        """Find projects that the user can submit.
 
203
 
 
204
        This will include projects for offerings in which the user is
 
205
        enrolled, as long as the project is not in a project set which has
 
206
        groups (ie. if maximum number of group members is 0).
 
207
 
 
208
        @param active_only: Whether to only search active offerings.
 
209
        @param offering: An optional offering to restrict the search to.
 
210
        """
 
211
        return Store.of(self).find(Project,
 
212
            Project.project_set_id == ProjectSet.id,
 
213
            ProjectSet.max_students_per_group == None,
 
214
            ProjectSet.offering_id == Offering.id,
 
215
            (offering is None) or (Offering.id == offering.id),
 
216
            Semester.id == Offering.semester_id,
 
217
            (not active_only) or (Semester.state == u'current'),
 
218
            Enrolment.offering_id == Offering.id,
 
219
            Enrolment.user_id == self.id,
 
220
            Enrolment.active == True)
 
221
 
191
222
    @staticmethod
192
223
    def hash_password(password):
193
 
        return md5.md5(password).hexdigest()
 
224
        """Hash a password with MD5."""
 
225
        return hashlib.md5(password).hexdigest()
194
226
 
195
227
    @classmethod
196
228
    def get_by_login(cls, store, login):
197
 
        """
198
 
        Get the User from the db associated with a given store and
199
 
        login.
200
 
        """
 
229
        """Find a user in a store by login name."""
201
230
        return store.find(cls, cls.login == unicode(login)).one()
202
231
 
203
 
    def get_permissions(self, user):
204
 
        if user and user.rolenm == 'admin' or user is self:
205
 
            return set(['view', 'edit'])
 
232
    def get_permissions(self, user, config):
 
233
        """Determine privileges held by a user over this object.
 
234
 
 
235
        If the user requesting privileges is this user or an admin,
 
236
        they may do everything. Otherwise they may do nothing.
 
237
        """
 
238
        if user and user.admin or user is self:
 
239
            return set(['view_public', 'view', 'edit', 'submit_project'])
206
240
        else:
207
 
            return set()
 
241
            return set(['view_public'])
208
242
 
209
243
# SUBJECTS AND ENROLMENTS #
210
244
 
211
245
class Subject(Storm):
 
246
    """A subject (or course) which is run in some semesters."""
 
247
 
212
248
    __storm_table__ = "subject"
213
249
 
214
250
    id = Int(primary=True, name="subjectid")
215
251
    code = Unicode(name="subj_code")
216
252
    name = Unicode(name="subj_name")
217
253
    short_name = Unicode(name="subj_short_name")
218
 
    url = Unicode()
219
254
 
220
255
    offerings = ReferenceSet(id, 'Offering.subject_id')
221
256
 
224
259
    def __repr__(self):
225
260
        return "<%s '%s'>" % (type(self).__name__, self.short_name)
226
261
 
227
 
    def get_permissions(self, user):
 
262
    def get_permissions(self, user, config):
 
263
        """Determine privileges held by a user over this object.
 
264
 
 
265
        If the user requesting privileges is an admin, they may edit.
 
266
        Otherwise they may only read.
 
267
        """
228
268
        perms = set()
229
269
        if user is not None:
230
270
            perms.add('view')
231
 
            if user.rolenm == 'admin':
 
271
            if user.admin:
232
272
                perms.add('edit')
233
273
        return perms
234
274
 
 
275
    def active_offerings(self):
 
276
        """Find active offerings for this subject.
 
277
 
 
278
        Return a sequence of currently active offerings for this subject
 
279
        (offerings whose semester.state is "current"). There should be 0 or 1
 
280
        elements in this sequence, but it's possible there are more.
 
281
        """
 
282
        return self.offerings.find(Offering.semester_id == Semester.id,
 
283
                                   Semester.state == u'current')
 
284
 
 
285
    def offering_for_semester(self, year, semester):
 
286
        """Get the offering for the given year/semester, or None.
 
287
 
 
288
        @param year: A string representation of the year.
 
289
        @param semester: A string representation of the semester.
 
290
        """
 
291
        return self.offerings.find(Offering.semester_id == Semester.id,
 
292
                               Semester.year == unicode(year),
 
293
                               Semester.semester == unicode(semester)).one()
 
294
 
235
295
class Semester(Storm):
 
296
    """A semester in which subjects can be run."""
 
297
 
236
298
    __storm_table__ = "semester"
237
299
 
238
300
    id = Int(primary=True, name="semesterid")
239
301
    year = Unicode()
240
302
    semester = Unicode()
241
 
    active = Bool()
 
303
    state = Unicode()
242
304
 
243
305
    offerings = ReferenceSet(id, 'Offering.semester_id')
 
306
    enrolments = ReferenceSet(id,
 
307
                              'Offering.semester_id',
 
308
                              'Offering.id',
 
309
                              'Enrolment.offering_id')
244
310
 
245
311
    __init__ = _kwarg_init
246
312
 
248
314
        return "<%s %s/%s>" % (type(self).__name__, self.year, self.semester)
249
315
 
250
316
class Offering(Storm):
 
317
    """An offering of a subject in a particular semester."""
 
318
 
251
319
    __storm_table__ = "offering"
252
320
 
253
321
    id = Int(primary=True, name="offeringid")
255
323
    subject = Reference(subject_id, Subject.id)
256
324
    semester_id = Int(name="semesterid")
257
325
    semester = Reference(semester_id, Semester.id)
 
326
    description = Unicode()
 
327
    url = Unicode()
 
328
    show_worksheet_marks = Bool()
 
329
    worksheet_cutoff = DateTime()
258
330
    groups_student_permissions = Unicode()
259
331
 
260
332
    enrolments = ReferenceSet(id, 'Enrolment.offering_id')
263
335
                           'Enrolment.user_id',
264
336
                           'User.id')
265
337
    project_sets = ReferenceSet(id, 'ProjectSet.offering_id')
 
338
    projects = ReferenceSet(id,
 
339
                            'ProjectSet.offering_id',
 
340
                            'ProjectSet.id',
 
341
                            'Project.project_set_id')
266
342
 
267
 
    worksheets = ReferenceSet(id, 'Worksheet.offering_id')
 
343
    worksheets = ReferenceSet(id, 
 
344
        'Worksheet.offering_id', 
 
345
        order_by="seq_no"
 
346
    )
268
347
 
269
348
    __init__ = _kwarg_init
270
349
 
272
351
        return "<%s %r in %r>" % (type(self).__name__, self.subject,
273
352
                                  self.semester)
274
353
 
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()
283
 
 
284
 
        e = Enrolment(user=user, offering=self, active=True)
285
 
        self.enrolments.add(e)
286
 
 
287
 
    def get_permissions(self, user):
 
354
    def enrol(self, user, role=u'student'):
 
355
        """Enrol a user in this offering.
 
356
 
 
357
        Enrolments handle both the staff and student cases. The role controls
 
358
        the privileges granted by this enrolment.
 
359
        """
 
360
        enrolment = Store.of(self).find(Enrolment,
 
361
                               Enrolment.user_id == user.id,
 
362
                               Enrolment.offering_id == self.id).one()
 
363
 
 
364
        if enrolment is None:
 
365
            enrolment = Enrolment(user=user, offering=self)
 
366
            self.enrolments.add(enrolment)
 
367
 
 
368
        enrolment.active = True
 
369
        enrolment.role = role
 
370
 
 
371
    def unenrol(self, user):
 
372
        '''Unenrol a user from this offering.'''
 
373
        enrolment = Store.of(self).find(Enrolment,
 
374
                               Enrolment.user_id == user.id,
 
375
                               Enrolment.offering_id == self.id).one()
 
376
        Store.of(enrolment).remove(enrolment)
 
377
 
 
378
    def get_permissions(self, user, config):
288
379
        perms = set()
289
380
        if user is not None:
290
 
            perms.add('view')
291
 
            if user.rolenm == 'admin':
292
 
                perms.add('edit')
 
381
            enrolment = self.get_enrolment(user)
 
382
            if enrolment or user.admin:
 
383
                perms.add('view')
 
384
            if enrolment and enrolment.role == u'tutor':
 
385
                perms.add('view_project_submissions')
 
386
                # Site-specific policy on the role of tutors
 
387
                if config['policy']['tutors_can_enrol_students']:
 
388
                    perms.add('enrol')
 
389
                    perms.add('enrol_student')
 
390
                if config['policy']['tutors_can_edit_worksheets']:
 
391
                    perms.add('edit_worksheets')
 
392
                if config['policy']['tutors_can_admin_groups']:
 
393
                    perms.add('admin_groups')
 
394
            if (enrolment and enrolment.role in (u'lecturer')) or user.admin:
 
395
                perms.add('view_project_submissions')
 
396
                perms.add('admin_groups')
 
397
                perms.add('edit_worksheets')
 
398
                perms.add('view_worksheet_marks')
 
399
                perms.add('edit')           # Can edit projects & details
 
400
                perms.add('enrol')          # Can see enrolment screen at all
 
401
                perms.add('enrol_student')  # Can enrol students
 
402
                perms.add('enrol_tutor')    # Can enrol tutors
 
403
            if user.admin:
 
404
                perms.add('enrol_lecturer') # Can enrol lecturers
293
405
        return perms
294
406
 
 
407
    def get_enrolment(self, user):
 
408
        """Find the user's enrolment in this offering."""
 
409
        try:
 
410
            enrolment = self.enrolments.find(user=user).one()
 
411
        except NotOneError:
 
412
            enrolment = None
 
413
 
 
414
        return enrolment
 
415
 
 
416
    def get_members_by_role(self, role):
 
417
        return Store.of(self).find(User,
 
418
                Enrolment.user_id == User.id,
 
419
                Enrolment.offering_id == self.id,
 
420
                Enrolment.role == role
 
421
                ).order_by(User.login)
 
422
 
 
423
    @property
 
424
    def students(self):
 
425
        return self.get_members_by_role(u'student')
 
426
 
 
427
    def get_open_projects_for_user(self, user):
 
428
        """Find all projects currently open to submissions by a user."""
 
429
        # XXX: Respect extensions.
 
430
        return self.projects.find(Project.deadline > datetime.datetime.now())
 
431
 
 
432
    def clone_worksheets(self, source):
 
433
        """Clone all worksheets from the specified source to this offering."""
 
434
        import ivle.worksheet.utils
 
435
        for worksheet in source.worksheets:
 
436
            newws = Worksheet()
 
437
            newws.seq_no = worksheet.seq_no
 
438
            newws.identifier = worksheet.identifier
 
439
            newws.name = worksheet.name
 
440
            newws.assessable = worksheet.assessable
 
441
            newws.published = worksheet.published
 
442
            newws.data = worksheet.data
 
443
            newws.format = worksheet.format
 
444
            newws.offering = self
 
445
            Store.of(self).add(newws)
 
446
            ivle.worksheet.utils.update_exerciselist(newws)
 
447
 
 
448
 
295
449
class Enrolment(Storm):
 
450
    """An enrolment of a user in an offering.
 
451
 
 
452
    This represents the roles of both staff and students.
 
453
    """
 
454
 
296
455
    __storm_table__ = "enrolment"
297
456
    __storm_primary__ = "user_id", "offering_id"
298
457
 
300
459
    user = Reference(user_id, User.id)
301
460
    offering_id = Int(name="offeringid")
302
461
    offering = Reference(offering_id, Offering.id)
 
462
    role = Unicode()
303
463
    notes = Unicode()
304
464
    active = Bool()
305
465
 
317
477
        return "<%s %r in %r>" % (type(self).__name__, self.user,
318
478
                                  self.offering)
319
479
 
320
 
class AlreadyEnrolledError(Exception):
321
 
    pass
 
480
    def get_permissions(self, user, config):
 
481
        # A user can edit any enrolment that they could have created.
 
482
        perms = set()
 
483
        if ('enrol_' + str(self.role)) in self.offering.get_permissions(
 
484
            user, config):
 
485
            perms.add('edit')
 
486
        return perms
 
487
 
 
488
    def delete(self):
 
489
        """Delete this enrolment."""
 
490
        Store.of(self).remove(self)
 
491
 
322
492
 
323
493
# PROJECTS #
324
494
 
325
495
class ProjectSet(Storm):
 
496
    """A set of projects that share common groups.
 
497
 
 
498
    Each student project group is attached to a project set. The group is
 
499
    valid for all projects in the group's set.
 
500
    """
 
501
 
326
502
    __storm_table__ = "project_set"
327
503
 
328
504
    id = Int(name="projectsetid", primary=True)
339
515
        return "<%s %d in %r>" % (type(self).__name__, self.id,
340
516
                                  self.offering)
341
517
 
 
518
    def get_permissions(self, user, config):
 
519
        return self.offering.get_permissions(user, config)
 
520
 
 
521
    def get_groups_for_user(self, user):
 
522
        """List all groups in this offering of which the user is a member."""
 
523
        assert self.is_group
 
524
        return Store.of(self).find(
 
525
            ProjectGroup,
 
526
            ProjectGroupMembership.user_id == user.id,
 
527
            ProjectGroupMembership.project_group_id == ProjectGroup.id,
 
528
            ProjectGroup.project_set_id == self.id)
 
529
 
 
530
    def get_submission_principal(self, user):
 
531
        """Get the principal on behalf of which the user can submit.
 
532
 
 
533
        If this is a solo project set, the given user is returned. If
 
534
        the user is a member of exactly one group, all the group is
 
535
        returned. Otherwise, None is returned.
 
536
        """
 
537
        if self.is_group:
 
538
            groups = self.get_groups_for_user(user)
 
539
            if groups.count() == 1:
 
540
                return groups.one()
 
541
            else:
 
542
                return None
 
543
        else:
 
544
            return user
 
545
 
 
546
    @property
 
547
    def is_group(self):
 
548
        return self.max_students_per_group is not None
 
549
 
 
550
    @property
 
551
    def assigned(self):
 
552
        """Get the entities (groups or users) assigned to submit this project.
 
553
 
 
554
        This will be a Storm ResultSet.
 
555
        """
 
556
        #If its a solo project, return everyone in offering
 
557
        if self.is_group:
 
558
            return self.project_groups
 
559
        else:
 
560
            return self.offering.students
 
561
 
 
562
class DeadlinePassed(Exception):
 
563
    """An exception indicating that a project cannot be submitted because the
 
564
    deadline has passed."""
 
565
    def __init__(self):
 
566
        pass
 
567
    def __str__(self):
 
568
        return "The project deadline has passed"
 
569
 
342
570
class Project(Storm):
 
571
    """A student project for which submissions can be made."""
 
572
 
343
573
    __storm_table__ = "project"
344
574
 
345
575
    id = Int(name="projectid", primary=True)
 
576
    name = Unicode()
 
577
    short_name = Unicode()
346
578
    synopsis = Unicode()
347
579
    url = Unicode()
348
580
    project_set_id = Int(name="projectsetid")
349
581
    project_set = Reference(project_set_id, ProjectSet.id)
350
582
    deadline = DateTime()
351
583
 
 
584
    assesseds = ReferenceSet(id, 'Assessed.project_id')
 
585
    submissions = ReferenceSet(id,
 
586
                               'Assessed.project_id',
 
587
                               'Assessed.id',
 
588
                               'ProjectSubmission.assessed_id')
 
589
 
352
590
    __init__ = _kwarg_init
353
591
 
354
592
    def __repr__(self):
355
 
        return "<%s '%s' in %r>" % (type(self).__name__, self.synopsis,
 
593
        return "<%s '%s' in %r>" % (type(self).__name__, self.short_name,
356
594
                                  self.project_set.offering)
357
595
 
 
596
    def can_submit(self, principal, user):
 
597
        return (self in principal.get_projects() and
 
598
                not self.has_deadline_passed(user))
 
599
 
 
600
    def submit(self, principal, path, revision, who):
 
601
        """Submit a Subversion path and revision to a project.
 
602
 
 
603
        @param principal: The owner of the Subversion repository, and the
 
604
                          entity on behalf of whom the submission is being made
 
605
        @param path: A path within that repository to submit.
 
606
        @param revision: The revision of that path to submit.
 
607
        @param who: The user who is actually making the submission.
 
608
        """
 
609
 
 
610
        if not self.can_submit(principal, who):
 
611
            raise DeadlinePassed()
 
612
 
 
613
        a = Assessed.get(Store.of(self), principal, self)
 
614
        ps = ProjectSubmission()
 
615
        # Raise SubmissionError if the path is illegal
 
616
        ps.path = ProjectSubmission.test_and_normalise_path(path)
 
617
        ps.revision = revision
 
618
        ps.date_submitted = datetime.datetime.now()
 
619
        ps.assessed = a
 
620
        ps.submitter = who
 
621
 
 
622
        return ps
 
623
 
 
624
    def get_permissions(self, user, config):
 
625
        return self.project_set.offering.get_permissions(user, config)
 
626
 
 
627
    @property
 
628
    def latest_submissions(self):
 
629
        """Return the latest submission for each Assessed."""
 
630
        return Store.of(self).find(ProjectSubmission,
 
631
            Assessed.project_id == self.id,
 
632
            ProjectSubmission.assessed_id == Assessed.id,
 
633
            ProjectSubmission.date_submitted == Select(
 
634
                    Max(ProjectSubmission.date_submitted),
 
635
                    ProjectSubmission.assessed_id == Assessed.id,
 
636
                    tables=ProjectSubmission
 
637
            )
 
638
        )
 
639
 
 
640
    def has_deadline_passed(self, user):
 
641
        """Check whether the deadline has passed."""
 
642
        # XXX: Need to respect extensions.
 
643
        return self.deadline < datetime.datetime.now()
 
644
 
 
645
    def get_submissions_for_principal(self, principal):
 
646
        """Fetch a ResultSet of all submissions by a particular principal."""
 
647
        assessed = Assessed.get(Store.of(self), principal, self)
 
648
        if assessed is None:
 
649
            return
 
650
        return assessed.submissions
 
651
 
 
652
    @property
 
653
    def can_delete(self):
 
654
        """Can only delete if there are no submissions."""
 
655
        return self.submissions.count() == 0
 
656
 
 
657
    def delete(self):
 
658
        """Delete the project. Fails if can_delete is False."""
 
659
        if not self.can_delete:
 
660
            raise IntegrityError()
 
661
        for assessed in self.assesseds:
 
662
            assessed.delete()
 
663
        Store.of(self).remove(self)
 
664
 
358
665
class ProjectGroup(Storm):
 
666
    """A group of students working together on a project."""
 
667
 
359
668
    __storm_table__ = "project_group"
360
669
 
361
670
    id = Int(name="groupid", primary=True)
378
687
        return "<%s %s in %r>" % (type(self).__name__, self.name,
379
688
                                  self.project_set.offering)
380
689
 
 
690
    @property
 
691
    def display_name(self):
 
692
        """Returns the "nice name" of the user or group."""
 
693
        return self.nick
 
694
 
 
695
    @property
 
696
    def short_name(self):
 
697
        """Returns the database "identifier" name of the user or group."""
 
698
        return self.name
 
699
 
 
700
    def get_projects(self, offering=None, active_only=True):
 
701
        '''Find projects that the group can submit.
 
702
 
 
703
        This will include projects in the project set which owns this group,
 
704
        unless the project set disallows groups (in which case none will be
 
705
        returned).
 
706
 
 
707
        @param active_only: Whether to only search active offerings.
 
708
        @param offering: An optional offering to restrict the search to.
 
709
        '''
 
710
        return Store.of(self).find(Project,
 
711
            Project.project_set_id == ProjectSet.id,
 
712
            ProjectSet.id == self.project_set.id,
 
713
            ProjectSet.max_students_per_group != None,
 
714
            ProjectSet.offering_id == Offering.id,
 
715
            (offering is None) or (Offering.id == offering.id),
 
716
            Semester.id == Offering.semester_id,
 
717
            (not active_only) or (Semester.state == u'current'))
 
718
 
 
719
 
 
720
    def get_permissions(self, user, config):
 
721
        if user.admin or user in self.members:
 
722
            return set(['submit_project'])
 
723
        else:
 
724
            return set()
 
725
 
381
726
class ProjectGroupMembership(Storm):
 
727
    """A student's membership in a project group."""
 
728
 
382
729
    __storm_table__ = "group_member"
383
730
    __storm_primary__ = "user_id", "project_group_id"
384
731
 
393
740
        return "<%s %r in %r>" % (type(self).__name__, self.user,
394
741
                                  self.project_group)
395
742
 
 
743
class Assessed(Storm):
 
744
    """A composite of a user or group combined with a project.
 
745
 
 
746
    Each project submission and extension refers to an Assessed. It is the
 
747
    sole specifier of the repository and project.
 
748
    """
 
749
 
 
750
    __storm_table__ = "assessed"
 
751
 
 
752
    id = Int(name="assessedid", primary=True)
 
753
    user_id = Int(name="loginid")
 
754
    user = Reference(user_id, User.id)
 
755
    project_group_id = Int(name="groupid")
 
756
    project_group = Reference(project_group_id, ProjectGroup.id)
 
757
 
 
758
    project_id = Int(name="projectid")
 
759
    project = Reference(project_id, Project.id)
 
760
 
 
761
    extensions = ReferenceSet(id, 'ProjectExtension.assessed_id')
 
762
    submissions = ReferenceSet(
 
763
        id, 'ProjectSubmission.assessed_id', order_by='date_submitted')
 
764
 
 
765
    def __repr__(self):
 
766
        return "<%s %r in %r>" % (type(self).__name__,
 
767
            self.user or self.project_group, self.project)
 
768
 
 
769
    @property
 
770
    def is_group(self):
 
771
        """True if the Assessed is a group, False if it is a user."""
 
772
        return self.project_group is not None
 
773
 
 
774
    @property
 
775
    def principal(self):
 
776
        return self.project_group or self.user
 
777
 
 
778
    @property
 
779
    def checkout_location(self):
 
780
        """Returns the location of the Subversion workspace for this piece of
 
781
        assessment, relative to each group member's home directory."""
 
782
        subjectname = self.project.project_set.offering.subject.short_name
 
783
        if self.is_group:
 
784
            checkout_dir_name = self.principal.short_name
 
785
        else:
 
786
            checkout_dir_name = "mywork"
 
787
        return subjectname + "/" + checkout_dir_name
 
788
 
 
789
    @classmethod
 
790
    def get(cls, store, principal, project):
 
791
        """Find or create an Assessed for the given user or group and project.
 
792
 
 
793
        @param principal: The user or group.
 
794
        @param project: The project.
 
795
        """
 
796
        t = type(principal)
 
797
        if t not in (User, ProjectGroup):
 
798
            raise AssertionError('principal must be User or ProjectGroup')
 
799
 
 
800
        a = store.find(cls,
 
801
            (t is User) or (cls.project_group_id == principal.id),
 
802
            (t is ProjectGroup) or (cls.user_id == principal.id),
 
803
            cls.project_id == project.id).one()
 
804
 
 
805
        if a is None:
 
806
            a = cls()
 
807
            if t is User:
 
808
                a.user = principal
 
809
            else:
 
810
                a.project_group = principal
 
811
            a.project = project
 
812
            store.add(a)
 
813
 
 
814
        return a
 
815
 
 
816
    def delete(self):
 
817
        """Delete the assessed. Fails if there are any submissions. Deletes
 
818
        extensions."""
 
819
        if self.submissions.count() > 0:
 
820
            raise IntegrityError()
 
821
        for extension in self.extensions:
 
822
            extension.delete()
 
823
        Store.of(self).remove(self)
 
824
 
 
825
class ProjectExtension(Storm):
 
826
    """An extension granted to a user or group on a particular project.
 
827
 
 
828
    The user or group and project are specified by the Assessed.
 
829
    """
 
830
 
 
831
    __storm_table__ = "project_extension"
 
832
 
 
833
    id = Int(name="extensionid", primary=True)
 
834
    assessed_id = Int(name="assessedid")
 
835
    assessed = Reference(assessed_id, Assessed.id)
 
836
    deadline = DateTime()
 
837
    approver_id = Int(name="approver")
 
838
    approver = Reference(approver_id, User.id)
 
839
    notes = Unicode()
 
840
 
 
841
    def delete(self):
 
842
        """Delete the extension."""
 
843
        Store.of(self).remove(self)
 
844
 
 
845
class SubmissionError(Exception):
 
846
    """Denotes a validation error during submission."""
 
847
    pass
 
848
 
 
849
class ProjectSubmission(Storm):
 
850
    """A submission from a user or group repository to a particular project.
 
851
 
 
852
    The content of a submission is a single path and revision inside a
 
853
    repository. The repository is that owned by the submission's user and
 
854
    group, while the path and revision are explicit.
 
855
 
 
856
    The user or group and project are specified by the Assessed.
 
857
    """
 
858
 
 
859
    __storm_table__ = "project_submission"
 
860
 
 
861
    id = Int(name="submissionid", primary=True)
 
862
    assessed_id = Int(name="assessedid")
 
863
    assessed = Reference(assessed_id, Assessed.id)
 
864
    path = Unicode()
 
865
    revision = Int()
 
866
    submitter_id = Int(name="submitter")
 
867
    submitter = Reference(submitter_id, User.id)
 
868
    date_submitted = DateTime()
 
869
 
 
870
    def get_verify_url(self, user):
 
871
        """Get the URL for verifying this submission, within the account of
 
872
        the given user."""
 
873
        # If this is a solo project, then self.path will be prefixed with the
 
874
        # subject name. Remove the first path segment.
 
875
        submitpath = self.path[1:] if self.path[:1] == '/' else self.path
 
876
        if not self.assessed.is_group:
 
877
            if '/' in submitpath:
 
878
                submitpath = submitpath.split('/', 1)[1]
 
879
            else:
 
880
                submitpath = ''
 
881
        return "/files/%s/%s/%s?r=%d" % (user.login,
 
882
            self.assessed.checkout_location, submitpath, self.revision)
 
883
 
 
884
    @staticmethod
 
885
    def test_and_normalise_path(path):
 
886
        """Test that path is valid, and normalise it. This prevents possible
 
887
        injections using malicious paths.
 
888
        Returns the updated path, if successful.
 
889
        Raises SubmissionError if invalid.
 
890
        """
 
891
        # Ensure the path is absolute to prevent being tacked onto working
 
892
        # directories.
 
893
        # Prevent '\n' because it will break all sorts of things.
 
894
        # Prevent '[' and ']' because they can be used to inject into the
 
895
        # svn.conf.
 
896
        # Normalise to avoid resulting in ".." path segments.
 
897
        if not os.path.isabs(path):
 
898
            raise SubmissionError("Path is not absolute")
 
899
        if any(c in path for c in "\n[]"):
 
900
            raise SubmissionError("Path must not contain '\\n', '[' or ']'")
 
901
        return os.path.normpath(path)
 
902
 
396
903
# WORKSHEETS AND EXERCISES #
397
904
 
398
905
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
 
906
    """An exercise for students to complete in a worksheet.
 
907
 
 
908
    An exercise may be present in any number of worksheets.
 
909
    """
 
910
 
 
911
    __storm_table__ = "exercise"
403
912
    id = Unicode(primary=True, name="identifier")
404
913
    name = Unicode()
405
914
    description = Unicode()
 
915
    _description_xhtml_cache = Unicode(name='description_xhtml_cache')
406
916
    partial = Unicode()
407
917
    solution = Unicode()
408
918
    include = Unicode()
409
919
    num_rows = Int()
410
920
 
 
921
    worksheet_exercises =  ReferenceSet(id,
 
922
        'WorksheetExercise.exercise_id')
 
923
 
411
924
    worksheets = ReferenceSet(id,
412
925
        'WorksheetExercise.exercise_id',
413
926
        'WorksheetExercise.worksheet_id',
414
927
        'Worksheet.id'
415
928
    )
416
 
    
417
 
    test_suites = ReferenceSet(id, 'TestSuite.exercise_id')
 
929
 
 
930
    test_suites = ReferenceSet(id, 
 
931
        'TestSuite.exercise_id',
 
932
        order_by='seq_no')
418
933
 
419
934
    __init__ = _kwarg_init
420
935
 
421
936
    def __repr__(self):
422
937
        return "<%s %s>" % (type(self).__name__, self.name)
423
938
 
 
939
    def get_permissions(self, user, config):
 
940
        return self.global_permissions(user, config)
 
941
 
 
942
    @staticmethod
 
943
    def global_permissions(user, config):
 
944
        """Gets the set of permissions this user has over *all* exercises.
 
945
        This is used to determine who may view the exercises list, and create
 
946
        new exercises."""
 
947
        perms = set()
 
948
        roles = set()
 
949
        if user is not None:
 
950
            if user.admin:
 
951
                perms.add('edit')
 
952
                perms.add('view')
 
953
            elif u'lecturer' in set((e.role for e in user.active_enrolments)):
 
954
                perms.add('edit')
 
955
                perms.add('view')
 
956
            elif (config['policy']['tutors_can_edit_worksheets']
 
957
            and u'tutor' in set((e.role for e in user.active_enrolments))):
 
958
                # Site-specific policy on the role of tutors
 
959
                perms.add('edit')
 
960
                perms.add('view')
 
961
 
 
962
        return perms
 
963
 
 
964
    def _cache_description_xhtml(self, invalidate=False):
 
965
        # Don't regenerate an existing cache unless forced.
 
966
        if self._description_xhtml_cache is not None and not invalidate:
 
967
            return
 
968
 
 
969
        if self.description:
 
970
            self._description_xhtml_cache = rst(self.description)
 
971
        else:
 
972
            self._description_xhtml_cache = None
 
973
 
 
974
    @property
 
975
    def description_xhtml(self):
 
976
        """The XHTML exercise description, converted from reStructuredText."""
 
977
        self._cache_description_xhtml()
 
978
        return self._description_xhtml_cache
 
979
 
 
980
    def set_description(self, description):
 
981
        self.description = description
 
982
        self._cache_description_xhtml(invalidate=True)
 
983
 
 
984
    def delete(self):
 
985
        """Deletes the exercise, providing it has no associated worksheets."""
 
986
        if (self.worksheet_exercises.count() > 0):
 
987
            raise IntegrityError()
 
988
        for suite in self.test_suites:
 
989
            suite.delete()
 
990
        Store.of(self).remove(self)
424
991
 
425
992
class Worksheet(Storm):
 
993
    """A worksheet with exercises for students to complete.
 
994
 
 
995
    Worksheets are owned by offerings.
 
996
    """
 
997
 
426
998
    __storm_table__ = "worksheet"
427
999
 
428
1000
    id = Int(primary=True, name="worksheetid")
429
 
    # XXX subject is not linked to a Subject object. This is a property of
430
 
    # the database, and will be refactored.
431
1001
    offering_id = Int(name="offeringid")
432
 
    name = Unicode(name="identifier")
 
1002
    identifier = Unicode()
 
1003
    name = Unicode()
433
1004
    assessable = Bool()
434
 
    mtime = DateTime()
 
1005
    published = Bool()
 
1006
    data = Unicode()
 
1007
    _data_xhtml_cache = Unicode(name='data_xhtml_cache')
 
1008
    seq_no = Int()
 
1009
    format = Unicode()
435
1010
 
436
1011
    attempts = ReferenceSet(id, "ExerciseAttempt.worksheetid")
437
1012
    offering = Reference(offering_id, 'Offering.id')
438
1013
 
439
 
    exercises = ReferenceSet(id,
440
 
        'WorksheetExercise.worksheet_id',
441
 
        'WorksheetExercise.exercise_id',
442
 
        Exercise.id)
443
 
    # Use worksheet_exercises to get access to the WorksheetExercise objects
444
 
    # binding worksheets to exercises. This is required to access the
 
1014
    all_worksheet_exercises = ReferenceSet(id,
 
1015
        'WorksheetExercise.worksheet_id')
 
1016
 
 
1017
    # Use worksheet_exercises to get access to the *active* WorksheetExercise
 
1018
    # objects binding worksheets to exercises. This is required to access the
445
1019
    # "optional" field.
446
 
    worksheet_exercises = ReferenceSet(id,
447
 
        'WorksheetExercise.worksheet_id')
448
 
        
 
1020
 
 
1021
    @property
 
1022
    def worksheet_exercises(self):
 
1023
        return self.all_worksheet_exercises.find(active=True)
449
1024
 
450
1025
    __init__ = _kwarg_init
451
1026
 
452
1027
    def __repr__(self):
453
1028
        return "<%s %s>" % (type(self).__name__, self.name)
454
1029
 
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()
 
1030
    def remove_all_exercises(self):
 
1031
        """Remove all exercises from this worksheet.
466
1032
 
467
 
    def remove_all_exercises(self, store):
468
 
        """
469
 
        Remove all exercises from this worksheet.
470
1033
        This does not delete the exercises themselves. It just removes them
471
1034
        from the worksheet.
472
1035
        """
 
1036
        store = Store.of(self)
 
1037
        for ws_ex in self.all_worksheet_exercises:
 
1038
            if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
 
1039
                raise IntegrityError()
473
1040
        store.find(WorksheetExercise,
474
1041
            WorksheetExercise.worksheet == self).remove()
475
 
            
476
 
    def get_permissions(self, user):
477
 
        return self.offering.get_permissions(user)
 
1042
 
 
1043
    def get_permissions(self, user, config):
 
1044
        offering_perms = self.offering.get_permissions(user, config)
 
1045
 
 
1046
        perms = set()
 
1047
 
 
1048
        # Anybody who can view an offering can view a published
 
1049
        # worksheet.
 
1050
        if 'view' in offering_perms and self.published:
 
1051
            perms.add('view')
 
1052
 
 
1053
        # Any worksheet editors can both view and edit.
 
1054
        if 'edit_worksheets' in offering_perms:
 
1055
            perms.add('view')
 
1056
            perms.add('edit')
 
1057
 
 
1058
        return perms
 
1059
 
 
1060
    def _cache_data_xhtml(self, invalidate=False):
 
1061
        # Don't regenerate an existing cache unless forced.
 
1062
        if self._data_xhtml_cache is not None and not invalidate:
 
1063
            return
 
1064
 
 
1065
        if self.format == u'rst':
 
1066
            self._data_xhtml_cache = rst(self.data)
 
1067
        else:
 
1068
            self._data_xhtml_cache = None
 
1069
 
 
1070
    @property
 
1071
    def data_xhtml(self):
 
1072
        """The XHTML of this worksheet, converted from rST if required."""
 
1073
        # Update the rST -> XHTML cache, if required.
 
1074
        self._cache_data_xhtml()
 
1075
 
 
1076
        if self.format == u'rst':
 
1077
            return self._data_xhtml_cache
 
1078
        else:
 
1079
            return self.data
 
1080
 
 
1081
    def set_data(self, data):
 
1082
        self.data = data
 
1083
        self._cache_data_xhtml(invalidate=True)
 
1084
 
 
1085
    def delete(self):
 
1086
        """Deletes the worksheet, provided it has no attempts on any exercises.
 
1087
 
 
1088
        Returns True if delete succeeded, or False if this worksheet has
 
1089
        attempts attached."""
 
1090
        for ws_ex in self.all_worksheet_exercises:
 
1091
            if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
 
1092
                raise IntegrityError()
 
1093
 
 
1094
        self.remove_all_exercises()
 
1095
        Store.of(self).remove(self)
478
1096
 
479
1097
class WorksheetExercise(Storm):
480
 
    __storm_table__ = "worksheet_problem"
481
 
    __storm_primary__ = "worksheet_id", "exercise_id"
 
1098
    """A link between a worksheet and one of its exercises.
 
1099
 
 
1100
    These may be marked optional, in which case the exercise does not count
 
1101
    for marking purposes. The sequence number is used to order the worksheet
 
1102
    ToC.
 
1103
    """
 
1104
 
 
1105
    __storm_table__ = "worksheet_exercise"
 
1106
 
 
1107
    id = Int(primary=True, name="ws_ex_id")
482
1108
 
483
1109
    worksheet_id = Int(name="worksheetid")
484
1110
    worksheet = Reference(worksheet_id, Worksheet.id)
485
 
    exercise_id = Unicode(name="problemid")
 
1111
    exercise_id = Unicode(name="exerciseid")
486
1112
    exercise = Reference(exercise_id, Exercise.id)
487
1113
    optional = Bool()
 
1114
    active = Bool()
 
1115
    seq_no = Int()
 
1116
 
 
1117
    saves = ReferenceSet(id, "ExerciseSave.ws_ex_id")
 
1118
    attempts = ReferenceSet(id, "ExerciseAttempt.ws_ex_id")
488
1119
 
489
1120
    __init__ = _kwarg_init
490
1121
 
491
1122
    def __repr__(self):
492
1123
        return "<%s %s in %s>" % (type(self).__name__, self.exercise.name,
493
 
                                  self.worksheet.name)
 
1124
                                  self.worksheet.identifier)
 
1125
 
 
1126
    def get_permissions(self, user, config):
 
1127
        return self.worksheet.get_permissions(user, config)
 
1128
 
494
1129
 
495
1130
class ExerciseSave(Storm):
496
 
    """
497
 
    Represents a potential solution to an exercise that a user has submitted
498
 
    to the server for storage.
499
 
    A basic ExerciseSave is just the current saved text for this exercise for
500
 
    this user (doesn't count towards their attempts).
501
 
    ExerciseSave may be extended with additional semantics (such as
502
 
    ExerciseAttempt).
503
 
    """
504
 
    __storm_table__ = "problem_save"
505
 
    __storm_primary__ = "exercise_id", "user_id", "date"
506
 
 
507
 
    exercise_id = Unicode(name="problemid")
508
 
    exercise = Reference(exercise_id, Exercise.id)
 
1131
    """A potential exercise solution submitted by a user for storage.
 
1132
 
 
1133
    This is not an actual tested attempt at an exercise, it's just a save of
 
1134
    the editing session.
 
1135
    """
 
1136
 
 
1137
    __storm_table__ = "exercise_save"
 
1138
    __storm_primary__ = "ws_ex_id", "user_id"
 
1139
 
 
1140
    ws_ex_id = Int(name="ws_ex_id")
 
1141
    worksheet_exercise = Reference(ws_ex_id, "WorksheetExercise.id")
 
1142
 
509
1143
    user_id = Int(name="loginid")
510
1144
    user = Reference(user_id, User.id)
511
1145
    date = DateTime()
512
1146
    text = Unicode()
513
 
    worksheetid = Int()
514
 
    worksheet = Reference(worksheetid, Worksheet.id)
515
1147
 
516
1148
    __init__ = _kwarg_init
517
1149
 
518
1150
    def __repr__(self):
519
1151
        return "<%s %s by %s at %s>" % (type(self).__name__,
520
 
            self.exercise.name, self.user.login, self.date.strftime("%c"))
 
1152
            self.worksheet_exercise.exercise.name, self.user.login,
 
1153
            self.date.strftime("%c"))
521
1154
 
522
1155
class ExerciseAttempt(ExerciseSave):
523
 
    """
524
 
    An ExerciseAttempt is a special case of an ExerciseSave. Like an
525
 
    ExerciseSave, it constitutes exercise solution data that the user has
526
 
    submitted to the server for storage.
527
 
    In addition, it contains additional information about the submission.
528
 
    complete - True if this submission was successful, rendering this exercise
529
 
        complete for this user.
530
 
    active - True if this submission is "active" (usually true). Submissions
531
 
        may be de-activated by privileged users for special reasons, and then
532
 
        they won't count (either as a penalty or success), but will still be
533
 
        stored.
534
 
    """
535
 
    __storm_table__ = "problem_attempt"
536
 
    __storm_primary__ = "exercise_id", "user_id", "date"
 
1156
    """An attempt at solving an exercise.
 
1157
 
 
1158
    This is a special case of ExerciseSave, used when the user submits a
 
1159
    candidate solution. Like an ExerciseSave, it constitutes exercise solution
 
1160
    data.
 
1161
 
 
1162
    In addition, it contains information about the result of the submission:
 
1163
 
 
1164
     - complete - True if this submission was successful, rendering this
 
1165
                  exercise complete for this user in this worksheet.
 
1166
     - active   - True if this submission is "active" (usually true).
 
1167
                  Submissions may be de-activated by privileged users for
 
1168
                  special reasons, and then they won't count (either as a
 
1169
                  penalty or success), but will still be stored.
 
1170
    """
 
1171
 
 
1172
    __storm_table__ = "exercise_attempt"
 
1173
    __storm_primary__ = "ws_ex_id", "user_id", "date"
537
1174
 
538
1175
    # The "text" field is the same but has a different name in the DB table
539
1176
    # for some reason.
540
1177
    text = Unicode(name="attempt")
541
1178
    complete = Bool()
542
1179
    active = Bool()
543
 
    
544
 
    def get_permissions(self, user):
 
1180
 
 
1181
    def get_permissions(self, user, config):
545
1182
        return set(['view']) if user is self.user else set()
546
 
  
 
1183
 
547
1184
class TestSuite(Storm):
548
 
    """A Testsuite acts as a container for the test cases of an exercise."""
 
1185
    """A container to group an exercise's test cases.
 
1186
 
 
1187
    The test suite contains some information on how to test. The function to
 
1188
    test, variables to set and stdin data are stored here.
 
1189
    """
 
1190
 
549
1191
    __storm_table__ = "test_suite"
550
1192
    __storm_primary__ = "exercise_id", "suiteid"
551
 
    
 
1193
 
552
1194
    suiteid = Int()
553
 
    exercise_id = Unicode(name="problemid")
 
1195
    exercise_id = Unicode(name="exerciseid")
554
1196
    description = Unicode()
555
1197
    seq_no = Int()
556
1198
    function = Unicode()
557
1199
    stdin = Unicode()
558
1200
    exercise = Reference(exercise_id, Exercise.id)
559
 
    test_cases = ReferenceSet(suiteid, 'TestCase.suiteid')
560
 
    variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid')
 
1201
    test_cases = ReferenceSet(suiteid, 'TestCase.suiteid', order_by="seq_no")
 
1202
    variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid', order_by='arg_no')
 
1203
 
 
1204
    def delete(self):
 
1205
        """Delete this suite, without asking questions."""
 
1206
        for variable in self.variables:
 
1207
            variable.delete()
 
1208
        for test_case in self.test_cases:
 
1209
            test_case.delete()
 
1210
        Store.of(self).remove(self)
561
1211
 
562
1212
class TestCase(Storm):
563
 
    """A TestCase is a member of a TestSuite.
564
 
    
565
 
    It contains the data necessary to check if an exercise is correct"""
 
1213
    """A container for actual tests (see TestCasePart), inside a test suite.
 
1214
 
 
1215
    It is the lowest level shown to students on their pass/fail status."""
 
1216
 
566
1217
    __storm_table__ = "test_case"
567
1218
    __storm_primary__ = "testid", "suiteid"
568
 
    
 
1219
 
569
1220
    testid = Int()
570
1221
    suiteid = Int()
571
1222
    suite = Reference(suiteid, "TestSuite.suiteid")
572
1223
    passmsg = Unicode()
573
1224
    failmsg = Unicode()
574
 
    test_default = Unicode()
 
1225
    test_default = Unicode() # Currently unused - only used for file matching.
575
1226
    seq_no = Int()
576
 
    
 
1227
 
577
1228
    parts = ReferenceSet(testid, "TestCasePart.testid")
578
 
    
 
1229
 
579
1230
    __init__ = _kwarg_init
580
1231
 
 
1232
    def delete(self):
 
1233
        for part in self.parts:
 
1234
            part.delete()
 
1235
        Store.of(self).remove(self)
 
1236
 
581
1237
class TestSuiteVar(Storm):
582
 
    """A container for the arguments of a Test Suite"""
583
 
    __storm_table__ = "suite_variables"
 
1238
    """A variable used by an exercise test suite.
 
1239
 
 
1240
    This may represent a function argument or a normal variable.
 
1241
    """
 
1242
 
 
1243
    __storm_table__ = "suite_variable"
584
1244
    __storm_primary__ = "varid"
585
 
    
 
1245
 
586
1246
    varid = Int()
587
1247
    suiteid = Int()
588
1248
    var_name = Unicode()
589
1249
    var_value = Unicode()
590
1250
    var_type = Unicode()
591
1251
    arg_no = Int()
592
 
    
 
1252
 
593
1253
    suite = Reference(suiteid, "TestSuite.suiteid")
594
 
    
 
1254
 
595
1255
    __init__ = _kwarg_init
596
 
    
 
1256
 
 
1257
    def delete(self):
 
1258
        Store.of(self).remove(self)
 
1259
 
597
1260
class TestCasePart(Storm):
598
 
    """A container for the test elements of a Test Case"""
599
 
    __storm_table__ = "test_case_parts"
 
1261
    """An actual piece of code to test an exercise solution."""
 
1262
 
 
1263
    __storm_table__ = "test_case_part"
600
1264
    __storm_primary__ = "partid"
601
 
    
 
1265
 
602
1266
    partid = Int()
603
1267
    testid = Int()
604
 
    
 
1268
 
605
1269
    part_type = Unicode()
606
1270
    test_type = Unicode()
607
1271
    data = Unicode()
608
1272
    filename = Unicode()
609
 
    
 
1273
 
610
1274
    test = Reference(testid, "TestCase.testid")
611
 
    
 
1275
 
612
1276
    __init__ = _kwarg_init
 
1277
 
 
1278
    def delete(self):
 
1279
        Store.of(self).remove(self)