Project

General

Profile

Gerrit » History » Version 83

neels, 09/17/2018 11:18 AM

1 1 zecke
h1. Contributing using Gerrit
2
3 11 laforge
{{>toc}}
4
5 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
6 1 zecke
7 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/
8 1 zecke
9 10 laforge
The advantages of Gerrit are:
10
* patch submission status is automatically tracked, also with several revisions for a patch set.
11
* patches are build-tested (and possibly even further tested) by jenkins before they are applied
12
* developers + maintainers can formally vote on a patch (developer: -1/0/+1, maintainer: -2/0/+2)
13
* once a patch has +2 score, it can be (automatically) merged into master
14
* patch sumissions not via git send-email but direcly from git
15
16
h2. Osmocom Subprojects using Gerrit
17
18 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/
19 1 zecke
20 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.
21 30 neels
22 1 zecke
h2. Configuring Gerrit/Account
23
24 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.
25 1 zecke
26 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).
27 55 neels
* go to https://gerrit.osmocom.org and click the "Sign in" link.
28 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.
29 61 neels
30
*careful:* enter 'https' to ensure that your openid credentials are passed on encryptedly.
31 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.
32 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.
33 54 neels
34
If you have no Osmocom redmine account, you can simply create one online at the "Register" link in the upper right corner.
35 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).
36
37
After the initial sign-up you will need to:
38 1 zecke
39
* Pick a username (can not be changed)
40
* Add your public ssh key(s)
41
* Add email addresses you intend to use as author/comitter
42 30 neels
43
If you would like to push private branches to the Gerrit repository, you also need to be added to the "known users" group.
44
Please send a short requesting email to openbsc@lists.osmocom.org.
45 1 zecke
46
h2. Setting up Gerrit for commits and pushing
47
48 33 neels
*Note:* it is easiest to work with gerrit when gerrit is the only remote in your git clone.
49
When you clone from git.osmocom.org and add the gerrit remote, git will have two remotes,
50 36 neels
so when you first checkout a branch you have to supply the remote explicitly (cumbersome).
51 34 neels
The gerrit repositories and git.osmocom.org are constantly synced, so it is sufficient
52
to clone from gerrit only.
53 33 neels
54
h3. Simplest: new clone
55
56 35 neels
* Create a new clone from gerrit
57
* Fetch the commit hook that adds Change-Id to each commit to uniquely identify a commit
58 42 neels
59 33 neels
<pre>
60
git clone ssh://$USERNAME@gerrit.osmocom.org:29418/$PROJECT.git
61
scp -P 29418 $USERNAME@gerrit.osmocom.org:hooks/commit-msg $PROJECT/.git/hooks/
62
</pre>
63
64
h3. SSH config
65
66
In '~/.ssh/config', add these lines:
67
<pre>
68 52 neels
Host go
69 33 neels
Hostname gerrit.osmocom.org
70
Port 29418
71
User $USERNAME
72
</pre>
73 52 neels
('go' means gerrit.osmocom, replace with your favorite shortcut name,
74 33 neels
replace '$USERNAME' with your user name as used on the gerrit website)
75
76
Then you can shorten above commands to
77 1 zecke
<pre>
78 52 neels
git clone ssh://go/$PROJECT.git
79 51 neels
cd $PROJECT
80
scp go:hooks/commit-msg .git/hooks/
81 33 neels
</pre>
82
83 46 neels
h3. Committer must match
84
85 47 neels
Your email address on gerrit and the email address git places in your
86 46 neels
commits must match, or you will get rejected with an error message like
87
"invalid commiter". You can add email addresses on the gerrit web UI.
88
89 33 neels
h3. Add gerrit to an existing clone
90
91 7 neels
* Add the remote to be able to fetch and push to gerrit
92
* Fetch the commit hook that adds Change-Id to each commit to uniquely identify a commit
93
94
<pre>
95
USERNAME=gerrit_user_name
96
PROJECT=$(basename $PWD)
97 1 zecke
git remote add gerrit ssh://$USERNAME@gerrit.osmocom.org:29418/$PROJECT.git
98
scp -P 29418 $USERNAME@gerrit.osmocom.org:hooks/commit-msg .git/hooks/
99 44 neels
</pre>
100
101 33 neels
h2. Push for review
102 1 zecke
103 81 neels
Prerequisites:
104
105
* your user on gerrit has an SSH public key
106
* your patch is committed in your local clone
107 82 neels
* 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.)
108 81 neels
109 77 neels
<pre>
110
git push $REMOTE $GITHASH:refs/for/$BRANCH/$TOPIC
111
</pre>
112
113
$REMOTE: from above instructions, that's either 'origin' (cloned from gerrit) or 'gerrit' (if you added a second remote).
114
$GITHASH: the committed patch to push, typically you're on your branch and simply push 'HEAD'.
115
$BRANCH: you will typically intend a patch to go to 'master'.
116
$TOPIC: an optional name you may choose.
117
118
For example, checkout the revision or branch that you want to submit for review,
119
i.e. the one where your patch or several patches are committed on top of the current master, then:
120 1 zecke
121 76 neels
If you cloned directly from gerrit:
122
123 1 zecke
<pre>
124 76 neels
git push origin HEAD:refs/for/master
125
</pre>
126
127
If you added 'gerrit' as a second remote to an existing clone:
128
129
<pre>
130 1 zecke
git push gerrit HEAD:refs/for/master
131 38 neels
</pre>
132 1 zecke
133 40 neels
You can optionally add a topic name with
134 1 zecke
135 40 neels
<pre>
136 76 neels
git push origin HEAD:refs/for/master/my_topic
137 38 neels
</pre>
138
139 57 neels
h2. Merge patch to master
140
141
A patch can be merged when it has CR+2 and V+1 votes, and if, in case of a
142
series of patches pushed from a branch, when its ancestor patches can also be
143
merged.
144
145
Sometimes the reviewer that gives CR+2 also hits the "Submit" button right away 
146
to merge the patch to master. Sometimes it is left up to the owner of the patch
147 59 neels
to decide when to hit "Submit" (who needs to be in the "Known Users" group).
148 57 neels
149
The V+1 vote means "build is verified" and is usually given by our jenkins
150 59 neels
gerrit builds: https://jenkins.osmocom.org/jenkins/view/Jenkins-Gerrit/
151 57 neels
152
The CR+2 vote means "code reviewed and ready for merge to master branch".
153
Accounts with the "Reviewer" role for a given project are allowed to give CR+2
154
votes. Others are allowed to give CR+1 (and CR-1). CR votes _don't_ add up.
155
156 67 neels
_Fixed by gerrit 2.12.6, see https://bugs.chromium.org/p/gerrit/issues/detail?id=4158:_
157
-Sometimes hitting the "Submit" button results in an error message saying
158 57 neels
"Change is New", which is a bug related to a private branch with the same
159 65 neels
patches being present. Can be fixed e.g. by an admin's manual push to master.-
160 1 zecke
161 38 neels
h2. Push a "private" user branch
162 33 neels
163 1 zecke
*Note* that you must be a member of the "known users" group, see above.
164 33 neels
165 43 neels
If your local branch name is of the form 'your_name/topic', you can just
166 1 zecke
<pre>
167
git push
168 33 neels
</pre>
169 41 neels
and git will tell you what to do.
170 1 zecke
171 41 neels
To push from a "nonstandard" local branch name, do
172
<pre>
173 50 msuraev
git push gerrit HEAD:refs/heads/user/$USERNAME/branch_name
174 33 neels
</pre>
175
176 39 neels
177
h2. List changesets in gerrit
178
179 7 neels
<pre>
180 48 ahuemer
git ls-remote gerrit changes/*
181 2 zecke
</pre>
182 12 msuraev
183 17 neels
h1. Tips and Tricks
184 1 zecke
185 80 neels
h2. A commit lacks a Change-Id
186
187
once you added the commit hook as above, just re-edit the commit log message, e.g. with
188
189
<pre>
190
git commit --amend
191
</pre>
192
193
or by
194
195
<pre>
196
git rebase -i
197
</pre>
198
199
and in the upcoming editor replacing 'pick' with 'r' in front of the commit to edit.
200
201
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.
202
203 74 neels
h2. Fetch fast from git.osmocom.org, push to gerrit
204
205 79 neels
Gerrit has moved to a faster host, so this should no longer be necessary. Anyway...
206
207
Adding a second remote forces you to often pass the remote on the command line ("origin").
208 1 zecke
It is possible to have only one remote for cmdline convenience, with differing push and pull URLs:
209 74 neels
210
<pre>
211 79 neels
git remote set-url origin git://git.osmocom.org/$PROJECT
212
git remote set-url --push origin ssh://$USERNAME@gerrit.osmocom.org:29418/$PROJECT
213 74 neels
</pre>
214 1 zecke
215 74 neels
With above .ssh config you can also use the shorter ssh:// URL:
216
<pre>
217 79 neels
git remote set-url --push origin ssh://go/$PROJECT
218 74 neels
</pre>
219
220 79 neels
The resulting .git/config in libosmocore would look something like:
221 74 neels
<pre>
222
[remote "origin"]
223
        url = git://git.osmocom.org/libosmocore
224
        pushurl = ssh://go/libosmocore
225
        fetch = +refs/heads/*:refs/remotes/origin/*
226
</pre>
227
228
Now you're fetching from git.osmocom.org, which is lightning fast, while pushing patches will still go to gerrit as usual.
229
230 17 neels
h2. Throw-away branch
231
232
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),
233 45 neels
make your changes/amendments and then send patch(es) back to gerrit while removing temporary branch automatically with "git review -f".
234 13 neels
235 56 neels
h2. Fetch a patch from gerrit
236
237
This script (I called it @P@) makes fetching a patch set from gerrit a breeze:
238
<pre>
239
#!/bin/sh
240
# fetch gerrit patch into new branch named like the patch number.
241
#
242
# Usage: go to a git clone and pass a patch number:
243
#
244
#   cd openbsc
245
#   P 973
246
# or
247
#   P 973/2
248
#
249
# Will create new local branches '973_4' (if 4 is the latest patch set)
250
# or '973_2', respectively.
251
252
patch="$1"
253
254
if [ -z "$patch" ]; then
255
  echo "Usage: P 1234[/5]"
256
  exit 1
257
fi
258
259
if [ -z "$(echo "$patch" | grep '/')" ]; then
260
  patch="/$patch/"
261
fi
262
263
if [ -z "$(echo "$patch" | grep '^/')" ]; then
264
  patch="/$patch"
265
fi
266
267
last_set="$(git ls-remote origin "changes/*" | grep "$patch" | sed 's#.*/\([^/]*\)$#\1 &#' | sort -n | tail -n 1)"
268
if [ -z "$last_set" ]; then
269
  echo "Not found: $patch"
270
  exit 1
271
fi
272
273
change_name="$(echo "$last_set" | sed 's/.*\(refs.*\)/\1/')"
274
branch_name="$(echo "$change_name" | sed 's#refs/changes/../\([0-9]*\)/\([0-9]*\)#\1_\2#')"
275
276
set -x
277
git fetch origin "$change_name"
278
git co -b "$branch_name" FETCH_HEAD
279
</pre>
280
281 25 neels
h2. Re-submit a Branch with Amended Commits
282 13 neels
283 1 zecke
On a feature branch, one typically has numerous commits that depend on their preceding commits.
284 58 neels
Often, some of the branch commits need to be amended for fixes. You can re-submit changes to
285
patches on your branch by pushing in the same way that you first submitted the branch.
286 22 neels
287 58 neels
Note: if you modify the Change-Ids in the commit logs, your push would open entirely new
288
review entries and you would have to abandon your previous submission. Comments on the first
289
submission are "lost" and you cannot diff between patch sets.
290 29 neels
291 58 neels
(There used to be a bug in gerrit that required editing the first patch to be able to
292
re-submit a branch, but that's fixed.)
293 29 neels
294
295
296 26 neels
h2. Re-submit Previously Abandoned Changes
297 1 zecke
298
You have to edit the Change-Ids, on a branch that would be every single commit log message.
299
300
<pre>
301
cd openbsc
302
git co my-branch
303
git rebase -i master
304
# replace all 'pick' with 'r' (or 'reword'), exit your editor
305
# git presents each commit log message for editing
306
</pre>
307
308
h2. 502 Bad Gateway
309
310
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.
311 78 neels
312
313
h2. Commit hook: Always put Change-Id at the bottom of the log message
314
315
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:
316
317
<pre>
318
cd $PROJECT
319
sed -i 's/if (unprinted /if (0 \&\& unprinted /' .git/hooks/commit-msg
320
</pre>
321
322
The goal is to disable the condition in line 163 with an 'if (0...':
323
324
<pre>
325
                        if (0 && unprinted && match(tolower(footer[line]), changeIdAfter) != 1) {
326
                                unprinted = 0
327
                                print "Change-Id: I'"$id"'"
328
                        }
329
</pre>
330
331
Then the Change-Id will be placed by line 170 instead.
332 60 neels
333 16 neels
h1. Reasons for Particular Configuration
334 13 neels
335 16 neels
h2. Rebase if necessary
336
337
There are different merge strategies that Gerrit performs to accept patches.
338 13 neels
Each project can be configured to a specific merge strategy, but unfortunately you can't
339
decide on a strategy per patch submission.
340
341
It seems that the "Merge if Necessary" strategy is best supported, but it creates non-linear
342
history with numerous merge commits that are usually not at all necessary.
343
344
Instead, the "Cherry Pick" strategy puts each patch onto current master's HEAD to create
345
linear history. However, this will cause merge failures as soon as one patch depends on
346
another submitted patch, as typical for a feature branch submission.
347
348 1 zecke
So we prefer the "Rebase if Necessary" strategy, which always tries to apply your patches to
349 13 neels
the current master HEAD, in sequence with the previous patches on the same branch.
350
However, some problems still remain, including some bugs in "Rebase if Necessary".
351 1 zecke
352 13 neels
There's a problem with "Rebase if Necessary": If your branch sits at master's HEAD, Gerrit
353
refuses to accept the submission, because it thinks that no new changes are submitted.
354
This is a bug in Gerrit, which holger has fixed manually in our Gerrit installation:
355 1 zecke
356
https://bugs.chromium.org/p/gerrit/issues/detail?id=4158
357
358
359 16 neels
h2. Private Branches: Create a new change for every commit...
360 1 zecke
361 13 neels
Say you have an extensive feature in development, and you want to keep it on the
362
upstream git repository to a) keep it safe and b) collaborate with other devs on it.
363 16 neels
So, of course, you have regularly pushed to refs/heads/yoyodyne/feature.
364 13 neels
365
Since you have the gerrit commit hook installed, your feature branch already has
366
Change-Id tags in all commit log messages.
367
368
Now your feature is complete and you would like to submit it to master.
369
Alas, Gerrit refuses to accept your patch submission for master, because it
370
knows the Change-Ids are also on a different branch.
371
372 16 neels
Gerrit by default enforces that a Change-Id must be unique across all branches,
373
so that each submission for review is separate for each branch. Instead, we
374
want to handle Change-Ids per-branch, so that you can have the same change
375
submitted to different branches, as separate patch submissions, without having
376
to cosmetically adjust the Change-Id.
377 13 neels
378 16 neels
Solution: set the option 
379
_Create a new change for every commit not in the target branch_ to _TRUE_
380 13 neels
381 20 neels
h2. Allow content merges
382 14 neels
383
By default, gerrit compares patches only by the files' paths. If two paths are the same,
384
it immediately shows them as conflicts (path conflicts).
385
386
In software development, a conflict usually means an actual content conflict, so if the
387
edits are in two entirely separate places in the file, we don't consider this a conflict.
388
389 23 neels
By setting _Allow content merges_ to _TRUE_ in the git project config, we tell Gerrit to
390 14 neels
perform text merges of the submitted patches and only complain about actual content
391
conflicts, in the usual software engineering sense.
392 32 neels
393
h1. Admin
394
395 72 laforge
h2. Adding a new repository
396
397
* create the repository in the Gerrit Ui, inherit from "All-Projects"
398
* create an empty git repository using gitosis on git.osmcoom.org
399
* configure a jenkins build testing job for this project, cloning/copying from any osmo-*-gerrit projects
400
401
git replication to gerrit.osmocom.org is enabled automatically, nothing to be done here.  In case of doubt, try
402
@ssh -p 29418 gerrit.osmocom.org replication start --all --wait@
403
404 32 neels
h2. Adding users to groups
405
406
Normally, the gerrit UI auto-completes a user name in the edit field. It has happened
407
though that an existing user is not auto-completed, as if it didn't exist. In that case,
408
find out the user ID (seven digit number like 1000123) and just enter that.
409
410
The user ID can be found on the user's "Settings" page, or in the database (s.b.).
411
412
h2. Querying the database directly
413
414
If your user has permission to access the database, you can place SQL queries using the
415
'gerrit gsql' commands over ssh:
416
417
<pre>
418 71 neels
ssh go "gerrit gsql -c \"show tables\""
419
ssh go "gerrit gsql -c \"select full_name,account_id from accounts\""
420 1 zecke
</pre>
421 53 neels
422
(see ~/.ssh/config above for the 'go' shortcut)
423 1 zecke
424
This seems to be the MySQL dialect.
425 71 neels
426
The "...\"...\"" quoting allows including single-quotes in the SQL statements.
427 62 neels
428
h2. Fix evil twin users
429
430
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:
431
432
<pre>
433 64 neels
ssh go "gerrit gsql -c \"select * from account_external_ids where email_address like '%foo%'\""
434 62 neels
# ACCOUNT_ID | EMAIL_ADDRESS   | PASSWORD | EXTERNAL_ID
435
# -----------+-----------------+----------+----------------------------------
436
# 100004     | foo@example.com | NULL     | https://osmocom.org/openid/user/777
437
# 100021     | foo@example.com | NULL     | https://projects.osmocom.org/openid/user/777
438
439 64 neels
ssh go "gerrit gsql -c \"update account_external_ids set account_id = 100004 where email_address like '%foo%'\""
440 62 neels
441 64 neels
ssh go "gerrit gsql -c \"select * from account_external_ids where email_address like '%foo%'\""
442 62 neels
# ACCOUNT_ID | EMAIL_ADDRESS   | PASSWORD | EXTERNAL_ID
443
# -----------+-----------------+----------+----------------------------------
444
# 100004     | foo@example.com | NULL     | https://osmocom.org/openid/user/777
445
# 100004     | foo@example.com | NULL     | https://projects.osmocom.org/openid/user/777
446
</pre>
Add picture from clipboard (Maximum size: 48.8 MB)