/usr/share/doc/junit4/api/src-html/org/junit/runners/BlockJUnit4ClassRunner.html is in junit4-doc 4.12-6.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 | <!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>package org.junit.runners;<a name="line.1"></a>
<span class="sourceLineNo">002</span><a name="line.2"></a>
<span class="sourceLineNo">003</span>import static org.junit.internal.runners.rules.RuleMemberValidator.RULE_METHOD_VALIDATOR;<a name="line.3"></a>
<span class="sourceLineNo">004</span>import static org.junit.internal.runners.rules.RuleMemberValidator.RULE_VALIDATOR;<a name="line.4"></a>
<span class="sourceLineNo">005</span><a name="line.5"></a>
<span class="sourceLineNo">006</span>import java.util.List;<a name="line.6"></a>
<span class="sourceLineNo">007</span>import java.util.concurrent.ConcurrentHashMap;<a name="line.7"></a>
<span class="sourceLineNo">008</span>import java.util.concurrent.TimeUnit;<a name="line.8"></a>
<span class="sourceLineNo">009</span><a name="line.9"></a>
<span class="sourceLineNo">010</span>import org.junit.After;<a name="line.10"></a>
<span class="sourceLineNo">011</span>import org.junit.Before;<a name="line.11"></a>
<span class="sourceLineNo">012</span>import org.junit.Ignore;<a name="line.12"></a>
<span class="sourceLineNo">013</span>import org.junit.Rule;<a name="line.13"></a>
<span class="sourceLineNo">014</span>import org.junit.Test;<a name="line.14"></a>
<span class="sourceLineNo">015</span>import org.junit.Test.None;<a name="line.15"></a>
<span class="sourceLineNo">016</span>import org.junit.internal.runners.model.ReflectiveCallable;<a name="line.16"></a>
<span class="sourceLineNo">017</span>import org.junit.internal.runners.statements.ExpectException;<a name="line.17"></a>
<span class="sourceLineNo">018</span>import org.junit.internal.runners.statements.Fail;<a name="line.18"></a>
<span class="sourceLineNo">019</span>import org.junit.internal.runners.statements.FailOnTimeout;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import org.junit.internal.runners.statements.InvokeMethod;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import org.junit.internal.runners.statements.RunAfters;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import org.junit.internal.runners.statements.RunBefores;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.junit.rules.MethodRule;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.junit.rules.RunRules;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.junit.rules.TestRule;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.junit.runner.Description;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.junit.runner.notification.RunNotifier;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.junit.runners.model.FrameworkMethod;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.junit.runners.model.InitializationError;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.junit.runners.model.MultipleFailureException;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.junit.runners.model.Statement;<a name="line.31"></a>
<span class="sourceLineNo">032</span><a name="line.32"></a>
<span class="sourceLineNo">033</span>/**<a name="line.33"></a>
<span class="sourceLineNo">034</span> * Implements the JUnit 4 standard test case class model, as defined by the<a name="line.34"></a>
<span class="sourceLineNo">035</span> * annotations in the org.junit package. Many users will never notice this<a name="line.35"></a>
<span class="sourceLineNo">036</span> * class: it is now the default test class runner, but it should have exactly<a name="line.36"></a>
<span class="sourceLineNo">037</span> * the same behavior as the old test class runner ({@code JUnit4ClassRunner}).<a name="line.37"></a>
<span class="sourceLineNo">038</span> * <p><a name="line.38"></a>
<span class="sourceLineNo">039</span> * BlockJUnit4ClassRunner has advantages for writers of custom JUnit runners<a name="line.39"></a>
<span class="sourceLineNo">040</span> * that are slight changes to the default behavior, however:<a name="line.40"></a>
<span class="sourceLineNo">041</span> *<a name="line.41"></a>
<span class="sourceLineNo">042</span> * <ul><a name="line.42"></a>
<span class="sourceLineNo">043</span> * <li>It has a much simpler implementation based on {@link Statement}s,<a name="line.43"></a>
<span class="sourceLineNo">044</span> * allowing new operations to be inserted into the appropriate point in the<a name="line.44"></a>
<span class="sourceLineNo">045</span> * execution flow.<a name="line.45"></a>
<span class="sourceLineNo">046</span> *<a name="line.46"></a>
<span class="sourceLineNo">047</span> * <li>It is published, and extension and reuse are encouraged, whereas {@code<a name="line.47"></a>
<span class="sourceLineNo">048</span> * JUnit4ClassRunner} was in an internal package, and is now deprecated.<a name="line.48"></a>
<span class="sourceLineNo">049</span> * </ul><a name="line.49"></a>
<span class="sourceLineNo">050</span> * <p><a name="line.50"></a>
<span class="sourceLineNo">051</span> * In turn, in 2009 we introduced {@link Rule}s. In many cases where extending<a name="line.51"></a>
<span class="sourceLineNo">052</span> * BlockJUnit4ClassRunner was necessary to add new behavior, {@link Rule}s can<a name="line.52"></a>
<span class="sourceLineNo">053</span> * be used, which makes the extension more reusable and composable.<a name="line.53"></a>
<span class="sourceLineNo">054</span> *<a name="line.54"></a>
<span class="sourceLineNo">055</span> * @since 4.5<a name="line.55"></a>
<span class="sourceLineNo">056</span> */<a name="line.56"></a>
<span class="sourceLineNo">057</span>public class BlockJUnit4ClassRunner extends ParentRunner<FrameworkMethod> {<a name="line.57"></a>
<span class="sourceLineNo">058</span> private final ConcurrentHashMap<FrameworkMethod, Description> methodDescriptions = new ConcurrentHashMap<FrameworkMethod, Description>();<a name="line.58"></a>
<span class="sourceLineNo">059</span> /**<a name="line.59"></a>
<span class="sourceLineNo">060</span> * Creates a BlockJUnit4ClassRunner to run {@code klass}<a name="line.60"></a>
<span class="sourceLineNo">061</span> *<a name="line.61"></a>
<span class="sourceLineNo">062</span> * @throws InitializationError if the test class is malformed.<a name="line.62"></a>
<span class="sourceLineNo">063</span> */<a name="line.63"></a>
<span class="sourceLineNo">064</span> public BlockJUnit4ClassRunner(Class<?> klass) throws InitializationError {<a name="line.64"></a>
<span class="sourceLineNo">065</span> super(klass);<a name="line.65"></a>
<span class="sourceLineNo">066</span> }<a name="line.66"></a>
<span class="sourceLineNo">067</span><a name="line.67"></a>
<span class="sourceLineNo">068</span> //<a name="line.68"></a>
<span class="sourceLineNo">069</span> // Implementation of ParentRunner<a name="line.69"></a>
<span class="sourceLineNo">070</span> //<a name="line.70"></a>
<span class="sourceLineNo">071</span><a name="line.71"></a>
<span class="sourceLineNo">072</span> @Override<a name="line.72"></a>
<span class="sourceLineNo">073</span> protected void runChild(final FrameworkMethod method, RunNotifier notifier) {<a name="line.73"></a>
<span class="sourceLineNo">074</span> Description description = describeChild(method);<a name="line.74"></a>
<span class="sourceLineNo">075</span> if (isIgnored(method)) {<a name="line.75"></a>
<span class="sourceLineNo">076</span> notifier.fireTestIgnored(description);<a name="line.76"></a>
<span class="sourceLineNo">077</span> } else {<a name="line.77"></a>
<span class="sourceLineNo">078</span> runLeaf(methodBlock(method), description, notifier);<a name="line.78"></a>
<span class="sourceLineNo">079</span> }<a name="line.79"></a>
<span class="sourceLineNo">080</span> }<a name="line.80"></a>
<span class="sourceLineNo">081</span> <a name="line.81"></a>
<span class="sourceLineNo">082</span> /**<a name="line.82"></a>
<span class="sourceLineNo">083</span> * Evaluates whether {@link FrameworkMethod}s are ignored based on the<a name="line.83"></a>
<span class="sourceLineNo">084</span> * {@link Ignore} annotation.<a name="line.84"></a>
<span class="sourceLineNo">085</span> */<a name="line.85"></a>
<span class="sourceLineNo">086</span> @Override<a name="line.86"></a>
<span class="sourceLineNo">087</span> protected boolean isIgnored(FrameworkMethod child) {<a name="line.87"></a>
<span class="sourceLineNo">088</span> return child.getAnnotation(Ignore.class) != null;<a name="line.88"></a>
<span class="sourceLineNo">089</span> }<a name="line.89"></a>
<span class="sourceLineNo">090</span><a name="line.90"></a>
<span class="sourceLineNo">091</span> @Override<a name="line.91"></a>
<span class="sourceLineNo">092</span> protected Description describeChild(FrameworkMethod method) {<a name="line.92"></a>
<span class="sourceLineNo">093</span> Description description = methodDescriptions.get(method);<a name="line.93"></a>
<span class="sourceLineNo">094</span><a name="line.94"></a>
<span class="sourceLineNo">095</span> if (description == null) {<a name="line.95"></a>
<span class="sourceLineNo">096</span> description = Description.createTestDescription(getTestClass().getJavaClass(),<a name="line.96"></a>
<span class="sourceLineNo">097</span> testName(method), method.getAnnotations());<a name="line.97"></a>
<span class="sourceLineNo">098</span> methodDescriptions.putIfAbsent(method, description);<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> return description;<a name="line.101"></a>
<span class="sourceLineNo">102</span> }<a name="line.102"></a>
<span class="sourceLineNo">103</span><a name="line.103"></a>
<span class="sourceLineNo">104</span> @Override<a name="line.104"></a>
<span class="sourceLineNo">105</span> protected List<FrameworkMethod> getChildren() {<a name="line.105"></a>
<span class="sourceLineNo">106</span> return computeTestMethods();<a name="line.106"></a>
<span class="sourceLineNo">107</span> }<a name="line.107"></a>
<span class="sourceLineNo">108</span><a name="line.108"></a>
<span class="sourceLineNo">109</span> //<a name="line.109"></a>
<span class="sourceLineNo">110</span> // Override in subclasses<a name="line.110"></a>
<span class="sourceLineNo">111</span> //<a name="line.111"></a>
<span class="sourceLineNo">112</span><a name="line.112"></a>
<span class="sourceLineNo">113</span> /**<a name="line.113"></a>
<span class="sourceLineNo">114</span> * Returns the methods that run tests. Default implementation returns all<a name="line.114"></a>
<span class="sourceLineNo">115</span> * methods annotated with {@code @Test} on this class and superclasses that<a name="line.115"></a>
<span class="sourceLineNo">116</span> * are not overridden.<a name="line.116"></a>
<span class="sourceLineNo">117</span> */<a name="line.117"></a>
<span class="sourceLineNo">118</span> protected List<FrameworkMethod> computeTestMethods() {<a name="line.118"></a>
<span class="sourceLineNo">119</span> return getTestClass().getAnnotatedMethods(Test.class);<a name="line.119"></a>
<span class="sourceLineNo">120</span> }<a name="line.120"></a>
<span class="sourceLineNo">121</span><a name="line.121"></a>
<span class="sourceLineNo">122</span> @Override<a name="line.122"></a>
<span class="sourceLineNo">123</span> protected void collectInitializationErrors(List<Throwable> errors) {<a name="line.123"></a>
<span class="sourceLineNo">124</span> super.collectInitializationErrors(errors);<a name="line.124"></a>
<span class="sourceLineNo">125</span><a name="line.125"></a>
<span class="sourceLineNo">126</span> validateNoNonStaticInnerClass(errors);<a name="line.126"></a>
<span class="sourceLineNo">127</span> validateConstructor(errors);<a name="line.127"></a>
<span class="sourceLineNo">128</span> validateInstanceMethods(errors);<a name="line.128"></a>
<span class="sourceLineNo">129</span> validateFields(errors);<a name="line.129"></a>
<span class="sourceLineNo">130</span> validateMethods(errors);<a name="line.130"></a>
<span class="sourceLineNo">131</span> }<a name="line.131"></a>
<span class="sourceLineNo">132</span><a name="line.132"></a>
<span class="sourceLineNo">133</span> protected void validateNoNonStaticInnerClass(List<Throwable> errors) {<a name="line.133"></a>
<span class="sourceLineNo">134</span> if (getTestClass().isANonStaticInnerClass()) {<a name="line.134"></a>
<span class="sourceLineNo">135</span> String gripe = "The inner class " + getTestClass().getName()<a name="line.135"></a>
<span class="sourceLineNo">136</span> + " is not static.";<a name="line.136"></a>
<span class="sourceLineNo">137</span> errors.add(new Exception(gripe));<a name="line.137"></a>
<span class="sourceLineNo">138</span> }<a name="line.138"></a>
<span class="sourceLineNo">139</span> }<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> * Adds to {@code errors} if the test class has more than one constructor,<a name="line.142"></a>
<span class="sourceLineNo">143</span> * or if the constructor takes parameters. Override if a subclass requires<a name="line.143"></a>
<span class="sourceLineNo">144</span> * different validation rules.<a name="line.144"></a>
<span class="sourceLineNo">145</span> */<a name="line.145"></a>
<span class="sourceLineNo">146</span> protected void validateConstructor(List<Throwable> errors) {<a name="line.146"></a>
<span class="sourceLineNo">147</span> validateOnlyOneConstructor(errors);<a name="line.147"></a>
<span class="sourceLineNo">148</span> validateZeroArgConstructor(errors);<a name="line.148"></a>
<span class="sourceLineNo">149</span> }<a name="line.149"></a>
<span class="sourceLineNo">150</span><a name="line.150"></a>
<span class="sourceLineNo">151</span> /**<a name="line.151"></a>
<span class="sourceLineNo">152</span> * Adds to {@code errors} if the test class has more than one constructor<a name="line.152"></a>
<span class="sourceLineNo">153</span> * (do not override)<a name="line.153"></a>
<span class="sourceLineNo">154</span> */<a name="line.154"></a>
<span class="sourceLineNo">155</span> protected void validateOnlyOneConstructor(List<Throwable> errors) {<a name="line.155"></a>
<span class="sourceLineNo">156</span> if (!hasOneConstructor()) {<a name="line.156"></a>
<span class="sourceLineNo">157</span> String gripe = "Test class should have exactly one public constructor";<a name="line.157"></a>
<span class="sourceLineNo">158</span> errors.add(new Exception(gripe));<a name="line.158"></a>
<span class="sourceLineNo">159</span> }<a name="line.159"></a>
<span class="sourceLineNo">160</span> }<a name="line.160"></a>
<span class="sourceLineNo">161</span><a name="line.161"></a>
<span class="sourceLineNo">162</span> /**<a name="line.162"></a>
<span class="sourceLineNo">163</span> * Adds to {@code errors} if the test class's single constructor takes<a name="line.163"></a>
<span class="sourceLineNo">164</span> * parameters (do not override)<a name="line.164"></a>
<span class="sourceLineNo">165</span> */<a name="line.165"></a>
<span class="sourceLineNo">166</span> protected void validateZeroArgConstructor(List<Throwable> errors) {<a name="line.166"></a>
<span class="sourceLineNo">167</span> if (!getTestClass().isANonStaticInnerClass()<a name="line.167"></a>
<span class="sourceLineNo">168</span> && hasOneConstructor()<a name="line.168"></a>
<span class="sourceLineNo">169</span> && (getTestClass().getOnlyConstructor().getParameterTypes().length != 0)) {<a name="line.169"></a>
<span class="sourceLineNo">170</span> String gripe = "Test class should have exactly one public zero-argument constructor";<a name="line.170"></a>
<span class="sourceLineNo">171</span> errors.add(new Exception(gripe));<a name="line.171"></a>
<span class="sourceLineNo">172</span> }<a name="line.172"></a>
<span class="sourceLineNo">173</span> }<a name="line.173"></a>
<span class="sourceLineNo">174</span><a name="line.174"></a>
<span class="sourceLineNo">175</span> private boolean hasOneConstructor() {<a name="line.175"></a>
<span class="sourceLineNo">176</span> return getTestClass().getJavaClass().getConstructors().length == 1;<a name="line.176"></a>
<span class="sourceLineNo">177</span> }<a name="line.177"></a>
<span class="sourceLineNo">178</span><a name="line.178"></a>
<span class="sourceLineNo">179</span> /**<a name="line.179"></a>
<span class="sourceLineNo">180</span> * Adds to {@code errors} for each method annotated with {@code @Test},<a name="line.180"></a>
<span class="sourceLineNo">181</span> * {@code @Before}, or {@code @After} that is not a public, void instance<a name="line.181"></a>
<span class="sourceLineNo">182</span> * method with no arguments.<a name="line.182"></a>
<span class="sourceLineNo">183</span> */<a name="line.183"></a>
<span class="sourceLineNo">184</span> @Deprecated<a name="line.184"></a>
<span class="sourceLineNo">185</span> protected void validateInstanceMethods(List<Throwable> errors) {<a name="line.185"></a>
<span class="sourceLineNo">186</span> validatePublicVoidNoArgMethods(After.class, false, errors);<a name="line.186"></a>
<span class="sourceLineNo">187</span> validatePublicVoidNoArgMethods(Before.class, false, errors);<a name="line.187"></a>
<span class="sourceLineNo">188</span> validateTestMethods(errors);<a name="line.188"></a>
<span class="sourceLineNo">189</span><a name="line.189"></a>
<span class="sourceLineNo">190</span> if (computeTestMethods().size() == 0) {<a name="line.190"></a>
<span class="sourceLineNo">191</span> errors.add(new Exception("No runnable methods"));<a name="line.191"></a>
<span class="sourceLineNo">192</span> }<a name="line.192"></a>
<span class="sourceLineNo">193</span> }<a name="line.193"></a>
<span class="sourceLineNo">194</span><a name="line.194"></a>
<span class="sourceLineNo">195</span> protected void validateFields(List<Throwable> errors) {<a name="line.195"></a>
<span class="sourceLineNo">196</span> RULE_VALIDATOR.validate(getTestClass(), errors);<a name="line.196"></a>
<span class="sourceLineNo">197</span> }<a name="line.197"></a>
<span class="sourceLineNo">198</span><a name="line.198"></a>
<span class="sourceLineNo">199</span> private void validateMethods(List<Throwable> errors) {<a name="line.199"></a>
<span class="sourceLineNo">200</span> RULE_METHOD_VALIDATOR.validate(getTestClass(), errors);<a name="line.200"></a>
<span class="sourceLineNo">201</span> }<a name="line.201"></a>
<span class="sourceLineNo">202</span><a name="line.202"></a>
<span class="sourceLineNo">203</span> /**<a name="line.203"></a>
<span class="sourceLineNo">204</span> * Adds to {@code errors} for each method annotated with {@code @Test}that<a name="line.204"></a>
<span class="sourceLineNo">205</span> * is not a public, void instance method with no arguments.<a name="line.205"></a>
<span class="sourceLineNo">206</span> */<a name="line.206"></a>
<span class="sourceLineNo">207</span> protected void validateTestMethods(List<Throwable> errors) {<a name="line.207"></a>
<span class="sourceLineNo">208</span> validatePublicVoidNoArgMethods(Test.class, false, errors);<a name="line.208"></a>
<span class="sourceLineNo">209</span> }<a name="line.209"></a>
<span class="sourceLineNo">210</span><a name="line.210"></a>
<span class="sourceLineNo">211</span> /**<a name="line.211"></a>
<span class="sourceLineNo">212</span> * Returns a new fixture for running a test. Default implementation executes<a name="line.212"></a>
<span class="sourceLineNo">213</span> * the test class's no-argument constructor (validation should have ensured<a name="line.213"></a>
<span class="sourceLineNo">214</span> * one exists).<a name="line.214"></a>
<span class="sourceLineNo">215</span> */<a name="line.215"></a>
<span class="sourceLineNo">216</span> protected Object createTest() throws Exception {<a name="line.216"></a>
<span class="sourceLineNo">217</span> return getTestClass().getOnlyConstructor().newInstance();<a name="line.217"></a>
<span class="sourceLineNo">218</span> }<a name="line.218"></a>
<span class="sourceLineNo">219</span><a name="line.219"></a>
<span class="sourceLineNo">220</span> /**<a name="line.220"></a>
<span class="sourceLineNo">221</span> * Returns the name that describes {@code method} for {@link Description}s.<a name="line.221"></a>
<span class="sourceLineNo">222</span> * Default implementation is the method's name<a name="line.222"></a>
<span class="sourceLineNo">223</span> */<a name="line.223"></a>
<span class="sourceLineNo">224</span> protected String testName(FrameworkMethod method) {<a name="line.224"></a>
<span class="sourceLineNo">225</span> return method.getName();<a name="line.225"></a>
<span class="sourceLineNo">226</span> }<a name="line.226"></a>
<span class="sourceLineNo">227</span><a name="line.227"></a>
<span class="sourceLineNo">228</span> /**<a name="line.228"></a>
<span class="sourceLineNo">229</span> * Returns a Statement that, when executed, either returns normally if<a name="line.229"></a>
<span class="sourceLineNo">230</span> * {@code method} passes, or throws an exception if {@code method} fails.<a name="line.230"></a>
<span class="sourceLineNo">231</span> *<a name="line.231"></a>
<span class="sourceLineNo">232</span> * Here is an outline of the default implementation:<a name="line.232"></a>
<span class="sourceLineNo">233</span> *<a name="line.233"></a>
<span class="sourceLineNo">234</span> * <ul><a name="line.234"></a>
<span class="sourceLineNo">235</span> * <li>Invoke {@code method} on the result of {@code createTest()}, and<a name="line.235"></a>
<span class="sourceLineNo">236</span> * throw any exceptions thrown by either operation.<a name="line.236"></a>
<span class="sourceLineNo">237</span> * <li>HOWEVER, if {@code method}'s {@code @Test} annotation has the {@code<a name="line.237"></a>
<span class="sourceLineNo">238</span> * expecting} attribute, return normally only if the previous step threw an<a name="line.238"></a>
<span class="sourceLineNo">239</span> * exception of the correct type, and throw an exception otherwise.<a name="line.239"></a>
<span class="sourceLineNo">240</span> * <li>HOWEVER, if {@code method}'s {@code @Test} annotation has the {@code<a name="line.240"></a>
<span class="sourceLineNo">241</span> * timeout} attribute, throw an exception if the previous step takes more<a name="line.241"></a>
<span class="sourceLineNo">242</span> * than the specified number of milliseconds.<a name="line.242"></a>
<span class="sourceLineNo">243</span> * <li>ALWAYS run all non-overridden {@code @Before} methods on this class<a name="line.243"></a>
<span class="sourceLineNo">244</span> * and superclasses before any of the previous steps; if any throws an<a name="line.244"></a>
<span class="sourceLineNo">245</span> * Exception, stop execution and pass the exception on.<a name="line.245"></a>
<span class="sourceLineNo">246</span> * <li>ALWAYS run all non-overridden {@code @After} methods on this class<a name="line.246"></a>
<span class="sourceLineNo">247</span> * and superclasses after any of the previous steps; all After methods are<a name="line.247"></a>
<span class="sourceLineNo">248</span> * always executed: exceptions thrown by previous steps are combined, if<a name="line.248"></a>
<span class="sourceLineNo">249</span> * necessary, with exceptions from After methods into a<a name="line.249"></a>
<span class="sourceLineNo">250</span> * {@link MultipleFailureException}.<a name="line.250"></a>
<span class="sourceLineNo">251</span> * <li>ALWAYS allow {@code @Rule} fields to modify the execution of the<a name="line.251"></a>
<span class="sourceLineNo">252</span> * above steps. A {@code Rule} may prevent all execution of the above steps,<a name="line.252"></a>
<span class="sourceLineNo">253</span> * or add additional behavior before and after, or modify thrown exceptions.<a name="line.253"></a>
<span class="sourceLineNo">254</span> * For more information, see {@link TestRule}<a name="line.254"></a>
<span class="sourceLineNo">255</span> * </ul><a name="line.255"></a>
<span class="sourceLineNo">256</span> *<a name="line.256"></a>
<span class="sourceLineNo">257</span> * This can be overridden in subclasses, either by overriding this method,<a name="line.257"></a>
<span class="sourceLineNo">258</span> * or the implementations creating each sub-statement.<a name="line.258"></a>
<span class="sourceLineNo">259</span> */<a name="line.259"></a>
<span class="sourceLineNo">260</span> protected Statement methodBlock(FrameworkMethod method) {<a name="line.260"></a>
<span class="sourceLineNo">261</span> Object test;<a name="line.261"></a>
<span class="sourceLineNo">262</span> try {<a name="line.262"></a>
<span class="sourceLineNo">263</span> test = new ReflectiveCallable() {<a name="line.263"></a>
<span class="sourceLineNo">264</span> @Override<a name="line.264"></a>
<span class="sourceLineNo">265</span> protected Object runReflectiveCall() throws Throwable {<a name="line.265"></a>
<span class="sourceLineNo">266</span> return createTest();<a name="line.266"></a>
<span class="sourceLineNo">267</span> }<a name="line.267"></a>
<span class="sourceLineNo">268</span> }.run();<a name="line.268"></a>
<span class="sourceLineNo">269</span> } catch (Throwable e) {<a name="line.269"></a>
<span class="sourceLineNo">270</span> return new Fail(e);<a name="line.270"></a>
<span class="sourceLineNo">271</span> }<a name="line.271"></a>
<span class="sourceLineNo">272</span><a name="line.272"></a>
<span class="sourceLineNo">273</span> Statement statement = methodInvoker(method, test);<a name="line.273"></a>
<span class="sourceLineNo">274</span> statement = possiblyExpectingExceptions(method, test, statement);<a name="line.274"></a>
<span class="sourceLineNo">275</span> statement = withPotentialTimeout(method, test, statement);<a name="line.275"></a>
<span class="sourceLineNo">276</span> statement = withBefores(method, test, statement);<a name="line.276"></a>
<span class="sourceLineNo">277</span> statement = withAfters(method, test, statement);<a name="line.277"></a>
<span class="sourceLineNo">278</span> statement = withRules(method, test, statement);<a name="line.278"></a>
<span class="sourceLineNo">279</span> return statement;<a name="line.279"></a>
<span class="sourceLineNo">280</span> }<a name="line.280"></a>
<span class="sourceLineNo">281</span><a name="line.281"></a>
<span class="sourceLineNo">282</span> //<a name="line.282"></a>
<span class="sourceLineNo">283</span> // Statement builders<a name="line.283"></a>
<span class="sourceLineNo">284</span> //<a name="line.284"></a>
<span class="sourceLineNo">285</span><a name="line.285"></a>
<span class="sourceLineNo">286</span> /**<a name="line.286"></a>
<span class="sourceLineNo">287</span> * Returns a {@link Statement} that invokes {@code method} on {@code test}<a name="line.287"></a>
<span class="sourceLineNo">288</span> */<a name="line.288"></a>
<span class="sourceLineNo">289</span> protected Statement methodInvoker(FrameworkMethod method, Object test) {<a name="line.289"></a>
<span class="sourceLineNo">290</span> return new InvokeMethod(method, test);<a name="line.290"></a>
<span class="sourceLineNo">291</span> }<a name="line.291"></a>
<span class="sourceLineNo">292</span><a name="line.292"></a>
<span class="sourceLineNo">293</span> /**<a name="line.293"></a>
<span class="sourceLineNo">294</span> * Returns a {@link Statement}: if {@code method}'s {@code @Test} annotation<a name="line.294"></a>
<span class="sourceLineNo">295</span> * has the {@code expecting} attribute, return normally only if {@code next}<a name="line.295"></a>
<span class="sourceLineNo">296</span> * throws an exception of the correct type, and throw an exception<a name="line.296"></a>
<span class="sourceLineNo">297</span> * otherwise.<a name="line.297"></a>
<span class="sourceLineNo">298</span> */<a name="line.298"></a>
<span class="sourceLineNo">299</span> protected Statement possiblyExpectingExceptions(FrameworkMethod method,<a name="line.299"></a>
<span class="sourceLineNo">300</span> Object test, Statement next) {<a name="line.300"></a>
<span class="sourceLineNo">301</span> Test annotation = method.getAnnotation(Test.class);<a name="line.301"></a>
<span class="sourceLineNo">302</span> return expectsException(annotation) ? new ExpectException(next,<a name="line.302"></a>
<span class="sourceLineNo">303</span> getExpectedException(annotation)) : next;<a name="line.303"></a>
<span class="sourceLineNo">304</span> }<a name="line.304"></a>
<span class="sourceLineNo">305</span><a name="line.305"></a>
<span class="sourceLineNo">306</span> /**<a name="line.306"></a>
<span class="sourceLineNo">307</span> * Returns a {@link Statement}: if {@code method}'s {@code @Test} annotation<a name="line.307"></a>
<span class="sourceLineNo">308</span> * has the {@code timeout} attribute, throw an exception if {@code next}<a name="line.308"></a>
<span class="sourceLineNo">309</span> * takes more than the specified number of milliseconds.<a name="line.309"></a>
<span class="sourceLineNo">310</span> */<a name="line.310"></a>
<span class="sourceLineNo">311</span> @Deprecated<a name="line.311"></a>
<span class="sourceLineNo">312</span> protected Statement withPotentialTimeout(FrameworkMethod method,<a name="line.312"></a>
<span class="sourceLineNo">313</span> Object test, Statement next) {<a name="line.313"></a>
<span class="sourceLineNo">314</span> long timeout = getTimeout(method.getAnnotation(Test.class));<a name="line.314"></a>
<span class="sourceLineNo">315</span> if (timeout <= 0) {<a name="line.315"></a>
<span class="sourceLineNo">316</span> return next;<a name="line.316"></a>
<span class="sourceLineNo">317</span> }<a name="line.317"></a>
<span class="sourceLineNo">318</span> return FailOnTimeout.builder()<a name="line.318"></a>
<span class="sourceLineNo">319</span> .withTimeout(timeout, TimeUnit.MILLISECONDS)<a name="line.319"></a>
<span class="sourceLineNo">320</span> .build(next);<a name="line.320"></a>
<span class="sourceLineNo">321</span> }<a name="line.321"></a>
<span class="sourceLineNo">322</span><a name="line.322"></a>
<span class="sourceLineNo">323</span> /**<a name="line.323"></a>
<span class="sourceLineNo">324</span> * Returns a {@link Statement}: run all non-overridden {@code @Before}<a name="line.324"></a>
<span class="sourceLineNo">325</span> * methods on this class and superclasses before running {@code next}; if<a name="line.325"></a>
<span class="sourceLineNo">326</span> * any throws an Exception, stop execution and pass the exception on.<a name="line.326"></a>
<span class="sourceLineNo">327</span> */<a name="line.327"></a>
<span class="sourceLineNo">328</span> protected Statement withBefores(FrameworkMethod method, Object target,<a name="line.328"></a>
<span class="sourceLineNo">329</span> Statement statement) {<a name="line.329"></a>
<span class="sourceLineNo">330</span> List<FrameworkMethod> befores = getTestClass().getAnnotatedMethods(<a name="line.330"></a>
<span class="sourceLineNo">331</span> Before.class);<a name="line.331"></a>
<span class="sourceLineNo">332</span> return befores.isEmpty() ? statement : new RunBefores(statement,<a name="line.332"></a>
<span class="sourceLineNo">333</span> befores, target);<a name="line.333"></a>
<span class="sourceLineNo">334</span> }<a name="line.334"></a>
<span class="sourceLineNo">335</span><a name="line.335"></a>
<span class="sourceLineNo">336</span> /**<a name="line.336"></a>
<span class="sourceLineNo">337</span> * Returns a {@link Statement}: run all non-overridden {@code @After}<a name="line.337"></a>
<span class="sourceLineNo">338</span> * methods on this class and superclasses before running {@code next}; all<a name="line.338"></a>
<span class="sourceLineNo">339</span> * After methods are always executed: exceptions thrown by previous steps<a name="line.339"></a>
<span class="sourceLineNo">340</span> * are combined, if necessary, with exceptions from After methods into a<a name="line.340"></a>
<span class="sourceLineNo">341</span> * {@link MultipleFailureException}.<a name="line.341"></a>
<span class="sourceLineNo">342</span> */<a name="line.342"></a>
<span class="sourceLineNo">343</span> protected Statement withAfters(FrameworkMethod method, Object target,<a name="line.343"></a>
<span class="sourceLineNo">344</span> Statement statement) {<a name="line.344"></a>
<span class="sourceLineNo">345</span> List<FrameworkMethod> afters = getTestClass().getAnnotatedMethods(<a name="line.345"></a>
<span class="sourceLineNo">346</span> After.class);<a name="line.346"></a>
<span class="sourceLineNo">347</span> return afters.isEmpty() ? statement : new RunAfters(statement, afters,<a name="line.347"></a>
<span class="sourceLineNo">348</span> target);<a name="line.348"></a>
<span class="sourceLineNo">349</span> }<a name="line.349"></a>
<span class="sourceLineNo">350</span><a name="line.350"></a>
<span class="sourceLineNo">351</span> private Statement withRules(FrameworkMethod method, Object target,<a name="line.351"></a>
<span class="sourceLineNo">352</span> Statement statement) {<a name="line.352"></a>
<span class="sourceLineNo">353</span> List<TestRule> testRules = getTestRules(target);<a name="line.353"></a>
<span class="sourceLineNo">354</span> Statement result = statement;<a name="line.354"></a>
<span class="sourceLineNo">355</span> result = withMethodRules(method, testRules, target, result);<a name="line.355"></a>
<span class="sourceLineNo">356</span> result = withTestRules(method, testRules, result);<a name="line.356"></a>
<span class="sourceLineNo">357</span><a name="line.357"></a>
<span class="sourceLineNo">358</span> return result;<a name="line.358"></a>
<span class="sourceLineNo">359</span> }<a name="line.359"></a>
<span class="sourceLineNo">360</span><a name="line.360"></a>
<span class="sourceLineNo">361</span> private Statement withMethodRules(FrameworkMethod method, List<TestRule> testRules,<a name="line.361"></a>
<span class="sourceLineNo">362</span> Object target, Statement result) {<a name="line.362"></a>
<span class="sourceLineNo">363</span> for (org.junit.rules.MethodRule each : getMethodRules(target)) {<a name="line.363"></a>
<span class="sourceLineNo">364</span> if (!testRules.contains(each)) {<a name="line.364"></a>
<span class="sourceLineNo">365</span> result = each.apply(result, method, target);<a name="line.365"></a>
<span class="sourceLineNo">366</span> }<a name="line.366"></a>
<span class="sourceLineNo">367</span> }<a name="line.367"></a>
<span class="sourceLineNo">368</span> return result;<a name="line.368"></a>
<span class="sourceLineNo">369</span> }<a name="line.369"></a>
<span class="sourceLineNo">370</span><a name="line.370"></a>
<span class="sourceLineNo">371</span> private List<org.junit.rules.MethodRule> getMethodRules(Object target) {<a name="line.371"></a>
<span class="sourceLineNo">372</span> return rules(target);<a name="line.372"></a>
<span class="sourceLineNo">373</span> }<a name="line.373"></a>
<span class="sourceLineNo">374</span><a name="line.374"></a>
<span class="sourceLineNo">375</span> /**<a name="line.375"></a>
<span class="sourceLineNo">376</span> * @param target the test case instance<a name="line.376"></a>
<span class="sourceLineNo">377</span> * @return a list of MethodRules that should be applied when executing this<a name="line.377"></a>
<span class="sourceLineNo">378</span> * test<a name="line.378"></a>
<span class="sourceLineNo">379</span> */<a name="line.379"></a>
<span class="sourceLineNo">380</span> protected List<MethodRule> rules(Object target) {<a name="line.380"></a>
<span class="sourceLineNo">381</span> List<MethodRule> rules = getTestClass().getAnnotatedMethodValues(target, <a name="line.381"></a>
<span class="sourceLineNo">382</span> Rule.class, MethodRule.class);<a name="line.382"></a>
<span class="sourceLineNo">383</span> <a name="line.383"></a>
<span class="sourceLineNo">384</span> rules.addAll(getTestClass().getAnnotatedFieldValues(target,<a name="line.384"></a>
<span class="sourceLineNo">385</span> Rule.class, MethodRule.class));<a name="line.385"></a>
<span class="sourceLineNo">386</span> <a name="line.386"></a>
<span class="sourceLineNo">387</span> return rules;<a name="line.387"></a>
<span class="sourceLineNo">388</span> }<a name="line.388"></a>
<span class="sourceLineNo">389</span><a name="line.389"></a>
<span class="sourceLineNo">390</span> /**<a name="line.390"></a>
<span class="sourceLineNo">391</span> * Returns a {@link Statement}: apply all non-static fields<a name="line.391"></a>
<span class="sourceLineNo">392</span> * annotated with {@link Rule}.<a name="line.392"></a>
<span class="sourceLineNo">393</span> *<a name="line.393"></a>
<span class="sourceLineNo">394</span> * @param statement The base statement<a name="line.394"></a>
<span class="sourceLineNo">395</span> * @return a RunRules statement if any class-level {@link Rule}s are<a name="line.395"></a>
<span class="sourceLineNo">396</span> * found, or the base statement<a name="line.396"></a>
<span class="sourceLineNo">397</span> */<a name="line.397"></a>
<span class="sourceLineNo">398</span> private Statement withTestRules(FrameworkMethod method, List<TestRule> testRules,<a name="line.398"></a>
<span class="sourceLineNo">399</span> Statement statement) {<a name="line.399"></a>
<span class="sourceLineNo">400</span> return testRules.isEmpty() ? statement :<a name="line.400"></a>
<span class="sourceLineNo">401</span> new RunRules(statement, testRules, describeChild(method));<a name="line.401"></a>
<span class="sourceLineNo">402</span> }<a name="line.402"></a>
<span class="sourceLineNo">403</span><a name="line.403"></a>
<span class="sourceLineNo">404</span> /**<a name="line.404"></a>
<span class="sourceLineNo">405</span> * @param target the test case instance<a name="line.405"></a>
<span class="sourceLineNo">406</span> * @return a list of TestRules that should be applied when executing this<a name="line.406"></a>
<span class="sourceLineNo">407</span> * test<a name="line.407"></a>
<span class="sourceLineNo">408</span> */<a name="line.408"></a>
<span class="sourceLineNo">409</span> protected List<TestRule> getTestRules(Object target) {<a name="line.409"></a>
<span class="sourceLineNo">410</span> List<TestRule> result = getTestClass().getAnnotatedMethodValues(target,<a name="line.410"></a>
<span class="sourceLineNo">411</span> Rule.class, TestRule.class);<a name="line.411"></a>
<span class="sourceLineNo">412</span><a name="line.412"></a>
<span class="sourceLineNo">413</span> result.addAll(getTestClass().getAnnotatedFieldValues(target,<a name="line.413"></a>
<span class="sourceLineNo">414</span> Rule.class, TestRule.class));<a name="line.414"></a>
<span class="sourceLineNo">415</span><a name="line.415"></a>
<span class="sourceLineNo">416</span> return result;<a name="line.416"></a>
<span class="sourceLineNo">417</span> }<a name="line.417"></a>
<span class="sourceLineNo">418</span><a name="line.418"></a>
<span class="sourceLineNo">419</span> private Class<? extends Throwable> getExpectedException(Test annotation) {<a name="line.419"></a>
<span class="sourceLineNo">420</span> if (annotation == null || annotation.expected() == None.class) {<a name="line.420"></a>
<span class="sourceLineNo">421</span> return null;<a name="line.421"></a>
<span class="sourceLineNo">422</span> } else {<a name="line.422"></a>
<span class="sourceLineNo">423</span> return annotation.expected();<a name="line.423"></a>
<span class="sourceLineNo">424</span> }<a name="line.424"></a>
<span class="sourceLineNo">425</span> }<a name="line.425"></a>
<span class="sourceLineNo">426</span><a name="line.426"></a>
<span class="sourceLineNo">427</span> private boolean expectsException(Test annotation) {<a name="line.427"></a>
<span class="sourceLineNo">428</span> return getExpectedException(annotation) != null;<a name="line.428"></a>
<span class="sourceLineNo">429</span> }<a name="line.429"></a>
<span class="sourceLineNo">430</span><a name="line.430"></a>
<span class="sourceLineNo">431</span> private long getTimeout(Test annotation) {<a name="line.431"></a>
<span class="sourceLineNo">432</span> if (annotation == null) {<a name="line.432"></a>
<span class="sourceLineNo">433</span> return 0;<a name="line.433"></a>
<span class="sourceLineNo">434</span> }<a name="line.434"></a>
<span class="sourceLineNo">435</span> return annotation.timeout();<a name="line.435"></a>
<span class="sourceLineNo">436</span> }<a name="line.436"></a>
<span class="sourceLineNo">437</span>}<a name="line.437"></a>
</pre>
</div>
</body>
</html>
|