gitlabform 4.2.6__tar.gz → 4.3.0__tar.gz

{gitlabform-4.2.6 → gitlabform-4.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gitlabform
-Version: 4.2.6
+Version: 4.3.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/
@@ -20,7 +20,7 @@ Classifier: Topic :: Software Development :: Version Control :: Git
 Requires-Python: >=3.12.0
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: certifi==2025.6.15
+Requires-Dist: certifi==2025.7.14
 Requires-Dist: cli-ui==0.19.0
 Requires-Dist: ez-yaml==1.2.0
 Requires-Dist: Jinja2==3.1.6
@@ -39,7 +39,7 @@ Provides-Extra: test
 Requires-Dist: coverage==7.9.2; extra == "test"
 Requires-Dist: cryptography==45.0.5; extra == "test"
 Requires-Dist: deepdiff==8.5.0; extra == "test"
-Requires-Dist: mypy==1.16.1; extra == "test"
+Requires-Dist: mypy==1.17.0; extra == "test"
 Requires-Dist: mypy-extensions==1.1.0; extra == "test"
 Requires-Dist: pre-commit==2.21.0; extra == "test"
 Requires-Dist: pytest==8.4.1; extra == "test"

{gitlabform-4.2.6 → gitlabform-4.3.0}/gitlabform/processors/group/group_members_processor.py

@@ -1,7 +1,6 @@
-from logging import debug, error
 from typing import Dict, Tuple
 
-from cli_ui import fatal, error, debug as verbose
+from cli_ui import info, fatal, error, debug as verbose
 
 from gitlabform.constants import EXIT_INVALID_INPUT
 from gitlabform.gitlab import GitLab, AccessLevel
@@ -67,7 +66,7 @@ class GroupMembersProcessor(AbstractProcessor):
         enforce_group_members: bool,
     ):
         shared_with_groups_before = group_being_processed.shared_with_groups
-        debug("Group shared with BEFORE: %s", shared_with_groups_before)
+        verbose("Group shared with BEFORE: %s", shared_with_groups_before)
 
         groups_before_by_group_path = dict()
         for shared_with_group in shared_with_groups_before:
@@ -87,15 +86,12 @@ class GroupMembersProcessor(AbstractProcessor):
                 expires_at_before = groups_before_by_group_path[share_with_group_path]["expires_at"]
 
                 if group_access_before == group_access_to_set and expires_at_before == expires_at_to_set:
-                    debug(
+                    verbose(
                         "Nothing to change for group '%s' - same config now as to set.",
                         share_with_group_path,
                     )
                 else:
-                    debug(
-                        "Re-adding group '%s' to change their access level or expires at.",
-                        share_with_group_path,
-                    )
+                    info(f"Re-adding group {share_with_group_path} to change their access level or expires at.")
                     share_with_group_id = groups_before_by_group_path[share_with_group_path]["group_id"]
                     # we will remove the group first and then re-add them,
                     # to ensure that the group has the expected access level
@@ -108,9 +104,8 @@ class GroupMembersProcessor(AbstractProcessor):
                         raise e
 
             else:
-                debug(
-                    "Adding group '%s' who previously was not a member.",
-                    share_with_group_path,
+                verbose(
+                    f"Adding group {share_with_group_path} who previously was not a member.",
                 )
 
                 share_with_group_id = self.gl.get_group_id(share_with_group_path)
@@ -124,16 +119,16 @@ class GroupMembersProcessor(AbstractProcessor):
             # remove groups not configured explicitly
             groups_not_configured = set(groups_before_by_group_path) - set(groups_to_share_with_by_path)
             for group_path in groups_not_configured:
-                debug(
+                verbose(
                     "Removing group '%s' who is not configured to be a member.",
                     group_path,
                 )
                 share_with_group_id = self.gl.get_group_id(group_path)
                 self._unshare(group_being_processed, share_with_group_id)
         else:
-            debug("Not enforcing group members.")
+            verbose("Not enforcing group members.")
 
-        debug(
+        verbose(
             "Group shared with AFTER: %s",
             group_being_processed.members.list(get_all=True),
         )
@@ -143,7 +138,7 @@ class GroupMembersProcessor(AbstractProcessor):
         try:
             group_being_processed.unshare(share_with_group_id)
         except GitlabDeleteError:
-            debug("Group could not be unshared, likely was never shared to begin with")
+            info(f"Group with id {share_with_group_id} could not be unshared, likely was never shared to begin with")
             pass
 
     def _process_users(
@@ -157,7 +152,7 @@ class GroupMembersProcessor(AbstractProcessor):
         # (note: we DON'T get inherited users as we don't manage them at this level anyway)
         users_before = self.get_group_members(group)
 
-        debug("Group members BEFORE: %s", users_before.keys())
+        verbose("Group members BEFORE: %s", users_before.keys())
 
         if users_to_set_by_username:
             # group users to set by access level
@@ -217,26 +212,28 @@ class GroupMembersProcessor(AbstractProcessor):
                             and expires_at_before == expires_at_to_set
                             and member_role_id_before == member_role_id_to_set
                         ):
-                            debug(
+                            verbose(
                                 "Nothing to change for user '%s' - same config now as to set.",
                                 common_username,
                             )
                         else:
-                            debug(
-                                "Editing user '%s' membership to change their access level or expires at.",
-                                common_username,
+                            verbose(
+                                f"Editing user {common_username} to change their access level to {access_level_to_set},"
+                                f" expires at to {expires_at_to_set},"
+                                f" and member_role_id to {member_role_id_to_set}."
                             )
 
                             group_member.access_level = access_level_to_set
                             group_member.expires_at = expires_at_to_set
                             group_member.member_role_id = member_role_id_to_set
-                            group_member.save()
+                            try:
+                                group_member.save()
+                            except GitlabError as e:
+                                error(f"Could not save user {common_username}, error: {e.error_message}")
+                                raise e
 
                     else:
-                        debug(
-                            "Adding user '%s' who previously was not a member.",
-                            common_username,
-                        )
+                        verbose(f"Adding user {common_username} who previously was not a member.")
                         group.members.create(
                             {
                                 "user_id": user_id,
@@ -266,7 +263,7 @@ class GroupMembersProcessor(AbstractProcessor):
                     continue
 
                 if keep_bots and gl_user.bot:
-                    debug(f"Will not remove bot user '{user}' as the 'keep_bots' option is true.")
+                    verbose(f"Will not remove bot user '{user}' as the 'keep_bots' option is true.")
                     continue
 
                 try:
@@ -276,9 +273,9 @@ class GroupMembersProcessor(AbstractProcessor):
                     raise delete_error
 
         else:
-            debug("Not enforcing group members.")
+            verbose("Not enforcing group members.")
 
-        debug(f"Group members AFTER: {group.members.list(get_all=True)}")
+        verbose(f"Group members AFTER: {group.members.list(get_all=True)}")
 
     @staticmethod
     def get_group_members(group) -> dict:

gitlabform-4.3.0/gitlabform/processors/group/group_settings_processor.py

@@ -0,0 +1,90 @@
+import os
+from logging import info, debug, warning
+from typing import Dict
+
+from gitlabform.gitlab import GitLab
+from gitlab.v4.objects.groups import Group
+from gitlabform.processors.abstract_processor import AbstractProcessor
+
+
+class GroupSettingsProcessor(AbstractProcessor):
+    def __init__(self, gitlab: GitLab):
+        super().__init__("group_settings", gitlab)
+
+    def _process_configuration(self, group: str, configuration: Dict):
+        configured_group_settings = configuration.get("group_settings", {})
+
+        gitlab_group: Group = self.gl.get_group_by_path_cached(group)
+
+        # Remove avatar from config to process it last
+        avatar_config = configured_group_settings.pop("avatar", None)
+
+        # Process other settings first
+        if self._needs_update(gitlab_group.asdict(), configured_group_settings):
+            info(f"Updating group settings for group {gitlab_group.name}")
+            self.update_group_settings(gitlab_group, configured_group_settings)
+        else:
+            debug("No update needed for Group Settings")
+
+        # Process avatar last - with error handling that doesn't stop execution
+        if avatar_config is not None:
+            try:
+                self._process_group_avatar(gitlab_group, {"avatar": avatar_config})
+            except Exception as e:
+                warning(f"Failed to process group avatar: {e}")
+                raise e
+
+    @staticmethod
+    def update_group_settings(gitlab_group: Group, group_settings_config: dict):
+        for key in group_settings_config:
+            value = group_settings_config[key]
+            debug(f"Updating setting {key} to value {value}")
+            gitlab_group.__setattr__(key, value)
+            gitlab_group.save()
+
+    def _process_group_avatar(self, gitlab_group: Group, group_settings_config: dict) -> None:
+        """Process group avatar settings from configuration."""
+        debug("Processing group avatar configuration")
+
+        avatar_path = group_settings_config.get("avatar")
+        if avatar_path is None:
+            debug("No avatar configuration provided, skipping avatar processing")
+            return
+
+        debug(f"Avatar configuration found: {avatar_path}")
+
+        # Check current avatar status
+        current_avatar = getattr(gitlab_group, "avatar_url", None)
+
+        if avatar_path == "":
+            # Want to remove avatar
+            if not current_avatar:
+                debug("Avatar already empty, no update needed")
+                return
+            debug("Deleting group avatar")
+            gitlab_group.avatar = ""
+            gitlab_group.save()
+            debug("Avatar deleted successfully")
+            return
+
+        # Resolve relative paths to absolute paths
+        if not os.path.isabs(avatar_path):
+            # Convert relative path to absolute path relative to current working directory
+            avatar_path = os.path.abspath(avatar_path)
+            debug(f"Resolved relative path to absolute path: {avatar_path}")
+
+        # Want to set avatar from file
+        debug(f"Setting group avatar from file: {avatar_path}")
+        try:
+            with open(avatar_path, "rb") as avatar_file:
+                gitlab_group.avatar = avatar_file
+                gitlab_group.save()
+            debug("Group avatar uploaded successfully")
+        except FileNotFoundError:
+            error_msg = f"Group avatar file not found: {avatar_path}"
+            debug(error_msg)
+            raise FileNotFoundError(error_msg)
+        except Exception as e:
+            error_msg = f"Error uploading group avatar: {str(e)}"
+            debug(error_msg)
+            raise Exception(error_msg) from e

{gitlabform-4.2.6 → gitlabform-4.3.0}/gitlabform/processors/project/project_settings_processor.py

@@ -1,4 +1,5 @@
-from logging import debug
+import os
+from logging import debug, error, warning
 from typing import Callable, Dict, List
 
 from gitlab.v4.objects import Project
@@ -24,6 +25,10 @@ class ProjectSettingsProcessor(AbstractProcessor):
 
         self._process_project_topics(project_settings_in_config, project_settings_in_gitlab)
 
+        # Remove avatar from config to process it last
+        avatar_config = project_settings_in_config.pop("avatar", None)
+
+        # Process other settings first
         if self._needs_update(project_settings_in_gitlab, project_settings_in_config):
             debug("Updating project settings")
             for key, value in project_settings_in_config.items():
@@ -37,7 +42,16 @@ class ProjectSettingsProcessor(AbstractProcessor):
         else:
             debug("No update needed for project settings")
 
+        # Process avatar last - with error handling that doesn't stop execution
+        if avatar_config is not None:
+            try:
+                self._process_project_avatar(project, {"avatar": avatar_config})
+            except Exception as e:
+                warning(f"Failed to process project avatar: {e}")
+                raise e
+
     def get_project_settings(self, project_path: str):
+        """Get project settings from GitLab."""
         return self.gl.get_project_by_path_cached(project_path).asdict()
 
     def _print_diff(self, project_or_project_and_group: str, entity_config, diff_only_changed: bool):
@@ -94,3 +108,50 @@ class ProjectSettingsProcessor(AbstractProcessor):
         debug(f"topics after adjustment: {adjusted_project_topics_to_set}")
 
         project_settings_in_config["topics"] = adjusted_project_topics_to_set
+
+    def _process_project_avatar(self, project: Project, project_settings_in_config: dict) -> None:
+        """Process project avatar settings from configuration."""
+        debug("Processing project avatar configuration")
+
+        avatar_path = project_settings_in_config.get("avatar")
+        if avatar_path is None:
+            debug("No avatar configuration provided, skipping avatar processing")
+            return
+
+        debug(f"Avatar configuration found: {avatar_path}")
+
+        # Check current avatar status
+        current_avatar = getattr(project, "avatar_url", None)
+
+        if avatar_path == "":
+            # Want to remove avatar
+            if not current_avatar:
+                debug("Avatar already empty, no update needed")
+                return
+            debug("Deleting project avatar")
+            project.avatar = ""
+            project.save()
+            debug("Project avatar deleted successfully")
+            return
+
+        # Resolve relative paths to absolute paths
+        if not os.path.isabs(avatar_path):
+            # Convert relative path to absolute path relative to current working directory
+            avatar_path = os.path.abspath(avatar_path)
+            debug(f"Resolved relative path to absolute path: {avatar_path}")
+
+        # Want to set avatar from file
+        debug(f"Setting project avatar from file: {avatar_path}")
+        try:
+            with open(avatar_path, "rb") as avatar_file:
+                project.avatar = avatar_file
+                project.save()
+            debug("Project avatar uploaded successfully")
+        except FileNotFoundError:
+            error_msg = f"Project avatar file not found: {avatar_path}"
+            error(error_msg)
+            raise FileNotFoundError(error_msg)
+        except Exception as e:
+            error_msg = f"Error uploading project avatar: {str(e)}"
+            error(error_msg)
+            raise Exception(error_msg) from e

{gitlabform-4.2.6 → gitlabform-4.3.0}/gitlabform.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gitlabform
-Version: 4.2.6
+Version: 4.3.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/
@@ -20,7 +20,7 @@ Classifier: Topic :: Software Development :: Version Control :: Git
 Requires-Python: >=3.12.0
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: certifi==2025.6.15
+Requires-Dist: certifi==2025.7.14
 Requires-Dist: cli-ui==0.19.0
 Requires-Dist: ez-yaml==1.2.0
 Requires-Dist: Jinja2==3.1.6
@@ -39,7 +39,7 @@ Provides-Extra: test
 Requires-Dist: coverage==7.9.2; extra == "test"
 Requires-Dist: cryptography==45.0.5; extra == "test"
 Requires-Dist: deepdiff==8.5.0; extra == "test"
-Requires-Dist: mypy==1.16.1; extra == "test"
+Requires-Dist: mypy==1.17.0; extra == "test"
 Requires-Dist: mypy-extensions==1.1.0; extra == "test"
 Requires-Dist: pre-commit==2.21.0; extra == "test"
 Requires-Dist: pytest==8.4.1; extra == "test"

{gitlabform-4.2.6 → gitlabform-4.3.0}/gitlabform.egg-info/requires.txt

@@ -1,4 +1,4 @@
-certifi==2025.6.15
+certifi==2025.7.14
 cli-ui==0.19.0
 ez-yaml==1.2.0
 Jinja2==3.1.6
@@ -22,7 +22,7 @@ mkdocs-material
 coverage==7.9.2
 cryptography==45.0.5
 deepdiff==8.5.0
-mypy==1.16.1
+mypy==1.17.0
 mypy-extensions==1.1.0
 pre-commit==2.21.0
 pytest==8.4.1

{gitlabform-4.2.6 → gitlabform-4.3.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "gitlabform"
-version = "4.2.6"
+version = "4.3.0"
 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"]
@@ -23,7 +23,7 @@ classifiers = [
 ]
 requires-python = ">=3.12.0"
 dependencies = [
-    "certifi==2025.6.15",
+    "certifi==2025.7.14",
     "cli-ui==0.19.0",
     "ez-yaml==1.2.0",
     "Jinja2==3.1.6",
@@ -55,7 +55,7 @@ test = [
     "coverage==7.9.2",
     "cryptography==45.0.5",
     "deepdiff==8.5.0",
-    "mypy==1.16.1",
+    "mypy==1.17.0",
     "mypy-extensions==1.1.0",
     "pre-commit==2.21.0",
     "pytest==8.4.1",

gitlabform-4.2.6/gitlabform/processors/group/group_settings_processor.py

@@ -1,30 +0,0 @@
-from logging import info, debug
-from typing import Dict
-
-from gitlabform.gitlab import GitLab
-from gitlab.v4.objects.groups import Group
-from gitlabform.processors.abstract_processor import AbstractProcessor
-
-
-class GroupSettingsProcessor(AbstractProcessor):
-    def __init__(self, gitlab: GitLab):
-        super().__init__("group_settings", gitlab)
-
-    def _process_configuration(self, group: str, configuration: Dict):
-        configured_group_settings = configuration.get("group_settings", {})
-
-        gitlab_group: Group = self.gl.get_group_by_path_cached(group)
-
-        if self._needs_update(gitlab_group.asdict(), configured_group_settings):
-            info(f"Updating group settings for group {gitlab_group.name}")
-            self.update_group_settings(gitlab_group, configured_group_settings)
-        else:
-            debug("No update needed for Group Settings")
-
-    @staticmethod
-    def update_group_settings(gitlab_group: Group, group_settings_config: dict):
-        for key in group_settings_config:
-            value = group_settings_config[key]
-            debug(f"Updating setting {key} to value {value}")
-            gitlab_group.__setattr__(key, value)
-            gitlab_group.save()