fix: stricter check for "tests" and "docs" directories in sp-repo-review (#527)

* Stricter test for "docs" folder

* Stricter checks for existence of "tests" directory

* Updated directory name "test" => "tests" in test_py005_src test.

* style: pre-commit fixes

* Slightly more lenient check for "tests" directory.
Also added some extra unit tests for the Py004 and Py005 checks.

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: ukmo-ccbunney

src/sp_repo_review/checks/general.py

@@ -65,7 +65,9 @@ class PY004(General):
     @staticmethod
     def check(package: Traversable) -> bool:
         "Projects must have documentation in a folder called docs (disable if not applicable)"
-        return len([p for p in package.iterdir() if "doc" in p.name]) > 0
+        return (
+            len([p for p in package.iterdir() if p.is_dir() and p.name == "docs"]) > 0
+        )
 
 
 class PY005(General):
@@ -75,9 +77,18 @@ class PY005(General):
 
     @staticmethod
     def check(package: Traversable) -> bool:
-        "Projects must have a folder called `*test*` or `src/*/*test*`"
+        "Projects must have a folder called `test*` or `src/*/test*`"
         # Out-of-source tests
-        if len([p for p in package.iterdir() if "test" in p.name]) > 0:
+        if (
+            len(
+                [
+                    p
+                    for p in package.iterdir()
+                    if p.is_dir() and p.name.startswith("test")
+                ]
+            )
+            > 0
+        ):
             return True
 
         # In-source tests
@@ -86,7 +97,14 @@ def check(package: Traversable) -> bool:
             for pkg in src.iterdir():
                 if (
                     pkg.is_dir()
-                    and len([p for p in pkg.iterdir() if "test" in p.name]) > 0
+                    and len(
+                        [
+                            p
+                            for p in pkg.iterdir()
+                            if p.is_dir() and p.name.startswith("test")
+                        ]
+                    )
+                    > 0
                 ):
                     return True
         return False

tests/test_general.py

@@ -54,6 +54,13 @@ def test_py004(tmp_path: Path):
     assert compute_check("PY004", package=simple).result
 
 
+def test_py004_not_dir(tmp_path: Path):
+    simple = tmp_path / "simple"
+    simple.mkdir()
+    simple.joinpath("docs")
+    assert not compute_check("PY004", package=simple).result
+
+
 def test_py004_missing(tmp_path: Path):
     simple = tmp_path / "simple"
     simple.mkdir()
@@ -67,6 +74,34 @@ def test_py005(tmp_path: Path):
     assert compute_check("PY005", package=simple).result
 
 
+def test_py005_alt_singular(tmp_path: Path):
+    simple = tmp_path / "simple"
+    simple.mkdir()
+    simple.joinpath("test").mkdir()
+    assert compute_check("PY005", package=simple).result
+
+
+def test_py005_alt_integration(tmp_path: Path):
+    simple = tmp_path / "simple"
+    simple.mkdir()
+    simple.joinpath("tests-integration").mkdir()
+    assert compute_check("PY005", package=simple).result
+
+
+def test_py005_not_folder(tmp_path: Path):
+    simple = tmp_path / "simple"
+    simple.mkdir()
+    simple.joinpath("tests")
+    assert not compute_check("PY005", package=simple).result
+
+
+def test_py005_not_tests(tmp_path: Path):
+    simple = tmp_path / "simple"
+    simple.mkdir()
+    simple.joinpath("fastest").mkdir()
+    assert not compute_check("PY005", package=simple).result
+
+
 def test_py005_missing(tmp_path: Path):
     simple = tmp_path / "simple"
     simple.mkdir()
@@ -80,7 +115,7 @@ def test_py005_src(tmp_path: Path):
     src.mkdir()
     pkg = src.joinpath("pkg")
     pkg.mkdir()
-    pkg.joinpath("test").mkdir()
+    pkg.joinpath("tests").mkdir()
     assert compute_check("PY005", package=simple).result