| // Copyright (C) 2017 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.ericsson.gerrit.plugins.highavailability; |
| |
| import static com.ericsson.gerrit.plugins.highavailability.Configuration.AutoReindex.AUTO_REINDEX_SECTION; |
| import static com.ericsson.gerrit.plugins.highavailability.Configuration.AutoReindex.DEFAULT_AUTO_REINDEX; |
| import static com.ericsson.gerrit.plugins.highavailability.Configuration.AutoReindex.DEFAULT_DELAY; |
| import static com.ericsson.gerrit.plugins.highavailability.Configuration.AutoReindex.DEFAULT_POLL_INTERVAL; |
| import static com.ericsson.gerrit.plugins.highavailability.Configuration.AutoReindex.DELAY; |
| import static com.ericsson.gerrit.plugins.highavailability.Configuration.AutoReindex.ENABLED; |
| import static com.ericsson.gerrit.plugins.highavailability.Configuration.AutoReindex.POLL_INTERVAL; |
| import static com.ericsson.gerrit.plugins.highavailability.Configuration.Cache.CACHE_SECTION; |
| import static com.ericsson.gerrit.plugins.highavailability.Configuration.Cache.PATTERN_KEY; |
| import static com.ericsson.gerrit.plugins.highavailability.Configuration.DEFAULT_THREAD_POOL_SIZE; |
| import static com.ericsson.gerrit.plugins.highavailability.Configuration.Event.EVENT_SECTION; |
| import static com.ericsson.gerrit.plugins.highavailability.Configuration.Forwarding.DEFAULT_SYNCHRONIZE; |
| import static com.ericsson.gerrit.plugins.highavailability.Configuration.Forwarding.SYNCHRONIZE_KEY; |
| import static com.ericsson.gerrit.plugins.highavailability.Configuration.HealthCheck.DEFAULT_HEALTH_CHECK_ENABLED; |
| import static com.ericsson.gerrit.plugins.highavailability.Configuration.HealthCheck.ENABLE_KEY; |
| import static com.ericsson.gerrit.plugins.highavailability.Configuration.HealthCheck.HEALTH_CHECK_SECTION; |
| import static com.ericsson.gerrit.plugins.highavailability.Configuration.Http.CONNECTION_TIMEOUT_KEY; |
| import static com.ericsson.gerrit.plugins.highavailability.Configuration.Http.DEFAULT_MAX_TRIES; |
| import static com.ericsson.gerrit.plugins.highavailability.Configuration.Http.DEFAULT_RETRY_INTERVAL; |
| import static com.ericsson.gerrit.plugins.highavailability.Configuration.Http.DEFAULT_TIMEOUT_MS; |
| import static com.ericsson.gerrit.plugins.highavailability.Configuration.Http.HTTP_SECTION; |
| import static com.ericsson.gerrit.plugins.highavailability.Configuration.Http.MAX_TRIES_KEY; |
| import static com.ericsson.gerrit.plugins.highavailability.Configuration.Http.PASSWORD_KEY; |
| import static com.ericsson.gerrit.plugins.highavailability.Configuration.Http.RETRY_INTERVAL_KEY; |
| import static com.ericsson.gerrit.plugins.highavailability.Configuration.Http.SOCKET_TIMEOUT_KEY; |
| import static com.ericsson.gerrit.plugins.highavailability.Configuration.Http.USER_KEY; |
| import static com.ericsson.gerrit.plugins.highavailability.Configuration.Index.INDEX_SECTION; |
| import static com.ericsson.gerrit.plugins.highavailability.Configuration.JGroups.CLUSTER_NAME_KEY; |
| import static com.ericsson.gerrit.plugins.highavailability.Configuration.JGroups.DEFAULT_CLUSTER_NAME; |
| import static com.ericsson.gerrit.plugins.highavailability.Configuration.JGroups.PROTOCOL_STACK_KEY; |
| import static com.ericsson.gerrit.plugins.highavailability.Configuration.JGroups.SKIP_INTERFACE_KEY; |
| import static com.ericsson.gerrit.plugins.highavailability.Configuration.Main.DEFAULT_SHARED_DIRECTORY; |
| import static com.ericsson.gerrit.plugins.highavailability.Configuration.Main.MAIN_SECTION; |
| import static com.ericsson.gerrit.plugins.highavailability.Configuration.Main.SHARED_DIRECTORY_KEY; |
| import static com.ericsson.gerrit.plugins.highavailability.Configuration.PEER_INFO_SECTION; |
| import static com.ericsson.gerrit.plugins.highavailability.Configuration.PeerInfo.STRATEGY_KEY; |
| import static com.ericsson.gerrit.plugins.highavailability.Configuration.PeerInfoJGroups.JGROUPS_SUBSECTION; |
| import static com.ericsson.gerrit.plugins.highavailability.Configuration.PeerInfoStatic.STATIC_SUBSECTION; |
| import static com.ericsson.gerrit.plugins.highavailability.Configuration.PeerInfoStatic.URL_KEY; |
| import static com.ericsson.gerrit.plugins.highavailability.Configuration.THREAD_POOL_SIZE_KEY; |
| import static com.ericsson.gerrit.plugins.highavailability.Configuration.Websession.CLEANUP_INTERVAL_KEY; |
| import static com.ericsson.gerrit.plugins.highavailability.Configuration.Websession.DEFAULT_CLEANUP_INTERVAL; |
| import static com.ericsson.gerrit.plugins.highavailability.Configuration.Websession.WEBSESSION_SECTION; |
| |
| import com.ericsson.gerrit.plugins.highavailability.Configuration.PeerInfoStrategy; |
| import com.google.common.base.Strings; |
| import com.google.gerrit.common.FileUtil; |
| import com.google.gerrit.extensions.annotations.PluginName; |
| import com.google.gerrit.pgm.init.api.ConsoleUI; |
| import com.google.gerrit.pgm.init.api.InitFlags; |
| import com.google.gerrit.pgm.init.api.InitStep; |
| import com.google.gerrit.server.config.SitePaths; |
| import com.google.inject.Inject; |
| import java.io.IOException; |
| import java.nio.file.Path; |
| import java.nio.file.Paths; |
| import java.util.EnumSet; |
| import java.util.Objects; |
| import org.eclipse.jgit.errors.ConfigInvalidException; |
| import org.eclipse.jgit.storage.file.FileBasedConfig; |
| import org.eclipse.jgit.util.FS; |
| |
| public class Setup implements InitStep { |
| |
| private final ConsoleUI ui; |
| private final String pluginName; |
| private final InitFlags flags; |
| private final SitePaths site; |
| private final SetupLocalHAReplica setupLocalHAReplica; |
| |
| private FileBasedConfig config; |
| |
| @Inject |
| public Setup( |
| ConsoleUI ui, |
| @PluginName String pluginName, |
| InitFlags flags, |
| SitePaths site, |
| SetupLocalHAReplica setupLocalHAReplica) { |
| this.ui = ui; |
| this.pluginName = pluginName; |
| this.flags = flags; |
| this.site = site; |
| this.setupLocalHAReplica = setupLocalHAReplica; |
| } |
| |
| @Override |
| public void run() throws Exception { |
| ui.message("\n"); |
| ui.header("%s Plugin", pluginName); |
| |
| Path pluginConfigFile = site.etc_dir.resolve(pluginName + ".config"); |
| boolean autoConfigure = !pluginConfigFile.toFile().exists(); |
| |
| if (ui.yesno(autoConfigure, "Configure %s", pluginName)) { |
| ui.header("Configuring %s", pluginName); |
| config = new FileBasedConfig(pluginConfigFile.toFile(), FS.DETECTED); |
| config.load(); |
| configureAutoReindexSection(); |
| configureHttpSection(); |
| configureCacheSection(); |
| configureEventSection(); |
| configureIndexSection(); |
| configureWebsessionsSection(); |
| configureHealthCheckSection(); |
| if (!createHAReplicaSite(config)) { |
| configureMainSection(); |
| configurePeerInfoSection(); |
| config.save(); |
| } |
| flags.cfg.setBoolean("database", "h2", "autoServer", true); |
| } |
| } |
| |
| private void configureAutoReindexSection() { |
| ui.header("AutoReindex section"); |
| Boolean autoReindex = |
| promptAndSetBoolean("Auto reindex", AUTO_REINDEX_SECTION, ENABLED, DEFAULT_AUTO_REINDEX); |
| config.setBoolean(AUTO_REINDEX_SECTION, null, ENABLED, autoReindex); |
| |
| String delay = |
| promptAndSetString("Delay", AUTO_REINDEX_SECTION, DELAY, numberToString(DEFAULT_DELAY)); |
| config.setLong(AUTO_REINDEX_SECTION, null, DELAY, Long.valueOf(delay)); |
| |
| String pollInterval = |
| promptAndSetString( |
| "Poll interval", |
| AUTO_REINDEX_SECTION, |
| POLL_INTERVAL, |
| numberToString(DEFAULT_POLL_INTERVAL)); |
| config.setLong(AUTO_REINDEX_SECTION, null, POLL_INTERVAL, Long.valueOf(pollInterval)); |
| } |
| |
| private void configureMainSection() { |
| ui.header("Main section"); |
| String sharedDirDefault = ui.isBatch() ? DEFAULT_SHARED_DIRECTORY : null; |
| String shared = |
| promptAndSetString( |
| "Shared directory", MAIN_SECTION, SHARED_DIRECTORY_KEY, sharedDirDefault); |
| if (!Strings.isNullOrEmpty(shared)) { |
| Path resolved = site.site_path.resolve(Paths.get(shared)); |
| FileUtil.mkdirsOrDie(resolved, "cannot create " + resolved); |
| } |
| } |
| |
| private void configurePeerInfoSection() { |
| ui.header("PeerInfo section"); |
| PeerInfoStrategy strategy = |
| ui.readEnum( |
| PeerInfoStrategy.JGROUPS, EnumSet.allOf(PeerInfoStrategy.class), "Peer info strategy"); |
| config.setEnum(PEER_INFO_SECTION, null, STRATEGY_KEY, strategy); |
| if (strategy == PeerInfoStrategy.STATIC) { |
| promptAndSetString( |
| titleWithNote("Peer URL", "urls"), PEER_INFO_SECTION, STATIC_SUBSECTION, URL_KEY, null); |
| } else { |
| promptAndSetString( |
| "JGroups cluster name", |
| PEER_INFO_SECTION, |
| JGROUPS_SUBSECTION, |
| CLUSTER_NAME_KEY, |
| DEFAULT_CLUSTER_NAME); |
| promptAndSetString( |
| "Protocol stack (optional)", |
| PEER_INFO_SECTION, |
| JGROUPS_SUBSECTION, |
| PROTOCOL_STACK_KEY, |
| null); |
| promptAndSetString( |
| titleForOptionalWithNote("Skip interface", "interfaces"), |
| PEER_INFO_SECTION, |
| JGROUPS_SUBSECTION, |
| SKIP_INTERFACE_KEY, |
| null); |
| } |
| } |
| |
| private void configureHttpSection() { |
| ui.header("Http section"); |
| promptAndSetString("User", HTTP_SECTION, USER_KEY, null); |
| promptAndSetString("Password", HTTP_SECTION, PASSWORD_KEY, null); |
| promptAndSetString( |
| "Max number of tries to forward to remote peer", |
| HTTP_SECTION, |
| MAX_TRIES_KEY, |
| numberToString(DEFAULT_MAX_TRIES)); |
| promptAndSetString( |
| "Retry interval [ms]", |
| HTTP_SECTION, |
| RETRY_INTERVAL_KEY, |
| numberToString(DEFAULT_RETRY_INTERVAL)); |
| promptAndSetString( |
| "Connection timeout [ms]", |
| HTTP_SECTION, |
| CONNECTION_TIMEOUT_KEY, |
| numberToString(DEFAULT_TIMEOUT_MS)); |
| promptAndSetString( |
| "Socket timeout [ms]", |
| HTTP_SECTION, |
| SOCKET_TIMEOUT_KEY, |
| numberToString(DEFAULT_TIMEOUT_MS)); |
| } |
| |
| private void configureCacheSection() { |
| ui.header("Cache section"); |
| promptAndSetSynchronize("Cache", CACHE_SECTION); |
| promptAndSetString( |
| "Cache thread pool size", |
| CACHE_SECTION, |
| THREAD_POOL_SIZE_KEY, |
| numberToString(DEFAULT_THREAD_POOL_SIZE)); |
| promptAndSetString( |
| titleForOptionalWithNote("Cache pattern", "patterns"), CACHE_SECTION, PATTERN_KEY, null); |
| } |
| |
| private void configureEventSection() { |
| ui.header("Event section"); |
| promptAndSetSynchronize("Event", EVENT_SECTION); |
| } |
| |
| private void configureIndexSection() { |
| ui.header("Index section"); |
| promptAndSetSynchronize("Index", INDEX_SECTION); |
| promptAndSetString( |
| "Index thread pool size", |
| INDEX_SECTION, |
| THREAD_POOL_SIZE_KEY, |
| numberToString(DEFAULT_THREAD_POOL_SIZE)); |
| } |
| |
| private void configureWebsessionsSection() { |
| ui.header("Websession section"); |
| promptAndSetSynchronize("Websession", WEBSESSION_SECTION); |
| promptAndSetString( |
| "Cleanup interval", WEBSESSION_SECTION, CLEANUP_INTERVAL_KEY, DEFAULT_CLEANUP_INTERVAL); |
| } |
| |
| private void configureHealthCheckSection() { |
| ui.header("HealthCheck section"); |
| Boolean healthCheck = |
| promptAndSetBoolean( |
| "Health check", HEALTH_CHECK_SECTION, ENABLE_KEY, DEFAULT_HEALTH_CHECK_ENABLED); |
| config.setBoolean(HEALTH_CHECK_SECTION, null, ENABLE_KEY, healthCheck); |
| } |
| |
| private void promptAndSetSynchronize(String sectionTitle, String section) { |
| String titleSuffix = ": synchronize?"; |
| String title = sectionTitle + titleSuffix; |
| promptAndSetBoolean(title, section, SYNCHRONIZE_KEY, DEFAULT_SYNCHRONIZE); |
| } |
| |
| private Boolean promptAndSetBoolean( |
| String title, String section, String name, Boolean defaultValue) { |
| Boolean oldValue = config.getBoolean(section, null, name, defaultValue); |
| Boolean newValue = Boolean.parseBoolean(ui.readString(String.valueOf(oldValue), title)); |
| if (!Objects.equals(oldValue, newValue)) { |
| config.setBoolean(section, null, name, newValue); |
| } |
| return newValue; |
| } |
| |
| private String promptAndSetString( |
| String title, String section, String name, String defaultValue) { |
| return promptAndSetString(title, section, null, name, defaultValue); |
| } |
| |
| private String promptAndSetString( |
| String title, String section, String subsection, String name, String defaultValue) { |
| String oldValue = Strings.emptyToNull(config.getString(section, subsection, name)); |
| String newValue = ui.readString(oldValue != null ? oldValue : defaultValue, title); |
| if (!Objects.equals(oldValue, newValue)) { |
| if (!Strings.isNullOrEmpty(newValue)) { |
| config.setString(section, subsection, name, newValue); |
| } else { |
| config.unset(section, subsection, name); |
| } |
| } |
| return newValue; |
| } |
| |
| private static String titleForOptionalWithNote(String prefix, String suffix) { |
| return titleWithNote(prefix + " (optional)", suffix); |
| } |
| |
| private static String titleWithNote(String prefix, String suffix) { |
| return prefix + "; manually repeat this line to configure more " + suffix; |
| } |
| |
| private static String numberToString(int number) { |
| return Integer.toString(number); |
| } |
| |
| private static String numberToString(long number) { |
| return Long.toString(number); |
| } |
| |
| private boolean createHAReplicaSite(FileBasedConfig pluginConfig) |
| throws ConfigInvalidException, IOException { |
| ui.header("HA replica site setup"); |
| if (ui.yesno(true, "Create a HA replica site")) { |
| String replicaPath = ui.readString("ha/1", "Location of the HA replica"); |
| Path replica = site.site_path.resolve(Paths.get(replicaPath)); |
| if (replica.toFile().exists()) { |
| ui.message("%s already exists, exiting", replica); |
| return true; |
| } |
| config.save(); |
| setupLocalHAReplica.run(new SitePaths(replica), pluginConfig); |
| return true; |
| } |
| return false; |
| } |
| |
| @Override |
| public void postRun() {} |
| } |