CM-26624-add-dockerhub-github-action (#5)

Author: idan-cyber

.github/workflows/docker-image.yml

@@ -0,0 +1,29 @@
+name: ci
+
+on:
+  release:
+    types:
+      - created
+
+jobs:
+  docker:
+    runs-on: ubuntu-latest
+    steps:
+      -
+        name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+      -
+        name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+      -
+        name: Login to Docker Hub
+        uses: docker/login-action@v2
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+      -
+        name: Build and push
+        uses: docker/build-push-action@v4
+        with:
+          push: true
+          tags: cycodehq/cycode_recovery_utils:latest

Dockerfile

@@ -11,9 +11,7 @@ WORKDIR /app
 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
+RUN pip install --no-cache-dir -r requirements.txt
 
 # Command to run your Python console app
 CMD ["python", "main.py"]

README.md

@@ -7,8 +7,8 @@
 - [Overview](#overview)
 - [Features](#features)
 - [Getting Started](#getting-started)
-- [Usage](#usage)
 - [Configuration](#configuration-file)
+- [Usage](#usage)
 - [License](#license)
 
 ## Overview
@@ -25,27 +25,11 @@ remain resilient even when faced with adversity.
 
 ## 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
 
-## Configuration File
+The tool expects a configuration file with SCM information named `config.json`. You can either add this config file when you build the docker image or mount the configuration file with `docker run -v`.
 
-There is a sample config file added to the project
+Sample config file:
 
 ```
 [
@@ -76,6 +60,34 @@ There is a sample config file added to the project
 * In case `organizations` are provided, we will update all the organization's default branch in all repositories.
 * You can provide multiple SCM configurations.
 
+There are 2 options to run the Cycode recovery tool:
+* Using our docker image
+* Building your own docker image
+
+### Pulling Cycode image
+```
+docker pull cycodehq/cycode_recovery_utils:latest
+```
+
+### Building an image locally
+```
+docker build -t cycode_recovery_tool . --no-cache
+```
+
+### Running the docker image
+You will need to provide your configuration file
+```
+docker run -v /path/to/file/config.json:/app/config.json -ti cycode_recovery_tool
+```
+
+## Usage
+
+1. Choose recovery action (currently only Release Block Pr)
+![recovery action](./docs/recovery_action.png)
+2. Choose provider (currently only GitHub)
+3. Choose which status checks to release
+![status_checks_release](./docs/status_checks_release.png)
+
 ## License
 
-This project is licensed under the [MIT License](LICENSE).
+This project is licensed under the [MIT License](LICENSE).

config.json

@@ -1,5 +1,5 @@
 config_file = "config.json"
-github = "Github"
+github = "GitHub"
 providers = [github]
 contexts = ["Cycode: Secrets",
             "Cycode: IaC",

consts.py

@@ -1,53 +1,67 @@
-from typing import Dict
+import os
+from typing import Dict, List
 
+import pydantic
 from PyInquirer import prompt
 
 from consts import providers, contexts, config_file
 from logger import logger
 from menus.menu_base import MenuBase
 from menus.release_block_pr_menu import ReleaseBlockPrMenu
+from release_block_pr_config import ReleaseBlockPrConfig
 
 release_block_pr_menu = ReleaseBlockPrMenu()
 menus = [release_block_pr_menu]
 menu_value_to_class: Dict[str, MenuBase] = {menu.get_menu(): menu for menu in menus}
 
 main_menu = [
     {
-        'type': 'list',
-        'name': 'menu',
-        'message': 'What would you like to do?',
-        'choices': [menu for menu in menu_value_to_class.keys()],
+        "type": "list",
+        "name": "menu",
+        "message": "What would you like to do?",
+        "choices": [menu for menu in menu_value_to_class.keys()],
 
     },
     {
-        'type': 'input',
-        'name': 'config_file',
-        "message": "Please provide a configuration file",
-        "default": config_file,
-        'validate': release_block_pr_menu.validate_config_file,
-        "when": release_block_pr_menu.menu_chosen
-    },
-    {
-        'type': 'list',
-        'name': 'provider',
+        "type": "list",
+        "name": "provider",
         "message": "Which SCM provider?",
         "choices": providers,
         "when": release_block_pr_menu.menu_chosen,
     },
     {
-        'type': 'checkbox',
-        'name': 'contexts',
+        "type": "checkbox",
+        "name": "contexts",
         "message": "Which status checks?",
         "choices": [{"name": context} for context in contexts],
         "when": release_block_pr_menu.menu_chosen
     }
 ]
 
-if __name__ == '__main__':
-    answer = prompt(main_menu)
-    menu = menu_value_to_class.get(answer.get('menu'))
-    if menu:
-        menu.handle(answer)
-        logger.info("Completed successfully")
+
+def validate_config_file():
+    if not os.path.isfile(config_file):
+        print("Files in /app directory:", os.listdir("/app"))
+        return f"Could not find '{config_file}' file in the directory {os.getcwd()}"
+    try:
+        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
+
+
+if __name__ == "__main__":
+    validation_result = validate_config_file()
+    if validation_result is not True:
+        logger.error(validation_result)
     else:
-        logger.error(f"invalid menu {answer.get('menu')}")
+        answer = prompt(main_menu)
+        menu = menu_value_to_class.get(answer.get("menu"))
+        if menu:
+            menu.handle(answer)
+            logger.info("Completed successfully")
+        else:
+            logger.error(f"Invalid menu {answer.get('menu')}")

main.py

@@ -3,7 +3,7 @@
 
 import pydantic
 
-from consts import github
+from consts import github, config_file
 from logger import logger
 from menus.menu_base import MenuBase
 from providers.github_handler import GithubHandler
@@ -21,7 +21,7 @@ def handle(self, answers):
         if answers.get("provider") in self.handlers:
             handler_class = self.handlers[answers["provider"]]
             release_block_pr_configs: List[ReleaseBlockPrConfig] = pydantic.parse_file_as(List[ReleaseBlockPrConfig],
-                                                                                          answers["config_file"])
+                                                                                          config_file)
             for release_block_pr_config in release_block_pr_configs:
                 handler = handler_class(release_block_pr_config.token)
                 repositories: List[RepositoryConfig] = []
@@ -42,16 +42,3 @@ def handle(self, answers):
 
     def get_menu(self):
         return release_block
-
-    @staticmethod
-    def validate_config_file(config_file):
-        if not os.path.isfile(config_file):
-            return "File does not exist"
-        try:
-            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