Google Git
Sign in
apache / hbase-site / 2e3aaee18b357604e6f6797bafb8e59d3025ccb0 / . / testdevapidocs / src-html / org / apache / hadoop / hbase / HBaseClassTestRule.html
blob: b86eeed9f1f67d8b87bdcc97570ee74ad2f94f0c [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a>
<span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a>
<span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a>
<span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a>
<span class="sourceLineNo">009</span> *<a name="line.9"></a>
<span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<span class="sourceLineNo">011</span> *<a name="line.11"></a>
<span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a>
<span class="sourceLineNo">013</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a>
<span class="sourceLineNo">014</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a>
<span class="sourceLineNo">015</span> * See the License for the specific language governing permissions and<a name="line.15"></a>
<span class="sourceLineNo">016</span> * limitations under the License.<a name="line.16"></a>
<span class="sourceLineNo">017</span> */<a name="line.17"></a>
<span class="sourceLineNo">018</span>package org.apache.hadoop.hbase;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>import edu.umd.cs.findbugs.annotations.NonNull;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.lang.reflect.InvocationTargetException;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.lang.reflect.Method;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.lang.reflect.Modifier;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.util.Arrays;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.util.Collection;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.util.Collections;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import java.util.List;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import java.util.Set;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import java.util.concurrent.TimeUnit;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.hadoop.hbase.testclassification.IntegrationTests;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.hadoop.hbase.testclassification.LargeTests;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.hadoop.hbase.testclassification.MediumTests;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.hadoop.hbase.testclassification.SmallTests;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.junit.experimental.categories.Category;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import org.junit.rules.TestRule;<a name="line.36"></a>
<span class="sourceLineNo">037</span>import org.junit.rules.Timeout;<a name="line.37"></a>
<span class="sourceLineNo">038</span>import org.junit.runner.Description;<a name="line.38"></a>
<span class="sourceLineNo">039</span>import org.junit.runner.RunWith;<a name="line.39"></a>
<span class="sourceLineNo">040</span>import org.junit.runners.Parameterized;<a name="line.40"></a>
<span class="sourceLineNo">041</span>import org.junit.runners.Parameterized.Parameters;<a name="line.41"></a>
<span class="sourceLineNo">042</span>import org.junit.runners.model.Statement;<a name="line.42"></a>
<span class="sourceLineNo">043</span>import org.slf4j.Logger;<a name="line.43"></a>
<span class="sourceLineNo">044</span>import org.slf4j.LoggerFactory;<a name="line.44"></a>
<span class="sourceLineNo">045</span>import org.apache.hbase.thirdparty.com.google.common.annotations.VisibleForTesting;<a name="line.45"></a>
<span class="sourceLineNo">046</span>import org.apache.hbase.thirdparty.com.google.common.collect.Iterables;<a name="line.46"></a>
<span class="sourceLineNo">047</span>import org.apache.hbase.thirdparty.com.google.common.collect.Sets;<a name="line.47"></a>
<span class="sourceLineNo">048</span><a name="line.48"></a>
<span class="sourceLineNo">049</span>/**<a name="line.49"></a>
<span class="sourceLineNo">050</span> * The class level TestRule for all the tests. Every test class should have a {@code ClassRule} with<a name="line.50"></a>
<span class="sourceLineNo">051</span> * it.<a name="line.51"></a>
<span class="sourceLineNo">052</span> * &lt;p&gt;<a name="line.52"></a>
<span class="sourceLineNo">053</span> * For now it only sets a test method timeout based off the test categories small, medium, large.<a name="line.53"></a>
<span class="sourceLineNo">054</span> * Based on junit Timeout TestRule; see https://github.com/junit-team/junit/wiki/Rules<a name="line.54"></a>
<span class="sourceLineNo">055</span> */<a name="line.55"></a>
<span class="sourceLineNo">056</span>@InterfaceAudience.Private<a name="line.56"></a>
<span class="sourceLineNo">057</span>public final class HBaseClassTestRule implements TestRule {<a name="line.57"></a>
<span class="sourceLineNo">058</span> private static final Logger LOG = LoggerFactory.getLogger(HBaseClassTestRule.class);<a name="line.58"></a>
<span class="sourceLineNo">059</span> public static final Set&lt;Class&lt;?&gt;&gt; UNIT_TEST_CLASSES = Collections.unmodifiableSet(<a name="line.59"></a>
<span class="sourceLineNo">060</span> Sets.&lt;Class&lt;?&gt;&gt; newHashSet(SmallTests.class, MediumTests.class, LargeTests.class));<a name="line.60"></a>
<span class="sourceLineNo">061</span><a name="line.61"></a>
<span class="sourceLineNo">062</span> // Each unit test has this timeout.<a name="line.62"></a>
<span class="sourceLineNo">063</span> private static long PER_UNIT_TEST_TIMEOUT_MINS = 13;<a name="line.63"></a>
<span class="sourceLineNo">064</span><a name="line.64"></a>
<span class="sourceLineNo">065</span> private final Class&lt;?&gt; clazz;<a name="line.65"></a>
<span class="sourceLineNo">066</span><a name="line.66"></a>
<span class="sourceLineNo">067</span> private final Timeout timeout;<a name="line.67"></a>
<span class="sourceLineNo">068</span><a name="line.68"></a>
<span class="sourceLineNo">069</span> private final SystemExitRule systemExitRule = new SystemExitRule();<a name="line.69"></a>
<span class="sourceLineNo">070</span><a name="line.70"></a>
<span class="sourceLineNo">071</span> private HBaseClassTestRule(Class&lt;?&gt; clazz, Timeout timeout) {<a name="line.71"></a>
<span class="sourceLineNo">072</span> this.clazz = clazz;<a name="line.72"></a>
<span class="sourceLineNo">073</span> this.timeout = timeout;<a name="line.73"></a>
<span class="sourceLineNo">074</span> }<a name="line.74"></a>
<span class="sourceLineNo">075</span><a name="line.75"></a>
<span class="sourceLineNo">076</span> /**<a name="line.76"></a>
<span class="sourceLineNo">077</span> * Mainly used for {@link HBaseClassTestRuleChecker} to confirm that we use the correct<a name="line.77"></a>
<span class="sourceLineNo">078</span> * class to generate timeout ClassRule.<a name="line.78"></a>
<span class="sourceLineNo">079</span> */<a name="line.79"></a>
<span class="sourceLineNo">080</span> public Class&lt;?&gt; getClazz() {<a name="line.80"></a>
<span class="sourceLineNo">081</span> return clazz;<a name="line.81"></a>
<span class="sourceLineNo">082</span> }<a name="line.82"></a>
<span class="sourceLineNo">083</span><a name="line.83"></a>
<span class="sourceLineNo">084</span> private static long getTimeoutInSeconds(Class&lt;?&gt; clazz) {<a name="line.84"></a>
<span class="sourceLineNo">085</span> Category[] categories = clazz.getAnnotationsByType(Category.class);<a name="line.85"></a>
<span class="sourceLineNo">086</span> // Starting JUnit 4.13, it appears that the timeout is applied across all the parameterized<a name="line.86"></a>
<span class="sourceLineNo">087</span> // runs. So the timeout is multiplied by number of parameterized runs.<a name="line.87"></a>
<span class="sourceLineNo">088</span> int numParams = getNumParameters(clazz);<a name="line.88"></a>
<span class="sourceLineNo">089</span> // @Category is not repeatable -- it is only possible to get an array of length zero or one.<a name="line.89"></a>
<span class="sourceLineNo">090</span> if (categories.length == 1) {<a name="line.90"></a>
<span class="sourceLineNo">091</span> for (Class&lt;?&gt; c : categories[0].value()) {<a name="line.91"></a>
<span class="sourceLineNo">092</span> if (UNIT_TEST_CLASSES.contains(c)) {<a name="line.92"></a>
<span class="sourceLineNo">093</span> long timeout = numParams * PER_UNIT_TEST_TIMEOUT_MINS;<a name="line.93"></a>
<span class="sourceLineNo">094</span> LOG.info("Test {} timeout: {} mins", clazz, timeout);<a name="line.94"></a>
<span class="sourceLineNo">095</span> return TimeUnit.MINUTES.toSeconds(timeout);<a name="line.95"></a>
<span class="sourceLineNo">096</span> }<a name="line.96"></a>
<span class="sourceLineNo">097</span> if (c == IntegrationTests.class) {<a name="line.97"></a>
<span class="sourceLineNo">098</span> return TimeUnit.MINUTES.toSeconds(Long.MAX_VALUE);<a name="line.98"></a>
<span class="sourceLineNo">099</span> }<a name="line.99"></a>
<span class="sourceLineNo">100</span> }<a name="line.100"></a>
<span class="sourceLineNo">101</span> }<a name="line.101"></a>
<span class="sourceLineNo">102</span> throw new IllegalArgumentException(<a name="line.102"></a>
<span class="sourceLineNo">103</span> clazz.getName() + " does not have SmallTests/MediumTests/LargeTests in @Category");<a name="line.103"></a>
<span class="sourceLineNo">104</span> }<a name="line.104"></a>
<span class="sourceLineNo">105</span><a name="line.105"></a>
<span class="sourceLineNo">106</span> /**<a name="line.106"></a>
<span class="sourceLineNo">107</span> * @param clazz Test class that is running.<a name="line.107"></a>
<span class="sourceLineNo">108</span> * @return the number of parameters for this given test class. If the test is not parameterized or<a name="line.108"></a>
<span class="sourceLineNo">109</span> * if there is any issue determining the number of parameters, returns 1.<a name="line.109"></a>
<span class="sourceLineNo">110</span> */<a name="line.110"></a>
<span class="sourceLineNo">111</span> @VisibleForTesting<a name="line.111"></a>
<span class="sourceLineNo">112</span> static int getNumParameters(Class&lt;?&gt; clazz) {<a name="line.112"></a>
<span class="sourceLineNo">113</span> RunWith[] runWiths = clazz.getAnnotationsByType(RunWith.class);<a name="line.113"></a>
<span class="sourceLineNo">114</span> boolean testParameterized = runWiths != null &amp;&amp; Arrays.stream(runWiths).anyMatch(<a name="line.114"></a>
<span class="sourceLineNo">115</span> (r) -&gt; r.value().equals(Parameterized.class));<a name="line.115"></a>
<span class="sourceLineNo">116</span> if (!testParameterized) {<a name="line.116"></a>
<span class="sourceLineNo">117</span> return 1;<a name="line.117"></a>
<span class="sourceLineNo">118</span> }<a name="line.118"></a>
<span class="sourceLineNo">119</span> for (Method method : clazz.getMethods()) {<a name="line.119"></a>
<span class="sourceLineNo">120</span> if (!isParametersMethod(method)) {<a name="line.120"></a>
<span class="sourceLineNo">121</span> continue;<a name="line.121"></a>
<span class="sourceLineNo">122</span> }<a name="line.122"></a>
<span class="sourceLineNo">123</span> // Found the parameters method. Figure out the number of parameters.<a name="line.123"></a>
<span class="sourceLineNo">124</span> Object parameters;<a name="line.124"></a>
<span class="sourceLineNo">125</span> try {<a name="line.125"></a>
<span class="sourceLineNo">126</span> parameters = method.invoke(clazz);<a name="line.126"></a>
<span class="sourceLineNo">127</span> } catch (IllegalAccessException | InvocationTargetException e) {<a name="line.127"></a>
<span class="sourceLineNo">128</span> LOG.warn("Error invoking parameters method {} in test class {}",<a name="line.128"></a>
<span class="sourceLineNo">129</span> method.getName(), clazz, e);<a name="line.129"></a>
<span class="sourceLineNo">130</span> continue;<a name="line.130"></a>
<span class="sourceLineNo">131</span> }<a name="line.131"></a>
<span class="sourceLineNo">132</span> if (parameters instanceof List) {<a name="line.132"></a>
<span class="sourceLineNo">133</span> return ((List) parameters).size();<a name="line.133"></a>
<span class="sourceLineNo">134</span> } else if (parameters instanceof Collection) {<a name="line.134"></a>
<span class="sourceLineNo">135</span> return ((Collection) parameters).size();<a name="line.135"></a>
<span class="sourceLineNo">136</span> } else if (parameters instanceof Iterable) {<a name="line.136"></a>
<span class="sourceLineNo">137</span> return Iterables.size((Iterable) parameters);<a name="line.137"></a>
<span class="sourceLineNo">138</span> } else if (parameters instanceof Object[]) {<a name="line.138"></a>
<span class="sourceLineNo">139</span> return ((Object[]) parameters).length;<a name="line.139"></a>
<span class="sourceLineNo">140</span> }<a name="line.140"></a>
<span class="sourceLineNo">141</span> }<a name="line.141"></a>
<span class="sourceLineNo">142</span> LOG.warn("Unable to determine parameters size. Returning the default of 1.");<a name="line.142"></a>
<span class="sourceLineNo">143</span> return 1;<a name="line.143"></a>
<span class="sourceLineNo">144</span> }<a name="line.144"></a>
<span class="sourceLineNo">145</span><a name="line.145"></a>
<span class="sourceLineNo">146</span> /**<a name="line.146"></a>
<span class="sourceLineNo">147</span> * Helper method that checks if the input method is a valid JUnit @Parameters method.<a name="line.147"></a>
<span class="sourceLineNo">148</span> * @param method Input method.<a name="line.148"></a>
<span class="sourceLineNo">149</span> * @return true if the method is a valid JUnit parameters method, false otherwise.<a name="line.149"></a>
<span class="sourceLineNo">150</span> */<a name="line.150"></a>
<span class="sourceLineNo">151</span> private static boolean isParametersMethod(@NonNull Method method) {<a name="line.151"></a>
<span class="sourceLineNo">152</span> // A valid parameters method is public static and with @Parameters annotation.<a name="line.152"></a>
<span class="sourceLineNo">153</span> boolean methodPublicStatic = Modifier.isPublic(method.getModifiers()) &amp;&amp;<a name="line.153"></a>
<span class="sourceLineNo">154</span> Modifier.isStatic(method.getModifiers());<a name="line.154"></a>
<span class="sourceLineNo">155</span> Parameters[] params = method.getAnnotationsByType(Parameters.class);<a name="line.155"></a>
<span class="sourceLineNo">156</span> return methodPublicStatic &amp;&amp; (params != null &amp;&amp; params.length &gt; 0);<a name="line.156"></a>
<span class="sourceLineNo">157</span> }<a name="line.157"></a>
<span class="sourceLineNo">158</span><a name="line.158"></a>
<span class="sourceLineNo">159</span> public static HBaseClassTestRule forClass(Class&lt;?&gt; clazz) {<a name="line.159"></a>
<span class="sourceLineNo">160</span> return new HBaseClassTestRule(clazz, Timeout.builder().withLookingForStuckThread(true)<a name="line.160"></a>
<span class="sourceLineNo">161</span> .withTimeout(getTimeoutInSeconds(clazz), TimeUnit.SECONDS).build());<a name="line.161"></a>
<span class="sourceLineNo">162</span> }<a name="line.162"></a>
<span class="sourceLineNo">163</span><a name="line.163"></a>
<span class="sourceLineNo">164</span> @Override<a name="line.164"></a>
<span class="sourceLineNo">165</span> public Statement apply(Statement base, Description description) {<a name="line.165"></a>
<span class="sourceLineNo">166</span> return timeout.apply(systemExitRule.apply(base, description), description);<a name="line.166"></a>
<span class="sourceLineNo">167</span> }<a name="line.167"></a>
<span class="sourceLineNo">168</span><a name="line.168"></a>
<span class="sourceLineNo">169</span>}<a name="line.169"></a>
</pre>
</div>
</body>
</html>