Project

General

Profile

Gerrit » History » Version 124

laforge, 11/29/2022 08:39 AM
voting: add high-level goal

1 110 fixeria
h1. Contributing using Gerrit
2 99 fixeria
3 1 zecke
{{>toc}}
4 11 laforge
5 117 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 was that we wanted to give Gerrit a try for some time and see if it helps us to have a better process.  We were (and still are) quite happy with it, and over time most Osmocom projects have migrated to using gerrit.
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 108 stsp
* patch submissions not via git send-email but direcly from git
13 10 laforge
14
h2. Osmocom Subprojects using Gerrit
15
16 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/
17 1 zecke
18 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.
19 30 neels
20 1 zecke
h2. Configuring Gerrit/Account
21
22 109 stsp
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.
23 1 zecke
24 109 stsp
* first sign in on https://osmocom.org. Do this before logging into 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).
25 55 neels
* go to https://gerrit.osmocom.org and click the "Sign in" link.
26 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.
27 61 neels
28 109 stsp
*careful:* enter 'https' to ensure that your openid credentials are passed on encrypted.
29 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.
30 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.
31 54 neels
32
If you have no Osmocom redmine account, you can simply create one online at the "Register" link in the upper right corner.
33 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).
34
35
After the initial sign-up you will need to:
36 1 zecke
37 109 stsp
* Pick a username (cannot be changed)
38 1 zecke
* Add your public ssh key(s)
39
* Add email addresses you intend to use as author/comitter
40 30 neels
41
If you would like to push private branches to the Gerrit repository, you also need to be added to the "known users" group.
42
Please send a short requesting email to openbsc@lists.osmocom.org.
43 1 zecke
44
h2. Setting up Gerrit for commits and pushing
45
46 33 neels
*Note:* it is easiest to work with gerrit when gerrit is the only remote in your git clone.
47 119 laforge
When you clone from gitea.osmocom.org and add the gerrit remote, git will have two remotes,
48 36 neels
so when you first checkout a branch you have to supply the remote explicitly (cumbersome).
49 119 laforge
The gerrit repositories and gitea.osmocom.org are constantly synced, so it is sufficient
50 34 neels
to clone from gerrit only.
51 33 neels
52
h3. Simplest: new clone
53
54 35 neels
* Create a new clone from gerrit
55 1 zecke
56 121 fixeria
<pre><code class="shell">
57 1 zecke
git clone ssh://$USERNAME@gerrit.osmocom.org:29418/$PROJECT.git
58 121 fixeria
</code></pre>
59
60
* Fetch the commit hook that adds Change-Id to each commit to uniquely identify a commit
61
62
<pre><code class="shell">
63
# Option a) using scp
64 1 zecke
scp -P 29418 $USERNAME@gerrit.osmocom.org:hooks/commit-msg $PROJECT/.git/hooks/
65 121 fixeria
66
# Option b) using curl
67
curl -o $PROJECT/.git/hooks/commit-msg https://gerrit.osmocom.org/tools/hooks/commit-msg
68
chmod +x $PROJECT/.git/hooks/commit-msg
69
</code></pre>
70 33 neels
71
h3. SSH config
72
73
In '~/.ssh/config', add these lines:
74
<pre>
75 52 neels
Host go
76 33 neels
Hostname gerrit.osmocom.org
77
Port 29418
78
User $USERNAME
79
</pre>
80 52 neels
('go' means gerrit.osmocom, replace with your favorite shortcut name,
81 33 neels
replace '$USERNAME' with your user name as used on the gerrit website)
82
83
Then you can shorten above commands to
84 1 zecke
<pre>
85 52 neels
git clone ssh://go/$PROJECT.git
86 51 neels
cd $PROJECT
87
scp go:hooks/commit-msg .git/hooks/
88 33 neels
</pre>
89
90 1 zecke
h3. Committer must match
91 46 neels
92 1 zecke
Your email address on gerrit and the email address git places in your
93 46 neels
commits must match, or you will get rejected with an error message like
94 108 stsp
"invalid committer". You can add email addresses on the gerrit web UI.
95 47 neels
96 1 zecke
h3. Add gerrit to an existing clone
97
98
* Add the remote to be able to fetch and push to gerrit
99
100 122 fixeria
<pre><code class="shell">
101 1 zecke
USERNAME=gerrit_user_name
102
PROJECT=$(basename $PWD)
103
git remote add gerrit ssh://$USERNAME@gerrit.osmocom.org:29418/$PROJECT.git
104 122 fixeria
</code></pre>
105
106
* Fetch the commit hook that adds Change-Id to each commit to uniquely identify a commit
107
108
<pre><code class="shell">
109
# Option a) using scp
110 1 zecke
scp -P 29418 $USERNAME@gerrit.osmocom.org:hooks/commit-msg .git/hooks/
111 122 fixeria
112
# Option b) using curl
113
curl -o .git/hooks/commit-msg https://gerrit.osmocom.org/tools/hooks/commit-msg
114
chmod +x .git/hooks/commit-msg
115
</code></pre>
116
117 1 zecke
118
h2. Push for review
119
120
Prerequisites:
121
122
* your user on gerrit has an SSH public key
123
* your patch is committed in your local clone
124
* the commit log message has a Change-Id (see 'commit-msg' hook above, and 'Tips and Tricks' below to add a Change-Id to a commit that lacks one.)
125
126
<pre>
127 115 neels
git push $REMOTE $GITHASH:refs/for/$BRANCH%topic=$TOPIC
128 1 zecke
</pre>
129
130
$REMOTE: from above instructions, that's either 'origin' (cloned from gerrit) or 'gerrit' (if you added a second remote).
131
$GITHASH: the committed patch to push, typically you're on your branch and simply push 'HEAD'.
132
$BRANCH: you will typically intend a patch to go to 'master'.
133 115 neels
%topic=$TOPIC: an optional name you may choose.
134 1 zecke
135 109 stsp
For example, check out the revision or branch that you want to submit for review,
136 1 zecke
i.e. the one where your patch or several patches are committed on top of the current master, then:
137
138
If you cloned directly from gerrit:
139
140
<pre>
141
git push origin HEAD:refs/for/master
142
</pre>
143
144
If you added 'gerrit' as a second remote to an existing clone:
145
146
<pre>
147
git push gerrit HEAD:refs/for/master
148
</pre>
149
150
You can optionally add a topic name with
151
152
<pre>
153 115 neels
git push origin HEAD:refs/for/master%topic=my_topic
154 1 zecke
</pre>
155
156 102 stsp
h2. Voting Rules for merging a patch to master
157 7 neels
158 124 laforge
High-level goal: Two people _other than the patch author/owner_ should have given positive review ("Review +1") _and_ the patch must pass automatic build/lint validation ("Verified: +1").
159
160 103 stsp
Please follow these voting rules:
161 44 neels
162 102 stsp
h3. Code Review ("CR")
163 77 neels
164 102 stsp
* Please review patches by others.
165
* Do not vote for your own patches (exceptions below).
166
* Before merging, each patch should receive at least two reviews that approve merging.
167 77 neels
168 123 laforge
When voting, please follow this social contract (written from the point of a _reviewer_):
169 77 neels
170 102 stsp
* When you approve, vote CR +1.
171 123 laforge
* If there already is someone else's CR +1, you *as a reviewer, not as the author/owner* may also choose to vote CR +2.
172 102 stsp
* If the patch owner sees two or more CR +1, the patch owner may apply to self a CR +2.
173
* Once there is at least one CR +2 and one CR +1 vote, a patch may be merged ("Submit" button), except:
174
** If there are two -1 votes, you should not merge, instead clarify the reason and try to fix it.
175
** If there is a single -1 vote, you may still merge the patch, if you are sure that the opinion of the -1 vote does not carry.
176
* Give the benefit of the doubt to the -1 vote, do not lightheartedly overrule.
177
* If there is a CR -2 vote, the patch will likely never pass review, it marks a fundamental flaw.
178
* Merging a patch ("Submit" button) may be done by a reviewer or by the patch owner,
179
  But if there is any negative vote, rather leave merging up to the patch owner.
180
* If you remove a +1 vote, try to make sure that there are no other CR +2 votes left alone
181
  (to prevent accidental "Submit including parents"). If needed, ping other reviewer / admin on IRC.
182
  But try to vote +1 only when you're sure, hence this situation should be rare.
183
* To prevent merging of your own patch before some issue is resolved, consider marking it Work In Progress.
184
185 104 stsp
h3. Exceptions for Trivial / Urgent Patches
186 102 stsp
187
A patch may receive a direct +2 when:
188
189
* it is very trivial, like a typo fix in a comment or log string, so that it is not worth wasting review time on.
190
* it reverts an earlier change that broke the master builds.
191
192
In these cases, the patch submitter may decide to +2 to self, after careful consideration. This should be rare.
193
194
h3. Verification ("V")
195
196
* For most projects, jenkins takes care of voting V +1 automatically.
197
* If you have actually tried out a patch and verified that it works, you may vote V +1.
198
* A patch owner may vote V +1 to self in a project that has no Jenkins verification job.
199
200
h3. Rationale
201
202
Gerrit allows merging a patch as soon as a CR +2 vote and a V +1 vote are in.
203
For quite some time, we had CR +2 permissions for only very few gatekeeper reviewers.
204
The result was that non-gatekeepers' votes seemed to not matter.
205
206
To encourage more peer review that actually has an effect, we would like to sum up +1 votes.
207
We have tried to apply a summing of votes in Gerrit with automatic enforcing
208
( https://gerrit-review.googlesource.com/Documentation/prolog-cookbook.html#_example_13_1_1_2_code_review )
209
but this had numerous quirks, particularly the issues summary shows wildly mismatching voting status.
210
211
The solution is to agree on a social contract: everyone gets +2 permissions,
212
but you shall only use it when it makes sense. Thanks!
213
214 84 neels
h2. Manage private branches
215 1 zecke
216 84 neels
Use a sub-directory with your name to group your own branches, please.
217 1 zecke
*Note* that you must be a member of the "known users" group, see above.
218
219 119 laforge
To share / backup local branches to gitea.osmocom.org, without starting a code review process on gerrit.osmocom.org, just push them as usual to gerrit.
220 84 neels
221
* Note that the git repository must be cloned from the gerrit SSH URL -- all pushing goes to gerrit ("pushurl" as described below also works).
222 119 laforge
* All private branches are automatically synced to gitea.osmocom.org in a matter of minutes.
223 1 zecke
* Private branches do not kick off patch sets for review, they are just branches. To kick off review for all patches on your branch, you'd use a 'refs/for/master' URL, as shown in the example below.
224 116 neels
225
*Pitfall*: always include both your name and a topic in a branch name, right from the start. If you first create a branch named "fred", creating branches named "fred/topic" later will cause conflicts in the .git admin tree, because first "fred" was a file, and then becomes a directory. Even if you fix it in your local repository, *all* other git repositories, including those on the build servers, may need manual action to become usable again. One solution is to push a deletion of "fred" and then "git fetch --purge" everywhere else.
226 84 neels
227
The typical transcript for "Fred" developing feature "Kazoo" looks like this:
228
229 1 zecke
<pre>
230 84 neels
# Set up ~/.ssh/config so that 'go' points at gerrit.osmocom.org
231
git clone ssh://go/libosmocore
232
233
cd libosmocore
234
git checkout -b fred/kazoo   # create local branch
235
236
$EDITOR
237
git add kazoo.c
238
git commit -m "implement kazoo"
239
240
# just invoke 'git push' and git tells you how to create the branch once-off:
241 1 zecke
git push
242 84 neels
|fatal: The current branch asdf has no upstream branch.
243
|To push the current branch and set the remote as upstream, use
244
|
245
|    git push --set-upstream origin fred/kazoo
246 1 zecke
247 84 neels
git push --set-upstream origin fred/kazoo
248 119 laforge
# Now the branch exists on gerrit, very soon will also exist on gitea.osmocom.org
249 84 neels
250
# Further tweaks
251
$EDITOR
252
git add kazoo.h
253
git commit --amend
254
255
# You are free to force-push private branches
256
git push -f
257
258
# origin/master has changed? Rebase onto the latest.
259
git fetch
260
git rebase -i origin/master
261
# resolve conflicts...
262
git push -f
263
264
# Feature is ready
265
git push origin HEAD:refs/for/master/kazoo
266 39 neels
</pre>
267 7 neels
268 48 ahuemer
h2. List changesets in gerrit
269 2 zecke
270 12 msuraev
<pre>
271 17 neels
git ls-remote gerrit changes/*
272 1 zecke
</pre>
273 80 neels
274
h1. Tips and Tricks
275
276
h2. A commit lacks a Change-Id
277
278
once you added the commit hook as above, just re-edit the commit log message, e.g. with
279
280
<pre>
281
git commit --amend
282
</pre>
283
284
or by
285
286
<pre>
287
git rebase -i
288
</pre>
289
290
and in the upcoming editor replacing 'pick' with 'r' in front of the commit to edit.
291 74 neels
292
No need to change the commit log if you don't want to, just exit the editor and the commit hook will add a Change-Id.
293 79 neels
294 87 msuraev
h2. Ignore WIP patches
295
296
Using following operators in "search" field of web UI allows to ignore Work-in-progress changes:
297
<pre>
298
status:open AND -is:wip
299
</pre>
300
301 119 laforge
h2. Fetch fast from gitea.osmocom.org, push to gerrit
302 79 neels
303 1 zecke
Gerrit has moved to a faster host, so this should no longer be necessary. Anyway...
304 74 neels
305 109 stsp
Adding a second remote forces you to explicitly pass the remote on the command line ("origin").
306
It is possible to have only one remote for convenience, with different push and pull URLs:
307 79 neels
308 74 neels
<pre>
309 119 laforge
git remote set-url origin https://gitea.osmocom.org/$ORG/$PROJECT
310 74 neels
git remote set-url --push origin ssh://$USERNAME@gerrit.osmocom.org:29418/$PROJECT
311
</pre>
312 79 neels
313 74 neels
With above .ssh config you can also use the shorter ssh:// URL:
314
<pre>
315 79 neels
git remote set-url --push origin ssh://go/$PROJECT
316 74 neels
</pre>
317
318
The resulting .git/config in libosmocore would look something like:
319
<pre>
320
[remote "origin"]
321 119 laforge
        url = https://gitea.osmocom.org/osmocom/libosmocore
322 74 neels
        pushurl = ssh://go/libosmocore
323
        fetch = +refs/heads/*:refs/remotes/origin/*
324
</pre>
325 17 neels
326 119 laforge
Now you're fetching from gitea.osmocom.org, which is lightning fast, while pushing patches will still go to gerrit as usual.
327 17 neels
328 45 neels
h2. Throw-away branch
329 13 neels
330 56 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),
331
make your changes/amendments and then send patch(es) back to gerrit while removing temporary branch automatically with "git review -f".
332
333
h2. Fetch a patch from gerrit
334
335
This script (I called it @P@) makes fetching a patch set from gerrit a breeze:
336
<pre>
337
#!/bin/sh
338
# fetch gerrit patch into new branch named like the patch number.
339
#
340
# Usage: go to a git clone and pass a patch number:
341
#
342
#   cd openbsc
343
#   P 973
344
# or
345
#   P 973/2
346
#
347
# Will create new local branches '973_4' (if 4 is the latest patch set)
348
# or '973_2', respectively.
349
350
patch="$1"
351
352
if [ -z "$patch" ]; then
353
  echo "Usage: P 1234[/5]"
354
  exit 1
355
fi
356
357
if [ -z "$(echo "$patch" | grep '/')" ]; then
358
  patch="/$patch/"
359
fi
360
361
if [ -z "$(echo "$patch" | grep '^/')" ]; then
362
  patch="/$patch"
363
fi
364
365 112 neels
remote="$(git remote get-url --push origin)"
366
367
last_set="$(git ls-remote "$remote" "changes/*" | grep "$patch" | sed 's#.*/\([^/]*\)$#\1 &#' | sort -n | tail -n 1)"
368 56 neels
if [ -z "$last_set" ]; then
369
  echo "Not found: $patch"
370
  exit 1
371
fi
372
373
change_name="$(echo "$last_set" | sed 's/.*\(refs.*\)/\1/')"
374
branch_name="$(echo "$change_name" | sed 's#refs/changes/../\([0-9]*\)/\([0-9]*\)#\1_\2#')"
375 1 zecke
376 56 neels
set -x
377 112 neels
git fetch "$remote" "$change_name"
378 25 neels
git co -b "$branch_name" FETCH_HEAD
379 13 neels
</pre>
380 1 zecke
381 58 neels
h2. Re-submit a Branch with Amended Commits
382
383 22 neels
On a feature branch, one typically has numerous commits that depend on their preceding commits.
384 58 neels
Often, some of the branch commits need to be amended for fixes. You can re-submit changes to
385
patches on your branch by pushing in the same way that you first submitted the branch.
386
387 29 neels
Note: if you modify the Change-Ids in the commit logs, your push would open entirely new
388 58 neels
review entries and you would have to abandon your previous submission. Comments on the first
389
submission are "lost" and you cannot diff between patch sets.
390 29 neels
391 26 neels
392 1 zecke
h2. Re-submit Previously Abandoned Changes
393
394
You have to edit the Change-Ids, on a branch that would be every single commit log message.
395
396
<pre>
397
cd openbsc
398
git co my-branch
399
git rebase -i master
400
# replace all 'pick' with 'r' (or 'reword'), exit your editor
401
# git presents each commit log message for editing
402
</pre>
403
404 78 neels
h2. 502 Bad Gateway
405
406
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.
407
408 120 fixeria
h2. scp fails with "subsystem request failed on channel 0"
409
410
Most likely, you're using a very recent OpenSSH release (9.0 - check https://www.openssh.com/txt/release-9.0 43 for more info), which changes the scp program to use the SFTP protocol under the hood.
411
412
<pre>
413
$ scp -P 29418 gerrit.osmocom.org:hooks/commit-msg .git/hooks/
414
subsystem request failed on channel 0
415
scp: Connection closed
416
</pre>
417
418
To work around the problem on the client side, use the new @-O@ (that is an uppercase letter "o") switch when invoking scp, which will cause it to fall back to the legacy behavior.
419
420
<pre>
421
$ scp -O -P 29418 gerrit.osmocom.org:hooks/commit-msg .git/hooks/
422
commit-msg                                              100% 2174     9.5KB/s   00:00
423
</pre>
424 78 neels
425
h2. Commit hook: Always put Change-Id at the bottom of the log message
426
427
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:
428
429
<pre>
430
cd $PROJECT
431
sed -i 's/if (unprinted /if (0 \&\& unprinted /' .git/hooks/commit-msg
432
</pre>
433
434
The goal is to disable the condition in line 163 with an 'if (0...':
435
436
<pre>
437
                        if (0 && unprinted && match(tolower(footer[line]), changeIdAfter) != 1) {
438
                                unprinted = 0
439
                                print "Change-Id: I'"$id"'"
440
                        }
441 60 neels
</pre>
442 16 neels
443 13 neels
Then the Change-Id will be placed by line 170 instead.
444 16 neels
445
h1. Reasons for Particular Configuration
446
447 13 neels
h2. Rebase if necessary
448
449
There are different merge strategies that Gerrit performs to accept patches.
450
Each project can be configured to a specific merge strategy, but unfortunately you can't
451
decide on a strategy per patch submission.
452
453
It seems that the "Merge if Necessary" strategy is best supported, but it creates non-linear
454
history with numerous merge commits that are usually not at all necessary.
455
456
Instead, the "Cherry Pick" strategy puts each patch onto current master's HEAD to create
457 1 zecke
linear history. However, this will cause merge failures as soon as one patch depends on
458 13 neels
another submitted patch, as typical for a feature branch submission.
459
460 1 zecke
So we prefer the "Rebase if Necessary" strategy, which always tries to apply your patches to
461 13 neels
the current master HEAD, in sequence with the previous patches on the same branch.
462
463
h2. Private Branches: Create a new change for every commit...
464 16 neels
465 13 neels
Say you have an extensive feature in development, and you want to keep it on the
466
upstream git repository to a) keep it safe and b) collaborate with other devs on it.
467
So, of course, you have regularly pushed to refs/heads/yoyodyne/feature.
468
469
Since you have the gerrit commit hook installed, your feature branch already has
470
Change-Id tags in all commit log messages.
471
472
Now your feature is complete and you would like to submit it to master.
473 16 neels
Alas, Gerrit refuses to accept your patch submission for master, because it
474
knows the Change-Ids are also on a different branch.
475
476
Gerrit by default enforces that a Change-Id must be unique across all branches,
477
so that each submission for review is separate for each branch. Instead, we
478 13 neels
want to handle Change-Ids per-branch, so that you can have the same change
479 16 neels
submitted to different branches, as separate patch submissions, without having
480
to cosmetically adjust the Change-Id.
481 13 neels
482 20 neels
Solution: set the option 
483 14 neels
_Create a new change for every commit not in the target branch_ to _TRUE_
484
485
h2. Allow content merges
486
487
By default, gerrit compares patches only by the files' paths. If two paths are the same,
488
it immediately shows them as conflicts (path conflicts).
489
490 23 neels
In software development, a conflict usually means an actual content conflict, so if the
491 14 neels
edits are in two entirely separate places in the file, we don't consider this a conflict.
492
493 32 neels
By setting _Allow content merges_ to _TRUE_ in the git project config, we tell Gerrit to
494
perform text merges of the submitted patches and only complain about actual content
495
conflicts, in the usual software engineering sense.
496 72 laforge
497
h1. Admin
498
499
h2. Adding a new repository
500
501 113 osmith
1. create the repository in the Gerrit UI, inherit from "All-Projects"
502 119 laforge
2. a) project does not exist on gitea.osmocom.org:
503
* create an empty git repository using gitea on https://gitea.osmocom.org/
504 113 osmith
505 119 laforge
2. b) project exists on https://gitea.osmocom.org:
506
* explicitly add gerrit as a second remote and push all branches/tags from gitea.osmocom.org to gerrit.
507 113 osmith
508
3. configure a jenkins build testing job for this project (see gerrit-verifications.yml in osmo-ci.git/jobs)
509 92 osmith
510 72 laforge
511 32 neels
git replication to gerrit.osmocom.org is enabled automatically, nothing to be done here.  In case of doubt, try
512
@ssh -p 29418 gerrit.osmocom.org replication start --all --wait@
513
514
h2. Adding users to groups
515
516
Normally, the gerrit UI auto-completes a user name in the edit field. It has happened
517
though that an existing user is not auto-completed, as if it didn't exist. In that case,
518
find out the user ID (seven digit number like 1000123) and just enter that.
519
520
The user ID can be found on the user's "Settings" page, or in the database (s.b.).
521
522
h2. Querying the database directly
523
524
If your user has permission to access the database, you can place SQL queries using the
525 71 neels
'gerrit gsql' commands over ssh:
526
527 1 zecke
<pre>
528 53 neels
ssh go "gerrit gsql -c \"show tables\""
529
ssh go "gerrit gsql -c \"select full_name,account_id from accounts\""
530 1 zecke
</pre>
531
532 71 neels
(see ~/.ssh/config above for the 'go' shortcut)
533
534 62 neels
This seems to be the MySQL dialect.
535
536
The "...\"...\"" quoting allows including single-quotes in the SQL statements.
537
538
h2. Fix evil twin users
539
540 111 laforge
If differing openid URLs have lead to evil twin users shadowing the same email address just without the permissions, we end up with duplicate users showing up in the UI, e.g. when you want to add somebody as a reviewer.
541 1 zecke
542 111 laforge
In past gerrit vesions based on ReviewDB, one could use SQL statements to manipulate the database. However, gerrit has migrated to NoteDB, and hence this access is no longer possible.
543 1 zecke
544 111 laforge
You can find information on how to manipulate users using the REST API at
545
* https://charm.cs.illinois.edu/gerrit/Documentation/rest-api-accounts.html#account-endpoints
546
* https://charm.cs.illinois.edu/gerrit/Documentation/rest-api.html
547 1 zecke
548 111 laforge
You can get a list of identities for one given e-mail address (e.g. @pmaier@sysmocom.de@) using
549
550
 curl 'https://gerrit.osmocom.org/accounts/?q=pmaier@sysmocom.de'
551
552
which would give you a result like this:
553
<pre>
554
[
555
  {
556
    "_account_id": 1000028
557
  },
558
  {
559
    "_account_id": 1000140
560
  }
561
]
562 62 neels
</pre>
563 111 laforge
564
565
And subsequetly check which of the identities you want to keep or remove:
566
567
 curl --user http_user:http_pass  'https://gerrit.osmocom.org/a/accounts/1000028/external.ids'
568
curl --user http_user:http_pass  'https://gerrit.osmocom.org/a/accounts/1000140/external.ids'
569
570
The "intended" ones typically have https://osmocom.org/openid URLs, while the unintended/dupliacte ones have http (not https) or use www.osmocom.org or projects.osmocom.org instead.
571
572
Once you have found the duplicate (in this case 100140), you can deactivate the duplicate using 
573
574
 curl --user http_user:http_pass -X DELETE 'https://gerrit.osmocom.org/a/accounts/1000140/active'
Add picture from clipboard (Maximum size: 48.8 MB)