From 00ce25b75f9c8a000ffdc82e61507dfc68da1448 Mon Sep 17 00:00:00 2001 From: Robert Scott Date: Sun, 15 Apr 2018 11:48:19 +0100 Subject: [PATCH v2 17/28] testutils: add PluginServer --- .../openstreetmap/josm/testutils/PluginServer.java | 249 +++++++++++++++++++++ 1 file changed, 249 insertions(+) create mode 100644 test/unit/org/openstreetmap/josm/testutils/PluginServer.java diff --git a/test/unit/org/openstreetmap/josm/testutils/PluginServer.java b/test/unit/org/openstreetmap/josm/testutils/PluginServer.java new file mode 100644 index 000000000..4e0586704 --- /dev/null +++ b/test/unit/org/openstreetmap/josm/testutils/PluginServer.java @@ -0,0 +1,249 @@ +// License: GPL. For details, see LICENSE file. +package org.openstreetmap.josm.testutils; + +import java.io.File; +import java.io.IOException; +import java.nio.file.Path; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Objects; +import java.util.jar.JarFile; +import java.util.stream.Collectors; + +import org.openstreetmap.josm.TestUtils; +import org.openstreetmap.josm.tools.Logging; + +import org.junit.runner.Description; +import org.junit.runners.model.Statement; + +import com.google.common.collect.ImmutableList; + +import com.github.tomakehurst.wiremock.client.MappingBuilder; +import com.github.tomakehurst.wiremock.client.ResponseDefinitionBuilder; +import com.github.tomakehurst.wiremock.client.WireMock; +import com.github.tomakehurst.wiremock.core.Options; +import com.github.tomakehurst.wiremock.junit.WireMockRule; +import com.github.tomakehurst.wiremock.WireMockServer; + +import static com.github.tomakehurst.wiremock.core.WireMockConfiguration.options; + +public class PluginServer { + public static class RemotePlugin { + private final File srcJar; + private final Map attrOverrides; + private final String pluginName; + private final String pluginURL; + + public RemotePlugin( + final File srcJar + ) { + this(srcJar, null, null, null); + } + + public RemotePlugin( + final File srcJar, + final Map attrOverrides + ) { + this(srcJar, attrOverrides, null, null); + } + + public RemotePlugin( + final File srcJar, + final Map attrOverrides, + final String pluginName + ) { + this(srcJar, attrOverrides, pluginName, null); + } + + public RemotePlugin( + final File srcJar, + final Map attrOverrides, + final String pluginName, + final String pluginURL + ) { + this.srcJar = srcJar; + this.attrOverrides = attrOverrides; + this.pluginName = pluginName; + this.pluginURL = pluginURL; + } + + @Override + public int hashCode() { + return Objects.hash(this.srcJar, this.attrOverrides, this.pluginName, this.pluginURL, this.getClass()); + } + + public String getRemotePluginsListManifestSection() { + final Map attrs = new HashMap(); + JarFile jarFile = null; + + if (srcJar != null) { + try { + jarFile = new JarFile(srcJar, false); + jarFile.getManifest().getMainAttributes().entrySet().stream().forEach( + entry -> attrs.put(entry.getKey().toString(), entry.getValue().toString()) + ); + } catch (IOException e) { + Logging.warn( + "Failed to open {0} as a jar file. Using empty initial manifest. Error was: {1}", + srcJar, + e + ); + } finally { + if (jarFile != null) { + try { + jarFile.close(); + } catch (IOException e) { + Logging.warn( + "Somehow failed to close jar file {0}. Error was: {1}", + srcJar, + e + ); + } + } + } + } + + if (this.attrOverrides != null) { + attrs.putAll(this.attrOverrides); + } + + return attrs.entrySet().stream().filter(entry -> entry.getValue() != null).map( + entry -> String.format("\t%s: %s\n", entry.getKey(), entry.getValue()) + ).collect(Collectors.joining()); + } + + private String getJarPathBeneathFilesDir() { + if (this.srcJar != null) { + final Path jarPath = this.srcJar.toPath().toAbsolutePath().normalize(); + final Path filesRootPath = new File(TestUtils.getTestDataRoot()).toPath().toAbsolutePath().resolve("__files").normalize(); + + if (jarPath.startsWith(filesRootPath)) { + return filesRootPath.relativize(jarPath).toString(); + } + } + return null; + } + + protected String getPluginURLPath() { + final String jarPathBeneathFilesDir = this.getJarPathBeneathFilesDir(); + + if (jarPathBeneathFilesDir != null) { + return "/" + jarPathBeneathFilesDir; + } + + return String.format("/%h/%s.jar", this.hashCode(), pluginName != null ? pluginName : Integer.toHexString(this.hashCode())); + } + + public String getPluginURL(Integer port) { + if (this.pluginURL != null) { + return this.pluginURL; + } else if (port != null && this.getJarPathBeneathFilesDir() != null) { + return String.format("http://localhost:%s%s", port, this.getPluginURLPath()); + } + return "http://example.com" + this.getPluginURLPath(); + } + + public String getName() { + if (this.pluginName != null) { + return this.pluginName; + } else if (this.srcJar != null) { + return this.srcJar.getName().split("\\.", 2)[0]; + } + return Integer.toHexString(this.hashCode()); + } + + public String getRemotePluginsListSection(Integer port) { + return String.format( + "%s.jar;%s\n%s", + this.getName(), + this.getPluginURL(port), + this.getRemotePluginsListManifestSection() + ); + } + + public MappingBuilder getMappingBuilder() { + final String jarPathBeneathFilesDir = this.getJarPathBeneathFilesDir(); + + if (jarPathBeneathFilesDir != null) { + return WireMock.get(WireMock.urlMatching(this.getPluginURLPath())); + } + return null; + } + + public ResponseDefinitionBuilder getResponseDefinitionBuilder() { + final String jarPathBeneathFilesDir = this.getJarPathBeneathFilesDir(); + + if (jarPathBeneathFilesDir != null) { + return WireMock.aResponse().withStatus(200).withHeader("Content-Type", "application/java-archive").withBodyFile( + jarPathBeneathFilesDir + ); + } + return null; + } + } + + protected final List pluginList; + + public PluginServer(RemotePlugin... remotePlugins) { + this.pluginList = ImmutableList.copyOf(remotePlugins); + } + + public void applyToWireMockServer(WireMockServer wireMockServer) { + // first add the plugins list + wireMockServer.stubFor( + WireMock.get(WireMock.urlEqualTo("/plugins")).willReturn( + WireMock.aResponse().withStatus(200).withHeader("Content-Type", "text/plain").withBody( + this.pluginList.stream().map( + remotePlugin -> remotePlugin.getRemotePluginsListSection(wireMockServer.port()) + ).collect(Collectors.joining()) + ) + ) + ); + + // now add each file that we're able to serve + for (final RemotePlugin remotePlugin : this.pluginList) { + final MappingBuilder mappingBuilder = remotePlugin.getMappingBuilder(); + final ResponseDefinitionBuilder responseDefinitionBuilder = remotePlugin.getResponseDefinitionBuilder(); + + if (mappingBuilder != null && responseDefinitionBuilder != null) { + wireMockServer.stubFor( + remotePlugin.getMappingBuilder().willReturn(remotePlugin.getResponseDefinitionBuilder()) + ); + } + } + } + + public PluginServerRule asWireMockRule() { + return this.asWireMockRule( + options().dynamicPort().usingFilesUnderDirectory(TestUtils.getTestDataRoot()), + true + ); + } + + public PluginServerRule asWireMockRule(Options ruleOptions, boolean failOnUnmatchedRequests) { + return new PluginServerRule(ruleOptions, failOnUnmatchedRequests); + } + + public class PluginServerRule extends WireMockRule { + public PluginServerRule(Options ruleOptions, boolean failOnUnmatchedRequests) { + super(ruleOptions, failOnUnmatchedRequests); + } + + public PluginServer getPluginServer() { + return PluginServer.this; + } + + @Override + public Statement apply(Statement base, Description description) { + return super.apply(new Statement() { + @Override + @SuppressWarnings("unchecked") + public void evaluate() throws Throwable { + PluginServer.this.applyToWireMockServer(PluginServerRule.this); + base.evaluate(); + } + }, description); + } + } +} -- 2.11.0