gitlabform 4.0.2__tar.gz → 4.0.4__tar.gz

{gitlabform-4.0.2 → gitlabform-4.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: gitlabform
-Version: 4.0.2
+Version: 4.0.4
 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
@@ -31,7 +31,7 @@ Requires-Dist: ruamel.yaml==0.17.21
 Requires-Dist: types-requests==2.32.0.20241016
 Requires-Dist: yamlpath==3.8.2
 Provides-Extra: test
-Requires-Dist: coverage==7.6.4; extra == "test"
+Requires-Dist: coverage==7.6.8; extra == "test"
 Requires-Dist: cryptography==43.0.3; extra == "test"
 Requires-Dist: deepdiff==8.0.1; extra == "test"
 Requires-Dist: mypy==1.13.0; extra == "test"
@@ -39,7 +39,7 @@ Requires-Dist: mypy-extensions==1.0.0; extra == "test"
 Requires-Dist: pre-commit==2.21.0; extra == "test"
 Requires-Dist: pytest==8.3.3; extra == "test"
 Requires-Dist: pytest-cov==6.0.0; extra == "test"
-Requires-Dist: pytest-rerunfailures==14.0; extra == "test"
+Requires-Dist: pytest-rerunfailures==15.0; extra == "test"
 Requires-Dist: xkcdpass==1.19.9; extra == "test"
 Provides-Extra: docs
 Requires-Dist: mkdocs; extra == "docs"

{gitlabform-4.0.2 → gitlabform-4.0.4}/gitlabform/processors/multiple_entities_processor.py

@@ -4,7 +4,6 @@ from cli_ui import fatal
 
 import abc
 from typing import Callable, Union, Any
-import time
 from gitlabform.constants import EXIT_INVALID_INPUT
 from gitlabform.gitlab import GitLab
 from gitlabform.processors.abstract_processor import AbstractProcessor
@@ -70,21 +69,6 @@ class MultipleEntitiesProcessor(AbstractProcessor, metaclass=abc.ABCMeta):
         else:
             enforce = False
 
-        if (
-            "members" in configuration
-            and ("protected_environments" or "merge_requests_approval_rules")
-            in configuration
-        ):
-            # When gitlabform needs to update project membership and also configure
-            # settings that are dependent on the members (i.e. environment protection
-            # or MR approval rule), there seems to be an issue in GitLab. Automated
-            # acceptance tests in gitlabform creates new user and adds to the project
-            # followed by configuring other setting. In that scenario need to wait a little
-            # before calling GitLab's REST API for processing other settings. Otherwise
-            # the users are not available to be configured in other settings and it
-            # does not return any error either"
-            time.sleep(2)
-
         # TODO: move/convert this to a configuration validation phase
         self._find_duplicates(project_or_group, entities_in_configuration)
 

{gitlabform-4.0.2 → gitlabform-4.0.4}/gitlabform/processors/project/branches_processor.py

@@ -1,7 +1,7 @@
 from typing import Optional
 from logging import debug, info
 from cli_ui import warning, fatal
-from gitlab.v4.objects import Project, ProjectBranch, ProjectProtectedBranch
+from gitlab.v4.objects import Project, ProjectProtectedBranch
 from gitlab import (
     GitlabGetError,
     GitlabDeleteError,
@@ -10,7 +10,6 @@ from gitlab import (
 from gitlabform.constants import EXIT_INVALID_INPUT, EXIT_PROCESSING_ERROR
 from gitlabform.gitlab import GitLab
 from gitlabform.processors.abstract_processor import AbstractProcessor
-import time
 
 
 class BranchesProcessor(AbstractProcessor):
@@ -19,18 +18,6 @@ class BranchesProcessor(AbstractProcessor):
         self.strict = strict
 
     def _process_configuration(self, project_and_group: str, configuration: dict):
-        if "members" in configuration:
-            # When gitlabform needs to update project membership and also
-            # configure branch protection, there seems to be a race condition
-            # or delay in GitLab. Automated acceptance tests in gitlabform
-            # creates new user and adds to the project followed by configuring
-            # branch protection setting. In that scenario need to wait a little
-            # before calling GitLab's REST API for branch protection. Otherwise
-            # the API returns error code 422 with an message like "Push access
-            # levels user is not a member of the project"
-
-            time.sleep(2)
-
         project: Project = self.gl.get_project_by_path_cached(project_and_group)
 
         for branch in sorted(configuration["branches"]):
@@ -46,20 +33,20 @@ class BranchesProcessor(AbstractProcessor):
         """
         Process branch protection according to gitlabform config.
         """
-        branch: Optional[ProjectBranch] = None
         protected_branch: Optional[ProjectProtectedBranch] = None
 
-        try:
-            branch = project.branches.get(branch_name)
-        except GitlabGetError:
-            message = f"Branch '{branch_name}' not found when trying to processing it to be protected/unprotected!"
-            if self.strict:
-                fatal(
-                    message,
-                    exit_code=EXIT_INVALID_INPUT,
-                )
-            else:
-                warning(message)
+        if not self.is_branch_name_wildcard(branch_name):
+            try:
+                branch = project.branches.get(branch_name)
+            except GitlabGetError:
+                message = f"Branch '{branch_name}' not found when processing it to be protected/unprotected!"
+                if self.strict:
+                    fatal(
+                        message,
+                        exit_code=EXIT_INVALID_INPUT,
+                    )
+                else:
+                    warning(message)
 
         try:
             protected_branch = project.protectedbranches.get(branch_name)
@@ -67,7 +54,7 @@ class BranchesProcessor(AbstractProcessor):
             message = f"The branch '{branch_name}' is not protected!"
             debug(message)
 
-        if branch and branch_config.get("protected"):
+        if branch_config.get("protected"):
             if protected_branch and self._needs_update(
                 protected_branch.attributes, branch_config
             ):
@@ -79,27 +66,25 @@ class BranchesProcessor(AbstractProcessor):
                 # protected branch is not the same. So, removing existing branch protection and
                 # reconfiguring branch protection seems simpler.
                 self.unprotect_branch(protected_branch)
-                self.protect_branch(project, branch, branch_config)
+                self.protect_branch(project, branch_name, branch_config)
             elif not protected_branch:
-                self.protect_branch(project, branch, branch_config)
+                self.protect_branch(project, branch_name, branch_config)
         elif protected_branch and not branch_config.get("protected"):
             self.unprotect_branch(protected_branch)
 
-    def protect_branch(
-        self, project: Project, branch: ProjectBranch, branch_config: dict
-    ):
+    def protect_branch(self, project: Project, branch_name: str, branch_config: dict):
         """
         Protect a branch using given config.
         Raise exception if running in strict mode.
         """
 
-        debug("Setting branch '%s' as protected", branch.name)
+        debug("Setting branch '%s' as protected", branch_name)
 
         try:
-            project.protectedbranches.create({"name": branch.name, **branch_config})
+            project.protectedbranches.create({"name": branch_name, **branch_config})
         except GitlabCreateError as e:
             message = (
-                f"Protecting branch '{branch.name}' failed! Error '{e.error_message}"
+                f"Protecting branch '{branch_name}' failed! Error '{e.error_message}"
             )
 
             if self.strict:
@@ -149,3 +134,7 @@ class BranchesProcessor(AbstractProcessor):
                             item["group_id"] = self.gl.get_group_id(item.pop("group"))
 
         return branch_config
+
+    @staticmethod
+    def is_branch_name_wildcard(branch):
+        return "*" in branch or "?" in branch

{gitlabform-4.0.2 → gitlabform-4.0.4}/gitlabform/processors/project/files_processor.py

@@ -135,10 +135,12 @@ class FilesProcessor(AbstractProcessor):
                         )
 
                     try:
+                        # Returns base64 encoded content: https://python-gitlab.readthedocs.io/en/stable/gl_objects/projects.html#project-files
                         repo_file: ProjectFile = project.files.get(
                             file_path=file, ref=branch.name
                         )
-                        current_content = repo_file.content
+                        decoded_file: bytes = repo_file.decode()
+                        current_content: str = decoded_file.decode("utf-8")
 
                         if current_content != new_content:
                             if configuration.get("files|" + file + "|overwrite"):
@@ -243,12 +245,9 @@ class FilesProcessor(AbstractProcessor):
                     # ...and protect the branch again after the operation
                     if configuration.get("branches|" + branch.name + "|protected"):
                         debug("> Protecting the branch again.")
-                        project_branch: ProjectBranch = project.branches.get(
-                            branch.name
-                        )
                         branch_config: dict = configuration["branches"][branch.name]
                         self.branch_processor.protect_branch(
-                            project, project_branch, branch_config
+                            project, branch.name, branch_config
                         )
 
             else:

{gitlabform-4.0.2 → gitlabform-4.0.4}/gitlabform.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: gitlabform
-Version: 4.0.2
+Version: 4.0.4
 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
@@ -31,7 +31,7 @@ Requires-Dist: ruamel.yaml==0.17.21
 Requires-Dist: types-requests==2.32.0.20241016
 Requires-Dist: yamlpath==3.8.2
 Provides-Extra: test
-Requires-Dist: coverage==7.6.4; extra == "test"
+Requires-Dist: coverage==7.6.8; extra == "test"
 Requires-Dist: cryptography==43.0.3; extra == "test"
 Requires-Dist: deepdiff==8.0.1; extra == "test"
 Requires-Dist: mypy==1.13.0; extra == "test"
@@ -39,7 +39,7 @@ Requires-Dist: mypy-extensions==1.0.0; extra == "test"
 Requires-Dist: pre-commit==2.21.0; extra == "test"
 Requires-Dist: pytest==8.3.3; extra == "test"
 Requires-Dist: pytest-cov==6.0.0; extra == "test"
-Requires-Dist: pytest-rerunfailures==14.0; extra == "test"
+Requires-Dist: pytest-rerunfailures==15.0; extra == "test"
 Requires-Dist: xkcdpass==1.19.9; extra == "test"
 Provides-Extra: docs
 Requires-Dist: mkdocs; extra == "docs"

{gitlabform-4.0.2 → gitlabform-4.0.4}/gitlabform.egg-info/requires.txt

@@ -17,7 +17,7 @@ mkdocs
 mkdocs-material
 
 [test]
-coverage==7.6.4
+coverage==7.6.8
 cryptography==43.0.3
 deepdiff==8.0.1
 mypy==1.13.0
@@ -25,5 +25,5 @@ mypy-extensions==1.0.0
 pre-commit==2.21.0
 pytest==8.3.3
 pytest-cov==6.0.0
-pytest-rerunfailures==14.0
+pytest-rerunfailures==15.0
 xkcdpass==1.19.9

{gitlabform-4.0.2 → gitlabform-4.0.4}/setup.py

@@ -56,7 +56,7 @@ setup(
     ],
     extras_require={
         "test": [
-            "coverage==7.6.4",
+            "coverage==7.6.8",
             "cryptography==43.0.3",
             "deepdiff==8.0.1",
             "mypy==1.13.0",
@@ -64,7 +64,7 @@ setup(
             "pre-commit==2.21.0",  # not really for tests, but for development
             "pytest==8.3.3",
             "pytest-cov==6.0.0",
-            "pytest-rerunfailures==14.0",
+            "pytest-rerunfailures==15.0",
             "xkcdpass==1.19.9",
         ],
         "docs": [

{gitlabform-4.0.2 → gitlabform-4.0.4}/tests/acceptance/standard/test_branches.py

@@ -60,6 +60,41 @@ class TestBranches:
         assert merge_access_user_ids is None
         assert unprotect_access_level is None
 
+    def test__protect_with_wildcard(self, project):
+        branch_wildcard = "r-*"
+        config_protect_branch = f"""
+        projects_and_groups:
+          {project.path_with_namespace}:
+            branches:
+              "{branch_wildcard}":
+                protected: true
+                push_access_level: {AccessLevel.NO_ACCESS.value}
+                merge_access_level: {AccessLevel.MAINTAINER.value}
+                unprotect_access_level: {AccessLevel.MAINTAINER.value}
+        """
+
+        run_gitlabform(config_protect_branch, project.path_with_namespace)
+
+        (
+            push_access_levels,
+            merge_access_levels,
+            push_access_user_ids,
+            merge_access_user_ids,
+            _,
+            _,
+            unprotect_access_level,
+        ) = get_only_branch_access_levels(project, branch_wildcard)
+        assert push_access_levels == [AccessLevel.NO_ACCESS.value]
+        assert merge_access_levels == [AccessLevel.MAINTAINER.value]
+        assert push_access_user_ids == []
+        assert merge_access_user_ids == []
+        assert unprotect_access_level is AccessLevel.MAINTAINER.value
+
+        wildcard_matching_branch = project.branches.create(
+            {"branch": "r-1", "ref": "main"}
+        )
+        assert wildcard_matching_branch.protected is True
+
     def test__config_with_access_level_names(self, project, branch):
         config_with_access_levels_names = f"""
         projects_and_groups:

{gitlabform-4.0.2 → gitlabform-4.0.4}/tests/acceptance/standard/test_files.py

@@ -91,6 +91,42 @@ class TestFiles:
         # check if main stays protected after the file update
         assert the_branch.protected is True
 
+    def test__does_not_commit_file_if_content_matches(self, project_for_function):
+        set_file_specific_branch = f"""
+        projects_and_groups:
+          {project_for_function.path_with_namespace}:
+            branches:
+              main:
+                protected: true
+                push_access_level: maintainer
+                merge_access_level: developer
+                unprotect_access_level: maintainer
+            files:
+              "README.md":
+                overwrite: true
+                branches:
+                  - main
+                content: {DEFAULT_README}
+        """
+
+        run_gitlabform(
+            set_file_specific_branch, project_for_function.path_with_namespace
+        )
+
+        the_branch = project_for_function.branches.get("main")
+        assert not any(
+            [
+                text in the_branch.commit["message"]
+                for text in ["Automated", "made by gitlabform"]
+            ]
+        )
+
+        project_file = project_for_function.files.get(ref="main", file_path="README.md")
+        assert project_file.decode().decode("utf-8") == DEFAULT_README
+
+        # check if main stays protected after the file update
+        assert the_branch.protected is True
+
     def test__set_file_strongly_protected_branch(self, project, no_access_branch):
         set_file_specific_branch = f"""
             projects_and_groups: