Fix issue in _deny_filter (#165)

Author: Nicoretti

doc/changes/unreleased.md

@@ -8,6 +8,7 @@
     The CI-CD workflow now assumes the changelog to be in markdown and the location `/doc/changes/change_x.y.z.md`
 
 ## 🐞 Fixed
+* Fixed `_deny_filter` function in `exasol.toolbox._shared` module
 * Fixed GitHub workflow references in `ci.yml`, ci-cd.yml` and `pr-merge.yml` workflows
 * Fixed indent error/issue in `checks.yml` workflow
 

exasol/toolbox/nox/_shared.py

@@ -40,14 +40,9 @@ def _python_files(
 def _deny_filter(files: Iterable[Path], deny_list: Iterable[str]) -> Iterable[Path]:
     """
     Adds a filter to remove unwanted paths containing python files from the iterator.
-
-     args:
-
-
-     return:
     """
     for entry in deny_list:
-        files = filter(lambda path: entry not in path.parts, files)
+        files = list(filter(lambda path: entry not in path.parts, files))
     return files
 
 

exasol/toolbox/tools/issue.py

@@ -1,7 +1,8 @@
 from pathlib import Path
+
 import typer
-from exasol.toolbox.tools import template
 
+from exasol.toolbox.tools import template
 
 CLI = typer.Typer()
 PKG = "exasol.toolbox.templates.github.ISSUE_TEMPLATE"
@@ -24,7 +25,9 @@ def show_issue(
     issue: str = typer.Argument(..., help="issue which shall be shown."),
 ) -> None:
     """Shows a specific issue."""
-    template.show_templates(template=issue, pkg=PKG, template_type=TEMPLATE_TYPE, lexer=LEXER)
+    template.show_templates(
+        template=issue, pkg=PKG, template_type=TEMPLATE_TYPE, lexer=LEXER
+    )
 
 
 @CLI.command(name="diff")
@@ -36,36 +39,44 @@ def diff_issue(
     ),
 ) -> None:
     """Diff a specific issue against the installed one."""
-    template.diff_template(template=issue, dest=dest, pkg=PKG, template_type=TEMPLATE_TYPE)
+    template.diff_template(
+        template=issue, dest=dest, pkg=PKG, template_type=TEMPLATE_TYPE
+    )
 
 
 @CLI.command(name="install")
 def install_issue(
     issue: str = typer.Argument("all", help="name of the issue to install."),
     dest: Path = typer.Argument(
-        Path("./.github/ISSUE_TEMPLATE"), help="target directory to install the issue to."
+        Path("./.github/ISSUE_TEMPLATE"),
+        help="target directory to install the issue to.",
     ),
 ) -> None:
     """
     Installs the requested issue into the target directory.
 
     Attention: If there is an existing issue with the same name it will be overwritten!
     """
-    template.install_template(template=issue, dest=dest, pkg=PKG, template_type=TEMPLATE_TYPE)
+    template.install_template(
+        template=issue, dest=dest, pkg=PKG, template_type=TEMPLATE_TYPE
+    )
 
 
 @CLI.command(name="update")
 def update_issue(
     issue: str = typer.Argument("all", help="name of the issue to install."),
     dest: Path = typer.Argument(
-        Path("./.github/ISSUE_TEMPLATE"), help="target directory to install the issue to."
+        Path("./.github/ISSUE_TEMPLATE"),
+        help="target directory to install the issue to.",
     ),
     confirm: bool = typer.Option(
         False, help="Automatically confirm overwritting exsisting issue(s)"
     ),
 ) -> None:
     """Similar to install but checks for existing issues and shows diff"""
-    template.update_template(template=issue, dest=dest, confirm=confirm, pkg=PKG, template_type=TEMPLATE_TYPE)
+    template.update_template(
+        template=issue, dest=dest, confirm=confirm, pkg=PKG, template_type=TEMPLATE_TYPE
+    )
 
 
 if __name__ == "__main__":

exasol/toolbox/tools/template.py

@@ -28,10 +28,7 @@ def _normalize(name: str) -> str:
     return {_normalize(w.name): w for w in resources.files(pkg).iterdir()}
 
 
-def list_templates(
-    columns: bool,
-    pkg: str
-) -> None:
+def list_templates(columns: bool, pkg: str) -> None:
     """List all available templates."""
 
     class List:
@@ -41,7 +38,9 @@ def __init__(self, items: Any):
         def __rich__(self) -> str:
             return "\n".join(self.items)
 
-    output = List(_templates(pkg)) if not columns else Columns(_templates(pkg), expand=True)
+    output = (
+        List(_templates(pkg)) if not columns else Columns(_templates(pkg), expand=True)
+    )
     stdout.print(output)
 
 
@@ -61,12 +60,7 @@ def show_templates(
     stdout.print(Syntax.from_path(path=template, encoding="utf-8", lexer=lexer))  # type: ignore
 
 
-def diff_template(
-    template: str,
-    dest: Path,
-    pkg: str,
-    template_type: str
-) -> None:
+def diff_template(template: str, dest: Path, pkg: str, template_type: str) -> None:
     """Diff a specific template against the installed one."""
     templates = _templates(pkg)
     if template not in templates:
@@ -79,7 +73,9 @@ def diff_template(
             old: Any = dest / f"{template}{path.suffix}"
             new: Any = Path(_templates(pkg)[template])
             with ExitStack() as stack:
-                old = stack.enter_context(open(old, encoding="utf-8") if old.exists() else io.StringIO(""))
+                old = stack.enter_context(
+                    open(old, encoding="utf-8") if old.exists() else io.StringIO("")
+                )
                 new = stack.enter_context(open(new, encoding="utf-8"))
                 old = old.read().split("\n")
                 new = new.read().split("\n")
@@ -90,7 +86,9 @@ def diff_template(
 
 def _install_template(
     template_type: str,
-    src: Union[str, Path], dest: Union[str, Path], exists_ok: bool = False,
+    src: Union[str, Path],
+    dest: Union[str, Path],
+    exists_ok: bool = False,
 ) -> None:
     src, dest = Path(src), Path(dest)
 
@@ -115,12 +113,7 @@ def _select_templates(template: str, pkg: str, template_type: str) -> Mapping[st
     return templates
 
 
-def install_template(
-    template: str,
-    dest: Path,
-    pkg: str,
-    template_type: str
-) -> None:
+def install_template(template: str, dest: Path, pkg: str, template_type: str) -> None:
     """
     Installs the requested template into the target directory.
 
@@ -142,11 +135,7 @@ def install_template(
 
 
 def update_template(
-    template: str,
-    dest: Path,
-    confirm: bool,
-    pkg: str,
-    template_type: str
+    template: str, dest: Path, confirm: bool, pkg: str, template_type: str
 ) -> None:
     """Similar to install but checks for existing templates and shows diff"""
     if not dest.exists():

exasol/toolbox/tools/workflow.py

@@ -1,5 +1,7 @@
 from pathlib import Path
+
 import typer
+
 from exasol.toolbox.tools import template
 
 CLI = typer.Typer()
@@ -23,7 +25,9 @@ def show_workflow(
     workflow: str = typer.Argument(..., help="Workflow which shall be shown."),
 ) -> None:
     """Shows a specific workflow."""
-    template.show_templates(template=workflow, pkg=PKG, template_type=TEMPLATE_TYPE, lexer=LEXER)
+    template.show_templates(
+        template=workflow, pkg=PKG, template_type=TEMPLATE_TYPE, lexer=LEXER
+    )
 
 
 @CLI.command(name="diff")
@@ -35,7 +39,9 @@ def diff_workflow(
     ),
 ) -> None:
     """Diff a specific workflow against the installed one."""
-    template.diff_template(template=workflow, dest=dest, pkg=PKG, template_type=TEMPLATE_TYPE)
+    template.diff_template(
+        template=workflow, dest=dest, pkg=PKG, template_type=TEMPLATE_TYPE
+    )
 
 
 @CLI.command(name="install")
@@ -50,7 +56,9 @@ def install_workflow(
 
     Attention: If there is an existing workflow with the same name it will be overwritten!
     """
-    template.install_template(template=workflow, dest=dest, pkg=PKG, template_type=TEMPLATE_TYPE)
+    template.install_template(
+        template=workflow, dest=dest, pkg=PKG, template_type=TEMPLATE_TYPE
+    )
 
 
 @CLI.command(name="update")
@@ -64,7 +72,13 @@ def update_workflow(
     ),
 ) -> None:
     """Similar to install but checks for existing workflows and shows diff"""
-    template.update_template(template=workflow, dest=dest, confirm=confirm, pkg=PKG, template_type=TEMPLATE_TYPE)
+    template.update_template(
+        template=workflow,
+        dest=dest,
+        confirm=confirm,
+        pkg=PKG,
+        template_type=TEMPLATE_TYPE,
+    )
 
 
 if __name__ == "__main__":

test/unit/deny_filter_test.py

@@ -0,0 +1,43 @@
+import os
+from pathlib import Path
+
+import pytest
+
+from exasol.toolbox.nox._shared import _deny_filter
+
+
+@pytest.fixture
+def directory_tree(tmp_path):
+    directories = {
+        "d1": ["d1-f1.txt", "d1-f2.py"],
+        "d2": ["d2-f1.txt", "d2-f2.py"],
+        ".d3": [".d3-f1.txt", ".d3-f2.py"],
+    }
+    file_list = []
+    for directory, files in directories.items():
+        directory_path = tmp_path / directory
+        directory_path.mkdir()
+        for file_name in files:
+            file_path = directory_path / file_name
+            file_path.touch()
+            file_list.append(file_path)
+
+    yield tmp_path, file_list
+
+
+@pytest.mark.parametrize(
+    "deny_list,expected",
+    [
+        (["d1"], {"d2-f1.txt", "d2-f2.py", ".d3-f1.txt", ".d3-f2.py"}),
+        (["d2"], {"d1-f1.txt", "d1-f2.py", ".d3-f1.txt", ".d3-f2.py"}),
+        ([".d3"], {"d1-f1.txt", "d1-f2.py", "d2-f1.txt", "d2-f2.py"}),
+        (["d1", "d2"], {".d3-f1.txt", ".d3-f2.py"}),
+        (["d2", ".d3"], {"d1-f1.txt", "d1-f2.py"}),
+        (["d1", ".d3"], {"d2-f1.txt", "d2-f2.py"}),
+        (["d1", "d2", ".d3"], set()),
+    ],
+)
+def test_deny_filter(directory_tree, deny_list, expected):
+    _, files = directory_tree
+    actual = {f.name for f in _deny_filter(files, deny_list)}
+    assert actual == expected

test/unit/template_test.py

@@ -1,5 +1,6 @@
-from pathlib import Path
 import os
+from pathlib import Path
+
 import pytest
 
 from exasol.toolbox.tools import template
@@ -41,28 +42,28 @@ def test_retrieve_issue_templates():
     "subpackage,expected",
     [
         (
-                "exasol.toolbox.templates.github.workflows",
-                {
-                    "build-and-publish": "build-and-publish.yml",
-                    "check-release-tag": "check-release-tag.yml",
-                    "checks": "checks.yml",
-                    "ci-cd": "ci-cd.yml",
-                    "ci": "ci.yml",
-                    "gh-pages": "gh-pages.yml",
-                    "pr-merge": "pr-merge.yml",
-                    "report": "report.yml",
-                },
+            "exasol.toolbox.templates.github.workflows",
+            {
+                "build-and-publish": "build-and-publish.yml",
+                "check-release-tag": "check-release-tag.yml",
+                "checks": "checks.yml",
+                "ci-cd": "ci-cd.yml",
+                "ci": "ci.yml",
+                "gh-pages": "gh-pages.yml",
+                "pr-merge": "pr-merge.yml",
+                "report": "report.yml",
+            },
         ),
         (
-                "exasol.toolbox.templates.github.ISSUE_TEMPLATE",
-                {
-                    "blank": "blank.md",
-                    "bug": "bug.md",
-                    "documentation": "documentation.md",
-                    "feature": "feature.md",
-                    "refactoring": "refactoring.md",
-                    "security": "security.md",
-                },
+            "exasol.toolbox.templates.github.ISSUE_TEMPLATE",
+            {
+                "blank": "blank.md",
+                "bug": "bug.md",
+                "documentation": "documentation.md",
+                "feature": "feature.md",
+                "refactoring": "refactoring.md",
+                "security": "security.md",
+            },
         ),
     ],
 )
@@ -78,7 +79,7 @@ def test_retrieve_templates(subpackage, expected):
         (
             "all",
             "exasol.toolbox.templates.github.ISSUE_TEMPLATE",
-    	    "issue",
+            "issue",
             [
                 "blank.md",
                 "bug.md",
@@ -103,7 +104,7 @@ def test_retrieve_templates(subpackage, expected):
                 "report.yml",
             ],
         ),
-    ]
+    ],
 )
 def test_install_templates(templates, pkg, template_type, expected, tmp_path):
     template.install_template(templates, tmp_path, pkg, template_type)