From 66a1029bd5c4593e7764ab3d6d631ad909eea318 Mon Sep 17 00:00:00 2001 From: TSRBerry <20988865+TSRBerry@users.noreply.github.com> Date: Sat, 27 Jan 2024 20:49:49 +0100 Subject: [PATCH] Refactor Mako actions, fix setup-git command & add exec-ryujinx-tasks command (#3) * Create multiple actions to make Mako easier to use * Add smoke tests for the new actions * Check if the required env vars aren't empty * Fix working directory for execute-command * Fix action_path references * Fix broken setup_git command * Add exec-ryujinx-tasks subcommand * Ensure python and pipx are installed * Improve help output * Add required environment variables to README.md * Add small script to generate subcommand sections automatically * Adjust help messages for ryujinx tasks as well * Remove required argument for positionals * Add exec-ryujinx-tasks to subcommands list * Apply black formatting * Fix event name for update-reviewers --- .github/actions/execute-command/README.md | 20 +++++ .github/actions/execute-command/action.yml | 35 +++++++++ .github/actions/setup-mako/README.md | 11 +-- .github/actions/setup-mako/action.yml | 28 ++++++- .github/workflows/test.yml | 35 +++++++++ README.md | 87 ++++++++++++--------- action.yml | 47 +++++++++++ ryujinx_mako/__main__.py | 6 +- ryujinx_mako/_const.py | 24 ++++-- ryujinx_mako/commands/__init__.py | 2 + ryujinx_mako/commands/_subcommand.py | 27 ++++++- ryujinx_mako/commands/exec_ryujinx_tasks.py | 86 ++++++++++++++++++++ ryujinx_mako/commands/setup_git.py | 8 +- ryujinx_mako/commands/update_reviewers.py | 16 +++- tools/generate_help.py | 53 +++++++++++++ 15 files changed, 418 insertions(+), 67 deletions(-) create mode 100644 .github/actions/execute-command/README.md create mode 100644 .github/actions/execute-command/action.yml create mode 100644 .github/workflows/test.yml create mode 100644 action.yml create mode 100644 ryujinx_mako/commands/exec_ryujinx_tasks.py create mode 100755 tools/generate_help.py diff --git a/.github/actions/execute-command/README.md b/.github/actions/execute-command/README.md new file mode 100644 index 0000000..5ea4dc8 --- /dev/null +++ b/.github/actions/execute-command/README.md @@ -0,0 +1,20 @@ +# execute-command + +A small composite action to run the specified Mako subcommand. + +## Usage + +Add the following step to your workflow: + +```yml +- name: Execute Ryujinx-Mako command + uses: Ryujinx/Ryujinx-Mako/.github/actions/execute-command@master + with: + command: "" + args: "" + app_id: ${{ secrets.MAKO_APP_ID }} + private_key: ${{ secrets.MAKO_PRIVATE_KEY }} + installation_id: ${{ secrets.MAKO_INSTALLATION_ID }} +``` + + diff --git a/.github/actions/execute-command/action.yml b/.github/actions/execute-command/action.yml new file mode 100644 index 0000000..6f8bd68 --- /dev/null +++ b/.github/actions/execute-command/action.yml @@ -0,0 +1,35 @@ +name: 'Mako command' +description: 'Execute a Mako subcommand' +inputs: + command: + description: 'Subcommand to execute with Mako' + required: true + args: + description: 'Arguments for the specified subcommand' + required: true + default: '' + app_id: + description: 'GitHub App ID' + required: true + private_key: + description: 'Private key for the GitHub App' + required: true + installation_id: + description: 'GitHub App Installation ID' + required: true +runs: + using: 'composite' + steps: + - name: Get Mako path + id: path + run: | + echo "mako=$(realpath '${{ github.action_path }}/../../../')" >> $GITHUB_OUTPUT + shell: bash + + - run: | + poetry -n -C "${{ steps.path.outputs.mako }}" run ryujinx-mako ${{ inputs.command }} ${{ inputs.args }} + shell: bash + env: + MAKO_APP_ID: ${{ inputs.app_id }} + MAKO_PRIVATE_KEY: ${{ inputs.private_key }} + MAKO_INSTALLATION_ID: ${{ inputs.installation_id }} diff --git a/.github/actions/setup-mako/README.md b/.github/actions/setup-mako/README.md index 2580d4e..2efff3e 100644 --- a/.github/actions/setup-mako/README.md +++ b/.github/actions/setup-mako/README.md @@ -6,18 +6,11 @@ It installs poetry and all module dependencies. ## Usage -Add the following steps to your workflow: +Add the following step to your workflow: ```yml -- name: Checkout Ryujinx-Mako - uses: actions/checkout@v3 - with: - repository: Ryujinx/Ryujinx-Mako - ref: master - path: ".ryujinx-mako" - - name: Setup Ryujinx-Mako - uses: .ryujinx-mako/.github/actions/setup-mako + uses: Ryujinx/Ryujinx-Mako/.github/actions/setup-mako@master ``` diff --git a/.github/actions/setup-mako/action.yml b/.github/actions/setup-mako/action.yml index a076da1..78f4e67 100644 --- a/.github/actions/setup-mako/action.yml +++ b/.github/actions/setup-mako/action.yml @@ -1,12 +1,32 @@ -name: 'Setup Ryujinx-Mako' -description: 'Setup the environment for Ryujinx-Mako' +name: 'Setup Mako' +description: 'Setup the environment for Mako' runs: using: 'composite' steps: - - run: pipx install poetry + - name: Get Mako path + id: path + run: | + echo "mako=$(realpath '${{ github.action_path }}/../../../')" >> $GITHUB_OUTPUT + shell: bash + + - uses: actions/setup-python@v4 + with: + cache: 'poetry' + + - name: Ensure pipx is available + run: | + if ! command -v pipx > /dev/null 2>&1; then + echo "$HOME/.local/bin" >> $GITHUB_PATH + python3 -m pip install --user pipx + python3 -m pipx ensurepath + fi + shell: bash + + - name: Install poetry + run: pipx install poetry shell: bash - run: | - cd .ryujinx-mako + cd "${{ steps.path.outputs.mako }}" poetry install --only main shell: bash diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml new file mode 100644 index 0000000..b3853b9 --- /dev/null +++ b/.github/workflows/test.yml @@ -0,0 +1,35 @@ +name: Test + +on: + push: + workflow_dispatch: + +jobs: + action: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + + - name: Test Ryujinx-Mako (setup-git) + uses: ./ + with: + command: setup-git + app_id: ${{ secrets.MAKO_APP_ID }} + private_key: ${{ secrets.MAKO_PRIVATE_KEY }} + installation_id: ${{ secrets.MAKO_INSTALLATION_ID }} + + subactions: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + + - name: Test setup-mako + uses: ./.github/actions/setup-mako + + - name: Test execute-command (setup-git) + uses: ./.github/actions/execute-command + with: + command: setup-git + app_id: ${{ secrets.MAKO_APP_ID }} + private_key: ${{ secrets.MAKO_PRIVATE_KEY }} + installation_id: ${{ secrets.MAKO_INSTALLATION_ID }} diff --git a/README.md b/README.md index 48cc75c..9ac9d5d 100644 --- a/README.md +++ b/README.md @@ -4,38 +4,29 @@ A custom GitHub App to aid Ryujinx with project management and moderation ## Usage -1. Add the following steps to your workflow: +Add the following step to your workflow: - ```yml - - name: Checkout Ryujinx-Mako - uses: actions/checkout@v3 - with: - repository: Ryujinx/Ryujinx-Mako - ref: master - path: '.ryujinx-mako' - - - name: Setup Ryujinx-Mako - uses: ./.ryujinx-mako/.github/actions/setup-mako - ``` - -2. Execute the available commands like this: - - ```yml - - name: Setup git identity for Ryujinx-Mako - run: | - # poetry -n -C .ryujinx-mako run ryujinx-mako [] - # for example: - poetry -n -C .ryujinx-mako run ryujinx-mako setup-git - env: - MAKO_APP_ID: ${{ secrets.MAKO_APP_ID }} - MAKO_PRIVATE_KEY: ${{ secrets.MAKO_PRIVATE_KEY }} - MAKO_INSTALLATION_ID: ${{ secrets.MAKO_INSTALLATION_ID }} - ``` +```yml +- name: Run Ryujinx-Mako + uses: Ryujinx/Ryujinx-Mako@master + with: + command: + args: + app_id: ${{ secrets.MAKO_APP_ID }} + private_key: ${{ secrets.MAKO_PRIVATE_KEY }} + installation_id: ${{ secrets.MAKO_INSTALLATION_ID }} +``` + +## Required environment variables + +- `MAKO_APP_ID`: the GitHub App ID +- `MAKO_PRIVATE_KEY`: the contents of the GitHub App private key +- `MAKO_INSTALLATION_ID`: the GitHub App installation ID ## Available commands ``` -usage: ryujinx_mako [-h] {setup-git,update-reviewers} ... +usage: ryujinx_mako [-h] {setup-git,update-reviewers,exec-ryujinx-tasks} ... A python module to aid Ryujinx with project management and moderation @@ -43,9 +34,10 @@ options: -h, --help show this help message and exit subcommands: - setup-git Set git identity to Ryujinx-Mako - - update-reviewers Update reviewers for the specified PR + {setup-git,update-reviewers,exec-ryujinx-tasks} + setup-git Configure git identity for Ryujinx-Mako + update-reviewers Update reviewers for the specified PR + exec-ryujinx-tasks Execute all Ryujinx tasks for a specific event ``` ### setup-git @@ -53,11 +45,11 @@ subcommands: ``` usage: ryujinx_mako setup-git [-h] [-l] -Set git identity to Ryujinx-Mako +Configure git identity for Ryujinx-Mako options: -h, --help show this help message and exit - -l, --local Set git identity only for the current repository. + -l, --local configure the git identity only for the current repository ``` ### update-reviewers @@ -68,10 +60,35 @@ usage: ryujinx_mako update-reviewers [-h] repo_path pr_number config_path Update reviewers for the specified PR positional arguments: - repo_path - pr_number - config_path + repo_path full name of the GitHub repository (format: OWNER/REPO) + pr_number the number of the pull request to check + config_path the path to the reviewers config file options: -h, --help show this help message and exit ``` + +### exec-ryujinx-tasks + +``` +usage: ryujinx_mako exec-ryujinx-tasks [-h] --event-name EVENT_NAME + --event-path EVENT_PATH [-w WORKSPACE] + repo_path run_id + +Execute all Ryujinx tasks for a specific event + +positional arguments: + repo_path full name of the GitHub repository (format: + OWNER/REPO) + run_id The unique identifier of the workflow run + +options: + -h, --help show this help message and exit + --event-name EVENT_NAME + the name of the event that triggered the workflow run + --event-path EVENT_PATH + the path to the file on the runner that contains the + full event webhook payload + -w WORKSPACE, --workspace WORKSPACE + the working directory on the runner +``` diff --git a/action.yml b/action.yml new file mode 100644 index 0000000..1a51e15 --- /dev/null +++ b/action.yml @@ -0,0 +1,47 @@ +name: 'Run Ryujinx-Mako' +description: 'Setup Mako and execute the specified subcommand' +inputs: + command: + description: 'Subcommand to execute with Mako' + required: true + args: + description: 'Arguments for the specified subcommand' + required: true + default: '' + app_id: + description: 'GitHub App ID' + required: true + private_key: + description: 'Private key for the GitHub App' + required: true + installation_id: + description: 'GitHub App Installation ID' + required: true +runs: + using: 'composite' + steps: + - name: Check if Mako was already setup + id: check_dest + run: | + [ -f "${{ github.action_path }}/.ryujinx-mako_setup-done" ] \ + && echo "exists=true" >> $GITHUB_OUTPUT \ + || echo "exists=false" >> $GITHUB_OUTPUT + shell: bash + + - name: Setup Mako + if: steps.check_dest.outputs.exists == 'false' + uses: ./.github/actions/setup-mako + + - name: Create setup finished flag + if: steps.check_dest.outputs.exists == 'false' + run: touch "${{ github.action_path }}/.ryujinx-mako_setup-done" + shell: bash + + - name: Run Mako subcommand + uses: ./.github/actions/execute-command + with: + command: ${{ inputs.command }} + args: ${{ inputs.args }} + app_id: ${{ inputs.app_id }} + private_key: ${{ inputs.private_key }} + installation_id: ${{ inputs.installation_id }} diff --git a/ryujinx_mako/__main__.py b/ryujinx_mako/__main__.py index b47dfef..3ab6f0d 100644 --- a/ryujinx_mako/__main__.py +++ b/ryujinx_mako/__main__.py @@ -3,6 +3,7 @@ import logging from ryujinx_mako import commands from ryujinx_mako._const import SCRIPT_NAME +from ryujinx_mako.commands import Subcommand parser = argparse.ArgumentParser( prog=SCRIPT_NAME, @@ -19,10 +20,11 @@ for subcommand in commands.SUBCOMMANDS: subcommand_parser = subparsers.add_parser( subcommand.name(), description=subcommand.description(), - add_help=True, + help=subcommand.description(), ) + Subcommand.add_subcommand(subcommand.name(), subcommand(subcommand_parser)) # Keep a reference to the subcommand - subcommands.append(subcommand(subcommand_parser)) + subcommands.append(Subcommand.get_subcommand(subcommand.name())) def run(): diff --git a/ryujinx_mako/_const.py b/ryujinx_mako/_const.py index 01613b7..c62df6c 100644 --- a/ryujinx_mako/_const.py +++ b/ryujinx_mako/_const.py @@ -11,6 +11,7 @@ except ImportError: class ConfigKey(StrEnum): + DryRun = "MAKO_DRY_RUN" AppID = "MAKO_APP_ID" PrivateKey = "MAKO_PRIVATE_KEY" InstallationID = "MAKO_INSTALLATION_ID" @@ -19,14 +20,23 @@ class ConfigKey(StrEnum): NAME = "Ryujinx-Mako" SCRIPT_NAME = NAME.lower().replace("-", "_") -# Check environment variables -for key in ConfigKey: - if key not in os.environ.keys(): - raise KeyError(f"Required environment variable not set: {key}") +if ConfigKey.DryRun not in os.environ.keys() or len(os.environ[ConfigKey.DryRun]) == 0: + IS_DRY_RUN = False + # Check environment variables + for key in ConfigKey: + if key == ConfigKey.DryRun: + continue + if key not in os.environ.keys() or len(os.environ[key]) == 0: + raise KeyError(f"Required environment variable not set: {key}") -APP_ID = int(os.environ[ConfigKey.AppID]) -PRIVATE_KEY = os.environ[ConfigKey.PrivateKey] -INSTALLATION_ID = int(os.environ[ConfigKey.InstallationID]) + APP_ID = int(os.environ[ConfigKey.AppID]) + PRIVATE_KEY = os.environ[ConfigKey.PrivateKey] + INSTALLATION_ID = int(os.environ[ConfigKey.InstallationID]) +else: + IS_DRY_RUN = True + APP_ID = 0 + PRIVATE_KEY = "" + INSTALLATION_ID = 0 GH_BOT_SUFFIX = "[bot]" GH_EMAIL_TEMPLATE = "{user_id}+{username}@users.noreply.github.com" diff --git a/ryujinx_mako/commands/__init__.py b/ryujinx_mako/commands/__init__.py index d2767d7..10890f9 100644 --- a/ryujinx_mako/commands/__init__.py +++ b/ryujinx_mako/commands/__init__.py @@ -1,12 +1,14 @@ from typing import Type from ryujinx_mako.commands._subcommand import Subcommand +from ryujinx_mako.commands.exec_ryujinx_tasks import ExecRyujinxTasks from ryujinx_mako.commands.setup_git import SetupGit from ryujinx_mako.commands.update_reviewers import UpdateReviewers SUBCOMMANDS: list[Type[Subcommand]] = [ SetupGit, UpdateReviewers, + ExecRyujinxTasks, ] __all__ = SUBCOMMANDS diff --git a/ryujinx_mako/commands/_subcommand.py b/ryujinx_mako/commands/_subcommand.py index 1ba3260..b33cf0a 100644 --- a/ryujinx_mako/commands/_subcommand.py +++ b/ryujinx_mako/commands/_subcommand.py @@ -1,14 +1,23 @@ import logging from abc import ABC, abstractmethod from argparse import ArgumentParser, Namespace +from typing import Any from github import Github from github.Auth import AppAuth -from ryujinx_mako._const import APP_ID, PRIVATE_KEY, INSTALLATION_ID, SCRIPT_NAME +from ryujinx_mako._const import ( + APP_ID, + PRIVATE_KEY, + INSTALLATION_ID, + SCRIPT_NAME, + IS_DRY_RUN, +) class Subcommand(ABC): + _subcommands: dict[str, Any] = {} + @abstractmethod def __init__(self, parser: ArgumentParser): parser.set_defaults(func=self.run) @@ -33,10 +42,22 @@ class Subcommand(ABC): def description() -> str: raise NotImplementedError() + @classmethod + def get_subcommand(cls, name: str): + return cls._subcommands[name] + + @classmethod + def add_subcommand(cls, name: str, subcommand): + if name in cls._subcommands.keys(): + raise ValueError(f"Key '{name}' already exists in {cls}._subcommands") + cls._subcommands[name] = subcommand + class GithubSubcommand(Subcommand, ABC): - _github = Github( - auth=AppAuth(APP_ID, PRIVATE_KEY).get_installation_auth(INSTALLATION_ID) + _github = ( + Github(auth=AppAuth(APP_ID, PRIVATE_KEY).get_installation_auth(INSTALLATION_ID)) + if not IS_DRY_RUN + else None ) @property diff --git a/ryujinx_mako/commands/exec_ryujinx_tasks.py b/ryujinx_mako/commands/exec_ryujinx_tasks.py new file mode 100644 index 0000000..ed9b24f --- /dev/null +++ b/ryujinx_mako/commands/exec_ryujinx_tasks.py @@ -0,0 +1,86 @@ +import json +import os +from argparse import ArgumentParser, Namespace +from pathlib import Path +from typing import Any + +from github.Repository import Repository +from github.WorkflowRun import WorkflowRun + +from ryujinx_mako.commands._subcommand import GithubSubcommand + + +class ExecRyujinxTasks(GithubSubcommand): + @staticmethod + def name() -> str: + return "exec-ryujinx-tasks" + + @staticmethod + def description() -> str: + return "Execute all Ryujinx tasks for a specific event" + + # noinspection PyTypeChecker + def __init__(self, parser: ArgumentParser): + self._workspace: Path = None + self._repo: Repository = None + self._workflow_run: WorkflowRun = None + self._event: dict[str, Any] = None + self._event_name: str = None + + parser.add_argument( + "--event-name", + type=str, + required=True, + help="the name of the event that triggered the workflow run", + ) + parser.add_argument( + "--event-path", + type=str, + required=True, + help="the path to the file on the runner that contains the full " + "event webhook payload", + ) + parser.add_argument( + "-w", + "--workspace", + type=Path, + required=False, + default=Path(os.getcwd()), + help="the working directory on the runner", + ) + parser.add_argument( + "repo_path", + type=str, + help="full name of the GitHub repository (format: OWNER/REPO)", + ) + parser.add_argument( + "run_id", + type=int, + help="The unique identifier of the workflow run", + ) + super().__init__(parser) + + def update_reviewers(self): + # Prepare update-reviewers + self.logger.info("Task: update-reviewers") + args = Namespace() + args.repo_path = self._repo.full_name + args.pr_number = self._event["number"] + args.config_path = Path(self._workspace, ".github", "reviewers.yml") + # Run task + self.get_subcommand("update-reviewers").run(args) + + def run(self, args: Namespace): + self.logger.info("Executing Ryujinx tasks...") + + self._workspace = args.workspace + self._repo = self.github.get_repo(args.repo_path) + self._workflow_run = self._repo.get_workflow_run(args.run_id) + self._event_name = args.event_name + with open(args.event_path, "r") as file: + self._event = json.load(file) + + if args.event_name == "pull_request_target": + self.update_reviewers() + + self.logger.info("Finished executing Ryujinx tasks!") diff --git a/ryujinx_mako/commands/setup_git.py b/ryujinx_mako/commands/setup_git.py index cd4a26c..1fcaefc 100644 --- a/ryujinx_mako/commands/setup_git.py +++ b/ryujinx_mako/commands/setup_git.py @@ -12,14 +12,14 @@ class SetupGit(GithubSubcommand): @staticmethod def description() -> str: - return f"Set git identity to {NAME}" + return f"Configure git identity for {NAME}" def __init__(self, parser: ArgumentParser): parser.add_argument( "-l", "--local", action="store_true", - help="Set git identity only for the current repository.", + help="configure the git identity only for the current repository", ) super().__init__(parser) @@ -29,7 +29,7 @@ class SetupGit(GithubSubcommand): self.logger.debug(f"Getting GitHub user for: {gh_username}") user = self.github.get_user(gh_username) - email = GH_EMAIL_TEMPLATE.format(user_id=user.id, username=user.name) + email = GH_EMAIL_TEMPLATE.format(user_id=user.id, username=user.login) if args.local: self.logger.debug("Setting git identity for local repo...") @@ -37,7 +37,7 @@ class SetupGit(GithubSubcommand): self.logger.debug("Setting git identity globally...") base_command.append("--global") - config = {"user.name": user.name, "user.email": email} + config = {"user.name": user.login, "user.email": email} for option, value in config.items(): self.logger.info(f"Setting git {option} to: {value}") command = base_command.copy() diff --git a/ryujinx_mako/commands/update_reviewers.py b/ryujinx_mako/commands/update_reviewers.py index cc9e766..18bc508 100644 --- a/ryujinx_mako/commands/update_reviewers.py +++ b/ryujinx_mako/commands/update_reviewers.py @@ -21,9 +21,19 @@ class UpdateReviewers(GithubSubcommand): self._reviewers = set() self._team_reviewers = set() - parser.add_argument("repo_path", type=str) - parser.add_argument("pr_number", type=int) - parser.add_argument("config_path", type=Path) + parser.add_argument( + "repo_path", + type=str, + help="full name of the GitHub repository (format: OWNER/REPO)", + ) + parser.add_argument( + "pr_number", type=int, help="the number of the pull request to check" + ) + parser.add_argument( + "config_path", + type=Path, + help="the path to the reviewers config file", + ) super().__init__(parser) diff --git a/tools/generate_help.py b/tools/generate_help.py new file mode 100755 index 0000000..3a8be13 --- /dev/null +++ b/tools/generate_help.py @@ -0,0 +1,53 @@ +#!/usr/bin/env python3 +import os +import re +import subprocess +from typing import Union + + +def run_mako_command(command: Union[str, list[str]]) -> str: + subprocess_cmd = ["poetry", "run", "ryujinx-mako"] + + if isinstance(command, str): + subprocess_cmd.append(command) + elif isinstance(command, list): + subprocess_cmd.extend(command) + else: + raise TypeError(command) + + env = os.environ.copy() + env["MAKO_DRY_RUN"] = "1" + + process = subprocess.run( + subprocess_cmd, stdout=subprocess.PIPE, check=True, env=env + ) + + return process.stdout.decode() + + +def print_help(name: str, output: str, level=3): + headline_prefix = "#" * level + print(f"{headline_prefix} {name}\n") + print("```") + print(output.rstrip()) + print("```\n") + + +general_help = run_mako_command("--help") +for line in general_help.splitlines(): + subcommands = re.match(r" {2}\{(.+)}", line) + if subcommands: + break +else: + subcommands = None + +if not subcommands: + print("Could not find subcommands in general help output:") + print(general_help) + exit(1) + +subcommands = subcommands.group(1).split(",") + +print_help("Available commands", general_help, 2) +for subcommand in subcommands: + print_help(subcommand, run_mako_command([subcommand, "--help"]))