Add REST endpoint to reindex a single account

This may become handy to fix single accounts that are stale in the
index.

Change-Id: If4c1787a26a564c19d1c4c1896afa89120ef4813
Signed-off-by: Edwin Kempin <ekempin@google.com>
This commit is contained in:
Edwin Kempin 2016-11-22 16:50:10 +01:00
parent 84c49a63d2
commit 7ee686adb9
7 changed files with 131 additions and 0 deletions

View File

@ -1945,6 +1945,24 @@ As response the contributor agreement name is returned.
"Individual"
----
[[index-account]]
=== Index Account
--
'POST /accounts/link:#account-id[\{account-id\}]/index'
--
Adds or updates the account in the secondary index.
.Request
----
POST /accounts/1000096/index HTTP/1.0
----
.Response
----
HTTP/1.1 204 No Content
----
[[ids]]
== IDs

View File

@ -705,6 +705,23 @@ public class AccountIT extends AbstractDaemonTest {
assertThat(info.get(1).seq).isEqualTo(3);
}
// reindex is tested by {@link AbstractQueryAccountsTest#reindex}
@Test
public void reindexPermissions() throws Exception {
// admin can reindex any account
setApiUser(admin);
gApi.accounts().id(user.username).index();
// user can reindex own account
setApiUser(user);
gApi.accounts().self().index();
// user cannot reindex any account
exception.expect(AuthException.class);
exception.expectMessage("not allowed to index account");
gApi.accounts().id(admin.username).index();
}
private void assertSequenceNumbers(List<SshKeyInfo> sshKeys) {
int seq = 1;
for (SshKeyInfo key : sshKeys) {

View File

@ -77,6 +77,8 @@ public interface AccountApi {
List<AgreementInfo> listAgreements() throws RestApiException;
void signAgreement(String agreementName) throws RestApiException;
void index() throws RestApiException;
/**
* A default implementation which allows source compatibility
* when adding new methods to the interface.
@ -224,5 +226,10 @@ public interface AccountApi {
public void signAgreement(String agreementName) throws RestApiException {
throw new NotImplementedException();
}
@Override
public void index() throws RestApiException {
throw new NotImplementedException();
}
}
}

View File

@ -0,0 +1,56 @@
//Copyright (C) 2016 The Android Open Source Project
//
//Licensed under the Apache License, Version 2.0 (the "License");
//you may not use this file except in compliance with the License.
//You may obtain a copy of the License at
//
//http://www.apache.org/licenses/LICENSE-2.0
//
//Unless required by applicable law or agreed to in writing, software
//distributed under the License is distributed on an "AS IS" BASIS,
//WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//See the License for the specific language governing permissions and
//limitations under the License.
package com.google.gerrit.server.account;
import com.google.gerrit.extensions.restapi.AuthException;
import com.google.gerrit.extensions.restapi.Response;
import com.google.gerrit.extensions.restapi.RestModifyView;
import com.google.gerrit.server.CurrentUser;
import com.google.gerrit.server.account.Index.Input;
import com.google.gwtorm.server.OrmException;
import com.google.inject.Inject;
import com.google.inject.Provider;
import com.google.inject.Singleton;
import java.io.IOException;
@Singleton
public class Index implements RestModifyView<AccountResource, Input> {
public static class Input {
}
private final AccountCache accountCache;
private final Provider<CurrentUser> self;
@Inject
Index(AccountCache accountCache,
Provider<CurrentUser> self) {
this.accountCache = accountCache;
this.self = self;
}
@Override
public Response<?> apply(AccountResource rsrc, Input input)
throws IOException, AuthException, OrmException {
if (self.get() != rsrc.getUser()
&& !self.get().getCapabilities().canModifyAccount()) {
throw new AuthException("not allowed to index account");
}
// evicting the account from the cache, reindexes the account
accountCache.evict(rsrc.getUser().getAccountId());
return Response.none();
}
}

View File

@ -40,6 +40,7 @@ public class Module extends RestApiModule {
put(ACCOUNT_KIND).to(PutAccount.class);
get(ACCOUNT_KIND).to(GetAccount.class);
get(ACCOUNT_KIND, "detail").to(GetDetail.class);
post(ACCOUNT_KIND, "index").to(Index.class);
get(ACCOUNT_KIND, "name").to(GetName.class);
put(ACCOUNT_KIND, "name").to(PutName.class);
delete(ACCOUNT_KIND, "name").to(PutName.class);

View File

@ -52,6 +52,7 @@ import com.google.gerrit.server.account.GetEditPreferences;
import com.google.gerrit.server.account.GetPreferences;
import com.google.gerrit.server.account.GetSshKeys;
import com.google.gerrit.server.account.GetWatchedProjects;
import com.google.gerrit.server.account.Index;
import com.google.gerrit.server.account.PostWatchedProjects;
import com.google.gerrit.server.account.PutActive;
import com.google.gerrit.server.account.PutAgreement;
@ -108,6 +109,7 @@ public class AccountApiImpl implements AccountApi {
private final GetActive getActive;
private final PutActive putActive;
private final DeleteActive deleteActive;
private final Index index;
@Inject
AccountApiImpl(AccountLoader.Factory ailf,
@ -138,6 +140,7 @@ public class AccountApiImpl implements AccountApi {
GetActive getActive,
PutActive putActive,
DeleteActive deleteActive,
Index index,
@Assisted AccountResource account) {
this.account = account;
this.accountLoaderFactory = ailf;
@ -168,6 +171,7 @@ public class AccountApiImpl implements AccountApi {
this.getActive = getActive;
this.putActive = putActive;
this.deleteActive = deleteActive;
this.index = index;
}
@Override
@ -435,4 +439,12 @@ public class AccountApiImpl implements AccountApi {
}
}
@Override
public void index() throws RestApiException {
try {
index.apply(account, new Index.Input());
} catch (IOException | OrmException e) {
throw new RestApiException("Cannot index account", e);
}
}
}

View File

@ -62,6 +62,7 @@ import org.junit.rules.TestName;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;
@ -390,6 +391,25 @@ public abstract class AbstractQueryAccountsTest extends GerritServerTests {
assertQuery("username:" + user1.username, user1);
}
// reindex permissions are tested by {@link AccountIT#reindexPermissions}
@Test
public void reindex() throws Exception {
AccountInfo user1 = newAccountWithFullName("tester", "Test Usre");
// update account in the database so that account index is stale
String newName = "Test User";
Account account = db.accounts().get(new Account.Id(user1._accountId));
account.setFullName(newName);
db.accounts().update(Collections.singleton(account));
assertQuery("name:" + quote(user1.name), user1);
assertQuery("name:" + quote(newName));
gApi.accounts().id(user1.username).index();
assertQuery("name:" + quote(user1.name));
assertQuery("name:" + quote(newName), user1);
}
protected AccountInfo newAccount(String username) throws Exception {
return newAccountWithEmail(username, null);
}