gitlab-projects-settings 2.1.0__tar.gz → 3.0.0__tar.gz

{gitlab_projects_settings-2.1.0 → gitlab_projects_settings-3.0.0}/.gitlab-ci.yml

@@ -53,43 +53,6 @@ changelog:
   rules:
     - if: $CI_LOCAL
 
-readme:
-  stage: development
-  image: local:silent
-  script:
-    - |
-      export COLUMNS=120
-      mkdir -p ./.tmp/
-      PACKAGE_NAME=$(grep '^PROJECT_NAME =' ./setup.py | cut -d"'" -f2)
-      {
-        echo ''
-        echo '```yaml'
-        alignments='[ ]\{2,\}'
-        argument='[[:alnum:]][[:alnum:]_-]\{0,\}'
-        letter='[[:alnum:]_]\{1\}'
-        parameter='[-]\{1,2\}[[:alnum:]][[:alnum:]_-]\{0,\}'
-        word='[[:alnum:]_-]\{1,\}'
-        "${PACKAGE_NAME}" --help \
-          | sed '1d; $d' \
-          | sed "s/^\(  ${parameter} ${word}${alignments}\)/\1# /g" \
-          | sed "s/^\(  ${parameter}${alignments}\)/\1# /g" \
-          | sed "s/^\(  ${parameter}, ${parameter}${alignments}\)/\1# /g" \
-          | sed "s/^\(  ${argument}${alignments}\)/\1# /g"
-        echo '```'
-        echo ''
-      } >./.tmp/README.help.tmp
-    - |
-      lead='^<!-- readme-help-start -->$'
-      tail='^<!-- readme-help-stop -->$'
-      sed -i "/${lead}/,/${tail}/{ /${lead}/{ p; r ./.tmp/README.help.tmp
-        }; /${tail}/p; d }"  ./README.md | head -n 100
-    - rm -f ./.tmp/README.help.tmp
-    - |
-      git -c color.diff=always --no-pager diff ./README.md | grep --color=never '.' && echo ''
-      echo  ' > README: Updated successfully'
-  rules:
-    - if: $CI_LOCAL
-
 # =============================================================================
 # Stage: prepare
 
@@ -192,6 +155,43 @@ install:
   rules:
     - if: $CI_LOCAL
 
+readme:
+  stage: build
+  image: local:silent
+  script:
+    - |
+      export COLUMNS=120
+      mkdir -p ./.tmp/
+      PACKAGE_NAME=$(grep '^PROJECT_NAME =' ./setup.py | cut -d"'" -f2)
+      {
+        echo ''
+        echo '```yaml'
+        alignments='[ ]\{2,\}'
+        argument='[[:alnum:]][[:alnum:]_-]\{0,\}'
+        letter='[[:alnum:]_]\{1\}'
+        parameter='[-]\{1,2\}[[:alnum:]][[:alnum:]_-]\{0,\}'
+        word='[[:alnum:]_-]\{1,\}'
+        "${PACKAGE_NAME}" --help \
+          | sed '1d; $d' \
+          | sed "s/^\(  ${parameter} ${word}${alignments}\)/\1# /g" \
+          | sed "s/^\(  ${parameter}${alignments}\)/\1# /g" \
+          | sed "s/^\(  ${parameter}, ${parameter}${alignments}\)/\1# /g" \
+          | sed "s/^\(  ${argument}${alignments}\)/\1# /g"
+        echo '```'
+        echo ''
+      } >./.tmp/README.help.tmp
+    - |
+      lead='^<!-- readme-help-start -->$'
+      tail='^<!-- readme-help-stop -->$'
+      sed -i "/${lead}/,/${tail}/{ /${lead}/{ p; r ./.tmp/README.help.tmp
+        }; /${tail}/p; d }"  ./README.md | head -n 100
+    - rm -f ./.tmp/README.help.tmp
+    - |
+      git -c color.diff=always --no-pager diff ./README.md | grep --color=never '.' && echo ''
+      echo  ' > README: Updated successfully'
+  rules:
+    - if: $CI_LOCAL
+
 # =============================================================================
 # Stage: deploy
 

{gitlab_projects_settings-2.1.0 → gitlab_projects_settings-3.0.0}/CHANGELOG.md

@@ -1,4 +1,34 @@
 
+<a name="3.0.0"></a>
+## [3.0.0](https://gitlab.com/AdrianDC/gitlab-projects-settings/compare/2.1.0...3.0.0) (2024-05-06)
+
+### Bug Fixes
+
+* **entrypoint:** resolve support for private user namespaces
+* **entrypoint:** detect if GitLab actions can continue
+* **entrypoint:** enforce against missing '.description' values
+* **gitlab:** enforce 'group_delete' usage in '--dry-run' mode
+* **gitlab:** delay groups deletion by 10s and projects by 5s
+* **gitlab:** get all branches and tags upon 'list()' calls
+* **gitlab:** get all members in 'project_reset_members'
+
+### Ci
+
+* **gitlab-ci:** move 'readme' job after 'build' and local 'install'
+
+### Cleanups
+
+* **gitlab:** minor comments changes in 'project_reset_features'
+
+### Features
+
+* **entrypoint:** preserve main group description if exists
+* **entrypoint:** always flush progress output logs
+* **gitlab:** detect multiple branches to keep 'Merge requests'
+* **gitlab:** detect 'Token Access' usage for 'CI/CD' features
+* **namespaces:** migrate 'Helper' class to 'Namespaces' class
+
+
 <a name="2.1.0"></a>
 ## [2.1.0](https://gitlab.com/AdrianDC/gitlab-projects-settings/compare/2.0.2...2.1.0) (2024-04-28)
 

{gitlab_projects_settings-2.1.0 → gitlab_projects_settings-3.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: gitlab-projects-settings
-Version: 2.1.0
+Version: 3.0.0
 Summary: Configure GitLab groups and projects settings automatically
 Home-page: https://gitlab.com/AdrianDC/gitlab-projects-settings
 Author: Adrian DC
@@ -64,8 +64,9 @@ The following step is required before using the tool:
 ```yaml
 usage: gitlab-projects-settings [-h] [--version] [-t TOKEN] [--dry-run] [--exclude-group] [--exclude-subgroups]
                                 [--exclude-projects] [--reset-features] [--reset-members] [--set-avatar FILE]
-                                [--set-description TEXT] [--update-description] [--protect-branches]
-                                [--protect-tags LEVEL]
+                                [--set-description TEXT] [--update-description] [--run-housekeeping]
+                                [--archive-project | --unarchive-project] [--delete-group] [--delete-project]
+                                [--protect-branches] [--protect-tags LEVEL]
                                 [gitlab] [path]
 
 gitlab-projects-settings: Configure GitLab groups and projects settings automatically
@@ -90,13 +91,20 @@ general settings arguments:
   --set-description TEXT  # Set description of GitLab projects and groups
   --update-description    # Update description of GitLab projects and groups automatically
 
+advanced settings arguments:
+  --run-housekeeping      # Run housekeeping of project or projects GitLab in groups
+  --archive-project       # Archive project or projects in GitLab groups
+  --unarchive-project     # Unarchive project or projects in GitLab groups
+  --delete-group          # Delete group or groups in GitLab groups
+  --delete-project        # Delete project or projects in GitLab groups
+
 repository settings arguments:
   --protect-branches      # Protect branches with default master/main, develop and staging
   --protect-tags LEVEL    # Protect tags at level [no-one,admins,maintainers,developers]
 
 positional arguments:
   gitlab                  # GitLab URL (default: https://gitlab.com)
-  path                    # GitLab group or project path
+  path                    # GitLab group, user namespace or project path
 ```
 
 <!-- readme-help-stop -->

{gitlab_projects_settings-2.1.0 → gitlab_projects_settings-3.0.0}/README.md

@@ -30,8 +30,9 @@ The following step is required before using the tool:
 ```yaml
 usage: gitlab-projects-settings [-h] [--version] [-t TOKEN] [--dry-run] [--exclude-group] [--exclude-subgroups]
                                 [--exclude-projects] [--reset-features] [--reset-members] [--set-avatar FILE]
-                                [--set-description TEXT] [--update-description] [--protect-branches]
-                                [--protect-tags LEVEL]
+                                [--set-description TEXT] [--update-description] [--run-housekeeping]
+                                [--archive-project | --unarchive-project] [--delete-group] [--delete-project]
+                                [--protect-branches] [--protect-tags LEVEL]
                                 [gitlab] [path]
 
 gitlab-projects-settings: Configure GitLab groups and projects settings automatically
@@ -56,13 +57,20 @@ general settings arguments:
   --set-description TEXT  # Set description of GitLab projects and groups
   --update-description    # Update description of GitLab projects and groups automatically
 
+advanced settings arguments:
+  --run-housekeeping      # Run housekeeping of project or projects GitLab in groups
+  --archive-project       # Archive project or projects in GitLab groups
+  --unarchive-project     # Unarchive project or projects in GitLab groups
+  --delete-group          # Delete group or groups in GitLab groups
+  --delete-project        # Delete project or projects in GitLab groups
+
 repository settings arguments:
   --protect-branches      # Protect branches with default master/main, develop and staging
   --protect-tags LEVEL    # Protect tags at level [no-one,admins,maintainers,developers]
 
 positional arguments:
   gitlab                  # GitLab URL (default: https://gitlab.com)
-  path                    # GitLab group or project path
+  path                    # GitLab group, user namespace or project path
 ```
 
 <!-- readme-help-stop -->

{gitlab_projects_settings-2.1.0 → gitlab_projects_settings-3.0.0}/gitlab_projects_settings.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: gitlab-projects-settings
-Version: 2.1.0
+Version: 3.0.0
 Summary: Configure GitLab groups and projects settings automatically
 Home-page: https://gitlab.com/AdrianDC/gitlab-projects-settings
 Author: Adrian DC
@@ -64,8 +64,9 @@ The following step is required before using the tool:
 ```yaml
 usage: gitlab-projects-settings [-h] [--version] [-t TOKEN] [--dry-run] [--exclude-group] [--exclude-subgroups]
                                 [--exclude-projects] [--reset-features] [--reset-members] [--set-avatar FILE]
-                                [--set-description TEXT] [--update-description] [--protect-branches]
-                                [--protect-tags LEVEL]
+                                [--set-description TEXT] [--update-description] [--run-housekeeping]
+                                [--archive-project | --unarchive-project] [--delete-group] [--delete-project]
+                                [--protect-branches] [--protect-tags LEVEL]
                                 [gitlab] [path]
 
 gitlab-projects-settings: Configure GitLab groups and projects settings automatically
@@ -90,13 +91,20 @@ general settings arguments:
   --set-description TEXT  # Set description of GitLab projects and groups
   --update-description    # Update description of GitLab projects and groups automatically
 
+advanced settings arguments:
+  --run-housekeeping      # Run housekeeping of project or projects GitLab in groups
+  --archive-project       # Archive project or projects in GitLab groups
+  --unarchive-project     # Unarchive project or projects in GitLab groups
+  --delete-group          # Delete group or groups in GitLab groups
+  --delete-project        # Delete project or projects in GitLab groups
+
 repository settings arguments:
   --protect-branches      # Protect branches with default master/main, develop and staging
   --protect-tags LEVEL    # Protect tags at level [no-one,admins,maintainers,developers]
 
 positional arguments:
   gitlab                  # GitLab URL (default: https://gitlab.com)
-  path                    # GitLab group or project path
+  path                    # GitLab group, user namespace or project path
 ```
 
 <!-- readme-help-stop -->

{gitlab_projects_settings-2.1.0 → gitlab_projects_settings-3.0.0}/gitlab_projects_settings.egg-info/SOURCES.txt

@@ -35,4 +35,6 @@ src/package/version.py
 src/prints/__init__.py
 src/prints/colors.py
 src/system/__init__.py
-src/system/platform.py
+src/system/platform.py
+src/types/__init__.py
+src/types/namespaces.py

{gitlab_projects_settings-2.1.0 → gitlab_projects_settings-3.0.0}/src/cli/entrypoint.py

@@ -5,23 +5,25 @@ from argparse import Namespace
 
 # Modules libraries
 from gitlab.exceptions import GitlabGetError
-from gitlab.v4.objects import Group, Project
+from gitlab.v4.objects import Group as GitLabGroup, Project as GitLabProject, User as GitLabUser
 
 # Components
 from ..features.gitlab import GitLabFeature
 from ..prints.colors import Colors
 from ..system.platform import Platform
+from ..types.namespaces import Namespaces
 
 # Entrypoint class, pylint: disable=too-few-public-methods
 class Entrypoint:
 
-    # CLI
+    # CLI, pylint: disable=too-many-branches
     @staticmethod
     def cli(options: Namespace) -> bool:
 
         # Variables
-        group: Group = None
-        project: Project = None
+        group: GitLabGroup = None
+        project: GitLabProject = None
+        user: GitLabUser = None
 
         # Header
         print(' ')
@@ -46,14 +48,26 @@ class Entrypoint:
                   f'{Colors.RESET}')
             print(' ')
             Platform.flush()
-        except GitlabGetError:
-            project = gitlab.project(options.path)
-            print(f'{Colors.BOLD} - GitLab project: '
-                  f'{Colors.GREEN}{project.path_with_namespace}'
-                  f'{Colors.CYAN} ({project.description})'
-                  f'{Colors.RESET}')
-            print(' ')
-            Platform.flush()
+        except GitlabGetError as exception:
+            try:
+                if '/' in options.path:
+                    raise TypeError from exception
+                user = gitlab.user(options.path)
+                namespace = gitlab.namespace(user.namespace_id)
+                print(f'{Colors.BOLD} - GitLab user namespace: '
+                      f'{Colors.GREEN}{namespace.full_path}'
+                      f'{Colors.CYAN} ({namespace.name})'
+                      f'{Colors.RESET}')
+                print(' ')
+                Platform.flush()
+            except (GitlabGetError, TypeError):
+                project = gitlab.project(options.path)
+                print(f'{Colors.BOLD} - GitLab project: '
+                      f'{Colors.GREEN}{project.path_with_namespace}'
+                      f'{Colors.CYAN} ({project.description})'
+                      f'{Colors.RESET}')
+                print(' ')
+                Platform.flush()
 
         # Handle single project
         if project:
@@ -68,11 +82,12 @@ class Entrypoint:
 
             # Handle group
             if not options.exclude_group:
-                Entrypoint.group(
-                    options,
-                    gitlab,
-                    group.id,
-                )
+                if not Entrypoint.group(
+                        options,
+                        gitlab,
+                        group.id,
+                ):
+                    return False
 
             # Iterate through subgroups
             if not options.exclude_subgroups:
@@ -85,12 +100,13 @@ class Entrypoint:
                         ),
                         key=lambda item: item.full_path,
                 ):
-                    Entrypoint.group(
-                        options,
-                        gitlab,
-                        group_subgroup.id,
-                        True,
-                    )
+                    if not Entrypoint.group(
+                            options,
+                            gitlab,
+                            group_subgroup.id,
+                            True,
+                    ):
+                        return False
 
             # Iterate through projects
             if not options.exclude_projects:
@@ -103,11 +119,32 @@ class Entrypoint:
                         ),
                         key=lambda item: item.path_with_namespace,
                 ):
-                    Entrypoint.project(
-                        options,
-                        gitlab,
-                        group_project.id,
-                    )
+                    if not Entrypoint.project(
+                            options,
+                            gitlab,
+                            group_project.id,
+                    ):
+                        return False
+
+        # Handle user recursively
+        elif user:
+
+            # Iterate through projects
+            if not options.exclude_projects:
+                for user_project in sorted(
+                        user.projects.list(
+                            get_all=True,
+                            order_by='path',
+                            sort='asc',
+                        ),
+                        key=lambda item: item.path_with_namespace,
+                ):
+                    if not Entrypoint.project(
+                            options,
+                            gitlab,
+                            user_project.id,
+                    ):
+                        return False
 
         # Result
         return True
@@ -119,13 +156,13 @@ class Entrypoint:
         gitlab: GitLabFeature,
         criteria: str,
         subgroup: bool = False,
-    ) -> None:
+    ) -> bool:
 
         # Acquire group
         group = gitlab.group(criteria)
 
         # Acquire parent group
-        parent_group: Group = None
+        parent_group: GitLabGroup = None
         if group.parent_id:
             parent_group = gitlab.group(group.parent_id)
 
@@ -142,6 +179,17 @@ class Entrypoint:
               f'{Colors.YELLOW_LIGHT}{group.full_path} '
               f'{Colors.CYAN}({group.description})'
               f'{Colors.RESET}')
+        Platform.flush()
+
+        # Delete group
+        if options.delete_group:
+            gitlab.group_delete(criteria)
+            print(f'{Colors.BOLD}   - Delete {group_type}: '
+                  f'{Colors.GREEN}Success'
+                  f'{Colors.RESET}')
+            print(' ')
+            Platform.flush()
+            return subgroup
 
         # Set group description
         if options.set_description:
@@ -149,27 +197,32 @@ class Entrypoint:
             print(f'{Colors.BOLD}   - Set description: '
                   f'{Colors.CYAN}{options.set_description}'
                   f'{Colors.RESET}')
+            Platform.flush()
 
         # Update group description
         elif options.update_description:
             parent_description_text: str = ''
             if parent_name:
-                parent_description_text = ' - ' + GitLabFeature.Helper.describe(
-                    parent_description,
-                    parent_name,
+                parent_description_text = ' - ' + Namespaces.describe(
+                    name=parent_name,
+                    description=parent_description,
                 )
-            if not parent_description_text or not group.description.endswith(
-                    f'{parent_description_text}'):
-                description = f'{GitLabFeature.Helper.capitalize(group.name)}' \
-                            f'{parent_description_text}'
+            if not group.description or subgroup and ( \
+                        not parent_description_text or \
+                        not group.description.endswith(f'{parent_description_text}') \
+                    ):
+                description = f'{Namespaces.describe(name=group.name)}' \
+                              f'{parent_description_text}'
                 gitlab.group_set_description(criteria, description)
                 print(f'{Colors.BOLD}   - Updated description: '
                       f'{Colors.CYAN}{description}'
                       f'{Colors.RESET}')
+                Platform.flush()
             else:
                 print(f'{Colors.BOLD}   - Kept description: '
                       f'{Colors.GREEN}{group.description}'
                       f'{Colors.RESET}')
+                Platform.flush()
 
         # Reset group members
         if options.reset_members:
@@ -177,6 +230,7 @@ class Entrypoint:
             print(f'{Colors.BOLD}   - Reset members: '
                   f'{Colors.GREEN}Success'
                   f'{Colors.RESET}')
+            Platform.flush()
 
         # Set group avatar
         if options.set_avatar:
@@ -184,30 +238,42 @@ class Entrypoint:
             print(f'{Colors.BOLD}   - Set avatar: '
                   f'{Colors.CYAN}{options.set_avatar}'
                   f'{Colors.RESET}')
+            Platform.flush()
 
         # Footer
         print(' ')
         Platform.flush()
 
-    # Project, pylint: disable=too-many-branches
+        # Result
+        return True
+
+    # Project, pylint: disable=too-many-branches,too-many-statements
     @staticmethod
     def project(
         options: Namespace,
         gitlab: GitLabFeature,
         criteria: str,
-    ) -> None:
+    ) -> bool:
 
         # Acquire project
         project = gitlab.project(criteria)
 
-        # Acquire group
-        group = gitlab.group(project.namespace['id'])
-
         # Show project details
         print(f'{Colors.BOLD} - GitLab project: '
               f'{Colors.YELLOW_LIGHT}{project.path_with_namespace} '
               f'{Colors.CYAN}({project.description})'
               f'{Colors.RESET}')
+        Platform.flush()
+
+        # Delete project
+        if options.delete_project:
+            gitlab.project_delete(criteria)
+            print(f'{Colors.BOLD}   - Delete project: '
+                  f'{Colors.GREEN}Success'
+                  f'{Colors.RESET}')
+            print(' ')
+            Platform.flush()
+            return True
 
         # Set project description
         if options.set_description:
@@ -215,24 +281,34 @@ class Entrypoint:
             print(f'{Colors.BOLD}   - Set description: '
                   f'{Colors.CYAN}{options.set_description}'
                   f'{Colors.RESET}')
+            Platform.flush()
 
         # Update project description
         elif options.update_description:
-            group_description = GitLabFeature.Helper.describe(
-                group.description,
-                group.name,
-            )
-            if not project.description.endswith(f' - {group_description}'):
-                description = f'{GitLabFeature.Helper.capitalize(project.name)}' \
-                              f' - {group_description}'
+            namespace_description: str
+            if project.namespace['kind'] == 'user':
+                namespace = gitlab.namespace(project.namespace['id'])
+                namespace_description = namespace.name
+            else:
+                group = gitlab.group(project.namespace['id'])
+                namespace_description = Namespaces.describe(
+                    name=group.name,
+                    description=group.description,
+                )
+            if not project.description or \
+                    not project.description.endswith(f' - {namespace_description}'):
+                description = f'{Namespaces.describe(name=project.name)}' \
+                              f' - {namespace_description}'
                 gitlab.project_set_description(criteria, description)
                 print(f'{Colors.BOLD}   - Updated description: '
                       f'{Colors.CYAN}{description}'
                       f'{Colors.RESET}')
+                Platform.flush()
             else:
                 print(f'{Colors.BOLD}   - Kept description: '
                       f'{Colors.GREEN}{project.description}'
                       f'{Colors.RESET}')
+                Platform.flush()
 
         # Reset project features
         if options.reset_features:
@@ -241,10 +317,12 @@ class Entrypoint:
                 print(f'{Colors.BOLD}   - Reset features: '
                       f'{Colors.CYAN}{features}'
                       f'{Colors.RESET}')
+                Platform.flush()
             else:
                 print(f'{Colors.BOLD}   - Reset features: '
                       f'{Colors.GREEN}Already done'
                       f'{Colors.RESET}')
+                Platform.flush()
 
         # Reset project members
         if options.reset_members:
@@ -252,6 +330,7 @@ class Entrypoint:
             print(f'{Colors.BOLD}   - Reset members: '
                   f'{Colors.GREEN}Success'
                   f'{Colors.RESET}')
+            Platform.flush()
 
         # Set project avatar
         if options.set_avatar:
@@ -259,6 +338,31 @@ class Entrypoint:
             print(f'{Colors.BOLD}   - Set avatar: '
                   f'{Colors.CYAN}{options.set_avatar}'
                   f'{Colors.RESET}')
+            Platform.flush()
+
+        # Run project housekeeping
+        if options.run_housekeeping:
+            gitlab.project_run_housekeeping(criteria)
+            print(f'{Colors.BOLD}   - Ran housekeeping: '
+                  f'{Colors.GREEN}Success'
+                  f'{Colors.RESET}')
+            Platform.flush()
+
+        # Archive project
+        if options.archive_project:
+            gitlab.project_set_archive(criteria, True)
+            print(f'{Colors.BOLD}   - Archive project: '
+                  f'{Colors.GREEN}Success'
+                  f'{Colors.RESET}')
+            Platform.flush()
+
+        # Unarchive project
+        elif options.unarchive_project:
+            gitlab.project_set_archive(criteria, False)
+            print(f'{Colors.BOLD}   - Unarchive project: '
+                  f'{Colors.GREEN}Success'
+                  f'{Colors.RESET}')
+            Platform.flush()
 
         # Protect project branches
         if options.protect_branches:
@@ -267,10 +371,12 @@ class Entrypoint:
                 print(f'{Colors.BOLD}   - Protecting branches: '
                       f'{Colors.CYAN}{branches}'
                       f'{Colors.RESET}')
+                Platform.flush()
             else:
                 print(f'{Colors.BOLD}   - Protecting branches: '
                       f'{Colors.GREEN}Already done'
                       f'{Colors.RESET}')
+                Platform.flush()
 
         # Protect project tags
         if options.protect_tags:
@@ -280,11 +386,16 @@ class Entrypoint:
                       f'{Colors.CYAN}{tags}'
                       f'{Colors.GREEN} (level: {options.protect_tags})'
                       f'{Colors.RESET}')
+                Platform.flush()
             else:
                 print(f'{Colors.BOLD}   - Protecting tags: '
                       f'{Colors.GREEN}Already done'
                       f'{Colors.RESET}')
+                Platform.flush()
 
         # Footer
         print(' ')
         Platform.flush()
+
+        # Result
+        return True

{gitlab_projects_settings-2.1.0 → gitlab_projects_settings-3.0.0}/src/cli/main.py

@@ -1,7 +1,8 @@
 #!/usr/bin/env python3
 
 # Standard libraries
-from argparse import (_ArgumentGroup, ArgumentParser, Namespace, RawTextHelpFormatter)
+from argparse import (_ArgumentGroup, _MutuallyExclusiveGroup, ArgumentParser, Namespace,
+                      RawTextHelpFormatter)
 from os import environ
 from shutil import get_terminal_size
 from sys import exit as sys_exit
@@ -19,6 +20,7 @@ def main() -> None:
     # Variables
     group: _ArgumentGroup
     result: bool = False
+    subgroup: _MutuallyExclusiveGroup
 
     # Arguments creation
     parser: ArgumentParser = ArgumentParser(
@@ -122,6 +124,40 @@ def main() -> None:
         help='Update description of GitLab projects and groups automatically',
     )
 
+    # Arguments advanced settings definitions
+    group = parser.add_argument_group('advanced settings arguments')
+    group.add_argument(
+        '--run-housekeeping',
+        dest='run_housekeeping',
+        action='store_true',
+        help='Run housekeeping of project or projects GitLab in groups',
+    )
+    subgroup = group.add_mutually_exclusive_group()
+    subgroup.add_argument(
+        '--archive-project',
+        dest='archive_project',
+        action='store_true',
+        help='Archive project or projects in GitLab groups',
+    )
+    subgroup.add_argument(
+        '--unarchive-project',
+        dest='unarchive_project',
+        action='store_true',
+        help='Unarchive project or projects in GitLab groups',
+    )
+    group.add_argument(
+        '--delete-group',
+        dest='delete_group',
+        action='store_true',
+        help='Delete group or groups in GitLab groups',
+    )
+    group.add_argument(
+        '--delete-project',
+        dest='delete_project',
+        action='store_true',
+        help='Delete project or projects in GitLab groups',
+    )
+
     # Arguments repository settings definitions
     group = parser.add_argument_group('repository settings arguments')
     group.add_argument(
@@ -151,7 +187,7 @@ def main() -> None:
         dest='path',
         action='store',
         nargs='?',
-        help='GitLab group or project path',
+        help='GitLab group, user namespace or project path',
     )
 
     # Arguments parser

{gitlab_projects_settings-2.1.0 → gitlab_projects_settings-3.0.0}/src/features/gitlab.py

@@ -1,12 +1,13 @@
 #!/usr/bin/env python3
 
 # Standard libraries
+from time import sleep
 from typing import List
 
 # Modules libraries
 from gitlab import Gitlab
-from gitlab.exceptions import GitlabListError
-from gitlab.v4.objects import Group, Project
+from gitlab.exceptions import GitlabGetError, GitlabListError
+from gitlab.v4.objects import Group, Namespace, Project, User
 
 # GitLabFeature class
 class GitLabFeature:
@@ -25,12 +26,21 @@ class GitLabFeature:
     def group(self, criteria: str) -> Group:
         return self.__gitlab.groups.get(criteria)
 
+    # Group delete
+    def group_delete(self, criteria: str) -> None:
+
+        # Delete group
+        if not self.__dry_run:
+            group = self.group(criteria)
+            group.delete()
+            sleep(10)
+
     # Group reset members
     def group_reset_members(self, criteria: str) -> None:
 
         # Remove group members
         group = self.group(criteria)
-        for member in group.members.list():
+        for member in group.members.list(get_all=True):
             if not self.__dry_run:
                 group.members.delete(member.id)
 
@@ -61,10 +71,23 @@ class GitLabFeature:
             # Save group
             group.save()
 
+    # Namespace
+    def namespace(self, criteria: str) -> Namespace:
+        return self.__gitlab.namespaces.get(criteria)
+
     # Project
     def project(self, criteria: str) -> Project:
         return self.__gitlab.projects.get(criteria)
 
+    # Project delete
+    def project_delete(self, criteria: str) -> None:
+
+        # Delete project
+        project = self.project(criteria)
+        if not self.__dry_run:
+            project.delete()
+            sleep(5)
+
     # Project protect branches
     def project_protect_branches(self, criteria: str) -> List[str]:
 
@@ -72,14 +95,15 @@ class GitLabFeature:
         result: List[str] = []
         project = self.project(criteria)
         try:
-            assert project.branches.list()
+            assert project.branches.list(get_all=True)
         except (AssertionError, GitlabListError):
             return result
 
         # Acquire project, branches and protected branches
-        branches = [branch.name for branch in project.branches.list()]
+        branches = [branch.name for branch in project.branches.list(get_all=True)]
         protectedbranches = [
-            protectedbranch.name for protectedbranch in project.protectedbranches.list()
+            protectedbranch.name
+            for protectedbranch in project.protectedbranches.list(get_all=True)
         ]
 
         # Protect main/master
@@ -132,7 +156,7 @@ class GitLabFeature:
         result: List[str] = []
         project = self.project(criteria)
         try:
-            assert project.tags.list()
+            assert project.tags.list(get_all=True)
         except (AssertionError, GitlabListError):
             return result
 
@@ -151,11 +175,11 @@ class GitLabFeature:
 
         # Acquire protected tags
         protectedtags = [
-            protectedtag.name for protectedtag in project.protectedtags.list()
+            protectedtag.name for protectedtag in project.protectedtags.list(get_all=True)
         ]
 
         # Update protected tags
-        for protectedtag in project.protectedtags.list():
+        for protectedtag in project.protectedtags.list(get_all=True):
             protectedtag_level = protectedtag.create_access_levels[0]['access_level']
             if protectedtag_level != 0 and (access_level == 0
                                             or protectedtag_level < access_level):
@@ -169,7 +193,7 @@ class GitLabFeature:
                 result += [name]
 
         # Protect unprotected tags
-        for tag in project.tags.list():
+        for tag in project.tags.list(get_all=True):
             if tag.name not in protectedtags:
                 if not self.__dry_run:
                     project.protectedtags.create({
@@ -193,80 +217,145 @@ class GitLabFeature:
         result: List[str] = []
         project = self.__gitlab.projects.get(criteria, statistics=True)
 
-        # Disable unused features
+        # Disable unused feature (Issues)
         if project.issues_enabled and not project.issues.list(get_all=False):
             project.issues_enabled = False
             result += ['Issues']
+
+        # Disable unused feature (Repository)
         try:
             assert project.commits.list(get_all=False)
         except (AssertionError, GitlabListError):
             if project.repository_access_level != 'disabled':
                 project.repository_access_level = 'disabled'
                 result += ['Repository']
-        if project.merge_requests_enabled and not project.mergerequests.list(
-                get_all=False):
-            project.merge_requests_enabled = False
-            result += ['Merge requests']
+
+        # Disable unused feature (Merge requests)
+        try:
+            if not project.mergerequests.list(get_all=False):
+                pass
+            elif len(project.branches.list(get_all=False)) > 1:
+                pass
+            else:
+                assert False
+        except (AssertionError, GitlabListError):
+            if project.merge_requests_enabled:
+                project.merge_requests_enabled = False
+                result += ['Merge requests']
+
+        # Disable unused feature (Forks)
         if project.forking_access_level != 'disabled' and not project.forks.list(
                 get_all=False):
             project.forking_access_level = 'disabled'
             result += ['Forks']
+
+        # Disable unused feature (Git LFS)
         if project.lfs_enabled and project.statistics['lfs_objects_size'] == 0:
             project.lfs_enabled = False
             result += ['Git LFS']
-        if project.jobs_enabled and not project.jobs.list(get_all=False):
-            project.jobs_enabled = False
-            result += ['CI/CD']
+
+        # Disable unused feature (CI/CD)
+        try:
+            if project.jobs.list(get_all=False):
+                pass
+            elif any('name' in item and item['name'] == '.gitlab-ci.yml'
+                     for item in project.repository_tree(get_all=True)):
+                pass
+            elif any('path_with_namespace' in item
+                     and item['path_with_namespace'] != project.path_with_namespace
+                     for item in self.__gitlab.http_get(
+                         f'/projects/{project.id}/job_token_scope/allowlist',
+                         get_all=True,
+                     )):
+                pass
+            else:
+                assert False
+        except (AssertionError, GitlabGetError, GitlabListError):
+            if project.jobs_enabled:
+                project.jobs_enabled = False
+                result += ['CI/CD']
+
+        # Disable unused feature (Container registry)
         if project.container_registry_enabled and not project.repositories.list(
                 get_all=False):
             project.container_registry_enabled = False
             result += ['Container registry']
+
+        # Disable unused feature (Analytics)
         if project.analytics_access_level != 'disabled':
             project.analytics_access_level = 'disabled'
             result += ['Analytics']
+
+        # Disable unused feature (Security and Compliance)
         if project.security_and_compliance_access_level != 'disabled':
             project.security_and_compliance_access_level = 'disabled'
             result += ['Security and Compliance']
+
+        # Disable unused feature (Wiki)
         if project.wiki_enabled and not project.wikis.list(get_all=False):
             project.wiki_enabled = False
             result += ['Wiki']
+
+        # Disable unused feature (Snippets)
         if project.snippets_enabled and not project.snippets.list(get_all=False):
             project.snippets_enabled = False
             result += ['Snippets']
+
+        # Disable unused feature (Package registry)
         if project.packages_enabled and not project.packages.list(get_all=False):
             project.packages_enabled = False
             result += ['Package registry']
+
+        # Disable unused feature (Model experiments)
         if project.model_experiments_access_level != 'disabled':
             project.model_experiments_access_level = 'disabled'
             result += ['Model experiments']
+
+        # Disable unused feature (Model registry)
         if project.model_registry_access_level != 'disabled':
             project.model_registry_access_level = 'disabled'
             result += ['Model registry']
+
+        # Disable unused feature (Pages)
         if project.pages_access_level != 'disabled':
             project.pages_access_level = 'disabled'
             result += ['Pages']
+
+        # Disable unused feature (Monitor)
         if project.monitor_access_level != 'disabled':
             project.monitor_access_level = 'disabled'
             result += ['Monitor']
+
+        # Disable unused feature (Environments)
         try:
             assert project.environments.list(get_all=False)
         except (AssertionError, GitlabListError):
             if project.environments_access_level != 'disabled':
                 project.environments_access_level = 'disabled'
                 result += ['Environments']
+
+        # Disable unused feature (Feature flags)
         if project.feature_flags_access_level != 'disabled':
             project.feature_flags_access_level = 'disabled'
             result += ['Feature flags']
+
+        # Disable unused feature (Infrastructure)
         if project.infrastructure_access_level != 'disabled':
             project.infrastructure_access_level = 'disabled'
             result += ['Infrastructure']
+
+        # Disable unused feature (Releases)
         if project.releases_access_level != 'disabled' and not project.releases.list(
                 get_all=False):
             project.releases_access_level = 'disabled'
             result += ['Releases']
+
+        # Disable unused feature (Service Desk)
         if project.service_desk_enabled:
             project.service_desk_enabled = False
             result += ['Service Desk']
+
+        # Disable unused feature (Auto DevOps)
         if project.auto_devops_enabled:
             project.auto_devops_enabled = False
             result += ['Auto DevOps']
@@ -284,12 +373,33 @@ class GitLabFeature:
         # Remove project members
         if not self.__dry_run:
             project = self.project(criteria)
-            for member in project.members.list():
+            for member in project.members.list(get_all=True):
                 project.members.delete(member.id)
 
             # Save project
             project.save()
 
+    # Project run housekeeping
+    def project_run_housekeeping(self, criteria: str) -> None:
+
+        # Run project housekeeping
+        if not self.__dry_run:
+            project = self.project(criteria)
+            project.housekeeping()
+
+    # Project set archive
+    def project_set_archive(self, criteria: str, enabled: bool) -> None:
+
+        # Archive project
+        if not self.__dry_run and enabled:
+            project = self.project(criteria)
+            project.archive()
+
+        # Unarchive project
+        elif not self.__dry_run:
+            project = self.project(criteria)
+            project.unarchive()
+
     # Project set avatar
     def project_set_avatar(self, criteria: str, file: str) -> None:
 
@@ -313,25 +423,11 @@ class GitLabFeature:
             # Save project
             project.save()
 
+    # User
+    def user(self, criteria: str) -> User:
+        return self.__gitlab.users.list(username=criteria)[0]
+
     # URL
     @property
     def url(self) -> str:
         return str(self.__gitlab.api_url)
-
-    # Helper class
-    class Helper:
-
-        # Capitalize
-        @staticmethod
-        def capitalize(text: str) -> str:
-            return f'{text[:1].capitalize()}{text[1:]}'
-
-        # Describe
-        @staticmethod
-        def describe(
-            description: str,
-            name: str,
-        ) -> str:
-            if description:
-                return description
-            return GitLabFeature.Helper.capitalize(name)

gitlab_projects_settings-3.0.0/src/types/namespaces.py

@@ -0,0 +1,33 @@
+#!/usr/bin/env python3
+
+# Standard libraries
+from re import sub
+
+# Namespaces class
+class Namespaces:
+
+    # Capitalize
+    @staticmethod
+    def capitalize(text: str, words: bool = False) -> str:
+
+        # Capitalize words
+        if words:
+            return ' '.join(
+                Namespaces.capitalize(word, words=False) for word in text.split())
+
+        # Capitalize text
+        return f'{text[:1].capitalize()}{text[1:]}'
+
+    # Describe
+    @staticmethod
+    def describe(
+        name: str,
+        description: str = '',
+    ) -> str:
+
+        # Use description
+        if description:
+            return description
+
+        # Adapt name
+        return Namespaces.capitalize(sub(r'[-_]', ' ', name), words=True)