Configuring Review Bot¶

Review Bot User¶

Review Bot uses a special user account to post reviews. If you were previously using Review Bot 0.1 or 0.2, select the existing Review Bot user. Otherwise, click create a new user for Review Bot.

Broker URL¶

For the broker URL, put in the URL of your RabbitMQ or other Celery broker. For example, if your broker is running on the same system as your Review Board server, this might look something like:

amqp://guest:guest@localhost:5672//

Checking Status and Updating Tools List¶

After saving the configuration, the page will attempt to contact the broker and check for workers. The Broker Status box will indicate whether everything is set up correctly. This will also save a list of the available tools, which is required for setting up tool configurations.

Paths¶

Review Bot will look for executables for the tools in the PATH environment variable. However, paths to executables can also be configured manually using exe_paths. For example:

exe_paths = {
    'go': '/path/to/go',
    'pmd': '/path/to/pmd',
}

Some Java-based tools require one or more .jar files, which can also be provided. For example:

java_classpaths = {
    'checkstyle': ['/path/to/checkstyle.jar'],
}

Cookie Storage¶

Review Bot needs to store Review Board API cookies somewhere, in order to maintain an authenticated user session. By default, these cookies will be stored in one of the following directories, depending on the operating system:

• Linux: ~/.cache/reviewbot

• macOS: ~/Library/Caches/reviewbot

• Windows (Vista on up): C:\Users\<username>\AppData\Local\Beanbag\reviewbot\Cache

The defaults require the user Review Bot is running as to have a home directory that can be written to.

If needed, an explicit path can be configured by setting cookie_dir to an absolute path on the local filesystem. For example:

cookie_dir = '/opt/reviewbot/data/'

Review Bot will refuse to start up if it can’t write cookies to the cookie directory.

Full Repository Access¶

Some tools require a full clone of the source repository, because they may need access to all files, not just those which have been changed.

Right now, Review Bot supports full repository access for the following types of repositories:

• Git

• Mercurial

The worker can define the list of repositories they’re allowed to clone. Your workers don’t all need to support the same list of repositories.

Each repository definition supports the following configuration fields:

name (required)

The configured name of the repository in Review Board.

type (required)

The repository type:

• Git: git

• Mercurial: mercurial

clone_path (required)

The git or Mercurial URL (possibly including credentials) to clone the repository from.

These repositories can be specified in the main Review Bot worker configuration file, or in a separate JSON file.

repositories = [
    {
        'name': 'Review Board',
        'type': 'git',
        'clone_path': 'https://github.com/reviewboard/reviewboard.git',
    },
    {
        'name': 'Upstream Git',
        'type': 'git',
        'clone_path': 'https://github.com/git/git.git',
    },
    {
        'name': 'Upstream Mercurial',
        'type': 'hg',
        'clone_path': 'https://www.mercurial-scm.org/repo/hg/',
    },
]

repositories_config_path = '/etc/xdg/reviewbot/repositories.json'

[
    {
        "name": "Review Board",
        "type": "git",
        "clone_path": "https://github.com/reviewboard/reviewboard.git"
    },
    {
        "name": "Upstream Git",
        "type": "git",
        "clone_path": "https://github.com/git/git.git"
    },
    {
        "name": "Upstream Mercurial",
        "type": "hg",
        "clone_path": "https://www.mercurial-scm.org/repo/hg/"
    }
]

Automatically Fetch Repositories From Review Board¶

If you have many workers and repositories, it may not be feasible to configure repositories by hand. You can also configure a list of Review Board servers to fetch lists of repositories from.

Each server definition supports the following configuration fields:

url (required)

The URL to the Review Board server. This must be accessible to the worker.

user (optional)

The username used to authenticate with the API.

This user must have access to the repositories you want to automatically configure.

token (optional)

The API token used to authenticate with the API.

The token can be set with a read-only access policy.

user and token are required if anonymous users are unable to access information on the repositories you want to use (i.e., if anonymous read-only access is turned off or the repositories are set up with access control lists in Review Board).

These servers can be specified in the main Review Bot worker configuration file, or in a separate JSON file.

reviewboard_servers = [
    {
        'user': 'reviewbot',
        'token': 'dd16b7208a2a8c88be6788c22340ae46823fc57e',
        'url': 'https://reviews1.eng.example.com',
    },
    {
        'url': 'https://reviews2.eng.example.com',
    },
]

reviewboard_servers_config_path = '/etc/xdg/reviewbot/servers.json'

[
    {
        "user": "reviewbot",
        "token": "dd16b7208a2a8c88be6788c22340ae46823fc57e",
        "url": "https://reviews1.eng.example.com"
    },
    {
        "url": "https://reviews2.eng.example.com"
    }
]