gitlabform 5.2.0__tar.gz → 5.3.0__tar.gz

{gitlabform-5.2.0 → gitlabform-5.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gitlabform
-Version: 5.2.0
+Version: 5.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/

{gitlabform-5.2.0 → gitlabform-5.3.0}/gitlabform/__init__.py

@@ -40,6 +40,7 @@ class GitLabForm:
     def __init__(
         self,
         include_archived_projects=True,
+        include_projects_scheduled_for_deletion=True,
         target=None,
         config_string=None,
         noop=False,
@@ -61,6 +62,7 @@ class GitLabForm:
             self.output_file = output_file
             self.skip_version_check = True
             self.include_archived_projects = include_archived_projects
+            self.include_projects_scheduled_for_deletion = include_projects_scheduled_for_deletion
             self.just_show_version = False
             self.terminate_after_error = True
             self.only_sections = "all"
@@ -84,6 +86,7 @@ class GitLabForm:
                 self.output_file,
                 self.skip_version_check,
                 self.include_archived_projects,
+                self.include_projects_scheduled_for_deletion,
                 self.just_show_version,
                 self.terminate_after_error,
                 self.only_sections,
@@ -115,6 +118,7 @@ class GitLabForm:
             self.gitlab,
             self.configuration,
             self.include_archived_projects,
+            self.include_projects_scheduled_for_deletion,
             self.recurse_subgroups,
         )
 
@@ -223,6 +227,13 @@ class GitLabForm:
             help="Includes processing projects that are archived",
         )
 
+        parser.add_argument(
+            "--include-projects-scheduled-for-deletion",
+            dest="include_projects_scheduled_for_deletion",
+            action="store_true",
+            help="Includes processing projects that are scheduled for deletion",
+        )
+
         parser.add_argument(
             "-t",
             "--terminate",
@@ -304,6 +315,7 @@ class GitLabForm:
             args.output_file,
             args.skip_version_check,
             args.include_archived_projects,
+            args.include_projects_scheduled_for_deletion,
             args.just_show_version,
             args.terminate_after_error,
             args.only_sections,
@@ -321,15 +333,14 @@ class GitLabForm:
 
         :param tests: True if we are running in tests mode
         """
+        rich_tracebacks = False
         if tests or self.debug:
             level = logging.DEBUG
             rich_tracebacks = True
         elif self.verbose:
             level = logging.INFO
-            rich_tracebacks = False
         else:
             level = logging.WARNING
-            rich_tracebacks = False
 
         logging.basicConfig(
             level=level, format="%(message)s", datefmt="[%X]", handlers=[RichHandler(rich_tracebacks=rich_tracebacks)]

{gitlabform-5.2.0 → gitlabform-5.3.0}/gitlabform/gitlab/__init__.py

@@ -1,5 +1,6 @@
 import enum
 import inspect
+import logging
 
 from typing import List
 

{gitlabform-5.2.0 → gitlabform-5.3.0}/gitlabform/lists/__init__.py

@@ -13,6 +13,7 @@ from enum import Enum
 @enum.unique
 class OmissionReason(Enum):
     ARCHIVED = "archived"
+    SCHEDULED_FOR_DELETION = "scheduled for deletion"
     EMPTY = "empty effective config"
     SKIPPED = "skipped"
 

{gitlabform-5.2.0 → gitlabform-5.3.0}/gitlabform/lists/projects.py

@@ -19,9 +19,17 @@ class ProjectsProvider(GroupsProvider):
     Because the projects depend on groups requested, this class inherits GroupsProvider.
     """
 
-    def __init__(self, gitlab, configuration, include_archived_projects, recurse_subgroups):
+    def __init__(
+        self,
+        gitlab,
+        configuration,
+        include_archived_projects,
+        include_projects_scheduled_for_deletion,
+        recurse_subgroups,
+    ):
         super().__init__(gitlab, configuration, recurse_subgroups)
         self.include_archived_projects = include_archived_projects
+        self.include_projects_scheduled_for_deletion = include_projects_scheduled_for_deletion
 
     def get_projects(self, target: str) -> Projects:
         """
@@ -70,9 +78,11 @@ class ProjectsProvider(GroupsProvider):
         (
             projects_from_groups,
             archived_projects_from_groups,
-        ) = self._get_all_and_archived_projects_from_groups(groups.get_effective())
+            scheduled_for_deletion_projects_from_groups,
+        ) = self._get_all_and_omitted_projects_from_groups(groups.get_effective())
         projects.add_requested(projects_from_groups)
         projects.add_omitted(OmissionReason.ARCHIVED, archived_projects_from_groups)
+        projects.add_omitted(OmissionReason.SCHEDULED_FOR_DELETION, scheduled_for_deletion_projects_from_groups)
 
         projects_from_configuration = self.configuration.get_projects()
 
@@ -84,17 +94,22 @@ class ProjectsProvider(GroupsProvider):
         if target == "ALL_DEFINED":
             # in this case we also need to get the list of projects explicitly
             # defined in the configuration, but we don't need to re-check for
-            # being archived projects that we already got from groups
+            # being archived or scheduled for deletion projects that we already got from groups
 
-            archived_projects_from_configuration_not_from_groups = (
-                self._verify_if_projects_exist_and_get_archived_projects(projects_from_configuration_not_from_groups)
-            )
+            (
+                archived_projects_from_configuration_not_from_groups,
+                scheduled_for_deletion_projects_from_configuration_not_from_groups,
+            ) = self._verify_if_projects_exist_and_get_omitted_projects(projects_from_configuration_not_from_groups)
 
             projects.add_requested(projects_from_configuration_not_from_groups)
             projects.add_omitted(
                 OmissionReason.ARCHIVED,
                 archived_projects_from_configuration_not_from_groups,
             )
+            projects.add_omitted(
+                OmissionReason.SCHEDULED_FOR_DELETION,
+                scheduled_for_deletion_projects_from_configuration_not_from_groups,
+            )
         else:
             # in all other cases, we also need to look for projects in the config
             # that are being transferred to a different namespace
@@ -117,20 +132,27 @@ class ProjectsProvider(GroupsProvider):
 
         return projects
 
-    def _verify_if_projects_exist_and_get_archived_projects(self, projects: list) -> list:
+    def _verify_if_projects_exist_and_get_omitted_projects(self, projects: list) -> Tuple[list, list]:
         archived = []
+        scheduled_for_deletion = []
         for project in projects:
             try:
                 project_object = self.gitlab.get_project_case_insensitive(project)
-                if project_object["archived"]:
+                if not self.include_archived_projects and project_object["archived"]:
                     archived.append(project_object["path_with_namespace"])
+                if not self.include_projects_scheduled_for_deletion and project_object.get("marked_for_deletion_on"):
+                    scheduled_for_deletion.append(project_object["path_with_namespace"])
             except NotFoundException:
                 debug("Could not find '%s'", project)
                 if project_transfer_source := self._get_project_transfer_source_from_config(project):
                     source_project = self._find_project_transfer_source_in_gitlab(project_transfer_source)
                     if source_project:
-                        if source_project["archived"]:
+                        if not self.include_archived_projects and source_project["archived"]:
                             archived.append(project)
+                        if not self.include_projects_scheduled_for_deletion and source_project.get(
+                            "marked_for_deletion_on"
+                        ):
+                            scheduled_for_deletion.append(project)
                     else:
                         critical(
                             f"""Configuration contains project {project} to be transferred from {project_transfer_source}
@@ -143,25 +165,30 @@ class ProjectsProvider(GroupsProvider):
                     )
                     sys.exit(EXIT_INVALID_INPUT)
 
-        return archived
+        return archived, scheduled_for_deletion
 
-    def _get_all_and_archived_projects_from_groups(self, groups: list) -> Tuple[list, list]:
+    def _get_all_and_omitted_projects_from_groups(self, groups: list) -> Tuple[list, list, list]:
         all = []
         archived = []
+        scheduled_for_deletion = []
         for group in groups:
-            if self.include_archived_projects:
+            if self.include_archived_projects and self.include_projects_scheduled_for_deletion:
                 all += self.gitlab.get_projects(group, include_archived=True)
             else:
                 project_objects = self.gitlab.get_projects(group, include_archived=True, only_names=False)
                 for project_object in project_objects:
                     project = project_object["path_with_namespace"]
                     all.append(project)
-                    if project_object["archived"]:
+                    if not self.include_archived_projects and project_object["archived"]:
                         archived.append(project)
+                    if not self.include_projects_scheduled_for_deletion and project_object.get(
+                        "marked_for_deletion_on"
+                    ):
+                        scheduled_for_deletion.append(project)
 
         # deduplicate as we may have a group X and its subgroup X/Y in the groups list so the effective projects
         # may occur more than once
-        return list(set(all)), list(set(archived))
+        return list(set(all)), list(set(archived)), list(set(scheduled_for_deletion))
 
     def _get_skipped_projects(self, projects: list) -> list:
         skipped = []

{gitlabform-5.2.0 → gitlabform-5.3.0}/gitlabform.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gitlabform
-Version: 5.2.0
+Version: 5.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/

{gitlabform-5.2.0 → gitlabform-5.3.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "gitlabform"
-version = "5.2.0"
+version = "5.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"]
@@ -79,7 +79,8 @@ exclude = ["tests*"]
 [tool.pytest.ini_options]
 filterwarnings = ["ignore::DeprecationWarning"]
 markers = [
-    "requires_license: marks tests which require GitLab paid (Premium/Ultimate) license '-m \"not requires_license\"')",
+    "requires_license: marks tests which require GitLab paid (Premium) license",
+    "requires_ultimate_license: marks tests which require GitLab paid (Ultimate) license)",
     "ce: marks tests which need to be run against GitLab CE image as well as the standard EE image"
 ]