Merge pull request #1320 from AaltoScienceIT/collect-before-due-date

Add nbgrader collect --before-duedate option

Author: willingc

nbgrader/apps/collectapp.py

@@ -20,6 +20,10 @@
         {'ExchangeCollect' : {'update': True}},
         "Update existing submissions with ones that have newer timestamps."
     ),
+    'before-duedate': (
+        {'ExchangeCollect' : {'before_duedate': True}},
+        "Collect the last submission before due date or the last submission if no submission before due date."
+    ),
 })
 
 class CollectApp(NbGrader):

nbgrader/exchange/collect.py

@@ -4,10 +4,12 @@
 import sys
 from collections import defaultdict
 from textwrap import dedent
+import datetime
 
 from traitlets import Bool
 
 from .exchange import Exchange
+from ..api import Gradebook, MissingEntry
 from ..utils import check_mode, parse_utc
 
 # pwd is for matching unix names with student ide, so we shouldn't import it on
@@ -31,6 +33,11 @@ class ExchangeCollect(Exchange):
         help="Update existing submissions with ones that have newer timestamps."
     ).tag(config=True)
 
+    before_duedate = Bool(
+        False,
+        help="Collect the last submission before due date or the last submission if no submission before due date."
+    ).tag(config=True)
+
     check_owner = Bool(
         default_value=True,
         help="Whether to cross-check the student_id with the UNIX-owner of the submitted directory."
@@ -63,7 +70,24 @@ def init_src(self):
         pattern = os.path.join(self.inbound_path, '{}+{}+*'.format(student_id, self.coursedir.assignment_id))
         records = [self._path_to_record(f) for f in glob.glob(pattern)]
         usergroups = groupby(records, lambda item: item['username'])
-        self.src_records = [self._sort_by_timestamp(v)[0] for v in usergroups.values()]
+
+        with Gradebook(self.coursedir.db_url, self.coursedir.course_id) as gb:
+            try:
+                assignment = gb.find_assignment(self.coursedir.assignment_id)
+                self.duedate = assignment.duedate
+            except MissingEntry:
+                self.duedate = None
+        if self.duedate is None or not self.before_duedate:
+            self.src_records = [self._sort_by_timestamp(v)[0] for v in usergroups.values()]
+        else:
+            self.src_records = []
+            for v in usergroups.values():
+                records = self._sort_by_timestamp(v)
+                records_before_duedate = [record for record in records if record['timestamp'] <= self.duedate]
+                if records_before_duedate:
+                    self.src_records.append(records_before_duedate[0])
+                else:
+                    self.src_records.append(records[0])
 
     def init_dest(self):
         pass
@@ -108,6 +132,10 @@ def copy_files(self):
                 if self.update and (existing_timestamp is None or new_timestamp > existing_timestamp):
                     copy = True
                     updating = True
+                elif self.before_duedate and existing_timestamp != new_timestamp:
+                    copy = True
+                    updating = True
+
             else:
                 copy = True
 

nbgrader/tests/apps/test_nbgrader_collect.py

@@ -1,3 +1,4 @@
+import datetime
 import os
 import time
 import pytest
@@ -7,6 +8,7 @@
 from .. import run_nbgrader
 from .base import BaseTestApp
 from .conftest import notwindows
+from ...api import Gradebook
 from ...utils import parse_utc, get_username
 
 
@@ -151,3 +153,45 @@ def test_permissions(self, exchange, course_dir, cache, groupshared):
         assert self._get_permissions(join(exchange, "abc101", "inbound")) == ("2733" if not groupshared else "2773")
         assert self._get_permissions(join(course_dir, "submitted", "foobar_student", "ps1")) == ("777" if not groupshared else "2777")
         assert self._get_permissions(join(course_dir, "submitted", "foobar_student", "ps1", "p1.ipynb")) == ("644" if not groupshared else "664")
+
+    @pytest.mark.parametrize('before_duedate',
+                              ['yes', 'no', 'nofirst'])
+    def test_collect_before_due_date(self, exchange, course_dir, cache, db, before_duedate):
+        """Test --before-duedate flag.
+
+        Test is parameterized so we test both with it and without the flag.
+
+        'yes': test with --before-duedate
+        'no': test without
+        'nofirst': test with --before-duedate but no assignment before duedate
+
+        """
+        # Release assignment
+        self._release_and_fetch("ps1", exchange, course_dir)
+
+        # Submit something, wait, submit again.  Due date is between.
+        if before_duedate != 'nofirst':
+            # We don't submit first assignment.
+            self._submit("ps1", exchange, cache)
+            time.sleep(.05)
+        time_duedate = datetime.datetime.utcnow()
+        time.sleep(.05)
+        self._submit("ps1", exchange, cache)
+
+        # Set the due date
+        with Gradebook(db) as gb:
+            gb.update_or_create_assignment('ps1', duedate=time_duedate)
+
+        # Collect
+        flags = ['--db', db]
+        if before_duedate != 'no':
+            flags.append('--before-duedate')
+        self._collect("ps1", exchange, flags=flags)
+
+        root = os.path.os.path.join(os.path.join(course_dir, "submitted", get_username(), "ps1"))
+        timestamp = self._read_timestamp(root)
+        # Test both ways: with --before-duedate flag and without
+        if before_duedate == 'yes':
+            assert timestamp < time_duedate
+        else: # 'no', 'nofirst'
+            assert timestamp > time_duedate