Merge branch 'stable-2.14' into stable-2.15
* stable-2.14: ElasticTestUtils: Set index.maxLimit as integer rather than string ElasticConfigurationTest: Add tests for elasticsearch.maxRetryTimeout ElasticConfigurationTest: Add tests for elasticsearch.prefix ElasticConfigurationTest: Add tests for elasticsearch.{username,password} ElasticConfiguration: Extract constants to statics Elasticsearch: Simplify configuration of servers Change-Id: Ic579d37734f285043f2d5ea9b764ec75cb485768
This commit is contained in:
commit
28ab32a2b9
|
@ -2912,6 +2912,18 @@ change index named `gerrit1_changes_0001`.
|
|||
+
|
||||
Not set by default.
|
||||
|
||||
[[elasticsearch.server]]elasticsearch.server::
|
||||
+
|
||||
Elasticsearch server URI in the form `http[s]://hostname:port`. The `port` is
|
||||
optional and defaults to `9200` if not specified.
|
||||
+
|
||||
At least one server must be specified. May be specified multiple times to
|
||||
configure multiple Elasticsearch servers.
|
||||
+
|
||||
Note that the site initialization program only allows to configure a single
|
||||
server. To configure multiple servers the `gerrit.config` file must be edited
|
||||
manually.
|
||||
|
||||
[[elasticsearch.maxRetryTimeout]]elasticsearch.maxRetryTimeout::
|
||||
+
|
||||
Sets the maximum timeout to honor in case of multiple retries of the same request.
|
||||
|
@ -2944,28 +2956,6 @@ Password used to connect to Elasticsearch.
|
|||
+
|
||||
Not set by default.
|
||||
|
||||
==== Elasticsearch server(s) configuration
|
||||
|
||||
Each section corresponds to one Elasticsearch server.
|
||||
|
||||
[[elasticsearch.name.protocol]]elasticsearch.name.protocol::
|
||||
+
|
||||
Elasticsearch server protocol. Can be `http` or `https`.
|
||||
+
|
||||
Defaults to `http`.
|
||||
|
||||
[[elasticsearch.name.hostname]]elasticsearch.name.hostname::
|
||||
+
|
||||
Elasticsearch server hostname.
|
||||
+
|
||||
Defaults to `localhost`.
|
||||
|
||||
[[elasticsearch.name.port]]elasticsearch.name.port::
|
||||
+
|
||||
Elasticsearch server port.
|
||||
+
|
||||
Defaults to `9200`.
|
||||
|
||||
[[ldap]]
|
||||
=== Section ldap
|
||||
|
||||
|
|
|
@ -16,15 +16,15 @@ package com.google.gerrit.elasticsearch;
|
|||
|
||||
import static com.google.common.base.MoreObjects.firstNonNull;
|
||||
|
||||
import com.google.common.base.MoreObjects;
|
||||
import com.google.common.base.Strings;
|
||||
import com.google.gerrit.server.config.GerritServerConfig;
|
||||
import com.google.inject.Inject;
|
||||
import com.google.inject.ProvisionException;
|
||||
import com.google.inject.Singleton;
|
||||
import java.net.URI;
|
||||
import java.net.URISyntaxException;
|
||||
import java.util.ArrayList;
|
||||
import java.util.Collections;
|
||||
import java.util.List;
|
||||
import java.util.Set;
|
||||
import java.util.concurrent.TimeUnit;
|
||||
import org.apache.http.HttpHost;
|
||||
import org.eclipse.jgit.lib.Config;
|
||||
|
@ -35,10 +35,16 @@ import org.slf4j.LoggerFactory;
|
|||
class ElasticConfiguration {
|
||||
private static final Logger log = LoggerFactory.getLogger(ElasticConfiguration.class);
|
||||
|
||||
private static final String DEFAULT_HOST = "localhost";
|
||||
private static final String DEFAULT_PORT = "9200";
|
||||
private static final String DEFAULT_PROTOCOL = "http";
|
||||
private static final String DEFAULT_USERNAME = "elastic";
|
||||
static final String SECTION_ELASTICSEARCH = "elasticsearch";
|
||||
static final String KEY_PASSWORD = "password";
|
||||
static final String KEY_USERNAME = "username";
|
||||
static final String KEY_MAX_RETRY_TIMEOUT = "maxRetryTimeout";
|
||||
static final String KEY_PREFIX = "prefix";
|
||||
static final String KEY_SERVER = "server";
|
||||
static final String DEFAULT_PORT = "9200";
|
||||
static final String DEFAULT_USERNAME = "elastic";
|
||||
static final int DEFAULT_MAX_RETRY_TIMEOUT_MS = 30000;
|
||||
static final TimeUnit MAX_RETRY_TIMEOUT_UNIT = TimeUnit.MILLISECONDS;
|
||||
|
||||
private final Config cfg;
|
||||
private final List<HttpHost> hosts;
|
||||
|
@ -51,34 +57,40 @@ class ElasticConfiguration {
|
|||
@Inject
|
||||
ElasticConfiguration(@GerritServerConfig Config cfg) {
|
||||
this.cfg = cfg;
|
||||
this.password = cfg.getString("elasticsearch", null, "password");
|
||||
this.password = cfg.getString(SECTION_ELASTICSEARCH, null, KEY_PASSWORD);
|
||||
this.username =
|
||||
password == null
|
||||
? null
|
||||
: firstNonNull(cfg.getString("elasticsearch", null, "username"), DEFAULT_USERNAME);
|
||||
: firstNonNull(
|
||||
cfg.getString(SECTION_ELASTICSEARCH, null, KEY_USERNAME), DEFAULT_USERNAME);
|
||||
this.maxRetryTimeout =
|
||||
(int)
|
||||
cfg.getTimeUnit("elasticsearch", null, "maxRetryTimeout", 30000, TimeUnit.MILLISECONDS);
|
||||
this.prefix = Strings.nullToEmpty(cfg.getString("elasticsearch", null, "prefix"));
|
||||
|
||||
Set<String> subsections = cfg.getSubsections("elasticsearch");
|
||||
if (subsections.isEmpty()) {
|
||||
HttpHost httpHost =
|
||||
new HttpHost(DEFAULT_HOST, Integer.valueOf(DEFAULT_PORT), DEFAULT_PROTOCOL);
|
||||
this.hosts = Collections.singletonList(httpHost);
|
||||
} else {
|
||||
this.hosts = new ArrayList<>(subsections.size());
|
||||
for (String subsection : subsections) {
|
||||
String port = getString(cfg, subsection, "port", DEFAULT_PORT);
|
||||
String host = getString(cfg, subsection, "hostname", DEFAULT_HOST);
|
||||
String protocol = getString(cfg, subsection, "protocol", DEFAULT_PROTOCOL);
|
||||
|
||||
HttpHost httpHost = new HttpHost(host, Integer.valueOf(port), protocol);
|
||||
cfg.getTimeUnit(
|
||||
SECTION_ELASTICSEARCH,
|
||||
null,
|
||||
KEY_MAX_RETRY_TIMEOUT,
|
||||
DEFAULT_MAX_RETRY_TIMEOUT_MS,
|
||||
MAX_RETRY_TIMEOUT_UNIT);
|
||||
this.prefix = Strings.nullToEmpty(cfg.getString(SECTION_ELASTICSEARCH, null, KEY_PREFIX));
|
||||
this.hosts = new ArrayList<>();
|
||||
for (String server : cfg.getStringList(SECTION_ELASTICSEARCH, null, KEY_SERVER)) {
|
||||
try {
|
||||
URI uri = new URI(server);
|
||||
int port = uri.getPort();
|
||||
HttpHost httpHost =
|
||||
new HttpHost(
|
||||
uri.getHost(), port == -1 ? Integer.valueOf(DEFAULT_PORT) : port, uri.getScheme());
|
||||
this.hosts.add(httpHost);
|
||||
} catch (URISyntaxException | IllegalArgumentException e) {
|
||||
log.error("Invalid server URI {}: {}", server, e.getMessage());
|
||||
}
|
||||
}
|
||||
|
||||
log.info("Elasticsearch hosts: {}", hosts);
|
||||
if (hosts.isEmpty()) {
|
||||
throw new ProvisionException("No valid Elasticsearch servers configured");
|
||||
}
|
||||
|
||||
log.info("Elasticsearch servers: {}", hosts);
|
||||
}
|
||||
|
||||
Config getConfig() {
|
||||
|
@ -92,8 +104,4 @@ class ElasticConfiguration {
|
|||
String getIndexName(String name, int schemaVersion) {
|
||||
return String.format("%s%s_%04d", prefix, name, schemaVersion);
|
||||
}
|
||||
|
||||
private String getString(Config cfg, String subsection, String name, String defaultValue) {
|
||||
return MoreObjects.firstNonNull(cfg.getString("elasticsearch", subsection, name), defaultValue);
|
||||
}
|
||||
}
|
||||
|
|
|
@ -0,0 +1,153 @@
|
|||
// Copyright (C) 2018 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.elasticsearch;
|
||||
|
||||
import static com.google.common.truth.Truth.assertThat;
|
||||
import static com.google.gerrit.elasticsearch.ElasticConfiguration.DEFAULT_MAX_RETRY_TIMEOUT_MS;
|
||||
import static com.google.gerrit.elasticsearch.ElasticConfiguration.DEFAULT_USERNAME;
|
||||
import static com.google.gerrit.elasticsearch.ElasticConfiguration.KEY_MAX_RETRY_TIMEOUT;
|
||||
import static com.google.gerrit.elasticsearch.ElasticConfiguration.KEY_PASSWORD;
|
||||
import static com.google.gerrit.elasticsearch.ElasticConfiguration.KEY_PREFIX;
|
||||
import static com.google.gerrit.elasticsearch.ElasticConfiguration.KEY_SERVER;
|
||||
import static com.google.gerrit.elasticsearch.ElasticConfiguration.KEY_USERNAME;
|
||||
import static com.google.gerrit.elasticsearch.ElasticConfiguration.MAX_RETRY_TIMEOUT_UNIT;
|
||||
import static com.google.gerrit.elasticsearch.ElasticConfiguration.SECTION_ELASTICSEARCH;
|
||||
import static java.util.stream.Collectors.toList;
|
||||
|
||||
import com.google.common.collect.ImmutableList;
|
||||
import com.google.inject.ProvisionException;
|
||||
import java.util.Arrays;
|
||||
import java.util.concurrent.TimeUnit;
|
||||
import org.eclipse.jgit.lib.Config;
|
||||
import org.junit.Rule;
|
||||
import org.junit.Test;
|
||||
import org.junit.rules.ExpectedException;
|
||||
|
||||
public class ElasticConfigurationTest {
|
||||
@Rule public ExpectedException exception = ExpectedException.none();
|
||||
|
||||
@Test
|
||||
public void singleServerNoOtherConfig() throws Exception {
|
||||
Config cfg = newConfig();
|
||||
ElasticConfiguration esCfg = new ElasticConfiguration(cfg);
|
||||
assertHosts(esCfg, "http://elastic:1234");
|
||||
assertThat(esCfg.username).isNull();
|
||||
assertThat(esCfg.password).isNull();
|
||||
assertThat(esCfg.prefix).isEmpty();
|
||||
assertThat(esCfg.maxRetryTimeout).isEqualTo(DEFAULT_MAX_RETRY_TIMEOUT_MS);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void serverWithoutPortSpecified() throws Exception {
|
||||
Config cfg = new Config();
|
||||
cfg.setString(SECTION_ELASTICSEARCH, null, KEY_SERVER, "http://elastic");
|
||||
ElasticConfiguration esCfg = new ElasticConfiguration(cfg);
|
||||
assertHosts(esCfg, "http://elastic:9200");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void prefix() throws Exception {
|
||||
Config cfg = newConfig();
|
||||
cfg.setString(SECTION_ELASTICSEARCH, null, KEY_PREFIX, "myprefix");
|
||||
ElasticConfiguration esCfg = new ElasticConfiguration(cfg);
|
||||
assertThat(esCfg.prefix).isEqualTo("myprefix");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void maxRetryTimeoutInDefaultUnit() {
|
||||
Config cfg = newConfig();
|
||||
cfg.setString(SECTION_ELASTICSEARCH, null, KEY_MAX_RETRY_TIMEOUT, "45000");
|
||||
ElasticConfiguration esCfg = new ElasticConfiguration(cfg);
|
||||
assertThat(esCfg.maxRetryTimeout).isEqualTo(45000);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void maxRetryTimeoutInOtherUnit() {
|
||||
Config cfg = newConfig();
|
||||
cfg.setString(SECTION_ELASTICSEARCH, null, KEY_MAX_RETRY_TIMEOUT, "45 s");
|
||||
ElasticConfiguration esCfg = new ElasticConfiguration(cfg);
|
||||
assertThat(esCfg.maxRetryTimeout)
|
||||
.isEqualTo(MAX_RETRY_TIMEOUT_UNIT.convert(45, TimeUnit.SECONDS));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void withAuthentication() throws Exception {
|
||||
Config cfg = newConfig();
|
||||
cfg.setString(SECTION_ELASTICSEARCH, null, KEY_USERNAME, "myself");
|
||||
cfg.setString(SECTION_ELASTICSEARCH, null, KEY_PASSWORD, "s3kr3t");
|
||||
ElasticConfiguration esCfg = new ElasticConfiguration(cfg);
|
||||
assertThat(esCfg.username).isEqualTo("myself");
|
||||
assertThat(esCfg.password).isEqualTo("s3kr3t");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void withAuthenticationPasswordOnlyUsesDefaultUsername() throws Exception {
|
||||
Config cfg = newConfig();
|
||||
cfg.setString(SECTION_ELASTICSEARCH, null, KEY_PASSWORD, "s3kr3t");
|
||||
ElasticConfiguration esCfg = new ElasticConfiguration(cfg);
|
||||
assertThat(esCfg.username).isEqualTo(DEFAULT_USERNAME);
|
||||
assertThat(esCfg.password).isEqualTo("s3kr3t");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void multipleServers() throws Exception {
|
||||
Config cfg = new Config();
|
||||
cfg.setStringList(
|
||||
SECTION_ELASTICSEARCH,
|
||||
null,
|
||||
KEY_SERVER,
|
||||
ImmutableList.of("http://elastic1:1234", "http://elastic2:1234"));
|
||||
ElasticConfiguration esCfg = new ElasticConfiguration(cfg);
|
||||
assertHosts(esCfg, "http://elastic1:1234", "http://elastic2:1234");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void noServers() throws Exception {
|
||||
assertProvisionException(new Config());
|
||||
}
|
||||
|
||||
@Test
|
||||
public void singleServerInvalid() throws Exception {
|
||||
Config cfg = new Config();
|
||||
cfg.setString(SECTION_ELASTICSEARCH, null, KEY_SERVER, "foo");
|
||||
assertProvisionException(cfg);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void multipleServersIncludingInvalid() throws Exception {
|
||||
Config cfg = new Config();
|
||||
cfg.setStringList(
|
||||
SECTION_ELASTICSEARCH, null, KEY_SERVER, ImmutableList.of("http://elastic1:1234", "foo"));
|
||||
ElasticConfiguration esCfg = new ElasticConfiguration(cfg);
|
||||
assertHosts(esCfg, "http://elastic1:1234");
|
||||
}
|
||||
|
||||
private static Config newConfig() {
|
||||
Config config = new Config();
|
||||
config.setString(SECTION_ELASTICSEARCH, null, KEY_SERVER, "http://elastic:1234");
|
||||
return config;
|
||||
}
|
||||
|
||||
private void assertHosts(ElasticConfiguration cfg, Object... hostURIs) throws Exception {
|
||||
assertThat(Arrays.asList(cfg.getHosts()).stream().map(h -> h.toURI()).collect(toList()))
|
||||
.containsExactly(hostURIs);
|
||||
}
|
||||
|
||||
private void assertProvisionException(Config cfg) throws Exception {
|
||||
exception.expect(ProvisionException.class);
|
||||
exception.expectMessage("No valid Elasticsearch servers configured");
|
||||
new ElasticConfiguration(cfg);
|
||||
}
|
||||
}
|
|
@ -34,9 +34,7 @@ public final class ElasticTestUtils {
|
|||
|
||||
public static void configure(Config config, int port, String prefix, String password) {
|
||||
config.setEnum("index", null, "type", IndexType.ELASTICSEARCH);
|
||||
config.setString("elasticsearch", "test", "protocol", "http");
|
||||
config.setString("elasticsearch", "test", "hostname", "localhost");
|
||||
config.setInt("elasticsearch", "test", "port", port);
|
||||
config.setString("elasticsearch", null, "server", "http://localhost:" + port);
|
||||
config.setString("elasticsearch", null, "prefix", prefix);
|
||||
config.setInt("index", null, "maxLimit", 10000);
|
||||
if (password != null) {
|
||||
|
|
|
@ -15,7 +15,6 @@
|
|||
package com.google.gerrit.pgm.init;
|
||||
|
||||
import com.google.common.collect.Iterables;
|
||||
import com.google.common.collect.Sets;
|
||||
import com.google.gerrit.index.SchemaDefinitions;
|
||||
import com.google.gerrit.pgm.init.api.ConsoleUI;
|
||||
import com.google.gerrit.pgm.init.api.InitFlags;
|
||||
|
@ -63,13 +62,7 @@ class InitIndex implements InitStep {
|
|||
if (type == IndexType.ELASTICSEARCH) {
|
||||
Section elasticsearch = sections.get("elasticsearch", null);
|
||||
elasticsearch.string("Index Prefix", "prefix", "gerrit_");
|
||||
String name = ui.readString("default", "Server Name");
|
||||
|
||||
Section defaultServer = sections.get("elasticsearch", name);
|
||||
defaultServer.select(
|
||||
"Transport protocol", "protocol", "http", Sets.newHashSet("http", "https"));
|
||||
defaultServer.string("Hostname", "hostname", "localhost");
|
||||
defaultServer.string("Port", "port", "9200");
|
||||
elasticsearch.string("Server", "server", "http://localhost:9200");
|
||||
index.string("Result window size", "maxLimit", "10000");
|
||||
}
|
||||
|
||||
|
|
Loading…
Reference in New Issue