Add tests for find_assignments and find_notebooks

Author: shreve

nbgrader/coursedir.py

@@ -361,7 +361,7 @@ def find_assignments(self,
         # Locate all matching directories using a glob
         dirs = list(
             filter(
-                lambda p: p.is_dir() and not is_ignored(p.name, self.ignore),
+                lambda p: p.is_dir() and not is_ignored(p.relative_to(self.root), self.ignore),
                 Path(self.root).glob(self.directory_structure.format(**kwargs))
             )
         )
@@ -385,7 +385,7 @@ def find_assignments(self,
         for dir in dirs:
             match = re.match(pattern, str(dir.relative_to(self.root)))
             if match:
-                results.append({ **kwargs, **match.groupdict() })
+                results.append({ **kwargs, **match.groupdict(), 'path': dir })
 
         return results
 
@@ -436,7 +436,7 @@ def find_notebooks(
         }
 
         # Convert to a Path and back to a string to remove any instances of `/.`
-        pattern = str(Path(pattern.format(**pattern_args)))
+        pattern = str(Path(pattern.replace(".", r"\.").format(**pattern_args)))
 
         if sys.platform == 'win32':
             # Escape backslashes on Windows
@@ -445,7 +445,7 @@ def find_notebooks(
         for file in files:
             match = re.match(pattern, str(file.relative_to(self.root)))
             if match:
-                results.append({ **kwargs, **match.groupdict(), "path": file})
+                results.append({ **kwargs, **match.groupdict(), "path": file })
 
         return results
 

nbgrader/tests/test_coursedir.py

@@ -7,17 +7,24 @@
 
 from nbgrader.coursedir import CourseDirectory
 
+def pluck(key, collection):
+    return sorted([x[key] for x in collection], key=lambda x: x)
+
+def touch(path):
+    path.parent.mkdir(parents=True, exist_ok=True)
+    path.touch()
+
 @pytest.mark.parametrize("root", [
     None, # Keep the course_dir fixture
     os.path.sep + "[special]~root",
     "C:\\Users\\Student",
 ])
 def test_coursedir_format_path(course_dir, root):
-    conf = Config()
+    config = Config()
     if root is None:
         root = course_dir
-    conf.CourseDirectory.root = root
-    coursedir = CourseDirectory(config=conf)
+    config.CourseDirectory.root = root
+    coursedir = CourseDirectory(config=config)
 
     # The default includes the un-escaped root
     path = os.path.join(coursedir.root, "step", "student_id", "assignment1")
@@ -37,3 +44,76 @@ def test_coursedir_format_path(course_dir, root):
     match = re.match(actual, path)
     assert match is not None
     assert match.group("assignment_id") == "assignment1"
+
+def test_find_assignments(course_dir):
+    config = Config({"CourseDirectory": {"root": course_dir}})
+    coursedir = CourseDirectory(config=config)
+
+    root = Path(coursedir.root)
+
+    root.joinpath("source", ".", "assn").mkdir(parents=True)
+    root.joinpath("release", ".", "assn").mkdir(parents=True)
+    root.joinpath("submitted", "student1", "assn").mkdir(parents=True)
+    root.joinpath("submitted", "student2", "assn").mkdir(parents=True)
+    root.joinpath("autograded", "student1", "assn").mkdir(parents=True)
+    root.joinpath("autograded", "student2", "assn").mkdir(parents=True)
+    root.joinpath("feedback", "student1", "assn").mkdir(parents=True)
+    root.joinpath("feedback", "student2", "assn").mkdir(parents=True)
+
+
+    assert pluck("assignment_id", coursedir.find_assignments("source", ".")) == [
+        "assn",
+    ]
+
+    assert pluck("student_id", coursedir.find_assignments("submitted")) == [
+        "student1", "student2",
+    ]
+
+    assert pluck("nbgrader_step", coursedir.find_assignments(student_id="student1")) == [
+        "autograded", "feedback", "submitted",
+    ]
+
+    # Finding by assignment has the shortcoming of not being able to find across
+    # student_id="." and student_id="*" at the same time.
+    assn = coursedir.find_assignments(assignment_id="assn", student_id=".")
+    assert pluck("nbgrader_step", assn) == ["release", "source"]
+
+    assn = coursedir.find_assignments(assignment_id="assn")
+    assert pluck("nbgrader_step", assn) == [
+        "autograded", "autograded", "feedback", "feedback", "submitted", "submitted",
+    ]
+
+def test_find_notebooks(course_dir):
+    config = Config({"CourseDirectory": {"root": course_dir}})
+    coursedir = CourseDirectory(config=config)
+
+    root = Path(coursedir.root)
+
+    touch(root.joinpath("source", ".", "assn", "assn.ipynb"))
+    touch(root.joinpath("release", ".", "assn", "assn.ipynb"))
+    touch(root.joinpath("submitted", "student1", "assn", "assn.ipynb"))
+    touch(root.joinpath("submitted", "student2", "assn", "assn.ipynb"))
+    touch(root.joinpath("autograded", "student1", "assn", "assn.ipynb"))
+    touch(root.joinpath("autograded", "student2", "assn", "assn.ipynb"))
+    touch(root.joinpath("feedback", "student1", "assn", "assn.html"))
+    touch(root.joinpath("feedback", "student2", "assn", "assn.html"))
+
+    assert pluck("ext", coursedir.find_notebooks(assignment_id="assn", ext="*")) == [
+        "html",
+        "html",
+        "ipynb",
+        "ipynb",
+        "ipynb",
+        "ipynb",
+    ]
+
+
+    # By default, we only look for .ipynb files
+    assert pluck("nbgrader_step", coursedir.find_notebooks(student_id="student1")) == [
+        "autograded", "submitted",
+    ]
+
+    assert pluck("nbgrader_step", coursedir.find_notebooks(student_id="student1", ext="*")) == [
+        "autograded", "feedback", "submitted",
+    ]
+