Project

General

Profile

Gerrit » History » Version 77

neels, 05/17/2018 12:46 AM

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