Project

General

Profile

Gerrit » History » Version 59

neels, 02/20/2017 12:05 PM

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