gitlabform 4.7.0__tar.gz → 5.0.0__tar.gz

{gitlabform-4.7.0 → gitlabform-5.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gitlabform
-Version: 4.7.0
+Version: 5.0.0
 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/
@@ -8,7 +8,7 @@ Project-URL: Repository, https://github.com/gitlabform/gitlabform.git
 Project-URL: Issues, https://github.com/gitlabform/gitlabform/issues
 Project-URL: Changelog, https://gitlabform.github.io/gitlabform/changelog/
 Keywords: cli,yaml,gitlab,configuration-as-code
-Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Information Technology
 Classifier: Intended Audience :: System Administrators
@@ -20,24 +20,22 @@ Classifier: Topic :: Software Development :: Version Control :: Git
 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
 Requires-Dist: luddite==1.0.4
 Requires-Dist: MarkupSafe==3.0.3
 Requires-Dist: mergedeep==1.3.4
-Requires-Dist: packaging==25.0
-Requires-Dist: python-gitlab==7.1.0
-Requires-Dist: python-gitlab[graphql]==7.1.0
+Requires-Dist: packaging==26.0
+Requires-Dist: python-gitlab==8.0.0
+Requires-Dist: python-gitlab[graphql]==8.0.0
 Requires-Dist: requests==2.32.5
 Requires-Dist: ruamel.yaml==0.17.21
-Requires-Dist: types-requests==2.32.4.20260107
-Requires-Dist: types-setuptools==80.9.0.20251223
 Requires-Dist: yamlpath==3.8.2
 Provides-Extra: test
-Requires-Dist: coverage==7.13.1; extra == "test"
-Requires-Dist: cryptography==46.0.3; extra == "test"
+Requires-Dist: coverage==7.13.4; extra == "test"
+Requires-Dist: cryptography==46.0.5; extra == "test"
 Requires-Dist: deepdiff==8.6.1; extra == "test"
 Requires-Dist: mypy==1.19.1; extra == "test"
 Requires-Dist: mypy-extensions==1.1.0; extra == "test"
@@ -45,6 +43,8 @@ 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-rerunfailures==16.1; extra == "test"
+Requires-Dist: types-requests==2.32.4.20260107; 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"

{gitlabform-4.7.0 → gitlabform-5.0.0}/gitlabform/__init__.py

@@ -143,8 +143,7 @@ class GitLabForm:
         :return: a tuple with all the arguments that have been parsed
         """
         parser = argparse.ArgumentParser(
-            description=textwrap.dedent(
-                f"""
+            description=textwrap.dedent(f"""
             🏗 Specialized configuration as a code tool for GitLab projects, groups and more
             using hierarchical configuration written in YAML.
 
@@ -152,8 +151,7 @@ class GitLabForm:
               * 0 - on success,
               * {EXIT_INVALID_INPUT} - on invalid input errors (f.e. bad syntax in the config file) ~ "it's your fault". 😅
               * {EXIT_PROCESSING_ERROR} - if there were backend processing errors (f.e. when requests to GitLab fail) ~ "it's not your fault". 😎
-            """
-            ),
+            """),
             formatter_class=Formatter,
         )
 

{gitlabform-4.7.0 → gitlabform-5.0.0}/gitlabform/configuration/__init__.py

@@ -2,7 +2,6 @@ from gitlabform.configuration.common import ConfigurationCommon
 from gitlabform.configuration.groups import ConfigurationGroups
 from gitlabform.configuration.projects import ConfigurationProjects
 
-
 #
 # This the only external interface for operating on the configuration from a given YAML file
 # (or an input string in case of tests).

{gitlabform-4.7.0 → gitlabform-5.0.0}/gitlabform/configuration/core.py

@@ -52,9 +52,9 @@ class ConfigurationCore(ABC):
                         exit_code=EXIT_INVALID_INPUT,
                     )
 
-                if self.config.get("config_version", 1) != 3:
+                if self.config.get("config_version", 1) != 4:
                     fatal(
-                        "This version of GitLabForm requires 'config_version: 3' entry in the config. "
+                        "This version of GitLabForm requires 'config_version: 4' entry in the config. "
                         "This ensures that if the application behavior changes in a backward-incompatible way,"
                         " you won't apply unwanted configuration to your GitLab instance.\n"
                         "Please follow this guide: https://gitlabform.github.io/gitlabform/upgrade/\n",
@@ -101,11 +101,11 @@ class ConfigurationCore(ABC):
         if config_string:
             config = textwrap.dedent(source)
             verbose("Reading config from the provided string.")
-            (yaml_data, doc_loaded) = Parsers.get_yaml_data(yaml, log, config, literal=True)
+            yaml_data, doc_loaded = Parsers.get_yaml_data(yaml, log, config, literal=True)
         else:
             config_path = source
             verbose(f"Reading config from file: {config_path}")
-            (yaml_data, doc_loaded) = Parsers.get_yaml_data(yaml, log, config_path)
+            yaml_data, doc_loaded = Parsers.get_yaml_data(yaml, log, config_path)
 
         if doc_loaded:
             debug("Config parsed successfully as YAML.")

{gitlabform-4.7.0 → gitlabform-5.0.0}/gitlabform/configuration/transform.py

@@ -15,7 +15,6 @@ from gitlabform.configuration import Configuration
 from gitlabform.gitlab import AccessLevel
 from gitlabform.gitlab import GitLab
 
-
 # Configuration transformers are classes which take the input configuration as YAML and change it
 # to from the more user-friendly input to an output that is more applicable to passing to GitLab
 # over its API.
@@ -26,7 +25,6 @@ from gitlabform.gitlab import GitLab
 
 class ConfigurationTransformers:
     def __init__(self, gitlab: GitLab):
-        self.merge_request_approvals_transformer = MergeRequestApprovalsTransformer(gitlab)
         self.user_transformer = UserTransformer(gitlab)
         self.group_transformer = GroupTransformer(gitlab)
         self.implicit_name_transformer = ImplicitNameTransformer(gitlab)
@@ -36,10 +34,6 @@ class ConfigurationTransformers:
         config_before = ez_yaml.to_string(obj=configuration.config, options={})
         debug(f"Config BEFORE transformations:\n{config_before}")
 
-        # this needs to run before user and group transformer as it may contain users and group
-        # names to convert to ids
-        self.merge_request_approvals_transformer.transform(configuration)
-
         self.user_transformer.transform(configuration)
         self.group_transformer.transform(configuration)
         self.implicit_name_transformer.transform(configuration)
@@ -263,91 +257,3 @@ class AccessLevelsTransformer(ConfigurationTransformer):
                 # this just means that we haven't found any keys in YAML
                 # under the given path
                 pass
-
-
-#
-# TODO: remove below code in v4.x
-#
-
-
-class MergeRequestApprovalsTransformer(ConfigurationTransformer):
-    def __init__(self, gitlab: GitLab):
-        # this transformer doesn't need to call gitlab
-        pass
-
-    def _do_transform(self, configuration: Configuration) -> None:
-        logging_args = SimpleNamespace(quiet=False, verbose=False, debug=False)
-        processor = Processor(ConsolePrinter(logging_args), configuration.config)
-
-        try:
-            for node_coordinate in processor.get_nodes(
-                "projects_and_groups.*.merge_requests",
-                mustexist=True,
-            ):
-                old_syntax_found = False
-
-                where_to_add_new_syntax = node_coordinate.parent
-
-                old_syntax = node_coordinate.node
-
-                approvals_required_guessed = True
-                approvals_required = 2
-
-                # approvals configurations
-                if "approvals" in old_syntax:
-                    old_syntax_found = True
-
-                    if "approvals_before_merge" in old_syntax["approvals"]:
-                        # this setting is now moved inside the approval rules, so remove it from here
-                        # but store it for adding there
-                        approvals_required = old_syntax["approvals"]["approvals_before_merge"]
-                        approvals_required_guessed = False
-                        old_syntax["approvals"].pop("approvals_before_merge")
-
-                    if old_syntax["approvals"]:
-                        # add the settings, if there are left any after removing 'approvals_before_merge'
-                        where_to_add_new_syntax["merge_requests_approvals"] = old_syntax["approvals"]
-
-                # approval rules
-                if "approvers" in old_syntax or "approver_groups" in old_syntax or not approvals_required_guessed:
-                    old_syntax_found = True
-
-                    where_to_add_new_syntax["merge_requests_approval_rules"] = {
-                        "legacy": {
-                            "approvals_required": approvals_required,
-                            "name": APPROVAL_RULE_NAME,
-                        }
-                    }
-
-                    if "approvers" in old_syntax:
-                        where_to_add_new_syntax["merge_requests_approval_rules"]["legacy"]["users"] = old_syntax[
-                            "approvers"
-                        ]
-                    if "approver_groups" in old_syntax:
-                        where_to_add_new_syntax["merge_requests_approval_rules"]["legacy"]["groups"] = old_syntax[
-                            "approver_groups"
-                        ]
-
-                    if "remove_other_approval_rules" in old_syntax and old_syntax["remove_other_approval_rules"]:
-                        old_syntax_found = True
-                        where_to_add_new_syntax["merge_requests_approval_rules"]["enforce"] = True
-
-                if old_syntax_found:
-                    where_to_add_new_syntax.pop("merge_requests")
-
-                    warning(
-                        "The 'merge_requests' configuration section syntax works but is deprecated and will be removed "
-                        "in the next major version of GitLabForm. "
-                        "Please migrate to the new syntax using the 'merge_requests_approvals' "
-                        "and the 'merge_requests_approval_rules' sections."
-                    )
-                if approvals_required_guessed:
-                    warning(
-                        "'approvals_before_merge' not found in the old 'merge_requests' configuration section",
-                        "- assuming that it is set to 2.",
-                    )
-
-        except YAMLPathException:
-            # this just means that we haven't found any keys in YAML
-            # under the given path
-            pass

{gitlabform-4.7.0 → gitlabform-5.0.0}/gitlabform/gitlab/__init__.py

@@ -8,7 +8,6 @@ from gitlab import Gitlab as GitlabClient, GraphQL
 from gitlabform.gitlab.commits import GitLabCommits
 from gitlabform.gitlab.group_badges import GitLabGroupBadges
 from gitlabform.gitlab.group_ldap_links import GitLabGroupLDAPLinks
-from gitlabform.gitlab.group_variables import GitLabGroupVariables
 from gitlabform.gitlab.merge_requests import GitLabMergeRequests
 from gitlabform.gitlab.pipelines import GitLabPipelines
 from gitlabform.gitlab.project_badges import GitLabProjectBadges
@@ -20,8 +19,6 @@ from gitlabform.gitlab.project_merge_requests_approvals import (
     GitLabProjectMergeRequestsApprovals,
 )
 from gitlabform.gitlab.python_gitlab import PythonGitlab
-from gitlabform.gitlab.variables import GitLabVariables
-from gitlabform.gitlab.project_security_settings import GitlabProjectSecuritySettings
 
 
 @enum.unique
@@ -55,14 +52,11 @@ class GitLab(
     GitLabMergeRequests,
     GitLabGroupLDAPLinks,
     GitLabGroupBadges,
-    GitLabGroupVariables,
     GitLabPipelines,
     GitLabProjectBadges,
     GitLabProjectDeployKeys,
     GitLabProjectProtectedEnvironments,
     GitLabProjectMergeRequestsApprovals,
-    GitLabVariables,
-    GitlabProjectSecuritySettings,
 ):
     pass
 

{gitlabform-4.7.0 → gitlabform-5.0.0}/gitlabform/gitlab/core.py

@@ -1,8 +1,12 @@
 import functools
 import os
+import re
 from logging import debug
+from typing import Union
 from urllib import parse
 
+from packaging import version
+
 from importlib.metadata import version as package_version
 import requests
 
@@ -90,6 +94,42 @@ class GitLabCore:
     def get_project(self, project_and_group_or_id):
         return self._make_requests_to_api("projects/%s", project_and_group_or_id)
 
+    def is_version_at_least(self, min_version: Union[str, version.Version]) -> bool:
+        """
+        Check if GitLab server version is at least the specified version
+
+        Args:
+             min_version: Version string like "15.4.0" or "16.0", or a Version object
+
+        Returns:
+            bool: True if server version is >= min_version, False otherwise
+        """
+        current_version = "0.0.0"
+
+        if self.version != "unknown":
+            sem_ver_regex = "^\d*\.\d*\.\d*"
+            # Get the pure semantic version from self.version, for example Gitlab will return 18.2.1-ee
+            match = re.search(sem_ver_regex, self.version)
+            if match:
+                current_version = match.group()
+
+        if isinstance(min_version, str):
+            min_version = version.parse(min_version)
+
+        return version.parse(current_version) >= min_version
+
+    def is_version_less_than(self, max_version: Union[str, version.Version]) -> bool:
+        """
+        Check if GitLab server version is less than the specified version
+        Args:
+             max_version: Version string like "15.4.0" or "16.0", or a Version object
+
+        Returns:
+            bool: True if server version is < max_version, False otherwise
+        """
+
+        return not self.is_version_at_least(max_version)
+
     @functools.lru_cache()
     def _get_user_id(self, username: str) -> int:
         users = self._make_requests_to_api("users?username=%s", username, "GET")

{gitlabform-4.7.0 → gitlabform-5.0.0}/gitlabform/gitlab/projects.py

@@ -116,12 +116,6 @@ class GitLabProjects(GitLabCore):
         except NotFoundException:
             return []
 
-    def get_project_settings(self, project_and_group_name):
-        try:
-            return self._make_requests_to_api("projects/%s", project_and_group_name)
-        except NotFoundException:
-            return dict()
-
     def get_groups_from_project(self, project_and_group_name):
         # couldn't find an API call that was giving me directly
         # the shared groups, so I'm using directly the GET /projects/:id call

{gitlabform-4.7.0 → gitlabform-5.0.0}/gitlabform/lists/filter.py

@@ -5,7 +5,6 @@ from cli_ui import fatal
 from gitlabform.constants import EXIT_INVALID_INPUT
 from gitlabform.lists import OmissionReason, Groups, Projects
 
-
 # Groups and projects filters jobs is to omit some groups and projects that GitLabForm is requested
 # to process for a speed-up.
 #

{gitlabform-4.7.0 → gitlabform-5.0.0}/gitlabform/processors/abstract_processor.py

@@ -43,10 +43,8 @@ class AbstractProcessor(ABC):
                 project_transfer_source = ""
                 try:
                     project_transfer_source = configuration["project"]["transfer_from"]
-                    verbose(
-                        f"""Project {project_or_project_and_group} is configured to be transferred, 
-                        diffing config from transfer source project {project_transfer_source}."""
-                    )
+                    verbose(f"""Project {project_or_project_and_group} is configured to be transferred, 
+                        diffing config from transfer source project {project_transfer_source}.""")
                 except KeyError:
                     pass
 

{gitlabform-4.7.0 → gitlabform-5.0.0}/gitlabform/processors/group/group_saml_links_processor.py

@@ -1,5 +1,6 @@
-from logging import debug
+from logging import debug, warning
 from typing import List
+from cli_ui import info
 
 from gitlabform.gitlab import GitLab
 from gitlab.v4.objects import Group, GroupSAMLGroupLink
@@ -9,13 +10,13 @@ from gitlabform.processors.abstract_processor import AbstractProcessor
 class GroupSAMLLinksProcessor(AbstractProcessor):
 
     def __init__(self, gitlab: GitLab):
-        super().__init__("saml_group_links", gitlab)
+        super().__init__("group_saml_links", gitlab)
 
     def _process_configuration(self, group_path: str, configuration: dict) -> None:
         """Process the SAML links configuration for a group."""
 
-        configured_links = configuration.get("saml_group_links", {})
-        enforce_links = configuration.get("saml_group_links|enforce", False)
+        configured_links = configuration.get("group_saml_links", {})
+        enforce_links = configuration.get("group_saml_links|enforce", False)
 
         group: Group = self.gl.get_group_by_path_cached(group_path)
         existing_links: List[GroupSAMLGroupLink] = group.saml_group_links.list(get_all=True)

gitlabform-5.0.0/gitlabform/processors/group/group_variables_processor.py

@@ -0,0 +1,26 @@
+from typing import Any, Dict
+from cli_ui import debug as verbose
+from gitlabform.gitlab import GitLab
+from gitlab.v4.objects import Group
+
+from gitlabform.processors.abstract_processor import AbstractProcessor
+from gitlabform.processors.util.variables_processor import VariablesProcessor
+
+
+class GroupVariablesProcessor(AbstractProcessor):
+    def __init__(self, gitlab: GitLab):
+        super().__init__("group_variables", gitlab)
+        self._variables_processor = VariablesProcessor(self._needs_update)
+
+    def _process_configuration(self, project_and_group: str, configuration: Dict[str, Any]) -> None:
+        group: Group = self.gl.get_group_by_path_cached(project_and_group)
+
+        configured_variables = configuration.get("group_variables", {})
+        enforce_mode: bool = configured_variables.get("enforce", False)
+
+        if enforce_mode:
+            verbose(f"Enforce mode enabled for variables in {project_and_group}")
+            # Remove 'enforce' key from the config so that it's not treated as a variable
+            configured_variables.pop("enforce")
+
+        self._variables_processor.process_variables(group, configured_variables, enforce_mode)

{gitlabform-4.7.0 → gitlabform-5.0.0}/gitlabform/processors/project/__init__.py

@@ -35,7 +35,7 @@ from gitlabform.processors.project.resource_groups_processor import (
 )
 from gitlabform.processors.project.schedules_processor import SchedulesProcessor
 from gitlabform.processors.project.tags_processor import TagsProcessor
-from gitlabform.processors.project.variables_processor import VariablesProcessor
+from gitlabform.processors.project.project_variables_processor import ProjectVariablesProcessor
 from gitlabform.processors.shared.protected_environments_processor import (
     ProtectedEnvironmentsProcessor,
 )
@@ -64,7 +64,7 @@ class ProjectProcessors(AbstractProcessors):
             ProjectLabelsProcessor(gitlab),
             JobTokenScopeProcessor(gitlab),
             DeployKeysProcessor(gitlab),
-            VariablesProcessor(gitlab),
+            ProjectVariablesProcessor(gitlab),
             BranchesProcessor(gitlab, strict),
             TagsProcessor(gitlab, strict),
             IntegrationsProcessor(gitlab),