CM-26623-add-support-block-pr-for-org #3

Author: idan-cyber

Dockerfile

@@ -0,0 +1,19 @@
+# Use the official Python image as the base image
+FROM python:3.8-alpine
+
+# Install necessary development tools
+RUN apk add --no-cache libffi-dev=3.4.4-r2 build-base=0.5-r3
+
+# Set the working directory inside the container
+WORKDIR /app
+
+# Copy all files from the build context into the container's /app/ directory
+COPY . /app/
+
+# Install your Python dependencies
+RUN pip install --no-cache-dir PyGithub==1.57
+RUN pip install --no-cache-dir PyInquirer==1.0.3
+RUN pip install --no-cache-dir pydantic==1.10.2
+
+# Command to run your Python console app
+CMD ["python", "main.py"]

README.md

@@ -1,39 +1,80 @@
-# cycode_recovery_utils
+# Cycode Recovery Tool
 
-This script will be responsible for various recovery utils. currently supports
+![logo](https://e5s6t7j5.rocketcdn.me/wp-content/uploads/2020/10/Cycode_logo.svg)
 
-- Release blocked pr's
-    - github
+## Table of Contents
 
-## installation
+- [Overview](#overview)
+- [Features](#features)
+- [Getting Started](#getting-started)
+- [Usage](#usage)
+- [License](#license)
 
-`pip install -r requirements.txt`
+## Overview
 
-## usage
+Introducing the Cycode Recovery Tool, an internal disaster recovery solution exclusively designed to support Cycode's
+customers. This invaluable tool steps in during times of a disaster, ensuring that your software development workflows
+remain resilient even when faced with adversity.
 
-`python3 main.py`
+## Features
 
-- choose recovery action:
-- Release Block Pr: provide path for the configuration file
-  ![recovery action](./docs/recovery_action.png)
-- Release Block Pr: choose provider
-- Release Block Pr: choose which status checks to release
-  ![status_checks_release](./docs/status_checks_release.png)
+* PR Unblocking: The Cycode Recovery Tool specializes in freeing up blocked Pull Requests (PRs), currently providing
+  support exclusively for GitHub repositories. If your development process hits a snag with a blocked PR, this tool
+  comes to the rescue, swiftly resolving the issue and getting your workflow back on track.
+
+## Getting Started
+
+As easy as 1-2-3!
+1. Clone this repository
+2. Build your local docker image
+```
+docker build -t cycode_recovery_tool . --no-cache
+```
+3. Run the docker image
+```
+docker run -ti cycode_recovery_tool
+```
+
+## Usage
+
+1. Choose recovery action (currently only Release Block Pr) ![recovery action](./docs/recovery_action.png)
+2. Provide path for the configuration file (or use our default config.json file)
+3. Choose provider (currently only Github)
+4. Choose which status checks to release ![status_checks_release](./docs/status_checks_release.png)
 
 ## configuration file
 
-Input is as follows:
+There is a sample config file added to the project
 
-```[
+```
+[
   {
-    "token": "token",
-    "provider": "github",
+    "token": "<Github token with repo scope permission>",
+    "provider": "Github",
     "repositories": [
       {
-        "repository_name": "ilan-repo4",
-        "organization_name": "firecorp",
+        "repository_name": "my_repository",
+        "organization_name": "my_organization",
         "branch": "main"
       }
+    ],
+    "organizations": [
+      {
+        "organization_name": "my_organization"
+      },
+      {
+        "organization_name": "my_second_organization"
+      }
     ]
   }
-]
+]
+```
+
+* The token should have `repo` scope permissions.
+* You can provide either `repositories` or `organizations`. You don't need both, but you need at least one of the two.
+* In case `organizations` are provided, we will update all the organization's default branch in all repositories.
+* You can provide multiple SCM configurations.
+
+## License
+
+This project is licensed under the MIT License.

config.json

@@ -0,0 +1,21 @@
+[
+  {
+    "token": "<Github token with repo scope permission>",
+    "provider": "Github",
+    "repositories": [
+      {
+        "repository_name": "my_repository",
+        "organization_name": "my_organization",
+        "branch": "main"
+      }
+    ],
+    "organizations": [
+      {
+        "organization_name": "my_organization"
+      },
+      {
+        "organization_name": "my_second_organization"
+      }
+    ]
+  }
+]

main.py

@@ -15,7 +15,7 @@
     {
         'type': 'list',
         'name': 'menu',
-        'message': 'What do you want to do?',
+        'message': 'What would you like to do?',
         'choices': [menu for menu in menu_value_to_class.keys()],
 
     },
@@ -30,14 +30,14 @@
     {
         'type': 'list',
         'name': 'provider',
-        "message": "Which provider?",
+        "message": "Which SCM provider?",
         "choices": providers,
         "when": release_block_pr_menu.menu_chosen,
     },
     {
         'type': 'checkbox',
         'name': 'contexts',
-        "message": "Which contexts?",
+        "message": "Which status checks?",
         "choices": [{"name": context} for context in contexts],
         "when": release_block_pr_menu.menu_chosen
     }

menus/release_block_pr_menu.py

@@ -7,9 +7,9 @@
 from logger import logger
 from menus.menu_base import MenuBase
 from providers.github_handler import GithubHandler
-from release_block_pr_config import ReleaseBlockPrConfig
+from release_block_pr_config import ReleaseBlockPrConfig, RepositoryConfig
 
-release_block = "Release Blocked PR's"
+release_block = "Release Blocked Pull Requests"
 
 
 class ReleaseBlockPrMenu(MenuBase):
@@ -20,11 +20,21 @@ class ReleaseBlockPrMenu(MenuBase):
     def handle(self, answers):
         if answers.get("provider") in self.handlers:
             handler_class = self.handlers[answers["provider"]]
-            repositories_to_unblock: List[ReleaseBlockPrConfig] = pydantic.parse_file_as(List[ReleaseBlockPrConfig],
-                                                                                         answers["config_file"])
-            for tokens_to_repositories in repositories_to_unblock:
-                handler = handler_class(tokens_to_repositories.token)
-                for repository in tokens_to_repositories.repositories:
+            release_block_pr_configs: List[ReleaseBlockPrConfig] = pydantic.parse_file_as(List[ReleaseBlockPrConfig],
+                                                                                          answers["config_file"])
+            for release_block_pr_config in release_block_pr_configs:
+                handler = handler_class(release_block_pr_config.token)
+                repositories: List[RepositoryConfig] = []
+                if release_block_pr_config.repositories is not None:
+                    repositories.extend(release_block_pr_config.repositories)
+
+                # Get all organizations repositories
+                organization_names = [organization.organization_name for organization
+                                      in release_block_pr_config.organizations]
+                repositories.extend(handler.get_organizations_repositories(organization_names))
+
+                # Release branch protection from all repositories
+                for repository in repositories:
                     handler.release_branch_protection(repository.organization_name, repository.repository_name,
                                                       repository.branch, answers["contexts"])
         else:
@@ -38,7 +48,10 @@ def validate_config_file(config_file):
         if not os.path.isfile(config_file):
             return "File does not exist"
         try:
-            pydantic.parse_file_as(List[ReleaseBlockPrConfig], config_file)
+            parsed_configs = pydantic.parse_file_as(List[ReleaseBlockPrConfig], config_file)
+            for parsed_config in parsed_configs:
+                if len(parsed_config.organizations) == 0 and len(parsed_config.repositories) == 0:
+                    return f"Invalid input, need at least one repository or organization"
         except Exception as e:
             return f"Invalid input, not in the expected format {e}"
         return True

providers/github_handler.py

@@ -4,6 +4,7 @@
 
 from logger import logger
 from providers.provider_handler import ProviderHandler
+from release_block_pr_config import RepositoryConfig
 
 
 class GithubHandler(ProviderHandler):
@@ -27,5 +28,22 @@ def release_branch_protection(self, organization_name, repository_name, branch,
                     branch.edit_required_status_checks(contexts=list(contexts_to_keep))
                 else:
                     logger.info(f"Skipping {full_repo_name} contexts to remove are not required")
-            except:
-                logger.exception(f"Failed to update required status checks on repository {full_repo_name}")
+            except Exception as e:
+                logger.exception(f"Failed to update required status checks on repository {full_repo_name}: {e}")
+
+    def get_organizations_repositories(self, organization_names):
+        repository_configs = []
+        for organization_name in organization_names:
+            try:
+                organization = self.github.get_organization(organization_name)
+                repositories = organization.get_repos()
+                for repository in repositories:
+                    repository_config = RepositoryConfig(
+                        repository_name=repository.name,
+                        organization_name=organization_name,
+                        branch=repository.default_branch
+                    )
+                    repository_configs.append(repository_config)
+            except Exception as e:
+                logger.exception(f"Failed to get repositories for organization {organization_name}: {e}")
+        return repository_configs

providers/provider_handler.py

@@ -10,3 +10,7 @@ def __init__(self, token):
     @abstractmethod
     def release_branch_protection(self, organization_name, repository_name, branch, contexts: List[str]):
         pass
+
+    @abstractmethod
+    def get_organizations_repositories(self, organization_names):
+        pass

release_block_pr_config.py

@@ -1,8 +1,12 @@
-from typing import List
+from typing import List, Optional
 
 import pydantic
 
 
+class OrganizationConfig(pydantic.BaseModel):
+    organization_name: str
+
+
 class RepositoryConfig(pydantic.BaseModel):
     repository_name: str
     organization_name: str
@@ -12,4 +16,5 @@ class RepositoryConfig(pydantic.BaseModel):
 class ReleaseBlockPrConfig(pydantic.BaseModel):
     token: str
     provider: str
-    repositories: List[RepositoryConfig]
+    repositories: Optional[List[RepositoryConfig]]
+    organizations: Optional[List[OrganizationConfig]]