Home Original page

feat(eval): implement sysadmin eval permissions by electron271 · Pull Request #884 · allthingslinux/tux

Reviewer's Guide

This PR introduces a new ALLOW_SYSADMINS_EVAL config flag and updates both the bot startup logic and the eval command to grant or deny sysadmin eval permissions based on that flag.

Sequence Diagram: Bot Startup Owner ID Configuration

sequenceDiagram
    participant AppStartup
    participant CONFIG
    participant TuxBot

    AppStartup->>AppStartup: Bot starting...
    AppStartup->>CONFIG: Get BOT_OWNER_ID
    CONFIG-->>AppStartup: bot_owner_id
    AppStartup->>AppStartup: owner_ids = {bot_owner_id}
    AppStartup->>CONFIG: Get ALLOW_SYSADMINS_EVAL
    CONFIG-->>AppStartup: allow_sysadmins_eval_flag
    alt allow_sysadmins_eval_flag is true
        AppStartup->>CONFIG: Get SYSADMIN_IDS
        CONFIG-->>AppStartup: sysadmin_ids_list
        AppStartup->>AppStartup: owner_ids.update(sysadmin_ids_list)
        AppStartup->>AppStartup: Log warning (Sysadmins can use eval)
    else allow_sysadmins_eval_flag is false
        AppStartup->>AppStartup: Log warning (Sysadmins cannot use eval)
    end
    AppStartup->>TuxBot: Initialize with dynamic owner_ids
Loading

Class Diagram: Update to Config Class

classDiagram
    class Config {
        +BOT_OWNER_ID: int
        +SYSADMIN_IDS: list[int]
        +ALLOW_SYSADMINS_EVAL: bool
        +DEFAULT_PROD_PREFIX: str
    }
Loading

File-Level Changes

Change Details Files
Add ALLOW_SYSADMINS_EVAL to configuration
  • Define ALLOW_SYSADMINS_EVAL in Config class
  • Extend example settings.yml with the new flag
 tux/utils/config.py
config/settings.yml.example
Make owner_ids dynamic according to ALLOW_SYSADMINS_EVAL
  • Build owner_ids set from BOT_OWNER_ID and optionally SYSADMIN_IDS
  • Log a warning when sysadmin evals are enabled or disabled
  • Pass the computed owner_ids into Tux initialization
 tux/app.py
Enforce sysadmin eval permissions in the eval command
  • Check for CONFIG.ALLOW_SYSADMINS_EVAL before allowing sysadmins to eval
  • Send distinct warning and messages when sysadmins are blocked
  • Update log text to mention sysadmins alongside owners
 tux/cogs/admin/eval.py
Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help