pbx-code-owners 1.0.0a4__tar.gz

pbx_code_owners-1.0.0a4/PKG-INFO

@@ -0,0 +1,9 @@
+Metadata-Version: 2.1
+Name: pbx-code-owners
+Version: 1.0.0a4
+Home-page: https://getprintbox.com/
+Author: 
+Author-email: 
+Requires-Python: >=3.8
+Requires-Dist: pyyaml
+Requires-Dist: requests

pbx_code_owners-1.0.0a4/README.md

@@ -0,0 +1,8 @@
+# Sample GitLab Project
+
+This sample project shows how a project in GitLab looks for demonstration purposes. It contains issues, merge requests and Markdown files in many branches,
+named and filled with lorem ipsum.
+
+You can look around to get an idea how to structure your project and, when done, you can safely delete this project.
+
+[Learn more about creating GitLab projects.](https://docs.gitlab.com/ee/gitlab-basics/create-project.html)

pbx_code_owners-1.0.0a4/code_owners/__init__.py

@@ -0,0 +1 @@
+from .parser import main  # noqa: F401

pbx_code_owners-1.0.0a4/code_owners/config.py

@@ -0,0 +1,17 @@
+import os
+from pathlib import Path
+
+DEFAULT_BRANCH = os.environ.get("DEFAULT_BRANCH", "master")
+CODEOWNERS_FILE = Path(os.getcwd()) / "codeowners.yml"
+
+
+CI_SERVER_URL = os.environ["CI_SERVER_URL"]
+CI_PROJECT_ID = os.environ["CI_PROJECT_ID"]
+CI_MERGE_REQUEST_IID = os.environ["CI_MERGE_REQUEST_IID"]
+GITLAB_TOKEN = os.environ["MR_QA_GUARD_TOKEN"]
+
+
+GITLAB_DISCUSSIONS_URL = (
+    f"{CI_SERVER_URL}/api/v4/projects/{CI_PROJECT_ID}"
+    f"/merge_requests/{CI_MERGE_REQUEST_IID}/discussions"
+)

pbx_code_owners-1.0.0a4/code_owners/parser.py

@@ -0,0 +1,80 @@
+import subprocess  # nosec
+
+import requests
+import yaml
+
+from code_owners import config
+
+
+def load_codeowners() -> dict:
+    with open(config.CODEOWNERS_FILE) as file:
+        return yaml.safe_load(file)
+
+
+def get_changed_paths() -> list[str]:
+    subprocess.run(["git", "fetch", "origin", "master:master"])  # nosec
+    git_diff = subprocess.run(  # nosec
+        ["git", "diff", "--name-only", config.DEFAULT_BRANCH], stdout=subprocess.PIPE
+    )
+    return git_diff.stdout.decode().splitlines()
+
+
+def match_any_path(sub_paths: list[str], base_paths: list[str]) -> bool:
+    # TODO: implement wildcards
+    matched_paths = (
+        sub_path
+        for sub_path in sub_paths
+        for base_path in base_paths
+        if sub_path.startswith(base_path)
+    )
+    try:
+        next(matched_paths)
+    except StopIteration:
+        return False
+    return True
+
+
+def discussion_exists(content: str) -> bool:
+    url = config.GITLAB_DISCUSSIONS_URL
+    headers = {"PRIVATE-TOKEN": config.GITLAB_TOKEN}
+    resp = requests.get(url, headers=headers, timeout=(3, 30))
+    resp.raise_for_status()
+    discussions = resp.json()
+    filtered_discussions = (
+        discussion
+        for discussion in discussions
+        if discussion["notes"][0]["body"] == content
+    )
+    try:
+        next(filtered_discussions)
+    except StopIteration:
+        return False
+    return True
+
+
+def notify_owner(owner: str, section_name: str) -> None:
+    content = f'Section "{section_name}" requires {owner} approval'
+    if discussion_exists(content):
+        return
+
+    url = config.GITLAB_DISCUSSIONS_URL
+    headers = {"PRIVATE-TOKEN": config.GITLAB_TOKEN}
+    resp = requests.post(url, headers=headers, json={"body": content}, timeout=(3, 30))
+    resp.raise_for_status()
+
+
+def main() -> None:
+    codeowners = load_codeowners()
+    changed_paths = get_changed_paths()
+    if not changed_paths:
+        print("No changes, checking codeowners stopped")
+        return
+
+    for section in codeowners["sections"]:
+        if "." in section["paths"] or match_any_path(changed_paths, section["paths"]):
+            for owner in section["owners"]:
+                notify_owner(owner, section["name"])
+
+
+if __name__ == "__main__":
+    main()

pbx_code_owners-1.0.0a4/pbx_code_owners.egg-info/PKG-INFO

@@ -0,0 +1,9 @@
+Metadata-Version: 2.1
+Name: pbx-code-owners
+Version: 1.0.0a4
+Home-page: https://getprintbox.com/
+Author: 
+Author-email: 
+Requires-Python: >=3.8
+Requires-Dist: pyyaml
+Requires-Dist: requests

pbx_code_owners-1.0.0a4/pbx_code_owners.egg-info/SOURCES.txt

@@ -0,0 +1,13 @@
+README.md
+setup.cfg
+setup.py
+code_owners/__init__.py
+code_owners/config.py
+code_owners/parser.py
+pbx_code_owners.egg-info/PKG-INFO
+pbx_code_owners.egg-info/SOURCES.txt
+pbx_code_owners.egg-info/dependency_links.txt
+pbx_code_owners.egg-info/entry_points.txt
+pbx_code_owners.egg-info/requires.txt
+pbx_code_owners.egg-info/top_level.txt
+tests/tests.py

pbx_code_owners-1.0.0a4/pbx_code_owners.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

pbx_code_owners-1.0.0a4/pbx_code_owners.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+pbx-code-owners = code_owners:main

pbx_code_owners-1.0.0a4/pbx_code_owners.egg-info/requires.txt

@@ -0,0 +1,2 @@
+pyyaml
+requests

pbx_code_owners-1.0.0a4/pbx_code_owners.egg-info/top_level.txt

@@ -0,0 +1 @@
+code_owners

pbx_code_owners-1.0.0a4/setup.cfg

@@ -0,0 +1,25 @@
+[bumpversion]
+current_version = 1.0.0
+commit = True
+tag = True
+
+[bumpversion:file:setup.py]
+
+[coverage:run]
+include = code_owners/*
+omit = */tests.py,*/tests/*.py
+
+[flake8]
+exclude = .git,__pycache
+max-line-length = 96
+
+[isort]
+profile = black
+default_section = THIRDPARTY
+known_first_party = code_owners
+sections = FUTURE,STDLIB,THIRDPARTY,FIRSTPARTY,LOCALFOLDER
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

pbx_code_owners-1.0.0a4/setup.py

@@ -0,0 +1,23 @@
+from setuptools import find_packages, setup
+
+setup(
+    name="pbx-code-owners",
+    version="1.0.0a4",
+    packages=find_packages(exclude=["tests*"]),
+    url="https://getprintbox.com/",
+    license="",
+    author="",
+    author_email="",
+    description="",
+    install_requires=[
+        "pyyaml",
+        "requests",
+    ],
+    extras_require={},
+    python_requires=">=3.8",
+    entry_points={
+        "console_scripts": [
+            "pbx-code-owners=code_owners:main",
+        ],
+    },
+)

pbx_code_owners-1.0.0a4/tests/tests.py

@@ -0,0 +1,101 @@
+from unittest.mock import ANY, MagicMock, patch
+
+from parameterized import parameterized
+
+from code_owners.parser import discussion_exists, main, notify_owner
+
+
+@parameterized.expand(
+    [
+        ("french_owner", "peugeot"),
+        ("polish_owner", "peugeot_too"),
+        ("polish_owner_too", "bmw"),
+    ]
+)
+@patch("code_owners.parser.requests.post")
+@patch("code_owners.config.GITLAB_DISCUSSIONS_URL", "https://gitlab.test")
+@patch("code_owners.config.GITLAB_TOKEN", "secret_token")
+def test_notify(owner: str, section_name: str, post_mock: MagicMock):
+    with patch("code_owners.parser.discussion_exists", return_value=False):
+        notify_owner(owner, section_name)
+    expected_message = f'Section "{section_name}" requires {owner} approval'
+    post_mock.assert_called_once_with(
+        "https://gitlab.test",
+        headers={"PRIVATE-TOKEN": "secret_token"},
+        json={"body": expected_message},
+        timeout=ANY,
+    )
+
+
+@parameterized.expand(
+    [
+        ("LGTM! :>", True),
+        ("CTZG", False),
+        ("Dzieen bobry", False),
+        ("Dzieen bobry *beaver_emoji*", True),
+    ]
+)
+def test_discussion_exists(searched_content: str, expeted_existence: bool):
+    mocked_reply = [
+        {
+            "id": "105a81c457103110851c7906d6b4424876ec1482",
+            "notes": [{"body": "Hi, have a nice day! :>"}],
+        },
+        {
+            "id": "9472da155271a85072741b27b9364860abc4add1",
+            "notes": [{"body": "Dzieen bobry *beaver_emoji*"}],
+        },
+        {
+            "id": "b4374de03ff500a8a790fe4c993e1c890a821589",
+            "notes": [{"body": "LGTM! :>"}],
+        },
+        {
+            "id": "6c10c938ddc3471c9075072d47d1d8d5938a0aee",
+            "notes": [{"body": 'Section "beer" requires @bald_man approval'}],
+        },
+    ]
+
+    with patch("code_owners.parser.requests.get") as get_mock:
+        get_mock.return_value.json.return_value = mocked_reply
+        assert discussion_exists(searched_content) == expeted_existence
+
+
+def test_code_owners_match():
+    code_owners = {
+        "sections": [
+            {"name": "Code owners", "owners": ["@user_owner"], "paths": ["."]},
+            {"name": "tests", "owners": ["@user_a"], "paths": ["tests/"]},
+            {"name": "config", "owners": ["@user_b"], "paths": ["config/config.py"]},
+            {
+                "name": "compose",
+                "owners": ["@user_c", "@user_d"],
+                "paths": ["docker/compose.yaml"],
+            },
+            {"name": "dependencies", "owners": ["@user_a"], "paths": ["requirements/"]},
+        ]
+    }
+    changed_paths = [
+        "path/to/file.py",
+        "urls.py",
+        "tests/tests.py",
+        "config/config-dev.py",
+        "docker/compose.yaml",
+        "requirements/requirements.txt",
+    ]
+
+    with patch(
+        "code_owners.parser.get_changed_paths", return_value=changed_paths
+    ), patch("code_owners.parser.load_codeowners", return_value=code_owners), patch(
+        "code_owners.parser.notify_owner"
+    ) as notify_owner_mock:
+        main()
+
+    assert notify_owner_mock.call_count == 5
+    for owner, section in (
+        ("@user_owner", "Code owners"),
+        ("@user_a", "tests"),
+        ("@user_c", "compose"),
+        ("@user_d", "compose"),
+        ("@user_a", "dependencies"),
+    ):
+        notify_owner_mock.assert_any_call(owner, section)