Merge changes from topic "elasticsearch-index-type"
* changes:
IndexType: Move Config-based construction to IndexConfig
IndexType: Make elasticsearch candidate check consistent w/ constructor
AbstractIndexTests: Provide default configureIndex method implementation
{Custom|Elastic|}IndexIT: Add javadoc with semantic link
IndexType: Add tested support for custom index type
diff --git a/java/com/google/gerrit/index/IndexConfig.java b/java/com/google/gerrit/index/IndexConfig.java
index 807c78c..29b8ea6 100644
--- a/java/com/google/gerrit/index/IndexConfig.java
+++ b/java/com/google/gerrit/index/IndexConfig.java
@@ -52,7 +52,8 @@
}
private static void setTypeOrDefault(Config cfg, Consumer<String> setter) {
- setter.accept(new IndexType(cfg).toString());
+ String type = cfg != null ? cfg.getString("index", null, "type") : null;
+ setter.accept(new IndexType(type).toString());
}
public static Builder builder() {
diff --git a/java/com/google/gerrit/index/IndexType.java b/java/com/google/gerrit/index/IndexType.java
index 10aa220..a92b734 100644
--- a/java/com/google/gerrit/index/IndexType.java
+++ b/java/com/google/gerrit/index/IndexType.java
@@ -16,8 +16,16 @@
import com.google.common.collect.ImmutableSet;
import com.google.gerrit.common.Nullable;
-import org.eclipse.jgit.lib.Config;
+/**
+ * Index types supported by the secondary index.
+ *
+ * <p>The explicitly known index types are Lucene (the default) and Elasticsearch.
+ *
+ * <p>The third supported index type is any other type String value, deemed as custom. This is for
+ * configuring index types that are internal or not to be disclosed. Supporting custom index types
+ * allows to not break that case upon core implementation changes.
+ */
public class IndexType {
private static final String LUCENE = "lucene";
private static final String ELASTICSEARCH = "elasticsearch";
@@ -28,10 +36,6 @@
this.type = type == null ? getDefault() : type.toLowerCase();
}
- public IndexType(@Nullable Config cfg) {
- this(cfg != null ? cfg.getString("index", null, "type") : null);
- }
-
public static String getDefault() {
return LUCENE;
}
@@ -49,7 +53,7 @@
}
public static boolean isElasticsearch(String type) {
- return type.equals(ELASTICSEARCH);
+ return type.toLowerCase().equals(ELASTICSEARCH);
}
@Override
diff --git a/java/com/google/gerrit/pgm/Daemon.java b/java/com/google/gerrit/pgm/Daemon.java
index 9cebee4..e6860c2 100644
--- a/java/com/google/gerrit/pgm/Daemon.java
+++ b/java/com/google/gerrit/pgm/Daemon.java
@@ -327,7 +327,7 @@
}
cfgInjector = createCfgInjector();
config = cfgInjector.getInstance(Key.get(Config.class, GerritServerConfig.class));
- initIndexType();
+ indexType = IndexModule.getIndexType(cfgInjector);
sysInjector = createSysInjector();
sysInjector.getInstance(PluginGuiceEnvironment.class).setDbCfgInjector(dbInjector, cfgInjector);
manager.add(dbInjector, cfgInjector, sysInjector);
@@ -498,13 +498,6 @@
throw new IllegalStateException("unsupported index.type = " + indexType);
}
- private void initIndexType() {
- indexType = IndexModule.getIndexType(cfgInjector);
- if (!indexType.isLucene() && !indexType.isElasticsearch()) {
- throw new IllegalStateException("unsupported index.type = " + indexType);
- }
- }
-
private void initSshd() {
sshInjector = createSshInjector();
sysInjector.getInstance(PluginGuiceEnvironment.class).setSshInjector(sshInjector);
diff --git a/java/com/google/gerrit/testing/InMemoryModule.java b/java/com/google/gerrit/testing/InMemoryModule.java
index 08835cc..d552095 100644
--- a/java/com/google/gerrit/testing/InMemoryModule.java
+++ b/java/com/google/gerrit/testing/InMemoryModule.java
@@ -227,10 +227,11 @@
IndexType indexType = new IndexType(cfg.getString("index", null, "type"));
// For custom index types, callers must provide their own module.
- if (indexType.isLucene()) {
- install(luceneIndexModule());
- } else if (indexType.isElasticsearch()) {
+ if (indexType.isElasticsearch()) {
install(elasticIndexModule());
+ } else {
+ // Also the default "custom" module for testing.
+ install(luceneIndexModule());
}
bind(ServerInformationImpl.class);
bind(ServerInformation.class).to(ServerInformationImpl.class);
diff --git a/javatests/com/google/gerrit/acceptance/ssh/AbstractIndexTests.java b/javatests/com/google/gerrit/acceptance/ssh/AbstractIndexTests.java
index ed3cdbc..a03d7f3 100644
--- a/javatests/com/google/gerrit/acceptance/ssh/AbstractIndexTests.java
+++ b/javatests/com/google/gerrit/acceptance/ssh/AbstractIndexTests.java
@@ -45,7 +45,7 @@
private RegistrationHandle changeIndexedCounterHandle;
/** @param injector injector */
- public abstract void configureIndex(Injector injector) throws Exception;
+ public void configureIndex(Injector injector) {}
@Before
public void addChangeIndexedCounter() {
diff --git a/javatests/com/google/gerrit/acceptance/ssh/CustomIndexIT.java b/javatests/com/google/gerrit/acceptance/ssh/CustomIndexIT.java
new file mode 100644
index 0000000..434071f
--- /dev/null
+++ b/javatests/com/google/gerrit/acceptance/ssh/CustomIndexIT.java
@@ -0,0 +1,33 @@
+// Copyright (C) 2019 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.acceptance.ssh;
+
+import com.google.gerrit.index.IndexType;
+import com.google.gerrit.testing.ConfigSuite;
+import org.eclipse.jgit.lib.Config;
+
+/**
+ * Tests for a defaulted custom index configuration. This unknown type is the opposite of {@link
+ * IndexType#getKnownTypes()}.
+ */
+public class CustomIndexIT extends AbstractIndexTests {
+
+ @ConfigSuite.Default
+ public static Config customIndexType() {
+ Config config = new Config();
+ config.setString("index", null, "type", "custom");
+ return config;
+ }
+}
diff --git a/javatests/com/google/gerrit/acceptance/ssh/ElasticIndexIT.java b/javatests/com/google/gerrit/acceptance/ssh/ElasticIndexIT.java
index 61a490b..1c41b55 100644
--- a/javatests/com/google/gerrit/acceptance/ssh/ElasticIndexIT.java
+++ b/javatests/com/google/gerrit/acceptance/ssh/ElasticIndexIT.java
@@ -18,10 +18,12 @@
import static com.google.gerrit.elasticsearch.ElasticTestUtils.getConfig;
import com.google.gerrit.elasticsearch.ElasticVersion;
+import com.google.gerrit.index.IndexType;
import com.google.gerrit.testing.ConfigSuite;
import com.google.inject.Injector;
import org.eclipse.jgit.lib.Config;
+/** Tests for every supported {@link IndexType#isElasticsearch()} most recent index version. */
public class ElasticIndexIT extends AbstractIndexTests {
@ConfigSuite.Default
@@ -40,7 +42,7 @@
}
@Override
- public void configureIndex(Injector injector) throws Exception {
+ public void configureIndex(Injector injector) {
createAllIndexes(injector);
}
}
diff --git a/javatests/com/google/gerrit/acceptance/ssh/IndexIT.java b/javatests/com/google/gerrit/acceptance/ssh/IndexIT.java
index 196a1e5..7062b00 100644
--- a/javatests/com/google/gerrit/acceptance/ssh/IndexIT.java
+++ b/javatests/com/google/gerrit/acceptance/ssh/IndexIT.java
@@ -14,10 +14,7 @@
package com.google.gerrit.acceptance.ssh;
-import com.google.inject.Injector;
+import com.google.gerrit.index.IndexType;
-public class IndexIT extends AbstractIndexTests {
-
- @Override
- public void configureIndex(Injector injector) throws Exception {}
-}
+/** Tests for the default {@link IndexType#isLucene()} index configuration. */
+public class IndexIT extends AbstractIndexTests {}
