gitlabform 5.0.0rc1__tar.gz → 5.0.2__tar.gz

{gitlabform-5.0.0rc1 → gitlabform-5.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gitlabform
-Version: 5.0.0rc1
+Version: 5.0.2
 Summary: 🏗 Specialized configuration as a code tool for GitLab projects, groups and more using hierarchical configuration written in YAML
 Author: Greg Dubicki and Contributors
 Project-URL: Homepage, https://gitlabform.github.io/gitlabform/
@@ -17,10 +17,10 @@ Classifier: Operating System :: POSIX :: Linux
 Classifier: Operating System :: MacOS
 Classifier: Operating System :: Microsoft :: Windows
 Classifier: Topic :: Software Development :: Version Control :: Git
-Requires-Python: >=3.14.0
+Requires-Python: >=3.12.0
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: certifi==2026.1.4
+Requires-Dist: certifi==2026.2.25
 Requires-Dist: cli-ui==0.19.0
 Requires-Dist: ez-yaml==1.2.0
 Requires-Dist: Jinja2==3.1.6
@@ -28,23 +28,23 @@ Requires-Dist: luddite==1.0.4
 Requires-Dist: MarkupSafe==3.0.3
 Requires-Dist: mergedeep==1.3.4
 Requires-Dist: packaging==26.0
-Requires-Dist: python-gitlab==8.0.0
-Requires-Dist: python-gitlab[graphql]==8.0.0
+Requires-Dist: python-gitlab==8.1.0
+Requires-Dist: python-gitlab[graphql]==8.1.0
 Requires-Dist: requests==2.32.5
 Requires-Dist: ruamel.yaml==0.17.21
 Requires-Dist: yamlpath==3.8.2
 Provides-Extra: test
-Requires-Dist: coverage==7.13.3; extra == "test"
-Requires-Dist: cryptography==46.0.4; extra == "test"
-Requires-Dist: deepdiff==8.6.1; extra == "test"
+Requires-Dist: coverage==7.13.5; extra == "test"
+Requires-Dist: cryptography==46.0.5; extra == "test"
+Requires-Dist: deepdiff==8.6.2; extra == "test"
 Requires-Dist: mypy==1.19.1; extra == "test"
 Requires-Dist: mypy-extensions==1.1.0; extra == "test"
 Requires-Dist: pre-commit==2.21.0; extra == "test"
 Requires-Dist: pytest==9.0.2; extra == "test"
-Requires-Dist: pytest-cov==7.0.0; extra == "test"
+Requires-Dist: pytest-cov==7.1.0; extra == "test"
 Requires-Dist: pytest-rerunfailures==16.1; extra == "test"
 Requires-Dist: types-requests==2.32.4.20260107; extra == "test"
-Requires-Dist: types-setuptools==81.0.0.20260209; extra == "test"
+Requires-Dist: types-setuptools==82.0.0.20260210; extra == "test"
 Requires-Dist: xkcdpass==1.30.0; extra == "test"
 Provides-Extra: docs
 Requires-Dist: mkdocs; extra == "docs"
@@ -56,7 +56,7 @@ Dynamic: license-file
 [![Downloads](https://static.pepy.tech/badge/gitlabform/month)](https://pepy.tech/project/gitlabform)
 [![code style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 [![codecov](https://codecov.io/gh/gitlabform/gitlabform/branch/main/graph/badge.svg?token=NOMttkpB2A)](https://codecov.io/gh/gitlabform/gitlabform)
-[![gitlabform](https://snyk.io/advisor/python/gitlabform/badge.svg)](https://snyk.io/advisor/python/gitlabform)
+[![snyk](https://snyk.io/test/github/gitlabform/gitlabform/badge.svg)](https://security.snyk.io/package/pip/gitlabform)
 
 <img src="https://raw.githubusercontent.com/gitlabform/gitlabform/main/docs/images/gitlabform-logo.png" width="600px" alt="logo">
 

{gitlabform-5.0.0rc1 → gitlabform-5.0.2}/README.md

@@ -3,7 +3,7 @@
 [![Downloads](https://static.pepy.tech/badge/gitlabform/month)](https://pepy.tech/project/gitlabform)
 [![code style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 [![codecov](https://codecov.io/gh/gitlabform/gitlabform/branch/main/graph/badge.svg?token=NOMttkpB2A)](https://codecov.io/gh/gitlabform/gitlabform)
-[![gitlabform](https://snyk.io/advisor/python/gitlabform/badge.svg)](https://snyk.io/advisor/python/gitlabform)
+[![snyk](https://snyk.io/test/github/gitlabform/gitlabform/badge.svg)](https://security.snyk.io/package/pip/gitlabform)
 
 <img src="https://raw.githubusercontent.com/gitlabform/gitlabform/main/docs/images/gitlabform-logo.png" width="600px" alt="logo">
 

{gitlabform-5.0.0rc1 → gitlabform-5.0.2}/gitlabform/configuration/core.py

@@ -66,7 +66,7 @@ class ConfigurationCore(ABC):
             # we are NOT checking for the existence of non-empty 'projects_and_groups' key here
             # as it would break using GitLabForm as a library
 
-        except FileNotFoundError, OSError:
+        except (FileNotFoundError, OSError):
             raise ConfigFileNotFoundException(config_path)
 
         except Exception as e:

{gitlabform-5.0.0rc1 → gitlabform-5.0.2}/gitlabform/gitlab/core.py

@@ -72,9 +72,12 @@ class GitLabCore:
         )
 
         try:
-            version = self._make_requests_to_api("version")
-            verbose(f"Connected to GitLab version: {version['version']} ({version['revision']})")
-            self.version = version["version"]
+            version_response = self._make_requests_to_api("version")
+            verbose(
+                f"Connected to GitLab version: {version_response['version']} ({version_response['revision']}), Enterprise Edition: {version_response['enterprise']}"
+            )
+            self.version = version_response["version"]
+            self.enterprise = version_response["enterprise"]
 
             current_user = self._make_requests_to_api("user")
             if current_user.get("is_admin", False):

{gitlabform-5.0.0rc1 → gitlabform-5.0.2}/gitlabform/processors/project/branches_processor.py

@@ -1,14 +1,15 @@
-from typing import Optional
+from typing import Optional, Any
+
 from cli_ui import info, warning, error, fatal, debug as verbose
 from gitlab import (
     GitlabGetError,
     GitlabDeleteError,
-    GitlabCreateError,
+    GitlabOperationError,
 )
 from gitlab.v4.objects import Project, ProjectProtectedBranch
 
 from gitlabform.constants import EXIT_INVALID_INPUT, EXIT_PROCESSING_ERROR
-from gitlabform.gitlab import GitLab, AccessLevel
+from gitlabform.gitlab import GitLab
 from gitlabform.processors.abstract_processor import AbstractProcessor
 
 
@@ -80,10 +81,13 @@ class BranchesProcessor(AbstractProcessor):
                 return
 
             # https://docs.gitlab.com/api/protected_branches/#update-a-protected-branch was only introduced after 15.6
-            # for user's on older versions of Gitlab we need to unprotect and then reprotect the branch to apply the
+            # for user's on older versions of Gitlab or Community Edition (https://gitlab.com/rluna-gitlab/gitlab-ce/-/work_items/37)
+            # We need to unprotect and then reprotect the branch to apply the
             # defined configuration
-            if self.gitlab.is_version_less_than("15.6.0"):
-                self.process_branch_config_gitlab_15_6_0_or_older(branch_config, branch_name, project, protected_branch)
+            if self.gitlab.is_version_less_than("15.6.0") or (self.gitlab.enterprise == False):
+                self.process_branch_config_gitlab_under_15_6_0_or_ce(
+                    branch_config, branch_name, project, protected_branch
+                )
                 return
 
             # For later Gitlab versions we dynamically generate the data to send to the update endpoint based on the
@@ -116,7 +120,7 @@ class BranchesProcessor(AbstractProcessor):
             verbose("Creating data to update merge_access_levels as necessary")
             merge_access_items_patch_data = self.build_patch_request_data(
                 transformed_access_levels=transformed_branch_config.get("merge_access_levels"),
-                existing_records=tuple(protected_branch.merge_access_levels),
+                existing_records=tuple(self._get_list_attribute(protected_branch, "merge_access_levels")),
             )
             if len(merge_access_items_patch_data) > 0:
                 protected_branch_api_patch_data["allowed_to_merge"] = merge_access_items_patch_data
@@ -124,16 +128,18 @@ class BranchesProcessor(AbstractProcessor):
             verbose("Creating data to update push_access_levels as necessary")
             push_access_items_patch_data = self.build_patch_request_data(
                 transformed_access_levels=transformed_branch_config.get("push_access_levels"),
-                existing_records=tuple(protected_branch.push_access_levels),
+                existing_records=tuple(self._get_list_attribute(protected_branch, "push_access_levels")),
             )
             if len(push_access_items_patch_data) > 0:
                 protected_branch_api_patch_data["allowed_to_push"] = push_access_items_patch_data
 
             verbose("Creating data to update unprotect_access_levels as necessary")
+
             unprotect_access_items_patch_data = self.build_patch_request_data(
                 transformed_access_levels=transformed_branch_config.get("unprotect_access_levels"),
-                existing_records=tuple(protected_branch.unprotect_access_levels),
+                existing_records=tuple(self._get_list_attribute(protected_branch, "unprotect_access_levels")),
             )
+
             if len(unprotect_access_items_patch_data) > 0:
                 protected_branch_api_patch_data["allowed_to_unprotect"] = unprotect_access_items_patch_data
 
@@ -146,9 +152,9 @@ class BranchesProcessor(AbstractProcessor):
             info(f"Removing branch protection for {branch_name}")
             self.unprotect_branch(protected_branch)
 
-    def process_branch_config_gitlab_15_6_0_or_older(self, branch_config, branch_name, project, protected_branch):
+    def process_branch_config_gitlab_under_15_6_0_or_ce(self, branch_config, branch_name, project, protected_branch):
         """
-        Processes the branches configuration for gitlab version 15.6.0 or older,
+        Processes the branches configuration for gitlab version <=15.6.0 or Community Edition,
         first checking if the branch needs to be updated, if it does, then the branch will be unprotected prior to being
         reprotected with the YAML configuration.
         """
@@ -186,7 +192,7 @@ class BranchesProcessor(AbstractProcessor):
                 project.protectedbranches.update(branch_name, branch_config)
             else:
                 project.protectedbranches.create({"name": branch_name, **branch_config})
-        except GitlabCreateError as e:
+        except GitlabOperationError as e:
             message = f"Protecting branch '{branch_name}' failed! Error '{e.error_message}"
 
             if self.strict:
@@ -374,15 +380,21 @@ class BranchesProcessor(AbstractProcessor):
                 matching_item_to_be_created = None
 
                 for item in patch_data:
-                    if (
+                    # We prioritize user_id and group_id matches over access_level.
+                    # This avoids ambiguity because a user/group record from GitLab also contains an access_level.
+                    # If we matched by access_level first, we might incorrectly pair a specific user's rule
+                    # with a generic role-based rule from the config.
+                    if existing_records_user_id is not None and item.get("user_id") == existing_records_user_id:
+                        matching_item_to_be_created = item
+                        break
+                    elif existing_records_group_id is not None and item.get("group_id") == existing_records_group_id:
+                        matching_item_to_be_created = item
+                        break
+                    elif (
                         existing_records_access_level is not None
                         and item.get("access_level") == existing_records_access_level
                     ):
                         matching_item_to_be_created = item
-                    elif existing_records_user_id is not None and item.get("user_id") == existing_records_user_id:
-                        matching_item_to_be_created = item
-                    elif existing_records_group_id is not None and item.get("group_id") == existing_records_group_id:
-                        matching_item_to_be_created = item
 
                 if matching_item_to_be_created is not None:
                     # If we found an existing item matching one that has been configured, remove the item
@@ -436,3 +448,19 @@ class BranchesProcessor(AbstractProcessor):
         https://docs.gitlab.com/user/project/repository/branches/protected/#use-wildcard-rules
         """
         return "*" in branch
+
+    @staticmethod
+    def _get_list_attribute(protected_branch: ProjectProtectedBranch, attribute_name: str) -> list[Any]:
+        """
+        Gets list attribute such as unprotect_access_levels, merge_access_levels, push_access_levels, etc.
+        Uses the python-gitlab attributes raw dict rather than direct parameter to gracefully handle when an attribute
+        is not present in the API response.
+        For example in CE: unprotect_access_levels is not returned on the protected_branch, so trying to access directly
+        throws a runtime-exception
+        """
+        existing_list_value: list[Any] = []
+        # Get from the "attributes" as this is the raw dict
+        existing_attr = protected_branch.attributes.get(attribute_name)
+        if existing_attr is not None:
+            existing_list_value = existing_attr
+        return existing_list_value

{gitlabform-5.0.0rc1 → gitlabform-5.0.2}/gitlabform.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gitlabform
-Version: 5.0.0rc1
+Version: 5.0.2
 Summary: 🏗 Specialized configuration as a code tool for GitLab projects, groups and more using hierarchical configuration written in YAML
 Author: Greg Dubicki and Contributors
 Project-URL: Homepage, https://gitlabform.github.io/gitlabform/
@@ -17,10 +17,10 @@ Classifier: Operating System :: POSIX :: Linux
 Classifier: Operating System :: MacOS
 Classifier: Operating System :: Microsoft :: Windows
 Classifier: Topic :: Software Development :: Version Control :: Git
-Requires-Python: >=3.14.0
+Requires-Python: >=3.12.0
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: certifi==2026.1.4
+Requires-Dist: certifi==2026.2.25
 Requires-Dist: cli-ui==0.19.0
 Requires-Dist: ez-yaml==1.2.0
 Requires-Dist: Jinja2==3.1.6
@@ -28,23 +28,23 @@ Requires-Dist: luddite==1.0.4
 Requires-Dist: MarkupSafe==3.0.3
 Requires-Dist: mergedeep==1.3.4
 Requires-Dist: packaging==26.0
-Requires-Dist: python-gitlab==8.0.0
-Requires-Dist: python-gitlab[graphql]==8.0.0
+Requires-Dist: python-gitlab==8.1.0
+Requires-Dist: python-gitlab[graphql]==8.1.0
 Requires-Dist: requests==2.32.5
 Requires-Dist: ruamel.yaml==0.17.21
 Requires-Dist: yamlpath==3.8.2
 Provides-Extra: test
-Requires-Dist: coverage==7.13.3; extra == "test"
-Requires-Dist: cryptography==46.0.4; extra == "test"
-Requires-Dist: deepdiff==8.6.1; extra == "test"
+Requires-Dist: coverage==7.13.5; extra == "test"
+Requires-Dist: cryptography==46.0.5; extra == "test"
+Requires-Dist: deepdiff==8.6.2; extra == "test"
 Requires-Dist: mypy==1.19.1; extra == "test"
 Requires-Dist: mypy-extensions==1.1.0; extra == "test"
 Requires-Dist: pre-commit==2.21.0; extra == "test"
 Requires-Dist: pytest==9.0.2; extra == "test"
-Requires-Dist: pytest-cov==7.0.0; extra == "test"
+Requires-Dist: pytest-cov==7.1.0; extra == "test"
 Requires-Dist: pytest-rerunfailures==16.1; extra == "test"
 Requires-Dist: types-requests==2.32.4.20260107; extra == "test"
-Requires-Dist: types-setuptools==81.0.0.20260209; extra == "test"
+Requires-Dist: types-setuptools==82.0.0.20260210; extra == "test"
 Requires-Dist: xkcdpass==1.30.0; extra == "test"
 Provides-Extra: docs
 Requires-Dist: mkdocs; extra == "docs"
@@ -56,7 +56,7 @@ Dynamic: license-file
 [![Downloads](https://static.pepy.tech/badge/gitlabform/month)](https://pepy.tech/project/gitlabform)
 [![code style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 [![codecov](https://codecov.io/gh/gitlabform/gitlabform/branch/main/graph/badge.svg?token=NOMttkpB2A)](https://codecov.io/gh/gitlabform/gitlabform)
-[![gitlabform](https://snyk.io/advisor/python/gitlabform/badge.svg)](https://snyk.io/advisor/python/gitlabform)
+[![snyk](https://snyk.io/test/github/gitlabform/gitlabform/badge.svg)](https://security.snyk.io/package/pip/gitlabform)
 
 <img src="https://raw.githubusercontent.com/gitlabform/gitlabform/main/docs/images/gitlabform-logo.png" width="600px" alt="logo">
 

{gitlabform-5.0.0rc1 → gitlabform-5.0.2}/gitlabform.egg-info/SOURCES.txt

@@ -41,7 +41,6 @@ gitlabform/processors/__init__.py
 gitlabform/processors/abstract_processor.py
 gitlabform/processors/defining_keys.py
 gitlabform/processors/multiple_entities_processor.py
-gitlabform/processors/single_entity_processor.py
 gitlabform/processors/application/__init__.py
 gitlabform/processors/application/application_settings_processor.py
 gitlabform/processors/group/__init__.py

{gitlabform-5.0.0rc1 → gitlabform-5.0.2}/gitlabform.egg-info/requires.txt

@@ -1,4 +1,4 @@
-certifi==2026.1.4
+certifi==2026.2.25
 cli-ui==0.19.0
 ez-yaml==1.2.0
 Jinja2==3.1.6
@@ -6,8 +6,8 @@ luddite==1.0.4
 MarkupSafe==3.0.3
 mergedeep==1.3.4
 packaging==26.0
-python-gitlab==8.0.0
-python-gitlab[graphql]==8.0.0
+python-gitlab==8.1.0
+python-gitlab[graphql]==8.1.0
 requests==2.32.5
 ruamel.yaml==0.17.21
 yamlpath==3.8.2
@@ -17,15 +17,15 @@ mkdocs
 mkdocs-material
 
 [test]
-coverage==7.13.3
-cryptography==46.0.4
-deepdiff==8.6.1
+coverage==7.13.5
+cryptography==46.0.5
+deepdiff==8.6.2
 mypy==1.19.1
 mypy-extensions==1.1.0
 pre-commit==2.21.0
 pytest==9.0.2
-pytest-cov==7.0.0
+pytest-cov==7.1.0
 pytest-rerunfailures==16.1
 types-requests==2.32.4.20260107
-types-setuptools==81.0.0.20260209
+types-setuptools==82.0.0.20260210
 xkcdpass==1.30.0

{gitlabform-5.0.0rc1 → gitlabform-5.0.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "gitlabform"
-version = "5.0.0-rc.1"
+version = "5.0.2"
 authors = [{ name = "Greg Dubicki and Contributors" }]
 description = "🏗 Specialized configuration as a code tool for GitLab projects, groups and more using hierarchical configuration written in YAML"
 keywords = ["cli", "yaml", "gitlab", "configuration-as-code"]
@@ -21,9 +21,9 @@ classifiers = [
     "Operating System :: Microsoft :: Windows",
     "Topic :: Software Development :: Version Control :: Git",
 ]
-requires-python = ">=3.14.0"
+requires-python = ">=3.12.0"
 dependencies = [
-    "certifi==2026.1.4",
+    "certifi==2026.2.25",
     "cli-ui==0.19.0",
     "ez-yaml==1.2.0",
     "Jinja2==3.1.6",
@@ -31,8 +31,8 @@ dependencies = [
     "MarkupSafe==3.0.3",
     "mergedeep==1.3.4",
     "packaging==26.0",
-    "python-gitlab==8.0.0",
-    "python-gitlab[graphql]==8.0.0",
+    "python-gitlab==8.1.0",
+    "python-gitlab[graphql]==8.1.0",
     "requests==2.32.5",
     "ruamel.yaml==0.17.21",
     "yamlpath==3.8.2",
@@ -50,17 +50,17 @@ content-type = "text/markdown"
 
 [project.optional-dependencies]
 test = [
-    "coverage==7.13.3",
-    "cryptography==46.0.4",
-    "deepdiff==8.6.1",
+    "coverage==7.13.5",
+    "cryptography==46.0.5",
+    "deepdiff==8.6.2",
     "mypy==1.19.1",
     "mypy-extensions==1.1.0",
     "pre-commit==2.21.0",
     "pytest==9.0.2",
-    "pytest-cov==7.0.0",
+    "pytest-cov==7.1.0",
     "pytest-rerunfailures==16.1",
     "types-requests==2.32.4.20260107",
-    "types-setuptools==81.0.0.20260209",
+    "types-setuptools==82.0.0.20260210",
     "xkcdpass==1.30.0",
 ]
 docs = ["mkdocs", "mkdocs-material"]
@@ -74,9 +74,9 @@ exclude = ["tests*"]
 
 [tool.pytest.ini_options]
 filterwarnings = ["ignore::DeprecationWarning"]
-
 markers = [
     "requires_license: marks tests which require GitLab paid (Premium/Ultimate) license '-m \"not requires_license\"')",
+    "ce: marks tests which need to be run against GitLab CE image as well as the standard EE image"
 ]
 
 #uncomment below for debug logging ALWAYS, even if the tests are passing

gitlabform-5.0.0rc1/gitlabform/processors/single_entity_processor.py

@@ -1,59 +0,0 @@
-from logging import debug
-from cli_ui import debug as verbose
-
-import abc
-from typing import Callable, Optional
-
-from gitlabform.gitlab import GitLab
-from gitlabform.processors.abstract_processor import AbstractProcessor
-from gitlabform.processors.util.difference_logger import DifferenceLogger
-
-
-def noop():
-    pass
-
-
-class SingleEntityProcessor(AbstractProcessor, metaclass=abc.ABCMeta):
-    def __init__(
-        self,
-        configuration_name: str,
-        gitlab: GitLab,
-        get_method_name: str,
-        edit_method_name: str,
-        add_method_name: Optional[str] = None,
-    ):
-        super().__init__(configuration_name, gitlab)
-        self.get_method: Callable = getattr(self.gitlab, get_method_name)
-        self.edit_method: Callable = getattr(self.gitlab, edit_method_name)
-        if add_method_name:
-            self.add_method: Callable = getattr(self.gitlab, add_method_name)
-        else:
-            self.add_method = noop
-
-    def _process_configuration(self, project_or_group: str, configuration: dict):
-        entity_config = configuration[self.configuration_name]
-
-        entity_in_gitlab = self.get_method(project_or_group)
-        debug(f"{self.configuration_name} BEFORE: ^^^")
-
-        if entity_in_gitlab:
-            if self._needs_update(entity_in_gitlab, entity_config):
-                verbose(f"Editing {self.configuration_name} in {project_or_group}")
-                self.edit_method(project_or_group, entity_config)
-                debug(f"{self.configuration_name} AFTER: ^^^")
-            else:
-                verbose(f"{self.configuration_name} in {project_or_group} doesn't need an update.")
-        else:
-            verbose(f"Adding {self.configuration_name} in {project_or_group}")
-            self.add_method(project_or_group, entity_config)
-            debug(f"{self.configuration_name} AFTER: ^^^")
-
-    def _print_diff(self, project_or_project_and_group: str, entity_config, diff_only_changed: bool):
-        entity_in_gitlab = self.get_method(project_or_project_and_group)
-
-        DifferenceLogger.log_diff(
-            f"{self.configuration_name} changes",
-            entity_in_gitlab,
-            entity_config,
-            only_changed=diff_only_changed,
-        )