Merge pull request #151 from man-group/bugfix-template-local-dirs

Fix minor bug in template directory argument

Author: jonbannister

CHANGELOG.md

@@ -1,6 +1,7 @@
 0.5.2 (2023-??)
 ------------------
 * Feature: Allow configuring error email addresses via UI. 
+* Bugfix: . and .. should now be allowed to be used when specifying the templates directory.
 
 
 

notebooker/utils/templates.py

@@ -14,7 +14,7 @@
 
 
 def _valid_dirname(d):
-    hidden_dirs = [dir for dir in d.split("/") if dir.startswith(".") and (dir != "." or dir != "..")]
+    hidden_dirs = [dir for dir in d.split("/") if dir.startswith(".") and dir not in {".", ".."}]
     return "__init__" not in d and "__pycache__" not in d and not hidden_dirs
 
 

tests/unit/utils/test_templates.py

@@ -1,11 +1,29 @@
 import os
+import pytest
 import shutil
 import tempfile
 
 from notebooker.utils.filesystem import mkdir_p
+from notebooker.utils.templates import _valid_dirname
 from notebooker.web.utils import get_directory_structure
 
 
+@pytest.mark.parametrize(
+    "input_dirname, expected_result",
+    [
+        ("./my_directory", True),
+        ("../hello_world/a/b/c/", True),
+        (".git/blah", False),
+        ("../.git/hello/world", False),
+        ("normal/path/to/something", True),
+        ("/absolute/path/.git", False),
+        ("/absolute/path/git", True),
+    ],
+)
+def test_valid_dirnames(input_dirname, expected_result):
+    assert _valid_dirname(input_dirname) is expected_result
+
+
 def test_get_directory_structure():
     temp_dir = tempfile.mkdtemp()
     try:
@@ -23,7 +41,7 @@ def test_get_directory_structure():
             ".hidden/visible/5.ipynb",
             ".hidden/.more-hidden/6.ipynb",
             "./visible/7.ipynb",
-            "this/is/../is/8.ipynb"
+            "this/is/../is/8.ipynb",
         ]
         for path in paths:
             abspath = os.path.join(temp_dir, path)
@@ -35,7 +53,10 @@ def test_get_directory_structure():
             "hello": None,
             "goodbye": None,
             "depth": {"depth/1": None, "depth/2": None, "depth/3": None},
-            "this": {"this/report": None, "is": {"this/is/8": None, "this/is/deep": None, "very": {"this/is/very/deep": None}}},
+            "this": {
+                "this/report": None,
+                "is": {"this/is/8": None, "this/is/deep": None, "very": {"this/is/very/deep": None}},
+            },
             "hello_again": None,
             "visible": {"visible/7": None},
         }