add nox task to verify dependency declarations

exasol/toolbox/nox/_dependencies_check.py

@@ -0,0 +1,71 @@
+import tomlkit
+import sys
+from pathlib import Path
+import nox
+from nox import Session
+from noxconfig import PROJECT_CONFIG
+from typing import List
+
+
+FILTERS = ['url', 'git', 'path']
+
+
+@nox.session(name="dependencies-check", python=False)
+def dependency_check(session: Session) -> None:
+    file = Path(PROJECT_CONFIG.root, "pyproject.toml")
+    output = _dependencies_check(file.read_text())
+    print("\033[31m"+output) if output else print("\033[32m"+"Success: no wrong dependencies found")
+    sys.exit(0 if not output else 1)
+
+
+def _source_filter(version, filters) -> bool:
+    for f in filters:
+        if f in version:
+            return True
+    return False
+
+
+def extract_dependencies(section, filters) -> List[str]:
+    dependencies = []
+    for name, version in section.items():
+        if _source_filter(version, filters):
+            dependencies.append(f"{name} = {version}")
+    return dependencies
+
+
+def _dependencies_check(string: str) -> str:
+    toml = tomlkit.loads(string)
+    group_dependencies = {}
+
+    poetry = toml.get("tool", {}).get("poetry", {})
+
+    dependencies = extract_dependencies(poetry.get("dependencies", {}), FILTERS)
+
+    dev_section = poetry.get("dev", {}).get("dependencies", {})
+    dev_dependencies = extract_dependencies(dev_section, FILTERS)
+
+    group_section = poetry.get("group", {})
+    for group, content in group_section.items():
+        group_deps = extract_dependencies(content.get("dependencies", {}), FILTERS)
+        if group_deps:
+            group_key = f'[tool.poetry.group.{group}.dependencies]'
+            group_dependencies[group_key] = group_deps
+
+    total_count = len(dependencies) + len(dev_dependencies) + sum(len(deps) for deps in group_dependencies.values())
+    if total_count > 0:
+        suffix = "y" if total_count == 1 else "ies"
+        output = [f"{total_count} illegal dependenc{suffix}:\n"]
+
+        if dependencies:
+            output.append(f"\n[tool.poetry.dependencies]\n" + "\n".join(dependencies) + "\n")
+        if dev_dependencies:
+            output.append(f"\n[tool.poetry.dev.dependencies]\n" + "\n".join(dev_dependencies) + "\n")
+        for key, value in group_dependencies.items():
+            output.append(f"\n{key}\n" + "\n".join(value) + "\n")
+
+        return "".join(output)
+    return ""
+
+
+if __name__ == "__main__":
+    print(_dependencies_check(Path("pyproject.toml").read_text()))

exasol/toolbox/nox/tasks.py

@@ -51,6 +51,9 @@
     integration_tests,
     unit_tests,
 )
+from exasol.toolbox.nox._dependencies_check import (
+    dependency_check
+)
 from noxconfig import PROJECT_CONFIG
 
 

test/unit/dependencies_check_test.py

@@ -0,0 +1,80 @@
+from tomlkit import loads
+import pytest
+from exasol.toolbox.nox._dependencies_check import (
+    _source_filter,
+    _dependencies_check
+)
+
+
+@pytest.mark.parametrize(
+    "filters,source,expected",
+    [
+        (
+                ['url', 'git', 'path'],
+                """example-url = {url = "https://example.com/my-package-0.1.0.tar.gz"}""",
+                'url'),
+        (
+                ['url', 'git', 'path'],
+                """example-git = {git = "[email protected]:requests/requests.git"}""",
+                'git'),
+        (
+                ['url', 'git', 'path'],
+                """example-path = {path = "../my-package/dist/my-package-0.1.0.tar.gz"}""",
+                'path'),
+        (
+                ['url', 'git', 'path'],
+                """example-url = {platform = "darwin", url = "https://example.com/my-package-0.1.0.tar.gz"}""",
+                'url'),
+        (
+                ['url', 'git', 'path'],
+                """example = "^2.31.0.6" """,
+                None),
+        (
+                ['url', 'git', 'path'],
+                """python = ">=3.8.0,<4.0" """,
+                None
+        )
+    ]
+)
+def test_dependencies_check(filters, source, expected):
+    for _, version in loads(source).items():
+        assert _source_filter(version, filter) == expected
+
+
+@pytest.mark.parametrize(
+    "toml, expected",
+    [
+        (
+                """[tool.poetry.dependencies]
+python = "^3.8"
+example-url = {url = "https://example.com/my-package-0.1.0.tar.gz"}
+
+[tool.poetry.dev.dependencies]
+nox = ">=2022.8.7"
+
+[tool.poetry.group.test.dependencies]
+sphinx = ">=5.3,<8"
+example-git = {git = "[email protected]:requests/requests.git"}
+
+[tool.poetry.group.dev.dependencies]
+pytest = ">=7.2.2,<9"
+example-path1 = {path = "../my-package/dist/my-package-0.1.0.tar.gz"}
+example-path2 = {path = "../my-package/dist/my-package-0.2.0.tar.gz"}
+""",
+                """4 illegal dependencies:
+
+[tool.poetry.dependencies]
+example-url = {'url': 'https://example.com/my-package-0.1.0.tar.gz'}
+
+[tool.poetry.group.test.dependencies]
+example-git = {'git': '[email protected]:requests/requests.git'}
+
+[tool.poetry.group.dev.dependencies]
+example-path1 = {'path': '../my-package/dist/my-package-0.1.0.tar.gz'}
+example-path2 = {'path': '../my-package/dist/my-package-0.2.0.tar.gz'}
+"""
+        ),
+    ]
+)
+def test_dependencies_check(toml, expected):
+    assert _dependencies_check(toml) == expected