Check Jira connectivity at startup
Make sure that Jira connectivity issues are well highlighted when
the its-jira plugin starts, by reading the default Jira URL config
and performing an health-check at the start() lifecycle listener action.
Fix a regression where an incorrect Jira URL in the gerrit.config
got unnoticed since the introduction of the multi-server support.
Bug: Issue 10639
Change-Id: I5373a9defb4c21d5f6b53407f64fb69d30c388fa
diff --git a/src/main/java/com/googlesource/gerrit/plugins/its/jira/JiraItsFacade.java b/src/main/java/com/googlesource/gerrit/plugins/its/jira/JiraItsFacade.java
index 866a664..00f965f 100644
--- a/src/main/java/com/googlesource/gerrit/plugins/its/jira/JiraItsFacade.java
+++ b/src/main/java/com/googlesource/gerrit/plugins/its/jira/JiraItsFacade.java
@@ -94,7 +94,7 @@
return execute(() -> jiraClient.issueExists(getJiraServerInstance(), issueKey));
}
- private JiraItsServerInfo getJiraServerInstance() {
+ public JiraItsServerInfo getJiraServerInstance() {
return itsServerInfo;
}
diff --git a/src/main/java/com/googlesource/gerrit/plugins/its/jira/JiraItsStartupHealthcheck.java b/src/main/java/com/googlesource/gerrit/plugins/its/jira/JiraItsStartupHealthcheck.java
new file mode 100644
index 0000000..4c1b24e
--- /dev/null
+++ b/src/main/java/com/googlesource/gerrit/plugins/its/jira/JiraItsStartupHealthcheck.java
@@ -0,0 +1,57 @@
+// 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.googlesource.gerrit.plugins.its.jira;
+
+import com.google.common.flogger.FluentLogger;
+import com.google.gerrit.extensions.annotations.PluginName;
+import com.google.gerrit.extensions.events.LifecycleListener;
+import com.google.gerrit.server.config.AllProjectsName;
+import com.google.inject.Inject;
+import com.googlesource.gerrit.plugins.its.base.its.ItsFacade.Check;
+import com.googlesource.gerrit.plugins.its.jira.restapi.JiraURL;
+import java.io.IOException;
+
+public class JiraItsStartupHealthcheck implements LifecycleListener {
+ private static final FluentLogger logger = FluentLogger.forEnclosingClass();
+
+ private final JiraItsServer jira;
+ private final AllProjectsName allProjectsName;
+ private final String pluginName;
+
+ @Inject
+ public JiraItsStartupHealthcheck(
+ JiraItsServer jira, AllProjectsName allProjectsName, @PluginName String pluginName) {
+ this.jira = jira;
+ this.allProjectsName = allProjectsName;
+ this.pluginName = pluginName;
+ }
+
+ @Override
+ public void start() {
+ JiraItsFacade jiraFacade = jira.getFacade(allProjectsName);
+ JiraURL jiraUrl = jiraFacade.getJiraServerInstance().getUrl();
+
+ try {
+ String sysInfo = jiraFacade.healthCheck(Check.SYSINFO);
+ logger.atInfo().log("Connection to Jira (%s) succeeded: %s", jiraUrl, sysInfo);
+ } catch (IOException e) {
+ logger.atSevere().withCause(e).log(
+ "%s plugin failed to start: unable to connect to Jira (%s)", pluginName, jiraUrl);
+ }
+ }
+
+ @Override
+ public void stop() {}
+}
diff --git a/src/main/java/com/googlesource/gerrit/plugins/its/jira/JiraModule.java b/src/main/java/com/googlesource/gerrit/plugins/its/jira/JiraModule.java
index b9e98b3..65026bc 100644
--- a/src/main/java/com/googlesource/gerrit/plugins/its/jira/JiraModule.java
+++ b/src/main/java/com/googlesource/gerrit/plugins/its/jira/JiraModule.java
@@ -20,9 +20,9 @@
import com.google.gerrit.extensions.annotations.Exports;
import com.google.gerrit.extensions.annotations.PluginName;
+import com.google.gerrit.lifecycle.LifecycleModule;
import com.google.gerrit.server.config.PluginConfigFactory;
import com.google.gerrit.server.config.ProjectConfigEntry;
-import com.google.inject.AbstractModule;
import com.google.inject.Inject;
import com.googlesource.gerrit.plugins.its.base.ItsHookModule;
import com.googlesource.gerrit.plugins.its.base.its.ItsConfig;
@@ -31,7 +31,7 @@
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-public class JiraModule extends AbstractModule {
+public class JiraModule extends LifecycleModule {
private static final Logger LOG = LoggerFactory.getLogger(JiraModule.class);
@@ -60,6 +60,8 @@
bind(ItsConfig.class);
install(new ItsHookModule(pluginName, pluginCfgFactory));
install(JiraItsServerCacheImpl.module());
+ listener().to(JiraItsStartupHealthcheck.class);
+
LOG.info("JIRA is configured as ITS");
}
}
