Project

General

Profile

Gerrit » History » Version 73

laforge, 03/05/2018 07:17 PM

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