refactor: migrate schedules_processor to use python-gitlab

gitlabform/gitlab/__init__.py

@@ -22,7 +22,6 @@
 from gitlabform.gitlab.variables import GitLabVariables
 from gitlabform.gitlab.repositories import GitLabRepositories
 from gitlabform.gitlab.resource_groups import GitLabResourceGroups
-from gitlabform.gitlab.schedules import GitLabPipelineSchedules
 from gitlabform.gitlab.integrations import GitLabIntegrations
 from gitlabform.gitlab.users import GitLabUsers
 
@@ -65,7 +64,6 @@ class GitLab(
     GitLabPipelines,
     GitLabMembers,
     GitLabUsers,
-    GitLabPipelineSchedules,
     GitLabProjectBadges,
     GitLabProjectDeployKeys,
     GitLabProjectProtectedEnvironments,

gitlabform/processors/project/schedules_processor.py

@@ -1,6 +1,9 @@
 from logging import debug
 from typing import Dict, List
 
+from gitlab.base import RESTObjectList, RESTObject
+from gitlab.v4.objects import Project, ProjectPipelineSchedule
+
 from gitlabform.gitlab import GitLab
 from gitlabform.processors.abstract_processor import AbstractProcessor
 
@@ -9,16 +12,21 @@
     def __init__(self, gitlab: GitLab):
         super().__init__("schedules", gitlab)
 
-    def _process_configuration(self, project_and_group: str, configuration: dict):
+    def _process_configuration(self, project_and_group: str, configuration: Dict):
         configured_schedules = configuration.get("schedules", {})
+
         enforce_schedules = configuration.get("schedules|enforce", False)
 
         # Remove 'enforce' key from the config so that it's not treated as a "schedule"
         if enforce_schedules:
             configured_schedules.pop("enforce")
 
-        existing_schedules = self.gitlab.get_all_pipeline_schedules(project_and_group)
-        schedule_ids_by_description = self.__group_schedule_ids_by_description(
+        project: Project = self.gl.projects.get(project_and_group)
+        existing_schedules: List[RESTObject] | RESTObjectList = (
+            project.pipelineschedules.list()
+        )
+
+        schedule_ids_by_description: Dict = self._group_schedule_ids_by_description(
             existing_schedules
         )
 
@@ -29,115 +37,134 @@
                 if schedule_ids:
                     debug("Deleting pipeline schedules '%s'", schedule_description)
                     for schedule_id in schedule_ids:
-                        self.gitlab.delete_pipeline_schedule(
-                            project_and_group, schedule_id
-                        )
+                        project.pipelineschedules.get(schedule_id).delete()
                 else:
                     debug(
                         "Not deleting pipeline schedules '%s', because none exist",
                         schedule_description,
                     )
             else:
+                entity_config = configured_schedules[schedule_description]
+
                 if schedule_ids and len(schedule_ids) == 1:
-                    debug(
-                        "Changing existing pipeline schedule '%s'", schedule_description
-                    )
-                    schedule_id = schedule_ids[0]
-                    self.gitlab.take_ownership(project_and_group, schedule_id)
-                    self.gitlab.update_pipeline_schedule(
-                        project_and_group,
-                        schedule_id,
-                        configuration.get("schedules|" + schedule_description),
-                    )
-                    self.__set_schedule_variables(
-                        project_and_group,
-                        schedule_id,
-                        configuration.get(
-                            "schedules|" + schedule_description + "|variables"
-                        ),
+                    schedule = project.pipelineschedules.get(schedule_ids[0])
+                    self._update_existing_schedule(
+                        entity_config, project, schedule, schedule_description
                     )
                 elif schedule_ids:
                     debug(
                         "Replacing existing pipeline schedules '%s'",
                         schedule_description,
                     )
                     for schedule_id in schedule_ids:
-                        self.gitlab.delete_pipeline_schedule(
-                            project_and_group, schedule_id
-                        )
-                    self.create_schedule_with_variables(
-                        configuration, project_and_group, schedule_description
+                        project.pipelineschedules.get(schedule_id).delete()
+
+                    self._create_schedule_with_variables(
+                        entity_config, project, schedule_description
                     )
                 else:
                     debug("Creating pipeline schedule '%s'", schedule_description)
-                    self.create_schedule_with_variables(
-                        configuration, project_and_group, schedule_description
+                    self._create_schedule_with_variables(
+                        entity_config, project, schedule_description
                     )
 
         if enforce_schedules:
             debug("Delete unconfigured schedules because enforce is enabled")
 
-            for schedule in existing_schedules:
-                schedule_description = schedule["description"]
-                schedule_id = schedule["id"]
+            self._delete_schedules_no_longer_in_config(
+                configured_schedules, existing_schedules, project
+            )
 
-                debug(f"processing {schedule_id}: {schedule_description}")
-                if schedule_description not in configured_schedules:
-                    debug(
-                        "Deleting pipeline schedule named '%s', because it is not in gitlabform configuration",
-                        schedule_description,
-                    )
-                    self.gitlab.delete_pipeline_schedule(project_and_group, schedule_id)
+    def _update_existing_schedule(
+        self,
+        entity_config: Dict,
+        project: Project,
+        schedule_in_gitlab: ProjectPipelineSchedule,
+        schedule_description: str,
+    ):
 
-    def create_schedule_with_variables(
-        self, configuration, project_and_group, schedule_description
+        if self._needs_update(schedule_in_gitlab.asdict(), entity_config):
+            debug("Changing existing pipeline schedule '%s'", schedule_description)
+            # In order to edit a Schedule created by someone else we need to take ownership:
+            # https://docs.gitlab.com/ee/ci/pipelines/schedules.html#take-ownership
+            shedule = project.pipelineschedules.get(schedule_in_gitlab.id)
+            shedule.take_ownership()
+            project.pipelineschedules.update(
+                schedule_in_gitlab.id,
+                {"description": schedule_description, **entity_config},
+            )
+            configured_variables = entity_config.get("variables")
+            if configured_variables is not None:
+                self._set_schedule_variables(
+                    schedule_in_gitlab,
+                    configured_variables,
+                )
+        else:
+            debug("No update required for pipeline schedule '%s'", schedule_description)
+
+    def _create_schedule_with_variables(
+        self,
+        entity_config: Dict,
+        project: Project,
+        schedule_description: str,
     ):
-        data = configuration.get("schedules|" + schedule_description)
-        created_schedule = self.gitlab.create_pipeline_schedule(
-            project_and_group,
-            schedule_description,
-            data.get("ref"),
-            data.get("cron"),
-            optional_data=data,
-        )
-        self.__set_schedule_variables(
-            project_and_group,
-            created_schedule.get("id"),
-            configuration.get("schedules|" + schedule_description + "|variables"),
-        )
+        schedule_data = {"description": schedule_description, **entity_config}
+        debug("Creating pipeline schedule using data: '%s'", schedule_data)
 
-    def __set_schedule_variables(self, project_and_group, schedule_id, variables):
-        schedule = self.gitlab.get_pipeline_schedule(project_and_group, schedule_id)
+        created_schedule_id = project.pipelineschedules.create(schedule_data).id
+        created_schedule = project.pipelineschedules.get(created_schedule_id)
 
-        existing_variables = schedule.get("variables")
-        if existing_variables:
-            debug(
-                "Deleting variables for pipeline schedule '%s'", schedule["description"]
+        configured_variables = entity_config.get("variables")
+        if configured_variables is not None:
+            self._set_schedule_variables(
+                created_schedule,
+                configured_variables,
             )
 
+        created_schedule.save()
+
+    @staticmethod
+    def _set_schedule_variables(
+        schedule: ProjectPipelineSchedule, variables: Dict
+    ) -> None:
+        attributes = schedule.attributes
+        existing_variables = attributes.get("variables")
+        if existing_variables:
+            debug("Deleting variables for pipeline schedule '%s'", schedule.description)
+
             for variable in existing_variables:
-                self.gitlab.delete_pipeline_schedule_variable(
-                    project_and_group, schedule_id, variable.get("key")
-                )
+                schedule.variables.delete(variable.get("key"))
 
         if variables:
             for variable_key, variable_data in variables.items():
-                self.gitlab.create_pipeline_schedule_variable(
-                    project_and_group,
-                    schedule_id,
-                    variable_key,
-                    variable_data.get("value"),
-                    variable_data,
-                )
+                schedule.variables.create({"key": variable_key, **variable_data})
 
     @staticmethod
-    def __group_schedule_ids_by_description(schedules) -> Dict[str, List[str]]:
+    def _group_schedule_ids_by_description(
+        schedules,
+    ) -> Dict[str, List[str]]:
         schedule_ids_by_description: Dict[str, List[str]] = {}
 
         for schedule in schedules:
-            description = schedule["description"]
-            schedule_ids_by_description.setdefault(description, []).append(
-                schedule["id"]
+            schedule_ids_by_description.setdefault(schedule.description, []).append(
+                schedule.id
             )
 
         return schedule_ids_by_description
+
+    @staticmethod
+    def _delete_schedules_no_longer_in_config(
+        configured_schedules: Dict, existing_schedules, project: Project
+    ) -> None:
+        schedule: ProjectPipelineSchedule
+        for schedule in existing_schedules:
+            schedule_description = schedule.description
+            schedule_id = schedule.id
+
+            debug(f"processing {schedule_id}: {schedule_description}")
+            if schedule_description not in configured_schedules:
+                debug(
+                    "Deleting pipeline schedule named '%s', because it is not in gitlabform configuration",
+                    schedule_description,
+                )
+                project.pipelineschedules.get(schedule_id).delete()