This is an automated email from the ASF dual-hosted git repository. udo pushed a commit to branch feature/GEODE-5660 in repository https://gitbox.apache.org/repos/asf/geode.git
commit 1f824af12eafa010a3b88e3b9e38859db3049709 Author: Udo Kohlmeyer <[email protected]> AuthorDate: Tue Aug 28 17:03:47 2018 -0700 GEODE-5660: Added method to lookup war file from classpath within AgentUtil.java. This is to address problem where http server is started from Java API (Spring Data Geode specifically) Now, the application can reference the `geode-web-api` war from repo and not have to specifically set `GEODE-HOME` property --- .../management/internal/AgentUtilJUnitTest.java | 18 ++++ .../geode/management/internal/AgentUtil.java | 95 ++++++++++++---------- 2 files changed, 70 insertions(+), 43 deletions(-) diff --git a/geode-assembly/src/integrationTest/java/org/apache/geode/management/internal/AgentUtilJUnitTest.java b/geode-assembly/src/integrationTest/java/org/apache/geode/management/internal/AgentUtilJUnitTest.java index 4d5b718..7307d65 100644 --- a/geode-assembly/src/integrationTest/java/org/apache/geode/management/internal/AgentUtilJUnitTest.java +++ b/geode-assembly/src/integrationTest/java/org/apache/geode/management/internal/AgentUtilJUnitTest.java @@ -15,9 +15,12 @@ package org.apache.geode.management.internal; import static org.junit.Assert.assertNotNull; +import static org.junit.Assert.assertNull; +import static org.junit.Assert.assertThat; import java.io.IOException; +import org.hamcrest.text.IsEqualIgnoringCase; import org.junit.Before; import org.junit.Rule; import org.junit.Test; @@ -50,4 +53,19 @@ public class AgentUtilJUnitTest { String gemFireWarLocation = agentUtil.findWarLocation("geode-pulse"); assertNotNull("Pulse WAR File was not found", gemFireWarLocation); } + + @Test + public void testLookupOfWarFileOnClassPath() { + String classpath = System.getProperty("java.class.path"); + String gemFireWarLocation = agentUtil.findWarLocation("testWarFile"); + assertNull(gemFireWarLocation); + + classpath = + classpath + System.getProperty("path.separator") + "somelocation/testWarFile.war"; + System.setProperty("java.class.path", classpath); + gemFireWarLocation = agentUtil.findWarLocation("testWarFile"); + assertNotNull(gemFireWarLocation); + assertThat(gemFireWarLocation, + IsEqualIgnoringCase.equalToIgnoringCase("somelocation/testWarFile.war")); + } } diff --git a/geode-core/src/main/java/org/apache/geode/management/internal/AgentUtil.java b/geode-core/src/main/java/org/apache/geode/management/internal/AgentUtil.java index 95e40dc..f97f97b 100755 --- a/geode-core/src/main/java/org/apache/geode/management/internal/AgentUtil.java +++ b/geode-core/src/main/java/org/apache/geode/management/internal/AgentUtil.java @@ -16,7 +16,8 @@ package org.apache.geode.management.internal; import java.io.File; -import java.net.URL; +import java.util.Arrays; +import java.util.stream.Stream; import org.apache.commons.lang.StringUtils; import org.apache.logging.log4j.Logger; @@ -27,17 +28,14 @@ import org.apache.geode.internal.logging.LogService; /** * Hosts common utility methods needed by the management package * - * @since Geode 1.0.0.0 - * + * @since Geode 1.0.0 */ public class AgentUtil { private static final Logger logger = LogService.getLogger(); - public static final String ERROR_VARIABLE_NOT_SET = - "The GEODE_HOME environment variable must be set!"; - - private String gemfireVersion = null; + private final String gemfireVersion; + private static final String GEODE_HOME = "GEODE_HOME"; public AgentUtil(String gemfireVersion) { this.gemfireVersion = gemfireVersion; @@ -53,49 +51,60 @@ public class AgentUtil { * geode-web-api */ public String findWarLocation(String warFilePrefix) { - String geodeHome = getGeodeHome(); - if (StringUtils.isNotBlank(geodeHome)) { - String[] possibleFiles = - {geodeHome + "/tools/Extensions/" + warFilePrefix + "-" + gemfireVersion + ".war", - geodeHome + "/tools/Pulse/" + warFilePrefix + "-" + gemfireVersion + ".war", - geodeHome + "/lib/" + warFilePrefix + "-" + gemfireVersion + ".war", - geodeHome + "/tools/Extensions/" + warFilePrefix + ".war", - geodeHome + "/tools/Pulse/" + warFilePrefix + ".war", - geodeHome + "/lib/" + warFilePrefix + ".war"}; - for (String possibleFile : possibleFiles) { - if (new File(possibleFile).isFile()) { - logger.info(warFilePrefix + " war found: {}", possibleFile); - return possibleFile; - } - } + final String versionedWarFileName = warFilePrefix + "-" + gemfireVersion + ".war"; + final String unversionedWarFileName = warFilePrefix + ".war"; + + // This will attempt to find the war file defined somewhere on the Java classpath, + // other than the + String possiblePath = + lookupWarLocationFromClasspath(versionedWarFileName, unversionedWarFileName); + if (possiblePath != null) { + return possiblePath; } - - // if $GEODE_HOME is not set or we are not able to find it in all the possible locations under - // $GEODE_HOME, try to - // find in the classpath - String[] possibleFiles = {warFilePrefix + "-" + gemfireVersion + ".war", - "tools/Pulse/" + warFilePrefix + "-" + gemfireVersion + ".war", - "tools/Extensions/" + warFilePrefix + "-" + gemfireVersion + ".war", - "lib/" + warFilePrefix + "-" + gemfireVersion + ".war", warFilePrefix + ".war"}; - for (String possibleFile : possibleFiles) { - URL url = this.getClass().getClassLoader().getResource(possibleFile); - if (url != null) { - // found the war file - logger.info(warFilePrefix + " war found: {}", possibleFile); - return url.getPath(); - } + possiblePath = + findPossibleWarLocationForGeodeHome(versionedWarFileName, unversionedWarFileName); + if (possiblePath != null) { + return possiblePath; } - // we still couldn't find the war file logger.warn(warFilePrefix + " war file was not found"); return null; } - public boolean isWebApplicationAvailable(final String warFileLocation) { + private String findPossibleWarLocationForGeodeHome(String versionedWarFileName, + String unversionedWarFileName) { + String[] possibleFiles = {}; + String geodeHome = getGeodeHome(); + if (StringUtils.isNotBlank(geodeHome)) { + possibleFiles = new String[] {geodeHome + "/tools/Extensions/" + versionedWarFileName, + geodeHome + "/tools/Pulse/" + versionedWarFileName, + geodeHome + "/lib/" + versionedWarFileName, + geodeHome + "/tools/Extensions/" + unversionedWarFileName, + geodeHome + "/tools/Pulse/" + unversionedWarFileName, + geodeHome + "/lib/" + unversionedWarFileName}; + } + return findPossibleWarLocationFromStream(Arrays.stream(possibleFiles)); + } + + private String findPossibleWarLocationFromStream(Stream<String> stream) { + return stream.filter(possiblePath -> new File(possiblePath).isFile()) + .findFirst().orElse(null); + } + + private String lookupWarLocationFromClasspath(String versionedWarFileName, + String unversionedWarFileName) { + return Arrays + .stream(System.getProperty("java.class.path").split(File.pathSeparator)) + .filter(pathString -> pathString.endsWith(versionedWarFileName) || pathString + .endsWith(unversionedWarFileName)) + .findFirst().orElse(null); + } + + boolean isWebApplicationAvailable(final String warFileLocation) { return StringUtils.isNotBlank(warFileLocation); } - public boolean isWebApplicationAvailable(final String... warFileLocations) { + boolean isWebApplicationAvailable(final String... warFileLocations) { for (String warFileLocation : warFileLocations) { if (isWebApplicationAvailable(warFileLocation)) { return true; @@ -105,11 +114,11 @@ public class AgentUtil { return false; } - public String getGeodeHome() { + private String getGeodeHome() { - String geodeHome = System.getenv("GEODE_HOME"); + String geodeHome = System.getenv(GEODE_HOME); - logger.info("GEODE_HOME:" + geodeHome); + logger.info(GEODE_HOME + ":" + geodeHome); // Check for empty variable. if empty, then log message and exit HTTP server // startup if (StringUtils.isBlank(geodeHome)) {
