buildbot/details

Clear message

┌─┬──────┐
│░│ ⊙  ʘ │        SageMath patchbot
│░│      │
│░│ ──── │
╘═╧══════╛

Installing the patchbot

It is safer to run the patchbot in an unused sage install.

(only works for sage version ≥ 6.10)

The patchbot uses the system python, not the python provided by sage.

Dependencies: shell commands git; tar; wget

You can instead use the --owner option (for patchbot version ≥ 2.5.4).

Running the patchbot

It will run forever, as long as it finds a ticket to work on. Tickets are only considered if their authors are trusted.

You can let the patchbot choose the tickets it will run on.

You can run a specific ticket by using sage -patchbot --ticket=N where N is a ticket number such as 12345.

Several other options are available, see sage -patchbot --help

--skip-base will skip the check that the base sage installation is sane.

--plugin-only will only build (sage and the doc) and run the plugins but not the tests (much quicker but less useful).

--safe-only will only test branches that only change files inside the directory "src/sage" (this is the case by default).

Configuration

By default, the patchbot should run without needing to tune its configuration. You can use a specific configuration file in the json format and run the patchbot with

sage -patchbot --config=fullpath/config_file.json

The json format mostly looks like a python dictionary. Here is an example of a valid configuration file

    {"bonus": {"niceguy": 200, "needs_work": -20},
     "use_ccache": false,
     "safe_only": true,
     "skip_base": true,
     "time_of_day": "22-7",
     "parallelism": 8
    }

Note that the booleans must be written with no capital first letter.

The config will be read again between every run, hence it allows live configuration of the patchbot.

The list of configurable entities are::

bonus

There are two kinds of bonus, the one related to tickets:

• logins (counted x2 if author and x1 if participant)

• component (e.g. "linear algebra", "combinatorics", ...)

• status (e.g. "needs_review", "positive_review", ...)

• priority (e.g "blocker", "critical", ...)

and the one related to other bot reports:

• behind: weight the number of commits behind master

  • (and count for -1 if the commit is not locally available)

• applies: whether previous bots succeeded when merging the branch with the current beta

• unique : give less chance for already seen tickets

The defaults are

 bonus = {
     "blocker"        : 100,
     "critical"       : 60,
     "major"          : 10,
     "minor"          : 0,
     "needs_review"   : 1000,
     "positive_review": 500,
     "needs_info"     : 0,
     "needs_work"     : 0
     "unique"         : 40,
     "applies"        : 20,
     "behind"         : 1
    }

But you could add

 bonus = {
     "vbraun": 10,
     "inconito": -5,
     "linear programming": 200,
     "finance": -200
     "14382": 100,
     "15777": 100
     }

Looking at patchbot activities

Remotely, you can have a look at the last tickets tested by patchbots here:

• http://patchbot.sagemath.org/ticket/0/

On your machine, the patchbot writes a summary of its activities in $SAGE_ROOT/logs/patchbot/history.txt

using an ipython session

You can try the patchbot inside a ipython session, as follows.

First, in the sage directory, create a branch "patchbot/base" by

git checkout develop -b patchbot/base

Then, in the patchbot source directory,

In [2]: cd sage-patchbot/src/
In [3]: from patchbot import Patchbot
In [4]: P = Patchbot('/home/platon/sage/', 'http://patchbot.sagemath.org', None, False, True, None)
In [5]: P.test_a_ticket(14974)

The arguments are (patchbot version < 2.5.5):

- sage_root -- path to the sage local repository
- server -- http address of the patchbot server
- config_path -- ``None`` or path to the json config file
- dry_run -- boolean
- plugin_only -- boolean
- an option class or None

The arguments are (patchbot version ≥ 2.5.5):

- sage_root -- path to the sage local repository
- server -- http address of the patchbot server
- config_path -- ``None`` or path to the json config file
- an option class or None