blob: ff091aad591baca5ca468468eadf386d6edc8d40 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>Source code</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="source: package: org.apache.hadoop.hbase, class: MockHttpApiRule">
<meta name="generator" content="javadoc/SourceToHTMLConverter">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body class="source-page">
<main role="main">
<div class="source-container">
<pre><span class="source-line-no">001</span><span id="line-1">/*</span>
<span class="source-line-no">002</span><span id="line-2"> * Licensed to the Apache Software Foundation (ASF) under one</span>
<span class="source-line-no">003</span><span id="line-3"> * or more contributor license agreements. See the NOTICE file</span>
<span class="source-line-no">004</span><span id="line-4"> * distributed with this work for additional information</span>
<span class="source-line-no">005</span><span id="line-5"> * regarding copyright ownership. The ASF licenses this file</span>
<span class="source-line-no">006</span><span id="line-6"> * to you under the Apache License, Version 2.0 (the</span>
<span class="source-line-no">007</span><span id="line-7"> * "License"); you may not use this file except in compliance</span>
<span class="source-line-no">008</span><span id="line-8"> * with the License. You may obtain a copy of the License at</span>
<span class="source-line-no">009</span><span id="line-9"> *</span>
<span class="source-line-no">010</span><span id="line-10"> * http://www.apache.org/licenses/LICENSE-2.0</span>
<span class="source-line-no">011</span><span id="line-11"> *</span>
<span class="source-line-no">012</span><span id="line-12"> * Unless required by applicable law or agreed to in writing, software</span>
<span class="source-line-no">013</span><span id="line-13"> * distributed under the License is distributed on an "AS IS" BASIS,</span>
<span class="source-line-no">014</span><span id="line-14"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<span class="source-line-no">015</span><span id="line-15"> * See the License for the specific language governing permissions and</span>
<span class="source-line-no">016</span><span id="line-16"> * limitations under the License.</span>
<span class="source-line-no">017</span><span id="line-17"> */</span>
<span class="source-line-no">018</span><span id="line-18">package org.apache.hadoop.hbase;</span>
<span class="source-line-no">019</span><span id="line-19"></span>
<span class="source-line-no">020</span><span id="line-20">import java.io.IOException;</span>
<span class="source-line-no">021</span><span id="line-21">import java.io.PrintWriter;</span>
<span class="source-line-no">022</span><span id="line-22">import java.net.URI;</span>
<span class="source-line-no">023</span><span id="line-23">import java.util.HashMap;</span>
<span class="source-line-no">024</span><span id="line-24">import java.util.Map;</span>
<span class="source-line-no">025</span><span id="line-25">import java.util.concurrent.locks.ReadWriteLock;</span>
<span class="source-line-no">026</span><span id="line-26">import java.util.concurrent.locks.ReentrantReadWriteLock;</span>
<span class="source-line-no">027</span><span id="line-27">import java.util.function.BiConsumer;</span>
<span class="source-line-no">028</span><span id="line-28">import java.util.regex.Pattern;</span>
<span class="source-line-no">029</span><span id="line-29">import javax.servlet.http.HttpServletRequest;</span>
<span class="source-line-no">030</span><span id="line-30">import javax.servlet.http.HttpServletResponse;</span>
<span class="source-line-no">031</span><span id="line-31">import org.junit.rules.ExternalResource;</span>
<span class="source-line-no">032</span><span id="line-32">import org.slf4j.Logger;</span>
<span class="source-line-no">033</span><span id="line-33">import org.slf4j.LoggerFactory;</span>
<span class="source-line-no">034</span><span id="line-34"></span>
<span class="source-line-no">035</span><span id="line-35">import org.apache.hbase.thirdparty.javax.ws.rs.core.MediaType;</span>
<span class="source-line-no">036</span><span id="line-36">import org.apache.hbase.thirdparty.org.eclipse.jetty.server.Request;</span>
<span class="source-line-no">037</span><span id="line-37">import org.apache.hbase.thirdparty.org.eclipse.jetty.server.RequestLog;</span>
<span class="source-line-no">038</span><span id="line-38">import org.apache.hbase.thirdparty.org.eclipse.jetty.server.Server;</span>
<span class="source-line-no">039</span><span id="line-39">import org.apache.hbase.thirdparty.org.eclipse.jetty.server.ServerConnector;</span>
<span class="source-line-no">040</span><span id="line-40">import org.apache.hbase.thirdparty.org.eclipse.jetty.server.Slf4jRequestLog;</span>
<span class="source-line-no">041</span><span id="line-41">import org.apache.hbase.thirdparty.org.eclipse.jetty.server.handler.AbstractHandler;</span>
<span class="source-line-no">042</span><span id="line-42">import org.apache.hbase.thirdparty.org.eclipse.jetty.util.RegexSet;</span>
<span class="source-line-no">043</span><span id="line-43"></span>
<span class="source-line-no">044</span><span id="line-44">/**</span>
<span class="source-line-no">045</span><span id="line-45"> * A {@link org.junit.Rule} that manages a simple http server. The caller registers request handlers</span>
<span class="source-line-no">046</span><span id="line-46"> * to URI path regexp.</span>
<span class="source-line-no">047</span><span id="line-47"> */</span>
<span class="source-line-no">048</span><span id="line-48">public class MockHttpApiRule extends ExternalResource {</span>
<span class="source-line-no">049</span><span id="line-49"> private static final Logger LOG = LoggerFactory.getLogger(MockHttpApiRule.class);</span>
<span class="source-line-no">050</span><span id="line-50"></span>
<span class="source-line-no">051</span><span id="line-51"> private MockHandler handler;</span>
<span class="source-line-no">052</span><span id="line-52"> private Server server;</span>
<span class="source-line-no">053</span><span id="line-53"></span>
<span class="source-line-no">054</span><span id="line-54"> /**</span>
<span class="source-line-no">055</span><span id="line-55"> * Register a callback handler for the specified path target.</span>
<span class="source-line-no">056</span><span id="line-56"> */</span>
<span class="source-line-no">057</span><span id="line-57"> public MockHttpApiRule addRegistration(final String pathRegex,</span>
<span class="source-line-no">058</span><span id="line-58"> final BiConsumer&lt;String, HttpServletResponse&gt; responder) {</span>
<span class="source-line-no">059</span><span id="line-59"> handler.register(pathRegex, responder);</span>
<span class="source-line-no">060</span><span id="line-60"> return this;</span>
<span class="source-line-no">061</span><span id="line-61"> }</span>
<span class="source-line-no">062</span><span id="line-62"></span>
<span class="source-line-no">063</span><span id="line-63"> /**</span>
<span class="source-line-no">064</span><span id="line-64"> * Shortcut method for calling {@link #addRegistration(String, BiConsumer)} with a 200 response.</span>
<span class="source-line-no">065</span><span id="line-65"> */</span>
<span class="source-line-no">066</span><span id="line-66"> public MockHttpApiRule registerOk(final String pathRegex, final String responseBody) {</span>
<span class="source-line-no">067</span><span id="line-67"> return addRegistration(pathRegex, (target, resp) -&gt; {</span>
<span class="source-line-no">068</span><span id="line-68"> try {</span>
<span class="source-line-no">069</span><span id="line-69"> resp.setStatus(HttpServletResponse.SC_OK);</span>
<span class="source-line-no">070</span><span id="line-70"> resp.setCharacterEncoding("UTF-8");</span>
<span class="source-line-no">071</span><span id="line-71"> resp.setContentType(MediaType.APPLICATION_JSON_TYPE.toString());</span>
<span class="source-line-no">072</span><span id="line-72"> final PrintWriter writer = resp.getWriter();</span>
<span class="source-line-no">073</span><span id="line-73"> writer.write(responseBody);</span>
<span class="source-line-no">074</span><span id="line-74"> writer.flush();</span>
<span class="source-line-no">075</span><span id="line-75"> } catch (IOException e) {</span>
<span class="source-line-no">076</span><span id="line-76"> throw new RuntimeException(e);</span>
<span class="source-line-no">077</span><span id="line-77"> }</span>
<span class="source-line-no">078</span><span id="line-78"> });</span>
<span class="source-line-no">079</span><span id="line-79"> }</span>
<span class="source-line-no">080</span><span id="line-80"></span>
<span class="source-line-no">081</span><span id="line-81"> public void clearRegistrations() {</span>
<span class="source-line-no">082</span><span id="line-82"> handler.clearRegistrations();</span>
<span class="source-line-no">083</span><span id="line-83"> }</span>
<span class="source-line-no">084</span><span id="line-84"></span>
<span class="source-line-no">085</span><span id="line-85"> /**</span>
<span class="source-line-no">086</span><span id="line-86"> * Retrieve the service URI for this service.</span>
<span class="source-line-no">087</span><span id="line-87"> */</span>
<span class="source-line-no">088</span><span id="line-88"> public URI getURI() {</span>
<span class="source-line-no">089</span><span id="line-89"> if (server == null || !server.isRunning()) {</span>
<span class="source-line-no">090</span><span id="line-90"> throw new IllegalStateException("server is not running");</span>
<span class="source-line-no">091</span><span id="line-91"> }</span>
<span class="source-line-no">092</span><span id="line-92"> return server.getURI();</span>
<span class="source-line-no">093</span><span id="line-93"> }</span>
<span class="source-line-no">094</span><span id="line-94"></span>
<span class="source-line-no">095</span><span id="line-95"> @Override</span>
<span class="source-line-no">096</span><span id="line-96"> protected void before() throws Exception {</span>
<span class="source-line-no">097</span><span id="line-97"> handler = new MockHandler();</span>
<span class="source-line-no">098</span><span id="line-98"> server = new Server();</span>
<span class="source-line-no">099</span><span id="line-99"> final ServerConnector http = new ServerConnector(server);</span>
<span class="source-line-no">100</span><span id="line-100"> http.setHost("localhost");</span>
<span class="source-line-no">101</span><span id="line-101"> server.addConnector(http);</span>
<span class="source-line-no">102</span><span id="line-102"> server.setStopAtShutdown(true);</span>
<span class="source-line-no">103</span><span id="line-103"> server.setHandler(handler);</span>
<span class="source-line-no">104</span><span id="line-104"> server.setRequestLog(buildRequestLog());</span>
<span class="source-line-no">105</span><span id="line-105"> server.start();</span>
<span class="source-line-no">106</span><span id="line-106"> }</span>
<span class="source-line-no">107</span><span id="line-107"></span>
<span class="source-line-no">108</span><span id="line-108"> @Override</span>
<span class="source-line-no">109</span><span id="line-109"> protected void after() {</span>
<span class="source-line-no">110</span><span id="line-110"> try {</span>
<span class="source-line-no">111</span><span id="line-111"> server.stop();</span>
<span class="source-line-no">112</span><span id="line-112"> } catch (Exception e) {</span>
<span class="source-line-no">113</span><span id="line-113"> throw new RuntimeException(e);</span>
<span class="source-line-no">114</span><span id="line-114"> }</span>
<span class="source-line-no">115</span><span id="line-115"> }</span>
<span class="source-line-no">116</span><span id="line-116"></span>
<span class="source-line-no">117</span><span id="line-117"> private static RequestLog buildRequestLog() {</span>
<span class="source-line-no">118</span><span id="line-118"> final Slf4jRequestLog requestLog = new Slf4jRequestLog();</span>
<span class="source-line-no">119</span><span id="line-119"> requestLog.setLoggerName(LOG.getName() + ".RequestLog");</span>
<span class="source-line-no">120</span><span id="line-120"> requestLog.setExtended(true);</span>
<span class="source-line-no">121</span><span id="line-121"> return requestLog;</span>
<span class="source-line-no">122</span><span id="line-122"> }</span>
<span class="source-line-no">123</span><span id="line-123"></span>
<span class="source-line-no">124</span><span id="line-124"> private static class MockHandler extends AbstractHandler {</span>
<span class="source-line-no">125</span><span id="line-125"></span>
<span class="source-line-no">126</span><span id="line-126"> private final ReadWriteLock responseMappingLock = new ReentrantReadWriteLock();</span>
<span class="source-line-no">127</span><span id="line-127"> private final Map&lt;String, BiConsumer&lt;String, HttpServletResponse&gt;&gt; responseMapping =</span>
<span class="source-line-no">128</span><span id="line-128"> new HashMap&lt;&gt;();</span>
<span class="source-line-no">129</span><span id="line-129"> private final RegexSet regexSet = new RegexSet();</span>
<span class="source-line-no">130</span><span id="line-130"></span>
<span class="source-line-no">131</span><span id="line-131"> void register(final String pathRegex, final BiConsumer&lt;String, HttpServletResponse&gt; responder) {</span>
<span class="source-line-no">132</span><span id="line-132"> LOG.debug("Registering responder to '{}'", pathRegex);</span>
<span class="source-line-no">133</span><span id="line-133"> responseMappingLock.writeLock().lock();</span>
<span class="source-line-no">134</span><span id="line-134"> try {</span>
<span class="source-line-no">135</span><span id="line-135"> responseMapping.put(pathRegex, responder);</span>
<span class="source-line-no">136</span><span id="line-136"> regexSet.add(pathRegex);</span>
<span class="source-line-no">137</span><span id="line-137"> } finally {</span>
<span class="source-line-no">138</span><span id="line-138"> responseMappingLock.writeLock().unlock();</span>
<span class="source-line-no">139</span><span id="line-139"> }</span>
<span class="source-line-no">140</span><span id="line-140"> }</span>
<span class="source-line-no">141</span><span id="line-141"></span>
<span class="source-line-no">142</span><span id="line-142"> void clearRegistrations() {</span>
<span class="source-line-no">143</span><span id="line-143"> LOG.debug("Clearing registrations");</span>
<span class="source-line-no">144</span><span id="line-144"> responseMappingLock.writeLock().lock();</span>
<span class="source-line-no">145</span><span id="line-145"> try {</span>
<span class="source-line-no">146</span><span id="line-146"> responseMapping.clear();</span>
<span class="source-line-no">147</span><span id="line-147"> regexSet.clear();</span>
<span class="source-line-no">148</span><span id="line-148"> } finally {</span>
<span class="source-line-no">149</span><span id="line-149"> responseMappingLock.writeLock().unlock();</span>
<span class="source-line-no">150</span><span id="line-150"> }</span>
<span class="source-line-no">151</span><span id="line-151"> }</span>
<span class="source-line-no">152</span><span id="line-152"></span>
<span class="source-line-no">153</span><span id="line-153"> @Override</span>
<span class="source-line-no">154</span><span id="line-154"> public void handle(final String target, final Request baseRequest,</span>
<span class="source-line-no">155</span><span id="line-155"> final HttpServletRequest request, final HttpServletResponse response) {</span>
<span class="source-line-no">156</span><span id="line-156"> responseMappingLock.readLock().lock();</span>
<span class="source-line-no">157</span><span id="line-157"> try {</span>
<span class="source-line-no">158</span><span id="line-158"> if (!regexSet.matches(target)) {</span>
<span class="source-line-no">159</span><span id="line-159"> response.setStatus(HttpServletResponse.SC_NOT_FOUND);</span>
<span class="source-line-no">160</span><span id="line-160"> return;</span>
<span class="source-line-no">161</span><span id="line-161"> }</span>
<span class="source-line-no">162</span><span id="line-162"> responseMapping.entrySet().stream().filter(e -&gt; Pattern.matches(e.getKey(), target))</span>
<span class="source-line-no">163</span><span id="line-163"> .findAny().map(Map.Entry::getValue).orElseThrow(() -&gt; noMatchFound(target))</span>
<span class="source-line-no">164</span><span id="line-164"> .accept(target, response);</span>
<span class="source-line-no">165</span><span id="line-165"> } finally {</span>
<span class="source-line-no">166</span><span id="line-166"> responseMappingLock.readLock().unlock();</span>
<span class="source-line-no">167</span><span id="line-167"> }</span>
<span class="source-line-no">168</span><span id="line-168"> }</span>
<span class="source-line-no">169</span><span id="line-169"></span>
<span class="source-line-no">170</span><span id="line-170"> private static RuntimeException noMatchFound(final String target) {</span>
<span class="source-line-no">171</span><span id="line-171"> return new RuntimeException(</span>
<span class="source-line-no">172</span><span id="line-172"> String.format("Target path '%s' matches no registered regex.", target));</span>
<span class="source-line-no">173</span><span id="line-173"> }</span>
<span class="source-line-no">174</span><span id="line-174"> }</span>
<span class="source-line-no">175</span><span id="line-175">}</span>
</pre>
</div>
</main>
</body>
</html>