Project

General

Profile

Gerrit » History » Version 56

neels, 10/16/2016 11:14 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 1 zecke
The following projects use Gerrit to contribute changes:
19 1 zecke
20 1 zecke
* libosmocore.git
21 1 zecke
* libosmo-abis.git
22 1 zecke
* libosmo-netif.git
23 1 zecke
* libosmo-sccp.git
24 1 zecke
* libsmpp34.git
25 1 zecke
* openbsc.git
26 1 zecke
* osmo-bts.git
27 1 zecke
* osmo-iuh.git
28 1 zecke
* 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 1 zecke
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 55 neels
* go to https://gerrit.osmocom.org and click the "Sign in" link.
38 55 neels
* enter "https://osmocom.org/openid" as OpenID provider and hit the "Sign in" button.
39 54 neels
40 54 neels
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 10 laforge
43 10 laforge
After the initial sign-up you will need to:
44 1 zecke
45 1 zecke
* Pick a username (can not be changed)
46 1 zecke
* Add your public ssh key(s)
47 1 zecke
* Add email addresses you intend to use as author/comitter
48 30 neels
49 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.
50 30 neels
Please send a short requesting email to openbsc@lists.osmocom.org.
51 1 zecke
52 1 zecke
h2. Setting up Gerrit for commits and pushing
53 1 zecke
54 33 neels
*Note:* it is easiest to work with gerrit when gerrit is the only remote in your git clone.
55 33 neels
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 34 neels
to clone from gerrit only.
59 33 neels
60 33 neels
h3. Simplest: new clone
61 33 neels
62 35 neels
* Create a new clone from gerrit
63 35 neels
* Fetch the commit hook that adds Change-Id to each commit to uniquely identify a commit
64 42 neels
65 33 neels
<pre>
66 33 neels
git clone ssh://$USERNAME@gerrit.osmocom.org:29418/$PROJECT.git
67 33 neels
scp -P 29418 $USERNAME@gerrit.osmocom.org:hooks/commit-msg $PROJECT/.git/hooks/
68 33 neels
</pre>
69 33 neels
70 33 neels
h3. SSH config
71 33 neels
72 33 neels
In '~/.ssh/config', add these lines:
73 33 neels
<pre>
74 52 neels
Host go
75 33 neels
Hostname gerrit.osmocom.org
76 33 neels
Port 29418
77 33 neels
User $USERNAME
78 33 neels
</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 33 neels
82 33 neels
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 51 neels
scp go:hooks/commit-msg .git/hooks/
87 33 neels
</pre>
88 33 neels
89 46 neels
h3. Committer must match
90 46 neels
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 46 neels
"invalid commiter". You can add email addresses on the gerrit web UI.
94 46 neels
95 33 neels
h3. Add gerrit to an existing clone
96 33 neels
97 7 neels
* Add the remote to be able to fetch and push to gerrit
98 7 neels
* Fetch the commit hook that adds Change-Id to each commit to uniquely identify a commit
99 7 neels
100 7 neels
<pre>
101 7 neels
USERNAME=gerrit_user_name
102 7 neels
PROJECT=$(basename $PWD)
103 1 zecke
git remote add gerrit ssh://$USERNAME@gerrit.osmocom.org:29418/$PROJECT.git
104 1 zecke
scp -P 29418 $USERNAME@gerrit.osmocom.org:hooks/commit-msg .git/hooks/
105 44 neels
</pre>
106 44 neels
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 38 neels
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 40 neels
<pre>
118 48 ahuemer
git push gerrit HEAD:refs/for/master/my_topic
119 38 neels
</pre>
120 38 neels
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 1 zecke
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 41 neels
<pre>
134 50 msuraev
git push gerrit HEAD:refs/heads/user/$USERNAME/branch_name
135 33 neels
</pre>
136 33 neels
137 39 neels
138 39 neels
h2. List changesets in gerrit
139 39 neels
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 17 neels
148 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),
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 56 neels
153 56 neels
This script (I called it @P@) makes fetching a patch set from gerrit a breeze:
154 56 neels
<pre>
155 56 neels
#!/bin/sh
156 56 neels
# fetch gerrit patch into new branch named like the patch number.
157 56 neels
#
158 56 neels
# Usage: go to a git clone and pass a patch number:
159 56 neels
#
160 56 neels
#   cd openbsc
161 56 neels
#   P 973
162 56 neels
# or
163 56 neels
#   P 973/2
164 56 neels
#
165 56 neels
# Will create new local branches '973_4' (if 4 is the latest patch set)
166 56 neels
# or '973_2', respectively.
167 56 neels
168 56 neels
patch="$1"
169 56 neels
170 56 neels
if [ -z "$patch" ]; then
171 56 neels
  echo "Usage: P 1234[/5]"
172 56 neels
  exit 1
173 56 neels
fi
174 56 neels
175 56 neels
if [ -z "$(echo "$patch" | grep '/')" ]; then
176 56 neels
  patch="/$patch/"
177 56 neels
fi
178 56 neels
179 56 neels
if [ -z "$(echo "$patch" | grep '^/')" ]; then
180 56 neels
  patch="/$patch"
181 56 neels
fi
182 56 neels
183 56 neels
last_set="$(git ls-remote origin "changes/*" | grep "$patch" | sed 's#.*/\([^/]*\)$#\1 &#' | sort -n | tail -n 1)"
184 56 neels
if [ -z "$last_set" ]; then
185 56 neels
  echo "Not found: $patch"
186 56 neels
  exit 1
187 56 neels
fi
188 56 neels
189 56 neels
change_name="$(echo "$last_set" | sed 's/.*\(refs.*\)/\1/')"
190 56 neels
branch_name="$(echo "$change_name" | sed 's#refs/changes/../\([0-9]*\)/\([0-9]*\)#\1_\2#')"
191 56 neels
192 56 neels
set -x
193 56 neels
git fetch origin "$change_name"
194 56 neels
git co -b "$branch_name" FETCH_HEAD
195 56 neels
</pre>
196 56 neels
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 29 neels
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 16 neels
git rebase -i master
208 16 neels
# replace the first line's 'pick' with 'r' (or 'reword'), exit editor
209 16 neels
# git presents you with commit log message, make any tiny modification.
210 1 zecke
</pre>
211 1 zecke
212 29 neels
The cause: Gerrit refuses to accept a commit with a Change-Id that it already knows and
213 29 neels
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 29 neels
is changed. Since the following commits contain their predecessor's commit hash, now
217 29 neels
all of the branch's commit hashes are modified, and gerrit happily accepts them as a 
218 29 neels
new patch set. It will still pick up the Change-Ids (which you shouldn't edit) and 
219 29 neels
notice if commits have remained identical (keeping the votes). But with the minor
220 29 neels
commit log tweak, it will no longer thwart your re-submission with an error message.
221 29 neels
222 29 neels
Note: you could modify all the Change-Ids, but now your branch submission would
223 29 neels
open entirely new review entries and you would have to abandon your previous submission.
224 29 neels
Comments on the first submission are lost and you cannot diff between patch sets.
225 29 neels
226 29 neels
227 26 neels
h2. Re-submit Previously Abandoned Changes
228 16 neels
229 16 neels
You have to edit the Change-Ids, on a branch that would be every single commit log message.
230 16 neels
231 13 neels
<pre>
232 1 zecke
cd openbsc
233 1 zecke
git co my-branch
234 1 zecke
git rebase -i master
235 1 zecke
# replace all 'pick' with 'r' (or 'reword'), exit your editor
236 13 neels
# git presents each commit log message for editing
237 13 neels
</pre>
238 13 neels
239 27 neels
h2. Submit a "private" branch for master
240 21 neels
241 21 neels
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 21 neels
245 16 neels
h1. Reasons for Particular Configuration
246 13 neels
247 16 neels
h2. Rebase if necessary
248 16 neels
249 16 neels
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 13 neels
decide on a strategy per patch submission.
252 13 neels
253 13 neels
It seems that the "Merge if Necessary" strategy is best supported, but it creates non-linear
254 13 neels
history with numerous merge commits that are usually not at all necessary.
255 13 neels
256 13 neels
Instead, the "Cherry Pick" strategy puts each patch onto current master's HEAD to create
257 13 neels
linear history. However, this will cause merge failures as soon as one patch depends on
258 13 neels
another submitted patch, as typical for a feature branch submission.
259 13 neels
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 13 neels
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 13 neels
refuses to accept the submission, because it thinks that no new changes are submitted.
266 13 neels
This is a bug in Gerrit, which holger has fixed manually in our Gerrit installation:
267 1 zecke
268 1 zecke
https://bugs.chromium.org/p/gerrit/issues/detail?id=4158
269 1 zecke
270 1 zecke
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 13 neels
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 13 neels
Since you have the gerrit commit hook installed, your feature branch already has
278 13 neels
Change-Id tags in all commit log messages.
279 13 neels
280 13 neels
Now your feature is complete and you would like to submit it to master.
281 13 neels
Alas, Gerrit refuses to accept your patch submission for master, because it
282 13 neels
knows the Change-Ids are also on a different branch.
283 13 neels
284 16 neels
Gerrit by default enforces that a Change-Id must be unique across all branches,
285 16 neels
so that each submission for review is separate for each branch. Instead, we
286 16 neels
want to handle Change-Ids per-branch, so that you can have the same change
287 16 neels
submitted to different branches, as separate patch submissions, without having
288 16 neels
to cosmetically adjust the Change-Id.
289 13 neels
290 16 neels
Solution: set the option 
291 16 neels
_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 14 neels
By default, gerrit compares patches only by the files' paths. If two paths are the same,
296 14 neels
it immediately shows them as conflicts (path conflicts).
297 14 neels
298 14 neels
In software development, a conflict usually means an actual content conflict, so if the
299 14 neels
edits are in two entirely separate places in the file, we don't consider this a conflict.
300 14 neels
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 14 neels
conflicts, in the usual software engineering sense.
304 32 neels
305 32 neels
h1. Admin
306 32 neels
307 32 neels
h2. Adding users to groups
308 32 neels
309 32 neels
Normally, the gerrit UI auto-completes a user name in the edit field. It has happened
310 32 neels
though that an existing user is not auto-completed, as if it didn't exist. In that case,
311 32 neels
find out the user ID (seven digit number like 1000123) and just enter that.
312 32 neels
313 32 neels
The user ID can be found on the user's "Settings" page, or in the database (s.b.).
314 32 neels
315 32 neels
h2. Querying the database directly
316 32 neels
317 32 neels
If your user has permission to access the database, you can place SQL queries using the
318 32 neels
'gerrit gsql' commands over ssh:
319 32 neels
320 32 neels
<pre>
321 53 neels
ssh go 'gerrit gsql --format PRETTY -c "show tables"'
322 53 neels
ssh go 'gerrit gsql --format PRETTY -c "select full_name,account_id from accounts"'
323 1 zecke
</pre>
324 53 neels
325 53 neels
(see ~/.ssh/config above for the 'go' shortcut)
326 32 neels
327 32 neels
This seems to be the MySQL dialect.
Add picture from clipboard (Maximum size: 48.8 MB)