gitlabform 0.0.540a0__py3-none-any.whl

gitlabform/processors/util/variables_processor.py

@@ -0,0 +1,143 @@
+from logging import warning, info
+from typing import Dict, List, Any, Set, Tuple, Callable, cast, overload
+
+from gitlab.v4.objects import Group, Project, GroupVariable, ProjectVariable
+
+
+class VariablesProcessor:
+    def __init__(self, needs_update: Callable):
+        self.needs_update: Callable = needs_update
+
+    @overload
+    def get_variables_from_gitlab(self, group_or_project: Group) -> List[GroupVariable]: ...
+
+    @overload
+    def get_variables_from_gitlab(self, group_or_project: Project) -> List[ProjectVariable]: ...
+
+    def get_variables_from_gitlab(
+        self, group_or_project: Group | Project
+    ) -> List[GroupVariable] | List[ProjectVariable]:
+        """Get variables as a properly typed list."""
+        variables = group_or_project.variables.list(get_all=True)
+
+        if isinstance(group_or_project, Project):
+            return [cast(ProjectVariable, var) for var in variables]  # Return type is List[ProjectVariable]
+        else:
+            return [cast(GroupVariable, var) for var in variables]  # Return type is List[GroupVariable]
+
+    def _variables_match(self, existing_var: Dict[str, Any], config_var: Dict[str, Any]) -> bool:
+        """Compare if existing variable matches the configured attributes."""
+        # Ignore internal GitLab attributes and delete flag
+        ignore_keys = {"id", "_links", "delete"}
+
+        # Check if all configured attributes match existing variable
+        return all(existing_var.get(key) == value for key, value in config_var.items() if key not in ignore_keys)
+
+    def process_variables(
+        self,
+        group_or_project: Group | Project,
+        configured_variables: Dict,
+        enforce: bool,
+    ) -> None:
+        """Process variables configuration for a project or group."""
+        try:
+            # Get existing variables
+            existing_variables = self.get_variables_from_gitlab(group_or_project)
+            info(f"Found {len(existing_variables)} existing variables in {group_or_project.name}")
+
+            # Process configured variables
+            processed_vars = set()
+            if configured_variables:
+                info(f"Processing {len(configured_variables)} variables from configuration")
+                for var_config in configured_variables.values():
+                    self._handle_variable(group_or_project, var_config, existing_variables)
+                    processed_vars.add((var_config["key"], var_config.get("environment_scope", "*")))
+
+            # Handle enforce mode
+            if enforce and existing_variables:
+                self._handle_enforce_mode(group_or_project, existing_variables, processed_vars)
+
+        except Exception as err:
+            warning(f"Failed to process variables for {group_or_project.name}: {str(err)}")
+            raise
+
+    def _handle_variable(
+        self,
+        group_or_project: Group | Project,
+        var_config: Dict[str, Any],
+        existing_variables: List[GroupVariable] | List[ProjectVariable],
+    ) -> None:
+        """Handle a single variable operation."""
+        key = var_config["key"]
+        scope = var_config.get("environment_scope", "*")
+        should_delete = var_config.get("delete", False)
+
+        # Find matching existing variable
+        existing_var = next(
+            (
+                existing_var
+                for existing_var in existing_variables
+                if existing_var.key == key and getattr(existing_var, "environment_scope", "*") == scope
+            ),
+            None,
+        )
+
+        if not existing_var:
+            # In case config refers to deleting non-existent variable, raise error
+            if should_delete:
+                raise Exception(f"Cannot delete variable '{key}' with scope '{scope}' - variable does not exist")
+            self._create_variable(group_or_project, var_config)
+            return
+        else:
+            # If the variable exists, check if it should be deleted or updated
+            if should_delete:
+                # If delete is requested, check if the variable matches the config
+                # and delete it if it does
+                if not self._variables_match(existing_var.asdict(), var_config):
+                    raise Exception(f"Cannot delete {key} - attributes don't match")
+                self._delete_variable(group_or_project, key, scope)
+                return
+            else:
+                # If delete is not requested, update the variable if config is different from gitlab
+                if self.needs_update(existing_var.asdict(), var_config):
+                    self._update_variable(group_or_project, var_config)
+                    return
+                else:
+                    info(f"Variable {key} with scope {scope} already matches configuration, no update needed")
+                    return
+
+    def _handle_enforce_mode(
+        self,
+        group_or_project: Group | Project,
+        existing_variables: List[GroupVariable] | List[ProjectVariable],
+        processed_vars: Set[Tuple[str, str]],
+    ) -> None:
+        """Delete variables not in configuration when enforce mode is enabled."""
+        vars_to_delete = [
+            existing_var
+            for existing_var in existing_variables
+            if (existing_var.key, getattr(existing_var, "environment_scope", "*")) not in processed_vars
+        ]
+
+        if vars_to_delete:
+            info(f"Enforce mode will delete {len(vars_to_delete)} variables")
+            for var in vars_to_delete:
+                self._delete_variable(group_or_project, var.key, getattr(var, "environment_scope", "*"))
+
+    def _create_variable(self, group_or_project: Group | Project, var_config: Dict[str, Any]) -> None:
+        """Create a new variable."""
+        attrs = var_config.copy()
+        info(f"Creating variable {attrs['key']}")
+        group_or_project.variables.create(attrs)
+
+    def _update_variable(self, group_or_project: Group | Project, var_config: Dict[str, Any]) -> None:
+        """Update an existing variable."""
+        attrs = var_config.copy()
+        scope = attrs.get("environment_scope", "*")
+        info(f"Updating variable {attrs['key']}")
+        group_or_project.variables.update(attrs["key"], attrs, filter={"environment_scope": scope})
+
+    def _delete_variable(self, group_or_project: Group | Project, key: str, scope: str) -> None:
+        """Delete a variable."""
+        info(f"Deleting variable {key}")
+        group_or_project.variables.delete(key, filter={"environment_scope": scope})

gitlabform/run.py

@@ -0,0 +1,9 @@
+from gitlabform import GitLabForm
+
+
+def run():
+    GitLabForm().run()
+
+
+if __name__ == "__main__":
+    run()

gitlabform/util.py

@@ -0,0 +1,7 @@
+import json
+
+
+def to_str(a_dict: dict) -> str:
+    # arguably the most readable form of a dict in a single line
+    # is JSON with sorted keys
+    return json.dumps(a_dict, sort_keys=True, default=str)

gitlabform-0.0.540a0.dist-info/METADATA

@@ -0,0 +1,54 @@
+Metadata-Version: 2.4
+Name: gitlabform
+Version: 0.0.540a0
+Summary: 🏗 Specialized configuration as a code tool for GitLab projects, groups and more using hierarchical configuration written in YAML
+Project-URL: Homepage, https://gitlabform.github.io/gitlabform/
+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/
+Author: Greg Dubicki and Contributors
+License-File: LICENSE
+Keywords: cli,configuration-as-code,gitlab,yaml
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Information Technology
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Version Control :: Git
+Requires-Python: >=3.12.0
+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==26.0
+Requires-Dist: python-gitlab[graphql]==8.2.0
+Requires-Dist: requests==2.33.1
+Requires-Dist: rich==15.0.0
+Requires-Dist: ruamel-yaml==0.17.21
+Requires-Dist: yamlpath==3.8.2
+Description-Content-Type: text/markdown
+
+[![version](https://badge.fury.io/gh/gitlabform%2Fgitlabform.svg)](https://badge.fury.io/gh/gitlabform%2Fgitlabform)
+![release date](https://img.shields.io/github/release-date/gitlabform/gitlabform)
+[![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)
+[![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 is a specialized configuration as a code tool for GitLab:
+
+* application settings,
+* groups,
+* projects,
+
+...and more using hierarchical configuration written in YAML.
+
+Please see <a href="https://gitlabform.github.io/gitlabform/">the project site</a> for more information.

gitlabform-0.0.540a0.dist-info/RECORD

@@ -0,0 +1,79 @@
+gitlabform/__init__.py,sha256=bCx-6CKJCBsQP5qG92VKdX4SSYUr2vP-Hl44FGK1nMY,26483
+gitlabform/constants.py,sha256=tAvpqHST3xnx1FeZ8acsdrQG4IkqNP6ZmIbn4nM7oN0,277
+gitlabform/output.py,sha256=Q3bK-gu7LjeM0Y8rk-ohdA5qoYVdSqLphkPqlcubxx4,1778
+gitlabform/run.py,sha256=bQK0mR0h1nM99wewCbzHHVm5lHpvkKj67Vd7jp1JBtA,109
+gitlabform/util.py,sha256=HUzBwQ2-tw-k5a-wZghaTwwvatEY-nT-gOhCFHFcXH0,202
+gitlabform/configuration/__init__.py,sha256=RZZsO0StbwybL_U7-hKAckuJRwOKCKC6_1wHAQTxEOQ,390
+gitlabform/configuration/common.py,sha256=Rw3MvCgnNJ18YBa3VHwmIsooYvkt7sAaxIvO2eTWH7M,589
+gitlabform/configuration/core.py,sha256=oka_JF_KwOcNxVNv2wlIz-WetBqtZyDTVZGXoPazgss,12783
+gitlabform/configuration/groups.py,sha256=5l77tLBj3pUvsIMy52R-c1wNqdozvn2bkfJOrBYhyyo,4774
+gitlabform/configuration/projects.py,sha256=VGWH1iGOPOQFO4gby-_9pWScvQRjtnFeYNfSi7G8LrI,2716
+gitlabform/configuration/transform.py,sha256=aZmTGWZ7BYlQOjjfrxQ6rytzCWZjUQ27TrZDggyYwvQ,10724
+gitlabform/gitlab/__init__.py,sha256=jhG8fHdlw4WKK1Rtg9_AfNTMKOhho9z-dryxH4-5X4A,3757
+gitlabform/gitlab/commits.py,sha256=QTJlMqSPEAvvBUeobVkKoTNNdVqBmDRMVt62lFKsbGg,1642
+gitlabform/gitlab/core.py,sha256=wBswBAGf1kLiZXS6vzEigteHDt4I5-nMJ9gQS21FriA,13826
+gitlabform/gitlab/group_badges.py,sha256=uKW5LS_jsCfcHy5o3obkxVFwdUkTLyCygehuctfMIDw,1354
+gitlabform/gitlab/group_ldap_links.py,sha256=YKjNx8ljB3HviiBa7qYffcrluDhi98WZ7OrDgu1pFzA,1536
+gitlabform/gitlab/groups.py,sha256=JzSnxCm_qyVyaFKYnNyeqzIS-lrbqO5PTPHFNRlHvbU,3648
+gitlabform/gitlab/merge_requests.py,sha256=KQ6U4cKfekwtGkklPhN20DEcIO4-SXHIHAeTPdwOQd4,1855
+gitlabform/gitlab/pipelines.py,sha256=oeNCYM8r_lWgegz_mVcezKfNxk5-ZVYtSJrFVmp-MLA,833
+gitlabform/gitlab/project_badges.py,sha256=RacZUX0K9ymBZ_BDTSlYA-NqIVuyYrGurloYyTVs-zI,1594
+gitlabform/gitlab/project_deploy_keys.py,sha256=woVQTJBCWZmTiNlg87kvhyHg41OxVL8jJDRJlKIYoE0,4405
+gitlabform/gitlab/project_merge_requests_approvals.py,sha256=JQfDBEWdADtly8lKYMvZMxtYVlptCK83dpiQUdKU_WI,3463
+gitlabform/gitlab/project_protected_environments.py,sha256=GBQYQGpTVXsWmziMj5EdLdKe_bepI9QzV8iSZVZUcAE,1562
+gitlabform/gitlab/projects.py,sha256=s3_J9I79hLyUuBRjwBOpaURToWYyqSbW_4ZYxPTXRO8,5866
+gitlabform/gitlab/python_gitlab.py,sha256=WQURLXpif5Md9tle2vW8QcvwSrOVTTgAObRKKy1JIRU,9117
+gitlabform/gitlab/variables.py,sha256=3FEcQnxA_okv-pWckxmFGC9O1eQO-5566tHrWBd3Maw,1781
+gitlabform/lists/__init__.py,sha256=_qh6nZpUrZBzmYE9l635hPAeNXFehvenMtt3r4GPKjQ,1743
+gitlabform/lists/filter.py,sha256=85773Cr__HuEveT1PuO1YM8MjbXPcjLC9otswl6jgIg,3818
+gitlabform/lists/groups.py,sha256=-EN1Dj8bpQYeFXdt15asiADxzG--umnhtTRr4IfE6qI,3021
+gitlabform/lists/projects.py,sha256=-LtPx_llEBv0qHoM6UIm3bzJ-kIpgWE6X67P9eR4XA8,10806
+gitlabform/processors/__init__.py,sha256=SJlGN52nsUYKk9tv0yT7UV_49bqjFHSYm3sDdCAHiAE,1568
+gitlabform/processors/abstract_processor.py,sha256=wMIvDZI1d94TBCTLHvmlYRNbgP2ECMBspFMpGYtDyDw,7890
+gitlabform/processors/defining_keys.py,sha256=CPyOJp09GI2Mb6c-PrGaqgmnb9mDtX9R5ZksJS9qil8,3934
+gitlabform/processors/multiple_entities_processor.py,sha256=9eGCnggkkLqv3ilDI0mx1jolVXh5iKpJUThcOo2ALck,8457
+gitlabform/processors/application/__init__.py,sha256=t7ShruST8WJ2MyyLheW-id9sSWw2SkhJ_9dR-L_nE68,642
+gitlabform/processors/application/application_settings_processor.py,sha256=EEAOcPvWNShX_rpDsPfM0W7wa8paVGxicAv4d4GInSs,1561
+gitlabform/processors/group/__init__.py,sha256=wjlshT1_ZC5_UeGqBARzgCfmP746gy3Q5d7zT4-hLgg,1723
+gitlabform/processors/group/group_badges_processor.py,sha256=otFGNqQwlQlWcPxS2Er2DcLn5TJMZbe5wJRtIXBf3b0,689
+gitlabform/processors/group/group_hooks_processor.py,sha256=w-sHL8fccyZX6iPp06YMMGfKmx039zkSQc88Ss4x4oo,3382
+gitlabform/processors/group/group_labels_processor.py,sha256=AJMz16rsN0MhjON2o3rwEESpDxJbGI3vDlN0rXJKliE,1014
+gitlabform/processors/group/group_ldap_links_processor.py,sha256=zTNRZ9zrkTKAHaDJM35rvo7Ih1D8IaQ5ilGVxe_X2aU,707
+gitlabform/processors/group/group_members_processor.py,sha256=HTUxYszLs8s8yERxG3k8CX70PYDQnoxNva1O0m7zt4E,13184
+gitlabform/processors/group/group_push_rules_processor.py,sha256=R_wEAymYBcn9qlEHGjJT9cxRiAU1lcVNgksMcUQ0fEo,1837
+gitlabform/processors/group/group_saml_links_processor.py,sha256=pd7SNPxvrOZtLyuliufMOPYFtQfx8MMpNrTNUBwWpn8,2876
+gitlabform/processors/group/group_settings_processor.py,sha256=uLGAIZBMMdw5HSxdHNgzNHPV81Qj4rItVdpeT5WVTqA,3665
+gitlabform/processors/group/group_variables_processor.py,sha256=M4I60LSxVmoGJvXm3h5rEKb2X1HL-ztYRDnf6OUsVRs,1157
+gitlabform/processors/project/__init__.py,sha256=fsJOoUxeDoAp4HikRjGQNYrQWanMvJ7_9WZVzFIopBk,3755
+gitlabform/processors/project/badges_processor.py,sha256=5Cg3noWD_ewhNsOU19WQL5SS2PjIOlND5mnhXG0mIKc,686
+gitlabform/processors/project/branches_processor.py,sha256=CxZvE51nrqwgSaqM8jH-BV-0-7TQWKsC-n18H5Jf0VU,26306
+gitlabform/processors/project/deploy_keys_processor.py,sha256=XiMyuVQpXkbkZkyBvLn2n-tM6NCyq_24wslpi6_1EOo,814
+gitlabform/processors/project/files_processor.py,sha256=BEQg8Ho7_KHvxilBgnl4C1EadAcQrW9dboKbA6kYspY,13452
+gitlabform/processors/project/hooks_processor.py,sha256=Vw3thcfhIKVrqGvQ_HrWtlS-JBveC24y0zSStiEyoKc,2810
+gitlabform/processors/project/integrations_processor.py,sha256=5WWfiIq1qoBOVtt4JHHAjDSZK-TpQP6YsuMvNFuHvm0,1564
+gitlabform/processors/project/job_token_scope_processor.py,sha256=aS52_B-XWAdEm6NsAUyILirnnJU2c16oMrE4Q_OZl-c,8800
+gitlabform/processors/project/members_processor.py,sha256=ifkWLjmLRKe0_GPddeq2u1pSsx3wUTLg2RJx1mIuN5g,9826
+gitlabform/processors/project/merge_requests_approval_rules.py,sha256=HuMWpggshYnGf48NwTyHM2gCGmSKYzDAPyIPnV4f57s,712
+gitlabform/processors/project/merge_requests_approvals.py,sha256=bYeJWA8mBBdvBRVYgV9cZ5CRhHt21lHQJZH8nqWJn7c,2790
+gitlabform/processors/project/project_labels_processor.py,sha256=v6DigXXBspxlZNtD1T68HPyUppdsB0wspDjU7HDNltM,973
+gitlabform/processors/project/project_processor.py,sha256=0GFEqHPlEPUiMSG1pk_4s9AJdJxZtRw7rWoJE2E4qJQ,3636
+gitlabform/processors/project/project_push_rules_processor.py,sha256=NxeyIUow1CWPp6nl53GOo1Q9xbIYH5xTJ-I-HQ_kPIE,2529
+gitlabform/processors/project/project_security_settings.py,sha256=s_HrYq7FX8_-Qv0ETrmG_jfmui_TrgrIEg3iicT1_gQ,3392
+gitlabform/processors/project/project_settings_processor.py,sha256=DCCRsrqY_nOvLemZY6MIpNVIDbQCnbKNu-pNLjBv3Xc,9972
+gitlabform/processors/project/project_variables_processor.py,sha256=SZJzCBVO3aRUpuVr8aaYviZRoZkS04iSkGFdLB7baiw,3798
+gitlabform/processors/project/remote_mirrors_processor.py,sha256=2kD_7p1_sfwTe3r2X54poxuPLcOPUzKjHu61EuUI4JU,12782
+gitlabform/processors/project/resource_groups_processor.py,sha256=NC1LWLbA3cxt1CA4Yy41Ygbiglstz3DCpUK9MM9AAuQ,2521
+gitlabform/processors/project/schedules_processor.py,sha256=F_-D21AaNztBY0GAIBKR3Qtr78kQWu3-XPambPrgbLU,9161
+gitlabform/processors/project/tags_processor.py,sha256=gm3p_HPr8FGgYyJfqj0cZ3OHHspmkdyrGIwdrw2eduw,4886
+gitlabform/processors/shared/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+gitlabform/processors/shared/protected_environments_processor.py,sha256=jletJgv8GeOo8Ny_Cp_0XEq00xaZ1zILmCHZSwre_jA,893
+gitlabform/processors/util/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+gitlabform/processors/util/decorators.py,sha256=IpngOQ9YlcDCGi53ZL4K9gmkceeDSU4nDOty8bwtmUU,1277
+gitlabform/processors/util/difference_logger.py,sha256=Ds2RHc8vA5jGviDKJAn8N5hL8LodcEbQpUWeauQwRMg,2350
+gitlabform/processors/util/labels_processor.py,sha256=AgdrULhz6mA6FP1iMczfRFjKGdJIW5sSmScATQfZtjM,5185
+gitlabform/processors/util/variables_processor.py,sha256=JdN5D38Sb1TlPcSfECCEEVYSafBTLp64kRU6fmuE1-s,6491
+gitlabform-0.0.540a0.dist-info/METADATA,sha256=24L0DKa2idKwQweC9lzE_n1LfGuCHuAC9sIZPDdx1yE,2645
+gitlabform-0.0.540a0.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
+gitlabform-0.0.540a0.dist-info/entry_points.txt,sha256=y-onIc1MxG7oRgzpKfRd_ytbpehDuN7sz-Ydplh3XQU,228
+gitlabform-0.0.540a0.dist-info/licenses/LICENSE,sha256=xg2iiBASCK3IVXNkq7mA5Qw82VJBS3PUXXKBwiSMShc,1090
+gitlabform-0.0.540a0.dist-info/RECORD,,

gitlabform-0.0.540a0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.29.0
+Root-Is-Purelib: true
+Tag: py3-none-any

gitlabform-0.0.540a0.dist-info/entry_points.txt

@@ -0,0 +1,9 @@
+[console_scripts]
+dev = dev.main:main
+docker = dev.main:docker
+docs = dev.main:docs
+gitlab-local = dev.main:gitlab_local
+gitlabform = gitlabform.run:run
+package = dev.main:package
+qa = dev.main:qa
+workspace = dev.main:workspace

gitlabform-0.0.540a0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016-∞ Greg Dubicki and Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.