HBASE-24274 `RESTApiClusterManager` attempts to deserialize response using serialization API
Use the correct GSON API for deserializing service responses. Add simple unit test covering a very limited selection of the overall API surface area, just enough to ensure deserialization works. Signed-off-by: stack <stack@apache.org>
This commit is contained in:
Nick Dimiduk
Nick Dimiduk
parent
1f556b3ad9
commit
fdf2bd7312
|
|
@ -253,6 +253,21 @@
|
|||
<groupId>log4j</groupId>
|
||||
<artifactId>log4j</artifactId>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<artifactId>javax.servlet-api</artifactId>
|
||||
<groupId>javax.servlet</groupId>
|
||||
<scope>test</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.eclipse.jetty</groupId>
|
||||
<artifactId>jetty-server</artifactId>
|
||||
<scope>test</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.eclipse.jetty</groupId>
|
||||
<artifactId>jetty-util</artifactId>
|
||||
<scope>test</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>junit</groupId>
|
||||
<artifactId>junit</artifactId>
|
||||
|
|
|
|||
|
|
@ -0,0 +1,187 @@
|
|||
/*
|
||||
* Licensed to the Apache Software Foundation (ASF) under one
|
||||
* or more contributor license agreements. See the NOTICE file
|
||||
* distributed with this work for additional information
|
||||
* regarding copyright ownership. The ASF licenses this file
|
||||
* to you 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 org.apache.hadoop.hbase;
|
||||
|
||||
import java.io.IOException;
|
||||
import java.io.PrintWriter;
|
||||
import java.net.URI;
|
||||
import java.util.HashMap;
|
||||
import java.util.Map;
|
||||
import java.util.concurrent.locks.ReadWriteLock;
|
||||
import java.util.concurrent.locks.ReentrantReadWriteLock;
|
||||
import java.util.function.BiConsumer;
|
||||
import java.util.regex.Pattern;
|
||||
import javax.servlet.http.HttpServletRequest;
|
||||
import javax.servlet.http.HttpServletResponse;
|
||||
import javax.ws.rs.core.MediaType;
|
||||
import org.eclipse.jetty.server.Request;
|
||||
import org.eclipse.jetty.server.RequestLog;
|
||||
import org.eclipse.jetty.server.Server;
|
||||
import org.eclipse.jetty.server.ServerConnector;
|
||||
import org.eclipse.jetty.server.Slf4jRequestLog;
|
||||
import org.eclipse.jetty.server.handler.AbstractHandler;
|
||||
import org.eclipse.jetty.util.RegexSet;
|
||||
import org.junit.rules.ExternalResource;
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
|
||||
/**
|
||||
* A {@link org.junit.Rule} that manages a simple http server. The caller registers request
|
||||
* handlers to URI path regexp.
|
||||
*/
|
||||
public class MockHttpApiRule extends ExternalResource {
|
||||
private static final Logger LOG = LoggerFactory.getLogger(MockHttpApiRule.class);
|
||||
|
||||
private MockHandler handler;
|
||||
private Server server;
|
||||
|
||||
/**
|
||||
* Register a callback handler for the specified path target.
|
||||
*/
|
||||
public MockHttpApiRule addRegistration(
|
||||
final String pathRegex,
|
||||
final BiConsumer<String, HttpServletResponse> responder
|
||||
) {
|
||||
handler.register(pathRegex, responder);
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Shortcut method for calling {@link #addRegistration(String, BiConsumer)} with a 200 response.
|
||||
*/
|
||||
public MockHttpApiRule registerOk(final String pathRegex, final String responseBody) {
|
||||
return addRegistration(pathRegex, (target, resp) -> {
|
||||
try {
|
||||
resp.setStatus(HttpServletResponse.SC_OK);
|
||||
resp.setCharacterEncoding("UTF-8");
|
||||
resp.setContentType(MediaType.APPLICATION_JSON_TYPE.toString());
|
||||
final PrintWriter writer = resp.getWriter();
|
||||
writer.write(responseBody);
|
||||
writer.flush();
|
||||
} catch (IOException e) {
|
||||
throw new RuntimeException(e);
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
public void clearRegistrations() {
|
||||
handler.clearRegistrations();
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieve the service URI for this service.
|
||||
*/
|
||||
public URI getURI() {
|
||||
if (server == null || !server.isRunning()) {
|
||||
throw new IllegalStateException("server is not running");
|
||||
}
|
||||
return server.getURI();
|
||||
}
|
||||
|
||||
@Override
|
||||
protected void before() throws Exception {
|
||||
handler = new MockHandler();
|
||||
server = new Server();
|
||||
final ServerConnector http = new ServerConnector(server);
|
||||
http.setHost("localhost");
|
||||
server.addConnector(http);
|
||||
server.setStopAtShutdown(true);
|
||||
server.setHandler(handler);
|
||||
server.setRequestLog(buildRequestLog());
|
||||
server.start();
|
||||
}
|
||||
|
||||
@Override
|
||||
protected void after() {
|
||||
try {
|
||||
server.stop();
|
||||
} catch (Exception e) {
|
||||
throw new RuntimeException(e);
|
||||
}
|
||||
}
|
||||
|
||||
private static RequestLog buildRequestLog() {
|
||||
final Slf4jRequestLog requestLog = new Slf4jRequestLog();
|
||||
requestLog.setLoggerName(LOG.getName() + ".RequestLog");
|
||||
requestLog.setExtended(true);
|
||||
return requestLog;
|
||||
}
|
||||
|
||||
private static class MockHandler extends AbstractHandler {
|
||||
|
||||
private final ReadWriteLock responseMappingLock = new ReentrantReadWriteLock();
|
||||
private final Map<String, BiConsumer<String, HttpServletResponse>> responseMapping =
|
||||
new HashMap<>();
|
||||
private final RegexSet regexSet = new RegexSet();
|
||||
|
||||
void register(
|
||||
final String pathRegex,
|
||||
final BiConsumer<String, HttpServletResponse> responder
|
||||
) {
|
||||
LOG.debug("Registering responder to '{}'", pathRegex);
|
||||
responseMappingLock.writeLock().lock();
|
||||
try {
|
||||
responseMapping.put(pathRegex, responder);
|
||||
regexSet.add(pathRegex);
|
||||
} finally {
|
||||
responseMappingLock.writeLock().unlock();
|
||||
}
|
||||
}
|
||||
|
||||
void clearRegistrations() {
|
||||
LOG.debug("Clearing registrations");
|
||||
responseMappingLock.writeLock().lock();
|
||||
try {
|
||||
responseMapping.clear();
|
||||
regexSet.clear();
|
||||
} finally {
|
||||
responseMappingLock.writeLock().unlock();
|
||||
}
|
||||
}
|
||||
|
||||
@Override
|
||||
public void handle(
|
||||
final String target,
|
||||
final Request baseRequest,
|
||||
final HttpServletRequest request,
|
||||
final HttpServletResponse response
|
||||
) {
|
||||
responseMappingLock.readLock().lock();
|
||||
try {
|
||||
if (!regexSet.matches(target)) {
|
||||
response.setStatus(HttpServletResponse.SC_NOT_FOUND);
|
||||
return;
|
||||
}
|
||||
responseMapping.entrySet()
|
||||
.stream()
|
||||
.filter(e -> Pattern.matches(e.getKey(), target))
|
||||
.findAny()
|
||||
.map(Map.Entry::getValue)
|
||||
.orElseThrow(() -> noMatchFound(target))
|
||||
.accept(target, response);
|
||||
} finally {
|
||||
responseMappingLock.readLock().unlock();
|
||||
}
|
||||
}
|
||||
|
||||
private static RuntimeException noMatchFound(final String target) {
|
||||
return new RuntimeException(
|
||||
String.format("Target path '%s' matches no registered regex.", target));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -1,4 +1,4 @@
|
|||
/**
|
||||
/*
|
||||
* Licensed to the Apache Software Foundation (ASF) under one
|
||||
* or more contributor license agreements. See the NOTICE file
|
||||
* distributed with this work for additional information
|
||||
|
|
@ -34,15 +34,13 @@ import javax.ws.rs.core.UriBuilder;
|
|||
import javax.xml.ws.http.HTTPException;
|
||||
import org.apache.hadoop.conf.Configuration;
|
||||
import org.apache.hadoop.conf.Configured;
|
||||
import org.apache.hadoop.hbase.util.GsonUtil;
|
||||
import org.apache.hadoop.util.ReflectionUtils;
|
||||
import org.glassfish.jersey.client.authentication.HttpAuthenticationFeature;
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
|
||||
import org.apache.hbase.thirdparty.com.google.gson.Gson;
|
||||
import org.apache.hbase.thirdparty.com.google.gson.JsonElement;
|
||||
import org.apache.hbase.thirdparty.com.google.gson.JsonObject;
|
||||
import org.apache.hbase.thirdparty.com.google.gson.JsonParser;
|
||||
|
||||
/**
|
||||
* A ClusterManager implementation designed to control Cloudera Manager (http://www.cloudera.com)
|
||||
|
|
@ -77,7 +75,7 @@ public class RESTApiClusterManager extends Configured implements ClusterManager
|
|||
private static final String REST_API_CLUSTER_MANAGER_CLUSTER_NAME =
|
||||
"hbase.it.clustermanager.restapi.clustername";
|
||||
|
||||
private static final Gson GSON = GsonUtil.createGson().create();
|
||||
private static final JsonParser parser = new JsonParser();
|
||||
|
||||
// Some default values for the above properties.
|
||||
private static final String DEFAULT_SERVER_HOSTNAME = "http://localhost:7180";
|
||||
|
|
@ -114,7 +112,7 @@ public class RESTApiClusterManager extends Configured implements ClusterManager
|
|||
public void setConf(Configuration conf) {
|
||||
super.setConf(conf);
|
||||
if (conf == null) {
|
||||
// Configured gets passed null before real conf. Why? I don't know.
|
||||
// `Configured()` constructor calls `setConf(null)` before calling again with a real value.
|
||||
return;
|
||||
}
|
||||
serverHostname = conf.get(REST_API_CLUSTER_MANAGER_HOSTNAME, DEFAULT_SERVER_HOSTNAME);
|
||||
|
|
@ -238,16 +236,18 @@ public class RESTApiClusterManager extends Configured implements ClusterManager
|
|||
|
||||
// Execute GET against URI, returning a JsonNode object to be traversed.
|
||||
private JsonElement getJsonNodeFromURIGet(URI uri) throws IOException {
|
||||
LOG.info("Executing GET against " + uri + "...");
|
||||
WebTarget webTarget = client.target(uri);
|
||||
Invocation.Builder invocationBuilder = webTarget.request(MediaType.APPLICATION_JSON);
|
||||
Response response = invocationBuilder.get();
|
||||
LOG.debug("Executing GET against " + uri + "...");
|
||||
final Response response = client.target(uri)
|
||||
.request(MediaType.APPLICATION_JSON_TYPE)
|
||||
.get();
|
||||
int statusCode = response.getStatus();
|
||||
if (statusCode != Response.Status.OK.getStatusCode()) {
|
||||
throw new HTTPException(statusCode);
|
||||
}
|
||||
// This API folds information as the value to an "items" attribute.
|
||||
return GSON.toJsonTree(response.readEntity(String.class)).getAsJsonObject().get("items");
|
||||
return parser.parse(response.readEntity(String.class))
|
||||
.getAsJsonObject()
|
||||
.get("items");
|
||||
}
|
||||
|
||||
// This API assigns a unique role name to each host's instance of a role.
|
||||
|
|
@ -334,7 +334,7 @@ public class RESTApiClusterManager extends Configured implements ClusterManager
|
|||
roleServiceType.put(ServiceType.HBASE_REGIONSERVER, Service.HBASE);
|
||||
}
|
||||
|
||||
private enum Service {
|
||||
enum Service {
|
||||
HBASE, HDFS, MAPREDUCE
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -0,0 +1,130 @@
|
|||
/*
|
||||
* Licensed to the Apache Software Foundation (ASF) under one
|
||||
* or more contributor license agreements. See the NOTICE file
|
||||
* distributed with this work for additional information
|
||||
* regarding copyright ownership. The ASF licenses this file
|
||||
* to you 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 org.apache.hadoop.hbase;
|
||||
|
||||
import static org.junit.Assert.assertTrue;
|
||||
import java.io.IOException;
|
||||
import java.util.HashMap;
|
||||
import java.util.Map;
|
||||
import org.apache.hadoop.conf.Configuration;
|
||||
import org.apache.hadoop.hbase.ClusterManager.ServiceType;
|
||||
import org.apache.hadoop.hbase.RESTApiClusterManager.Service;
|
||||
import org.apache.hadoop.hbase.testclassification.SmallTests;
|
||||
import org.junit.Before;
|
||||
import org.junit.BeforeClass;
|
||||
import org.junit.ClassRule;
|
||||
import org.junit.Rule;
|
||||
import org.junit.Test;
|
||||
import org.junit.experimental.categories.Category;
|
||||
import org.junit.rules.TestName;
|
||||
|
||||
@Category(SmallTests.class)
|
||||
public class TestRESTApiClusterManager {
|
||||
|
||||
@ClassRule
|
||||
public static final HBaseClassTestRule testRule =
|
||||
HBaseClassTestRule.forClass(TestRESTApiClusterManager.class);
|
||||
|
||||
@ClassRule
|
||||
public static MockHttpApiRule mockHttpApi = new MockHttpApiRule();
|
||||
|
||||
@Rule
|
||||
public final TestName testName = new TestName();
|
||||
|
||||
private static HBaseCommonTestingUtility testingUtility;
|
||||
private ClusterManager clusterManager;
|
||||
|
||||
@BeforeClass
|
||||
public static void beforeClass() {
|
||||
testingUtility = new HBaseCommonTestingUtility();
|
||||
configureClusterManager(testingUtility.getConfiguration());
|
||||
}
|
||||
|
||||
@Before
|
||||
public void before() {
|
||||
mockHttpApi.clearRegistrations();
|
||||
final Configuration methodConf = new Configuration(testingUtility.getConfiguration());
|
||||
methodConf.set("hbase.it.clustermanager.restapi.clustername", testName.getMethodName());
|
||||
clusterManager = new RESTApiClusterManager();
|
||||
clusterManager.setConf(methodConf);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void isRunningPositive() throws IOException {
|
||||
final String clusterName = testName.getMethodName();
|
||||
final String hostName = "somehost";
|
||||
final String serviceName = "hbase";
|
||||
final String hostId = "some-id";
|
||||
registerServiceName(clusterName, Service.HBASE, serviceName);
|
||||
registerHost(hostName, hostId);
|
||||
final Map<String, String> hostProperties = new HashMap<>();
|
||||
hostProperties.put("roleState", "STARTED");
|
||||
hostProperties.put("healthSummary", "GOOD");
|
||||
registerHostProperties(
|
||||
clusterName, serviceName, hostId, ServiceType.HBASE_MASTER, hostProperties);
|
||||
assertTrue(clusterManager.isRunning(ServiceType.HBASE_MASTER, hostName, -1));
|
||||
}
|
||||
|
||||
private static void configureClusterManager(final Configuration conf) {
|
||||
conf.set("hbase.it.clustermanager.restapi.hostname", mockHttpApi.getURI().toString());
|
||||
}
|
||||
|
||||
private static void registerServiceName(
|
||||
final String clusterName,
|
||||
final Service service,
|
||||
final String serviceName
|
||||
) {
|
||||
final String target = String.format("^/api/v6/clusters/%s/services", clusterName);
|
||||
final String response = String.format(
|
||||
"{ \"items\": [ { \"type\": \"%s\", \"name\": \"%s\" } ] }", service, serviceName);
|
||||
mockHttpApi.registerOk(target, response);
|
||||
}
|
||||
|
||||
private static void registerHost(final String hostName, final String hostId) {
|
||||
final String target = "^/api/v6/hosts";
|
||||
final String response = String.format(
|
||||
"{ \"items\": [ { \"hostname\": \"%s\", \"hostId\": \"%s\" } ] }", hostName, hostId);
|
||||
mockHttpApi.registerOk(target, response);
|
||||
}
|
||||
|
||||
private static void registerHostProperties(
|
||||
final String clusterName,
|
||||
final String serviceName,
|
||||
final String hostId,
|
||||
final ServiceType serviceType,
|
||||
final Map<String, String> properties
|
||||
) {
|
||||
final String target = String.format(
|
||||
"^/api/v6/clusters/%s/services/%s/roles", clusterName, serviceName);
|
||||
final StringBuilder builder = new StringBuilder()
|
||||
.append("{ \"items\": [ ")
|
||||
.append("{ \"hostRef\": { \"hostId\": \"")
|
||||
.append(hostId)
|
||||
.append("\" }, \"type\": \"")
|
||||
.append(serviceType)
|
||||
.append("\"");
|
||||
properties.forEach((k, v) -> builder
|
||||
.append(", \"")
|
||||
.append(k)
|
||||
.append("\": \"")
|
||||
.append(v)
|
||||
.append("\""));
|
||||
builder.append(" } ] }");
|
||||
mockHttpApi.registerOk(target, builder.toString());
|
||||
}
|
||||
}
|
||||
Loading…
Reference in New Issue