TST/DOC: add tests and docstring for OnyoRepo.validate_anchors()

onyo/lib/onyo.py

@@ -424,8 +424,12 @@ def get_template_file(self,
 
     def validate_anchors(self) -> bool:
         """
-        Check if all dirs (except those in .onyo) contain an .anchor file.
-        Returns True or False.
+        Check if all dirs (except those in `.onyo/`) contain an .anchor file.
+
+        Returns
+        -------
+        boolean
+            True if all directories contain an `.anchor` file, otherwise False.
         """
         # Note: First line not using protected_paths, because `.anchor` is part
         #       of it. But ultimately, exist vs expected should take the same

onyo/lib/tests/test_onyo.py

@@ -145,3 +145,22 @@ def test_Repo_get_template_file(repo: OnyoRepo) -> None:
     # does not exist
     with pytest.raises(ValueError):
         repo.get_template_file('I DO NOT EXIST')
+
+
+@pytest.mark.repo_dirs('a/test/directory/structure/',
+                       'another/dir/')
+def test_Repo_validate_anchors(repo: OnyoRepo) -> None:
+    """
+    `OnyoRepo.validate_anchors()` must return True when all existing directories
+    have an `.anchor` file, and otherwise False.
+    """
+    # Must be true for valid repository
+    assert repo.validate_anchors()
+
+    # Delete an .anchor, commit changes, reload object
+    Path.unlink(repo.git.root / "a" / "test" / ".anchor")
+    repo.git.stage_and_commit(repo.git.root / "a" / "test" / ".anchor", "TEST")
+    repo = OnyoRepo(repo.git.root)
+
+    # Must return False, because an .anchor is missing
+    assert not repo.validate_anchors()