Project

General

Profile

Gerrit » History » Version 105

stsp, 12/18/2018 04:49 PM
remove paragraphs about gerrit bugs which have been fixed

1 99 fixeria
2
{{>toc}}
3 93 neels
4 1 zecke
h1. Contributing using Gerrit
5 11 laforge
6 10 laforge
At [[OpenBSC:OsmoDevCon2016]] we discussed problems with our past contribution / patch submission process using mails on the mailing list as well as patchwork.  The result is that we want to give Gerrit a try for some time and see if it helps us to have a better process
7 1 zecke
8 10 laforge
Gerrit is a review tool that integrates nicely with git and ssh. You can find general information about Gerrit at https://www.gerritcodereview.com/
9 1 zecke
10 10 laforge
The advantages of Gerrit are:
11
* patch submission status is automatically tracked, also with several revisions for a patch set.
12
* patches are build-tested (and possibly even further tested) by jenkins before they are applied
13
* developers + maintainers can formally vote on a patch (developer: -1/0/+1, maintainer: -2/0/+2)
14
* once a patch has +2 score, it can be (automatically) merged into master
15
* patch sumissions not via git send-email but direcly from git
16
17
h2. Osmocom Subprojects using Gerrit
18
19 73 laforge
The majority of Osmocom sub-projects have chosen to use Gerrit for patch review.  In order to check if a given program uses Gerrit, please check the auto-generated list at https://gerrit.osmocom.org/#/admin/projects/
20 1 zecke
21 75 laforge
If the project is listed there, then it uses Gerrit.   If the project is not listed there, please send patches by e-mail to the respective project [[Mailing_Lists]] instead.
22 30 neels
23 1 zecke
h2. Configuring Gerrit/Account
24
25 54 neels
You will need to sign-up at https://gerrit.osmocom.org/login/. If you have an Osmocom Redmine account you can use https://osmocom.org/openid as OpenID provider.
26 1 zecke
27 68 neels
* first sign in on https://osmocom.org. Do this before logging in on gerrit (the redmine login process loses the gerrit login data and you'd have to do the same thing twice if not logged in on osmocom.org already).
28 55 neels
* go to https://gerrit.osmocom.org and click the "Sign in" link.
29 68 neels
* click the "Sign in with Osmocom":https://gerrit.osmocom.org/login/%23%2Fq%2Fstatus%3Aopen?id=https://osmocom.org/openid link (can be bookmarked). -- This is the same as entering https://osmocom.org/openid as OpenID provider and hitting the "Sign in" button.
30 61 neels
31
*careful:* enter 'https' to ensure that your openid credentials are passed on encryptedly.
32 68 neels
*pitfall:* if you're logged in on 'projects.osmocom.org' (including the 'projects.' part), you should also use the openid provider: https://projects.osmocom.org/openid; the 'projects.' part may be omitted, what's important is that redmine login and OpenID URLs match. Also, decide for one of those URLs once, because when picking a different OpenID URL next time, you will create a new user instead of logging in as yourself.
33 61 neels
*note:* gerrit will create a distinct user for each openid URL you pass. If you logged in successfully but your user seems to have lost permissions, you may have created an evil twin user: contact us on the mailing list so we can fix it in the user database.
34 54 neels
35
If you have no Osmocom redmine account, you can simply create one online at the "Register" link in the upper right corner.
36 10 laforge
Even without an existing or new redmine account, you should also be able to use any other OpenID provider to authenticate against gerrit (untested).
37
38
After the initial sign-up you will need to:
39 1 zecke
40
* Pick a username (can not be changed)
41
* Add your public ssh key(s)
42
* Add email addresses you intend to use as author/comitter
43 30 neels
44
If you would like to push private branches to the Gerrit repository, you also need to be added to the "known users" group.
45
Please send a short requesting email to openbsc@lists.osmocom.org.
46 1 zecke
47
h2. Setting up Gerrit for commits and pushing
48
49 33 neels
*Note:* it is easiest to work with gerrit when gerrit is the only remote in your git clone.
50
When you clone from git.osmocom.org and add the gerrit remote, git will have two remotes,
51 36 neels
so when you first checkout a branch you have to supply the remote explicitly (cumbersome).
52 34 neels
The gerrit repositories and git.osmocom.org are constantly synced, so it is sufficient
53
to clone from gerrit only.
54 33 neels
55
h3. Simplest: new clone
56
57 35 neels
* Create a new clone from gerrit
58
* Fetch the commit hook that adds Change-Id to each commit to uniquely identify a commit
59 42 neels
60 33 neels
<pre>
61
git clone ssh://$USERNAME@gerrit.osmocom.org:29418/$PROJECT.git
62
scp -P 29418 $USERNAME@gerrit.osmocom.org:hooks/commit-msg $PROJECT/.git/hooks/
63
</pre>
64
65
h3. SSH config
66
67
In '~/.ssh/config', add these lines:
68
<pre>
69 52 neels
Host go
70 33 neels
Hostname gerrit.osmocom.org
71
Port 29418
72
User $USERNAME
73
</pre>
74 52 neels
('go' means gerrit.osmocom, replace with your favorite shortcut name,
75 33 neels
replace '$USERNAME' with your user name as used on the gerrit website)
76
77
Then you can shorten above commands to
78 1 zecke
<pre>
79 52 neels
git clone ssh://go/$PROJECT.git
80 51 neels
cd $PROJECT
81
scp go:hooks/commit-msg .git/hooks/
82 33 neels
</pre>
83
84 1 zecke
h3. Committer must match
85 46 neels
86 1 zecke
Your email address on gerrit and the email address git places in your
87 46 neels
commits must match, or you will get rejected with an error message like
88 1 zecke
"invalid commiter". You can add email addresses on the gerrit web UI.
89 47 neels
90 1 zecke
h3. Add gerrit to an existing clone
91
92
* Add the remote to be able to fetch and push to gerrit
93 46 neels
* Fetch the commit hook that adds Change-Id to each commit to uniquely identify a commit
94 1 zecke
95 46 neels
<pre>
96 1 zecke
USERNAME=gerrit_user_name
97
PROJECT=$(basename $PWD)
98
git remote add gerrit ssh://$USERNAME@gerrit.osmocom.org:29418/$PROJECT.git
99
scp -P 29418 $USERNAME@gerrit.osmocom.org:hooks/commit-msg .git/hooks/
100
</pre>
101
102
h2. Push for review
103
104
Prerequisites:
105
106
* your user on gerrit has an SSH public key
107
* your patch is committed in your local clone
108
* the commit log message has a Change-Id (see 'commit-msg' hook above, and 'Tips and Tricks' below to add a Change-Id to a commit that lacks one.)
109
110
<pre>
111
git push $REMOTE $GITHASH:refs/for/$BRANCH/$TOPIC
112
</pre>
113
114
$REMOTE: from above instructions, that's either 'origin' (cloned from gerrit) or 'gerrit' (if you added a second remote).
115
$GITHASH: the committed patch to push, typically you're on your branch and simply push 'HEAD'.
116
$BRANCH: you will typically intend a patch to go to 'master'.
117
$TOPIC: an optional name you may choose.
118
119
For example, checkout the revision or branch that you want to submit for review,
120
i.e. the one where your patch or several patches are committed on top of the current master, then:
121
122
If you cloned directly from gerrit:
123
124
<pre>
125
git push origin HEAD:refs/for/master
126
</pre>
127
128
If you added 'gerrit' as a second remote to an existing clone:
129
130
<pre>
131
git push gerrit HEAD:refs/for/master
132
</pre>
133
134
You can optionally add a topic name with
135
136
<pre>
137
git push origin HEAD:refs/for/master/my_topic
138
</pre>
139
140 102 stsp
h2. Voting Rules for merging a patch to master
141 7 neels
142 103 stsp
Please follow these voting rules:
143 44 neels
144 102 stsp
h3. Code Review ("CR")
145 77 neels
146 102 stsp
* Please review patches by others.
147
* Do not vote for your own patches (exceptions below).
148
* Before merging, each patch should receive at least two reviews that approve merging.
149 77 neels
150 102 stsp
When voting, please follow this social contract:
151 77 neels
152 102 stsp
* When you approve, vote CR +1.
153
* If there already is someone else's CR +1, you may also choose to vote CR +2.
154
* If the patch owner sees two or more CR +1, the patch owner may apply to self a CR +2.
155
* Once there is at least one CR +2 and one CR +1 vote, a patch may be merged ("Submit" button), except:
156
** If there are two -1 votes, you should not merge, instead clarify the reason and try to fix it.
157
** If there is a single -1 vote, you may still merge the patch, if you are sure that the opinion of the -1 vote does not carry.
158
* Give the benefit of the doubt to the -1 vote, do not lightheartedly overrule.
159
* If there is a CR -2 vote, the patch will likely never pass review, it marks a fundamental flaw.
160
* Merging a patch ("Submit" button) may be done by a reviewer or by the patch owner,
161
  But if there is any negative vote, rather leave merging up to the patch owner.
162
* If you remove a +1 vote, try to make sure that there are no other CR +2 votes left alone
163
  (to prevent accidental "Submit including parents"). If needed, ping other reviewer / admin on IRC.
164
  But try to vote +1 only when you're sure, hence this situation should be rare.
165
* To prevent merging of your own patch before some issue is resolved, consider marking it Work In Progress.
166
167 104 stsp
h3. Exceptions for Trivial / Urgent Patches
168 102 stsp
169
A patch may receive a direct +2 when:
170
171
* it is very trivial, like a typo fix in a comment or log string, so that it is not worth wasting review time on.
172
* it reverts an earlier change that broke the master builds.
173
174
In these cases, the patch submitter may decide to +2 to self, after careful consideration. This should be rare.
175
176
h3. Verification ("V")
177
178
* For most projects, jenkins takes care of voting V +1 automatically.
179
* If you have actually tried out a patch and verified that it works, you may vote V +1.
180
* A patch owner may vote V +1 to self in a project that has no Jenkins verification job.
181
182
h3. Rationale
183
184
Gerrit allows merging a patch as soon as a CR +2 vote and a V +1 vote are in.
185
For quite some time, we had CR +2 permissions for only very few gatekeeper reviewers.
186
The result was that non-gatekeepers' votes seemed to not matter.
187
188
To encourage more peer review that actually has an effect, we would like to sum up +1 votes.
189
We have tried to apply a summing of votes in Gerrit with automatic enforcing
190
( https://gerrit-review.googlesource.com/Documentation/prolog-cookbook.html#_example_13_1_1_2_code_review )
191
but this had numerous quirks, particularly the issues summary shows wildly mismatching voting status.
192
193
The solution is to agree on a social contract: everyone gets +2 permissions,
194
but you shall only use it when it makes sense. Thanks!
195
196 1 zecke
197 84 neels
h2. Manage private branches
198 1 zecke
199 84 neels
Use a sub-directory with your name to group your own branches, please.
200 1 zecke
*Note* that you must be a member of the "known users" group, see above.
201
202 85 neels
To share / backup local branches to git.osmocom.org, without starting a code review process on gerrit.osmocom.org, just push them as usual to gerrit.
203 84 neels
204
* Note that the git repository must be cloned from the gerrit SSH URL -- all pushing goes to gerrit ("pushurl" as described below also works).
205
* All private branches are automatically synced to git.osmocom.org in a matter of minutes.
206 86 neels
* Private branches do not kick off patch sets for review, they are just branches. To kick off review for all patches on your branch, you'd use a 'refs/for/master' URL, as shown in the example below.
207 84 neels
208
The typical transcript for "Fred" developing feature "Kazoo" looks like this:
209
210 1 zecke
<pre>
211 84 neels
# Set up ~/.ssh/config so that 'go' points at gerrit.osmocom.org
212
git clone ssh://go/libosmocore
213
214
cd libosmocore
215
git checkout -b fred/kazoo   # create local branch
216
217
$EDITOR
218
git add kazoo.c
219
git commit -m "implement kazoo"
220
221
# just invoke 'git push' and git tells you how to create the branch once-off:
222 1 zecke
git push
223 84 neels
|fatal: The current branch asdf has no upstream branch.
224
|To push the current branch and set the remote as upstream, use
225
|
226
|    git push --set-upstream origin fred/kazoo
227 1 zecke
228 84 neels
git push --set-upstream origin fred/kazoo
229
# Now the branch exists on gerrit, very soon will also exist on git.osmocom.org
230
231
# Further tweaks
232
$EDITOR
233
git add kazoo.h
234
git commit --amend
235
236
# You are free to force-push private branches
237
git push -f
238
239
# origin/master has changed? Rebase onto the latest.
240
git fetch
241
git rebase -i origin/master
242
# resolve conflicts...
243
git push -f
244
245
# Feature is ready
246
git push origin HEAD:refs/for/master/kazoo
247 39 neels
</pre>
248 7 neels
249 48 ahuemer
h2. List changesets in gerrit
250 2 zecke
251 12 msuraev
<pre>
252 17 neels
git ls-remote gerrit changes/*
253 1 zecke
</pre>
254 80 neels
255
h1. Tips and Tricks
256
257
h2. A commit lacks a Change-Id
258
259
once you added the commit hook as above, just re-edit the commit log message, e.g. with
260
261
<pre>
262
git commit --amend
263
</pre>
264
265
or by
266
267
<pre>
268
git rebase -i
269
</pre>
270
271
and in the upcoming editor replacing 'pick' with 'r' in front of the commit to edit.
272 74 neels
273
No need to change the commit log if you don't want to, just exit the editor and the commit hook will add a Change-Id.
274 79 neels
275 87 msuraev
h2. Ignore WIP patches
276
277
Using following operators in "search" field of web UI allows to ignore Work-in-progress changes:
278
<pre>
279
status:open AND -is:wip
280
</pre>
281
282 79 neels
h2. Fetch fast from git.osmocom.org, push to gerrit
283
284 1 zecke
Gerrit has moved to a faster host, so this should no longer be necessary. Anyway...
285 74 neels
286
Adding a second remote forces you to often pass the remote on the command line ("origin").
287 79 neels
It is possible to have only one remote for cmdline convenience, with differing push and pull URLs:
288
289 74 neels
<pre>
290 1 zecke
git remote set-url origin git://git.osmocom.org/$PROJECT
291 74 neels
git remote set-url --push origin ssh://$USERNAME@gerrit.osmocom.org:29418/$PROJECT
292
</pre>
293 79 neels
294 74 neels
With above .ssh config you can also use the shorter ssh:// URL:
295
<pre>
296 79 neels
git remote set-url --push origin ssh://go/$PROJECT
297 74 neels
</pre>
298
299
The resulting .git/config in libosmocore would look something like:
300
<pre>
301
[remote "origin"]
302
        url = git://git.osmocom.org/libosmocore
303
        pushurl = ssh://go/libosmocore
304
        fetch = +refs/heads/*:refs/remotes/origin/*
305
</pre>
306 17 neels
307
Now you're fetching from git.osmocom.org, which is lightning fast, while pushing patches will still go to gerrit as usual.
308
309 45 neels
h2. Throw-away branch
310 13 neels
311 56 neels
If you need to adjust and re-submit patches, it may be handy to create a throw-away branch ("R D" in magit-gerrit in emacs for example),
312
make your changes/amendments and then send patch(es) back to gerrit while removing temporary branch automatically with "git review -f".
313
314
h2. Fetch a patch from gerrit
315
316
This script (I called it @P@) makes fetching a patch set from gerrit a breeze:
317
<pre>
318
#!/bin/sh
319
# fetch gerrit patch into new branch named like the patch number.
320
#
321
# Usage: go to a git clone and pass a patch number:
322
#
323
#   cd openbsc
324
#   P 973
325
# or
326
#   P 973/2
327
#
328
# Will create new local branches '973_4' (if 4 is the latest patch set)
329
# or '973_2', respectively.
330
331
patch="$1"
332
333
if [ -z "$patch" ]; then
334
  echo "Usage: P 1234[/5]"
335
  exit 1
336
fi
337
338
if [ -z "$(echo "$patch" | grep '/')" ]; then
339
  patch="/$patch/"
340
fi
341
342
if [ -z "$(echo "$patch" | grep '^/')" ]; then
343
  patch="/$patch"
344
fi
345
346
last_set="$(git ls-remote origin "changes/*" | grep "$patch" | sed 's#.*/\([^/]*\)$#\1 &#' | sort -n | tail -n 1)"
347
if [ -z "$last_set" ]; then
348
  echo "Not found: $patch"
349
  exit 1
350
fi
351
352
change_name="$(echo "$last_set" | sed 's/.*\(refs.*\)/\1/')"
353
branch_name="$(echo "$change_name" | sed 's#refs/changes/../\([0-9]*\)/\([0-9]*\)#\1_\2#')"
354
355
set -x
356
git fetch origin "$change_name"
357 25 neels
git co -b "$branch_name" FETCH_HEAD
358 13 neels
</pre>
359 1 zecke
360 58 neels
h2. Re-submit a Branch with Amended Commits
361
362 22 neels
On a feature branch, one typically has numerous commits that depend on their preceding commits.
363 58 neels
Often, some of the branch commits need to be amended for fixes. You can re-submit changes to
364
patches on your branch by pushing in the same way that you first submitted the branch.
365
366 29 neels
Note: if you modify the Change-Ids in the commit logs, your push would open entirely new
367 58 neels
review entries and you would have to abandon your previous submission. Comments on the first
368
submission are "lost" and you cannot diff between patch sets.
369 29 neels
370 26 neels
371 1 zecke
h2. Re-submit Previously Abandoned Changes
372
373
You have to edit the Change-Ids, on a branch that would be every single commit log message.
374
375
<pre>
376
cd openbsc
377
git co my-branch
378
git rebase -i master
379
# replace all 'pick' with 'r' (or 'reword'), exit your editor
380
# git presents each commit log message for editing
381
</pre>
382
383 78 neels
h2. 502 Bad Gateway
384
385
When getting a "Bad Gateway" error message upon trying to login on gerrit, you probably just need to restart your web browser. The reason is not clear.
386
387
388
h2. Commit hook: Always put Change-Id at the bottom of the log message
389
390
The commit-msg hook places a Change-Id tag in the footer, often above other tags like 'Depends:' or 'Related:'. Since the Change-Id is an implementation detail for Gerrit, I personally prefer it always placed right at the bottom. This simple edit changes the commit-msg hook to add Change-Id at the bottom unconditionally:
391
392
<pre>
393
cd $PROJECT
394
sed -i 's/if (unprinted /if (0 \&\& unprinted /' .git/hooks/commit-msg
395
</pre>
396
397
The goal is to disable the condition in line 163 with an 'if (0...':
398
399
<pre>
400
                        if (0 && unprinted && match(tolower(footer[line]), changeIdAfter) != 1) {
401
                                unprinted = 0
402
                                print "Change-Id: I'"$id"'"
403
                        }
404 60 neels
</pre>
405 16 neels
406 13 neels
Then the Change-Id will be placed by line 170 instead.
407 16 neels
408
h1. Reasons for Particular Configuration
409
410 13 neels
h2. Rebase if necessary
411
412
There are different merge strategies that Gerrit performs to accept patches.
413
Each project can be configured to a specific merge strategy, but unfortunately you can't
414
decide on a strategy per patch submission.
415
416
It seems that the "Merge if Necessary" strategy is best supported, but it creates non-linear
417
history with numerous merge commits that are usually not at all necessary.
418
419
Instead, the "Cherry Pick" strategy puts each patch onto current master's HEAD to create
420 1 zecke
linear history. However, this will cause merge failures as soon as one patch depends on
421 13 neels
another submitted patch, as typical for a feature branch submission.
422
423 1 zecke
So we prefer the "Rebase if Necessary" strategy, which always tries to apply your patches to
424 13 neels
the current master HEAD, in sequence with the previous patches on the same branch.
425
426
h2. Private Branches: Create a new change for every commit...
427 16 neels
428 13 neels
Say you have an extensive feature in development, and you want to keep it on the
429
upstream git repository to a) keep it safe and b) collaborate with other devs on it.
430
So, of course, you have regularly pushed to refs/heads/yoyodyne/feature.
431
432
Since you have the gerrit commit hook installed, your feature branch already has
433
Change-Id tags in all commit log messages.
434
435
Now your feature is complete and you would like to submit it to master.
436 16 neels
Alas, Gerrit refuses to accept your patch submission for master, because it
437
knows the Change-Ids are also on a different branch.
438
439
Gerrit by default enforces that a Change-Id must be unique across all branches,
440
so that each submission for review is separate for each branch. Instead, we
441 13 neels
want to handle Change-Ids per-branch, so that you can have the same change
442 16 neels
submitted to different branches, as separate patch submissions, without having
443
to cosmetically adjust the Change-Id.
444 13 neels
445 20 neels
Solution: set the option 
446 14 neels
_Create a new change for every commit not in the target branch_ to _TRUE_
447
448
h2. Allow content merges
449
450
By default, gerrit compares patches only by the files' paths. If two paths are the same,
451
it immediately shows them as conflicts (path conflicts).
452
453 23 neels
In software development, a conflict usually means an actual content conflict, so if the
454 14 neels
edits are in two entirely separate places in the file, we don't consider this a conflict.
455
456 32 neels
By setting _Allow content merges_ to _TRUE_ in the git project config, we tell Gerrit to
457
perform text merges of the submitted patches and only complain about actual content
458
conflicts, in the usual software engineering sense.
459 72 laforge
460
h1. Admin
461
462
h2. Adding a new repository
463
464
* create the repository in the Gerrit Ui, inherit from "All-Projects"
465
* create an empty git repository using gitosis on git.osmcoom.org
466 88 osmith
* configure a jenkins build testing job for this project (see gerrit-verifications.yml in osmo-ci.git/jobs)
467 92 osmith
468 72 laforge
469 32 neels
git replication to gerrit.osmocom.org is enabled automatically, nothing to be done here.  In case of doubt, try
470
@ssh -p 29418 gerrit.osmocom.org replication start --all --wait@
471
472
h2. Adding users to groups
473
474
Normally, the gerrit UI auto-completes a user name in the edit field. It has happened
475
though that an existing user is not auto-completed, as if it didn't exist. In that case,
476
find out the user ID (seven digit number like 1000123) and just enter that.
477
478
The user ID can be found on the user's "Settings" page, or in the database (s.b.).
479
480
h2. Querying the database directly
481
482
If your user has permission to access the database, you can place SQL queries using the
483 71 neels
'gerrit gsql' commands over ssh:
484
485 1 zecke
<pre>
486 53 neels
ssh go "gerrit gsql -c \"show tables\""
487
ssh go "gerrit gsql -c \"select full_name,account_id from accounts\""
488 1 zecke
</pre>
489
490 71 neels
(see ~/.ssh/config above for the 'go' shortcut)
491
492 62 neels
This seems to be the MySQL dialect.
493
494
The "...\"...\"" quoting allows including single-quotes in the SQL statements.
495
496
h2. Fix evil twin users
497
498 64 neels
If differing openid URLs have lead to evil twin users shadowing the same email address just without the permissions, you can fix it like this:
499 62 neels
500
<pre>
501
ssh go "gerrit gsql -c \"select * from account_external_ids where email_address like '%foo%'\""
502
# ACCOUNT_ID | EMAIL_ADDRESS   | PASSWORD | EXTERNAL_ID
503
# -----------+-----------------+----------+----------------------------------
504 64 neels
# 100004     | foo@example.com | NULL     | https://osmocom.org/openid/user/777
505 62 neels
# 100021     | foo@example.com | NULL     | https://projects.osmocom.org/openid/user/777
506 64 neels
507 62 neels
ssh go "gerrit gsql -c \"update account_external_ids set account_id = 100004 where email_address like '%foo%'\""
508
509
ssh go "gerrit gsql -c \"select * from account_external_ids where email_address like '%foo%'\""
510
# ACCOUNT_ID | EMAIL_ADDRESS   | PASSWORD | EXTERNAL_ID
511
# -----------+-----------------+----------+----------------------------------
512 1 zecke
# 100004     | foo@example.com | NULL     | https://osmocom.org/openid/user/777
513
# 100004     | foo@example.com | NULL     | https://projects.osmocom.org/openid/user/777
514
</pre>
Add picture from clipboard (Maximum size: 48.8 MB)