fix: dry run failure when project transfer is configured along with o…

…ther additional configs (#726)

The `project: transfer_from` config fails when run with `--noop`, if there are other configurations for the project (i.e. `project_settings`). This is due to the `project_settings` processor getting a 404 when trying to fetch the settings from GitLab API(since the project doesn't get moved in dry-run).

The dry-run/noop logic is updated to account for situation when project transfer configuration is used. Additional relevant test cases have been included as well.

Fixes #725

gitlabform/__init__.py

@@ -47,7 +47,13 @@
 
 
 class GitLabForm:
-    def __init__(self, include_archived_projects=True, target=None, config_string=None):
+    def __init__(
+        self,
+        include_archived_projects=True,
+        target=None,
+        config_string=None,
+        noop=False,
+    ):
         if target and config_string:
             # this mode is basically only for testing
 
@@ -58,7 +64,7 @@ def __init__(self, include_archived_projects=True, target=None, config_string=No
             self.strict = True
             self.start_from = 1
             self.start_from_group = 1
-            self.noop = False
+            self.noop = noop
             self.output_file = None
             self.skip_version_check = True
             self.include_archived_projects = include_archived_projects

gitlabform/processors/abstract_processor.py

@@ -51,6 +51,16 @@ def process(
                 verbose(
                     f"Processing section '{self.configuration_name}' in dry-run mode."
                 )
+                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}."""
+                    )
+                    project_or_project_and_group = project_transfer_source
+                except KeyError:
+                    pass
+
                 self._print_diff(
                     project_or_project_and_group,
                     configuration.get(self.configuration_name),

tests/acceptance/__init__.py

@@ -247,7 +247,7 @@ def randomize_case(input: str) -> str:
     return "".join(random.choice((str.upper, str.lower))(char) for char in input)
 
 
-def run_gitlabform(config, target, include_archived_projects=True):
+def run_gitlabform(config, target, include_archived_projects=True, noop=False):
     # f-strings with """ used as configs have the disadvantage of having indentation in them - let's remove it here
     config = textwrap.dedent(config)
 
@@ -264,5 +264,6 @@ def run_gitlabform(config, target, include_archived_projects=True):
         include_archived_projects=include_archived_projects,
         config_string=config,
         target=target,
+        noop=noop,
     )
     gf.run()

tests/acceptance/standard/test_running.py

@@ -22,6 +22,23 @@ def test__ALL(self, gl, project, other_project):
         other_project = gl.projects.get(other_project.id)
         assert other_project.request_access_enabled is True
 
+    # noinspection PyPep8Naming
+    def test__ALL_dry_run(self, gl, project, other_project):
+        config = f"""
+        projects_and_groups:
+          '*':
+            project_settings:
+              request_access_enabled: false
+        """
+
+        run_gitlabform(config, "ALL", noop=True)
+
+        project = gl.projects.get(project.id)
+        assert project.request_access_enabled is True
+
+        other_project = gl.projects.get(other_project.id)
+        assert other_project.request_access_enabled is True
+
     # noinspection PyPep8Naming
     def test__ALL_DEFINED(self, gl, project, other_project):
         config = f"""

tests/acceptance/standard/test_transfer_project.py

@@ -9,6 +9,30 @@
 
 
 class TestTransferProject:
+    def test__transfer_between_two_root_groups_dry_run(
+        self, project_for_function, group, other_group
+    ):
+        project_new_path_with_namespace = (
+            f"{other_group.path}/{project_for_function.name}"
+        )
+        projects_in_destination_before_transfer = other_group.projects.list()
+
+        config = f"""
+        projects_and_groups:
+          {project_new_path_with_namespace}:
+            project:
+              transfer_from: {project_for_function.path_with_namespace}
+            project_settings:
+              description: test
+        """
+
+        run_gitlabform(config, project_new_path_with_namespace, noop=True)
+        projects_in_destination_after_transfer = other_group.projects.list()
+
+        assert len(projects_in_destination_after_transfer) == len(
+            projects_in_destination_before_transfer
+        )
+
     def test__transfer_between_two_root_groups(
         self, project_for_function, group, other_group
     ):