Project

General

Profile

Gerrit » History » Version 56

neels, 10/16/2016 11:14 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 1 zecke
122 38 neels
h2. Push a "private" user branch
123 33 neels
124 1 zecke
*Note* that you must be a member of the "known users" group, see above.
125 33 neels
126 43 neels
If your local branch name is of the form 'your_name/topic', you can just
127 1 zecke
<pre>
128
git push
129 33 neels
</pre>
130 41 neels
and git will tell you what to do.
131 1 zecke
132 41 neels
To push from a "nonstandard" local branch name, do
133
<pre>
134 50 msuraev
git push gerrit HEAD:refs/heads/user/$USERNAME/branch_name
135 33 neels
</pre>
136
137 39 neels
138
h2. List changesets in gerrit
139
140 7 neels
<pre>
141 48 ahuemer
git ls-remote gerrit changes/*
142 2 zecke
</pre>
143 12 msuraev
144 17 neels
h1. Tips and Tricks
145 1 zecke
146 17 neels
h2. Throw-away branch
147
148
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),
149 45 neels
make your changes/amendments and then send patch(es) back to gerrit while removing temporary branch automatically with "git review -f".
150 13 neels
151 56 neels
h2. Fetch a patch from gerrit
152
153
This script (I called it @P@) makes fetching a patch set from gerrit a breeze:
154
<pre>
155
#!/bin/sh
156
# fetch gerrit patch into new branch named like the patch number.
157
#
158
# Usage: go to a git clone and pass a patch number:
159
#
160
#   cd openbsc
161
#   P 973
162
# or
163
#   P 973/2
164
#
165
# Will create new local branches '973_4' (if 4 is the latest patch set)
166
# or '973_2', respectively.
167
168
patch="$1"
169
170
if [ -z "$patch" ]; then
171
  echo "Usage: P 1234[/5]"
172
  exit 1
173
fi
174
175
if [ -z "$(echo "$patch" | grep '/')" ]; then
176
  patch="/$patch/"
177
fi
178
179
if [ -z "$(echo "$patch" | grep '^/')" ]; then
180
  patch="/$patch"
181
fi
182
183
last_set="$(git ls-remote origin "changes/*" | grep "$patch" | sed 's#.*/\([^/]*\)$#\1 &#' | sort -n | tail -n 1)"
184
if [ -z "$last_set" ]; then
185
  echo "Not found: $patch"
186
  exit 1
187
fi
188
189
change_name="$(echo "$last_set" | sed 's/.*\(refs.*\)/\1/')"
190
branch_name="$(echo "$change_name" | sed 's#refs/changes/../\([0-9]*\)/\([0-9]*\)#\1_\2#')"
191
192
set -x
193
git fetch origin "$change_name"
194
git co -b "$branch_name" FETCH_HEAD
195
</pre>
196
197 25 neels
h2. Re-submit a Branch with Amended Commits
198 13 neels
199 1 zecke
On a feature branch, one typically has numerous commits that depend on their preceding commits.
200 29 neels
Often, some of the branch commits need to be amended for fixes. But, Gerrit will refuse your branch
201
re-submission if the first branch commit is unchanged.
202 1 zecke
203 16 neels
To re-submit a branch, make sure to cosmetically tweak the branch's first commit log message
204 22 neels
before each re-submission (keep the Change-Id, really make just a cosmetic change).
205 13 neels
206 16 neels
<pre>
207
git rebase -i master
208
# replace the first line's 'pick' with 'r' (or 'reword'), exit editor
209
# git presents you with commit log message, make any tiny modification.
210 1 zecke
</pre>
211
212 29 neels
The cause: Gerrit refuses to accept a commit with a Change-Id that it already knows and
213
where the commit hash is identical.
214 1 zecke
215 29 neels
If you just cosmetically tweak the first commit's log message, the commit hash
216
is changed. Since the following commits contain their predecessor's commit hash, now
217
all of the branch's commit hashes are modified, and gerrit happily accepts them as a 
218
new patch set. It will still pick up the Change-Ids (which you shouldn't edit) and 
219
notice if commits have remained identical (keeping the votes). But with the minor
220
commit log tweak, it will no longer thwart your re-submission with an error message.
221
222
Note: you could modify all the Change-Ids, but now your branch submission would
223
open entirely new review entries and you would have to abandon your previous submission.
224
Comments on the first submission are lost and you cannot diff between patch sets.
225
226
227 26 neels
h2. Re-submit Previously Abandoned Changes
228 16 neels
229
You have to edit the Change-Ids, on a branch that would be every single commit log message.
230
231 13 neels
<pre>
232 1 zecke
cd openbsc
233
git co my-branch
234
git rebase -i master
235
# replace all 'pick' with 'r' (or 'reword'), exit your editor
236 13 neels
# git presents each commit log message for editing
237
</pre>
238
239 27 neels
h2. Submit a "private" branch for master
240 21 neels
241
If you've pushed a branch to refs/heads/* somewhere, gerrit will already know the Change-Ids on it.
242 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,
243 21 neels
or gerrit will refuse to accept your submission.
244
245 16 neels
h1. Reasons for Particular Configuration
246 13 neels
247 16 neels
h2. Rebase if necessary
248
249
There are different merge strategies that Gerrit performs to accept patches.
250 13 neels
Each project can be configured to a specific merge strategy, but unfortunately you can't
251
decide on a strategy per patch submission.
252
253
It seems that the "Merge if Necessary" strategy is best supported, but it creates non-linear
254
history with numerous merge commits that are usually not at all necessary.
255
256
Instead, the "Cherry Pick" strategy puts each patch onto current master's HEAD to create
257
linear history. However, this will cause merge failures as soon as one patch depends on
258
another submitted patch, as typical for a feature branch submission.
259
260 1 zecke
So we prefer the "Rebase if Necessary" strategy, which always tries to apply your patches to
261 13 neels
the current master HEAD, in sequence with the previous patches on the same branch.
262
However, some problems still remain, including some bugs in "Rebase if Necessary".
263 1 zecke
264 13 neels
There's a problem with "Rebase if Necessary": If your branch sits at master's HEAD, Gerrit
265
refuses to accept the submission, because it thinks that no new changes are submitted.
266
This is a bug in Gerrit, which holger has fixed manually in our Gerrit installation:
267 1 zecke
268
https://bugs.chromium.org/p/gerrit/issues/detail?id=4158
269
270
271 16 neels
h2. Private Branches: Create a new change for every commit...
272 1 zecke
273 13 neels
Say you have an extensive feature in development, and you want to keep it on the
274
upstream git repository to a) keep it safe and b) collaborate with other devs on it.
275 16 neels
So, of course, you have regularly pushed to refs/heads/yoyodyne/feature.
276 13 neels
277
Since you have the gerrit commit hook installed, your feature branch already has
278
Change-Id tags in all commit log messages.
279
280
Now your feature is complete and you would like to submit it to master.
281
Alas, Gerrit refuses to accept your patch submission for master, because it
282
knows the Change-Ids are also on a different branch.
283
284 16 neels
Gerrit by default enforces that a Change-Id must be unique across all branches,
285
so that each submission for review is separate for each branch. Instead, we
286
want to handle Change-Ids per-branch, so that you can have the same change
287
submitted to different branches, as separate patch submissions, without having
288
to cosmetically adjust the Change-Id.
289 13 neels
290 16 neels
Solution: set the option 
291
_Create a new change for every commit not in the target branch_ to _TRUE_
292 13 neels
293 20 neels
h2. Allow content merges
294 14 neels
295
By default, gerrit compares patches only by the files' paths. If two paths are the same,
296
it immediately shows them as conflicts (path conflicts).
297
298
In software development, a conflict usually means an actual content conflict, so if the
299
edits are in two entirely separate places in the file, we don't consider this a conflict.
300
301 23 neels
By setting _Allow content merges_ to _TRUE_ in the git project config, we tell Gerrit to
302 14 neels
perform text merges of the submitted patches and only complain about actual content
303
conflicts, in the usual software engineering sense.
304 32 neels
305
h1. Admin
306
307
h2. Adding users to groups
308
309
Normally, the gerrit UI auto-completes a user name in the edit field. It has happened
310
though that an existing user is not auto-completed, as if it didn't exist. In that case,
311
find out the user ID (seven digit number like 1000123) and just enter that.
312
313
The user ID can be found on the user's "Settings" page, or in the database (s.b.).
314
315
h2. Querying the database directly
316
317
If your user has permission to access the database, you can place SQL queries using the
318
'gerrit gsql' commands over ssh:
319
320
<pre>
321 53 neels
ssh go 'gerrit gsql --format PRETTY -c "show tables"'
322
ssh go 'gerrit gsql --format PRETTY -c "select full_name,account_id from accounts"'
323 1 zecke
</pre>
324 53 neels
325
(see ~/.ssh/config above for the 'go' shortcut)
326 32 neels
327
This seems to be the MySQL dialect.
Add picture from clipboard (Maximum size: 48.8 MB)