gitlabform 3.9.0__tar.gz → 3.9.2__tar.gz

{gitlabform-3.9.0 → gitlabform-3.9.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: gitlabform
-Version: 3.9.0
+Version: 3.9.2
 Summary: 🏗 Specialized configuration as a code tool for GitLab projects, groups and more using hierarchical configuration written in YAML
 Home-page: https://gitlabform.github.io/gitlabform
 Author: Greg Dubicki and Contributors
@@ -28,22 +28,22 @@ Requires-Dist: Jinja2==3.1.3
 Requires-Dist: luddite==1.0.2
 Requires-Dist: MarkupSafe==2.1.5
 Requires-Dist: mergedeep==1.3.4
-Requires-Dist: packaging==23.2
+Requires-Dist: packaging==24.0
 Requires-Dist: python-gitlab==4.4.0
 Requires-Dist: requests==2.31.0
 Requires-Dist: ruamel.yaml==0.17.21
-Requires-Dist: types-requests==2.31.0.20240125
+Requires-Dist: types-requests==2.31.0.20240311
 Requires-Dist: yamlpath==3.8.2
 Provides-Extra: test
-Requires-Dist: coverage==7.4.1; extra == "test"
-Requires-Dist: cryptography==42.0.2; extra == "test"
+Requires-Dist: coverage==7.4.4; extra == "test"
+Requires-Dist: cryptography==42.0.5; extra == "test"
 Requires-Dist: deepdiff==6.7.1; extra == "test"
-Requires-Dist: mypy==1.8.0; extra == "test"
+Requires-Dist: mypy==1.9.0; extra == "test"
 Requires-Dist: mypy-extensions==1.0.0; extra == "test"
 Requires-Dist: pre-commit==2.21.0; extra == "test"
-Requires-Dist: pytest==7.4.4; extra == "test"
-Requires-Dist: pytest-cov==4.1.0; extra == "test"
-Requires-Dist: pytest-rerunfailures==13.0; extra == "test"
+Requires-Dist: pytest==8.1.1; extra == "test"
+Requires-Dist: pytest-cov==5.0.0; extra == "test"
+Requires-Dist: pytest-rerunfailures==14.0; extra == "test"
 Requires-Dist: xkcdpass==1.19.8; extra == "test"
 Provides-Extra: docs
 Requires-Dist: mkdocs; extra == "docs"

{gitlabform-3.9.0 → gitlabform-3.9.2}/gitlabform/lists/projects.py

@@ -1,4 +1,4 @@
-from typing import Tuple
+from typing import Optional, Tuple
 from logging import debug
 from cli_ui import fatal
 
@@ -50,27 +50,19 @@ class ProjectsProvider(GroupsProvider):
 
         except NotFoundException:
             debug("Could not find '%s'", target)
-            debug(
-                "Checking if it's a project that needs to be transferred from elsewhere"
-            )
-            project_transfer_source = self.configuration.config["projects_and_groups"][
+            if project_transfer_source := self._get_project_transfer_source_from_config(
                 target
-            ]["project"]["transfer_from"]
-
-            if project_transfer_source:
-                try:
-                    maybe_project = self.gitlab.get_project_case_insensitive(
-                        project_transfer_source
-                    )
-                    debug(
-                        "Found a project '%s' to be transferred to '%s'",
-                        maybe_project["path_with_namespace"],
-                        target,
-                    )
+            ):
+                if self._find_project_transfer_source_in_gitlab(
+                    project_transfer_source
+                ):
                     projects.add_requested([target])
-                except NotFoundException:
-                    # it's a group or a subgroup - ignore it here
-                    pass
+                else:
+                    fatal(
+                        f"""Configuration contains project {target} to be transferred from {project_transfer_source}
+                            but the source project cannot be found in GitLab!""",
+                        exit_code=EXIT_INVALID_INPUT,
+                    )
 
         return projects
 
@@ -85,21 +77,19 @@ class ProjectsProvider(GroupsProvider):
         projects.add_requested(projects_from_groups)
         projects.add_omitted(OmissionReason.ARCHIVED, archived_projects_from_groups)
 
-        if target == "ALL_DEFINED":
-            # in this case we also need to get the list of projects explicitly
-            # defined in the configuration
-
-            projects_from_configuration = self.configuration.get_projects()
+        projects_from_configuration = self.configuration.get_projects()
 
-            # ...but we don't need to re-check for being archived projects that we
-            # already got from groups
+        # TODO: this check should be case-insensitive
+        projects_from_configuration_not_from_groups = [
+            project
+            for project in projects_from_configuration
+            if project not in projects.requested
+        ]
 
-            # TODO: this check should be case-insensitive
-            projects_from_configuration_not_from_groups = [
-                project
-                for project in projects_from_configuration
-                if project not in projects.requested
-            ]
+        if target == "ALL_DEFINED":
+            # in this case we also need to get the list of projects explicitly
+            # defined in the configuration, but we don't need to re-check for
+            # being archived projects that we already got from groups
 
             archived_projects_from_configuration_not_from_groups = (
                 self._verify_if_projects_exist_and_get_archived_projects(
@@ -112,6 +102,26 @@ class ProjectsProvider(GroupsProvider):
                 OmissionReason.ARCHIVED,
                 archived_projects_from_configuration_not_from_groups,
             )
+        else:
+            # in all other cases, we also need to look for projects in the config
+            # that are being transferred to a different namespace
+            for project in projects_from_configuration_not_from_groups:
+                # if the target is a group, and the project is not in the group
+                if (
+                    len(groups.get_effective()) == 1
+                    and target != "ALL"
+                    and target != project.rsplit("/", 1)[0]
+                ):
+                    debug(
+                        "Ignore project '%s', since it's not in target group '%s",
+                        project,
+                        target,
+                    )
+                else:
+                    if (maybe_projects := self._get_single_project(project)) and len(
+                        maybe_projects.get_effective()
+                    ) != 0:
+                        projects.add_requested([project])
 
         # TODO: consider checking for skipped earlier to avoid making requests for projects that will be skipped anyway
         projects.add_omitted(
@@ -130,10 +140,28 @@ class ProjectsProvider(GroupsProvider):
                 if project_object["archived"]:
                     archived.append(project_object["path_with_namespace"])
             except NotFoundException:
-                fatal(
-                    f"Configuration contains project {project} but it cannot be found in GitLab!",
-                    exit_code=EXIT_INVALID_INPUT,
-                )
+                debug("Could not find '%s'", project)
+                if project_transfer_source := self._get_project_transfer_source_from_config(
+                    project
+                ):
+                    source_project = self._find_project_transfer_source_in_gitlab(
+                        project_transfer_source
+                    )
+                    if source_project:
+                        if source_project["archived"]:
+                            archived.append(project)
+                    else:
+                        fatal(
+                            f"""Configuration contains project {project} to be transferred from {project_transfer_source}
+                                but the source project cannot be found in GitLab!""",
+                            exit_code=EXIT_INVALID_INPUT,
+                        )
+                else:
+                    fatal(
+                        f"Configuration contains project {project} but it cannot be found in GitLab and it's not a project that is configured to be transferred from elsewhere.",
+                        exit_code=EXIT_INVALID_INPUT,
+                    )
+
         return archived
 
     def _get_all_and_archived_projects_from_groups(
@@ -165,3 +193,47 @@ class ProjectsProvider(GroupsProvider):
                 skipped.append(project)
 
         return skipped
+
+    def _get_project_transfer_source_from_config(self, project: str) -> Optional[str]:
+        try:
+            debug(
+                "Checking if project '%s' needs to be transferred from elsewhere",
+                project,
+            )
+            project_transfer_source = self.configuration.config["projects_and_groups"][
+                project
+            ]["project"]["transfer_from"]
+            debug(
+                "Project '%s' needs to be transferred from '%s'",
+                project,
+                project_transfer_source,
+            )
+        except KeyError:
+            debug("'%s' is not a project needing to be transferred", project)
+            return None
+
+        return project_transfer_source
+
+    def _find_project_transfer_source_in_gitlab(
+        self, project_transfer_source: str
+    ) -> Optional[dict]:
+        try:
+            debug(
+                "Checking if project transfer source ('%s') exists in GitLab",
+                project_transfer_source,
+            )
+            maybe_project = self.gitlab.get_project_case_insensitive(
+                project_transfer_source
+            )
+            debug(
+                "Project transfer source ('%s') exists",
+                project_transfer_source,
+            )
+        except NotFoundException:
+            debug(
+                "Project transfer source ('%s') does not exist",
+                project_transfer_source,
+            )
+            return None
+
+        return maybe_project

gitlabform-3.9.2/gitlabform/processors/project/hooks_processor.py

@@ -0,0 +1,70 @@
+from logging import debug
+from typing import Dict, Any, List
+
+from gitlab.base import RESTObject, RESTObjectList
+from gitlab.v4.objects import Project
+
+from gitlabform.gitlab import GitLab
+from gitlabform.processors.abstract_processor import AbstractProcessor
+
+
+class HooksProcessor(AbstractProcessor):
+    def __init__(self, gitlab: GitLab):
+        super().__init__("hooks", gitlab)
+
+    def _process_configuration(self, project_and_group: str, configuration: dict):
+        debug("Processing hooks...")
+        project: Project = self.gl.projects.get(project_and_group)
+        project_hooks: RESTObjectList | List[RESTObject] = project.hooks.list()
+        hooks_in_config: tuple[str, ...] = tuple(
+            x for x in sorted(configuration["hooks"]) if x != "enforce"
+        )
+
+        for hook in hooks_in_config:
+            hook_in_gitlab: RESTObject | None = next(
+                (h for h in project_hooks if h.url == hook), None
+            )
+            hook_config = {"url": hook}
+            hook_config.update(configuration["hooks"][hook])
+
+            hook_id = hook_in_gitlab.id if hook_in_gitlab else None
+
+            # Process hooks configured for deletion
+            if configuration.get("hooks|" + hook + "|delete"):
+                if hook_id:
+                    debug(f"Deleting hook '{hook}'")
+                    project.hooks.delete(hook_id)
+                    debug(f"Deleted hook '{hook}'")
+                else:
+                    debug(f"Not deleting hook '{hook}', because it doesn't exist")
+                continue
+
+            # Process new hook creation
+            if not hook_id:
+                debug(f"Creating hook '{hook}'")
+                created_hook: RESTObject = project.hooks.create(hook_config)
+                debug(f"Created hook: {created_hook}")
+                continue
+
+            # Processing existing hook updates
+            gl_hook: dict = hook_in_gitlab.asdict() if hook_in_gitlab else {}
+            if self._needs_update(gl_hook, hook_config):
+                debug(
+                    f"The hook '{hook}' config is different from what's in gitlab OR it contains a token"
+                )
+                debug(f"Updating hook '{hook}'")
+                updated_hook: Dict[str, Any] = project.hooks.update(
+                    hook_id, hook_config
+                )
+                debug(f"Updated hook: {updated_hook}")
+            else:
+                debug(f"Hook '{hook}' remains unchanged")
+
+        # Process hook config enforcements
+        if configuration.get("hooks|enforce"):
+            for gh in project_hooks:
+                if gh.url not in hooks_in_config:
+                    debug(
+                        f"Deleting hook '{gh.url}' currently setup in the project but it is not in the configuration and enforce is enabled"
+                    )
+                    project.hooks.delete(gh.id)

{gitlabform-3.9.0 → gitlabform-3.9.2}/gitlabform.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: gitlabform
-Version: 3.9.0
+Version: 3.9.2
 Summary: 🏗 Specialized configuration as a code tool for GitLab projects, groups and more using hierarchical configuration written in YAML
 Home-page: https://gitlabform.github.io/gitlabform
 Author: Greg Dubicki and Contributors
@@ -28,22 +28,22 @@ Requires-Dist: Jinja2==3.1.3
 Requires-Dist: luddite==1.0.2
 Requires-Dist: MarkupSafe==2.1.5
 Requires-Dist: mergedeep==1.3.4
-Requires-Dist: packaging==23.2
+Requires-Dist: packaging==24.0
 Requires-Dist: python-gitlab==4.4.0
 Requires-Dist: requests==2.31.0
 Requires-Dist: ruamel.yaml==0.17.21
-Requires-Dist: types-requests==2.31.0.20240125
+Requires-Dist: types-requests==2.31.0.20240311
 Requires-Dist: yamlpath==3.8.2
 Provides-Extra: test
-Requires-Dist: coverage==7.4.1; extra == "test"
-Requires-Dist: cryptography==42.0.2; extra == "test"
+Requires-Dist: coverage==7.4.4; extra == "test"
+Requires-Dist: cryptography==42.0.5; extra == "test"
 Requires-Dist: deepdiff==6.7.1; extra == "test"
-Requires-Dist: mypy==1.8.0; extra == "test"
+Requires-Dist: mypy==1.9.0; extra == "test"
 Requires-Dist: mypy-extensions==1.0.0; extra == "test"
 Requires-Dist: pre-commit==2.21.0; extra == "test"
-Requires-Dist: pytest==7.4.4; extra == "test"
-Requires-Dist: pytest-cov==4.1.0; extra == "test"
-Requires-Dist: pytest-rerunfailures==13.0; extra == "test"
+Requires-Dist: pytest==8.1.1; extra == "test"
+Requires-Dist: pytest-cov==5.0.0; extra == "test"
+Requires-Dist: pytest-rerunfailures==14.0; extra == "test"
 Requires-Dist: xkcdpass==1.19.8; extra == "test"
 Provides-Extra: docs
 Requires-Dist: mkdocs; extra == "docs"

{gitlabform-3.9.0 → gitlabform-3.9.2}/gitlabform.egg-info/requires.txt

@@ -5,11 +5,11 @@ Jinja2==3.1.3
 luddite==1.0.2
 MarkupSafe==2.1.5
 mergedeep==1.3.4
-packaging==23.2
+packaging==24.0
 python-gitlab==4.4.0
 requests==2.31.0
 ruamel.yaml==0.17.21
-types-requests==2.31.0.20240125
+types-requests==2.31.0.20240311
 yamlpath==3.8.2
 
 [docs]
@@ -17,13 +17,13 @@ mkdocs
 mkdocs-material
 
 [test]
-coverage==7.4.1
-cryptography==42.0.2
+coverage==7.4.4
+cryptography==42.0.5
 deepdiff==6.7.1
-mypy==1.8.0
+mypy==1.9.0
 mypy-extensions==1.0.0
 pre-commit==2.21.0
-pytest==7.4.4
-pytest-cov==4.1.0
-pytest-rerunfailures==13.0
+pytest==8.1.1
+pytest-cov==5.0.0
+pytest-rerunfailures==14.0
 xkcdpass==1.19.8

{gitlabform-3.9.0 → gitlabform-3.9.2}/setup.py

@@ -51,24 +51,24 @@ setup(
         "luddite==1.0.2",
         "MarkupSafe==2.1.5",
         "mergedeep==1.3.4",
-        "packaging==23.2",
+        "packaging==24.0",
         "python-gitlab==4.4.0",
         "requests==2.31.0",
         "ruamel.yaml==0.17.21",
-        "types-requests==2.31.0.20240125",
+        "types-requests==2.31.0.20240311",
         "yamlpath==3.8.2",
     ],
     extras_require={
         "test": [
-            "coverage==7.4.1",
-            "cryptography==42.0.2",
+            "coverage==7.4.4",
+            "cryptography==42.0.5",
             "deepdiff==6.7.1",
-            "mypy==1.8.0",
+            "mypy==1.9.0",
             "mypy-extensions==1.0.0",
             "pre-commit==2.21.0",  # not really for tests, but for development
-            "pytest==7.4.4",
-            "pytest-cov==4.1.0",
-            "pytest-rerunfailures==13.0",
+            "pytest==8.1.1",
+            "pytest-cov==5.0.0",
+            "pytest-rerunfailures==14.0",
             "xkcdpass==1.19.8",
         ],
         "docs": [

{gitlabform-3.9.0 → gitlabform-3.9.2}/tests/acceptance/conftest.py

@@ -99,6 +99,18 @@ def subgroup(gl: Gitlab, group: Group):
         gl.groups.delete(f"{group.full_path}/{subgroup_name}")
 
 
+@pytest.fixture(scope="class")
+def other_subgroup(gl: Gitlab, group: Group):
+    # TODO: deduplicate this - it's a copy and paste from the above fixture
+    subgroup_name = get_random_name("subgroup")
+    gitlab_subgroup = create_group(subgroup_name, group.id)
+
+    yield gitlab_subgroup
+
+    with allowed_codes(404):
+        gl.groups.delete(f"{group.full_path}/{subgroup_name}")
+
+
 @pytest.fixture(scope="class")
 def project(gl: Gitlab, group: Group):
     project_name = get_random_name("project")
@@ -119,6 +131,17 @@ def project_in_subgroup(gl: Gitlab, subgroup: Group):
     gitlab_project.delete()
 
 
+@pytest.fixture(scope="class")
+def project_in_other_subgroup(gl: Gitlab, other_subgroup: Group):
+    # TODO: deduplicate this - it's a copy and paste from the above fixture
+    project_name = get_random_name("project")
+    gitlab_project = create_project(other_subgroup, project_name)
+
+    yield gitlab_project
+
+    gitlab_project.delete()
+
+
 @pytest.fixture(scope="function")
 def project_for_function(gl: Gitlab, group: Group):
     project_name = get_random_name("project")