6d6e3ab542
The following changes were made: - Improve the wording of comments in the Python files and of the documentation in the README file. - Add 10 seconds to the query age so that the bot wouldn't miss any new changes that could be missed due to time difference between the Gerrit server and the bot. Change-Id: Ic75f9572653a248230a8b4b0bd360a8d22efd371 Signed-off-by: Hoa Nguyen <hoanguyen@ucdavis.edu> Reviewed-on: https://gem5-review.googlesource.com/c/public/gem5/+/38155 Maintainer: Jason Lowe-Power <power.jg@gmail.com> Tested-by: kokoro <noreply+kokoro@google.com> Reviewed-by: Jason Lowe-Power <power.jg@gmail.com>
Gerrit Bot
Getting Username and Password
Gerrit REST API uses the account username and password for the authentication purpose. They are necessary to make a request.
The following are steps to obtain the username and password from .gitcookies
files,
-
Follow this link https://gem5-review.googlesource.com/new-password and copy the authenticating script to a new file.
-
After that, run the
extract_gitcookies.pyto extract the username and password from the authenticating script. For example, the following command extracts the username and password fromgerrit_auth_scriptand writes them to.data/auth,
python3 extract_gitcookies.py gerrit_auth_script .data/auth
The .data/auth will have two lines: the first line contains the username and
the second line is the corresponding password.
Notes:
- The above link, https://gem5-review.googlesource.com/new-password, generates a new pair of username and password per visit.
- The
extract_gitcookies.pyfile is also able to read from.gitcookiesfile. For example,python3 extract_gitcookies.py ~/.gitcookies outputwill write all pairs of username and password in two lines per pair tooutput. - The gerrit-bot only reads the pair of username and password appearing
in the first and the second line in the
.data/authfile.
Gerrit Bot
The structure of the Gerrit bot is as follows:
- The
GerritBotConfigclass should contain all constants that are configurable prior to running.
Gerrit API
- Query options: https://gerrit-review.googlesource.com/Documentation/rest-api-changes.html#query-options
Deployment
The Gerrit bot is intended to be run as a cron job. Each run of the Gerrit bot will query new changes made to the Gerrit server within a certain period of time, perform actions on each change, and exit.
The following are steps to deploy the Gerrit bot:
- Create
.datafolder in the same folder asbot.py,
mkdir .data
-
Follow the steps here to get the Gerrit bot account username and password.
-
To run the Gerrit bot once,
./bot.py
- To edit the cron table,
crontab -e
To run the Gerrit bot every 30 minutes, add the following line to the crontable,
*/1 * * * * cd /path/to/gerrit/bot/directory && ./bot.py