/usr/share/doc/junit4/api/src-html/org/junit/experimental/categories/Categories.IncludeCategory.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 | <!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.experimental.categories;<a name="line.1"></a>
<span class="sourceLineNo">002</span><a name="line.2"></a>
<span class="sourceLineNo">003</span>import java.lang.annotation.Retention;<a name="line.3"></a>
<span class="sourceLineNo">004</span>import java.lang.annotation.RetentionPolicy;<a name="line.4"></a>
<span class="sourceLineNo">005</span>import java.util.Collections;<a name="line.5"></a>
<span class="sourceLineNo">006</span>import java.util.HashSet;<a name="line.6"></a>
<span class="sourceLineNo">007</span>import java.util.Set;<a name="line.7"></a>
<span class="sourceLineNo">008</span><a name="line.8"></a>
<span class="sourceLineNo">009</span>import org.junit.runner.Description;<a name="line.9"></a>
<span class="sourceLineNo">010</span>import org.junit.runner.manipulation.Filter;<a name="line.10"></a>
<span class="sourceLineNo">011</span>import org.junit.runner.manipulation.NoTestsRemainException;<a name="line.11"></a>
<span class="sourceLineNo">012</span>import org.junit.runners.Suite;<a name="line.12"></a>
<span class="sourceLineNo">013</span>import org.junit.runners.model.InitializationError;<a name="line.13"></a>
<span class="sourceLineNo">014</span>import org.junit.runners.model.RunnerBuilder;<a name="line.14"></a>
<span class="sourceLineNo">015</span><a name="line.15"></a>
<span class="sourceLineNo">016</span>/**<a name="line.16"></a>
<span class="sourceLineNo">017</span> * From a given set of test classes, runs only the classes and methods that are<a name="line.17"></a>
<span class="sourceLineNo">018</span> * annotated with either the category given with the @IncludeCategory<a name="line.18"></a>
<span class="sourceLineNo">019</span> * annotation, or a subtype of that category.<a name="line.19"></a>
<span class="sourceLineNo">020</span> * <p><a name="line.20"></a>
<span class="sourceLineNo">021</span> * Note that, for now, annotating suites with {@code @Category} has no effect.<a name="line.21"></a>
<span class="sourceLineNo">022</span> * Categories must be annotated on the direct method or class.<a name="line.22"></a>
<span class="sourceLineNo">023</span> * <p><a name="line.23"></a>
<span class="sourceLineNo">024</span> * Example:<a name="line.24"></a>
<span class="sourceLineNo">025</span> * <pre><a name="line.25"></a>
<span class="sourceLineNo">026</span> * public interface FastTests {<a name="line.26"></a>
<span class="sourceLineNo">027</span> * }<a name="line.27"></a>
<span class="sourceLineNo">028</span> *<a name="line.28"></a>
<span class="sourceLineNo">029</span> * public interface SlowTests {<a name="line.29"></a>
<span class="sourceLineNo">030</span> * }<a name="line.30"></a>
<span class="sourceLineNo">031</span> *<a name="line.31"></a>
<span class="sourceLineNo">032</span> * public interface SmokeTests<a name="line.32"></a>
<span class="sourceLineNo">033</span> * }<a name="line.33"></a>
<span class="sourceLineNo">034</span> *<a name="line.34"></a>
<span class="sourceLineNo">035</span> * public static class A {<a name="line.35"></a>
<span class="sourceLineNo">036</span> * &#064;Test<a name="line.36"></a>
<span class="sourceLineNo">037</span> * public void a() {<a name="line.37"></a>
<span class="sourceLineNo">038</span> * fail();<a name="line.38"></a>
<span class="sourceLineNo">039</span> * }<a name="line.39"></a>
<span class="sourceLineNo">040</span> *<a name="line.40"></a>
<span class="sourceLineNo">041</span> * &#064;Category(SlowTests.class)<a name="line.41"></a>
<span class="sourceLineNo">042</span> * &#064;Test<a name="line.42"></a>
<span class="sourceLineNo">043</span> * public void b() {<a name="line.43"></a>
<span class="sourceLineNo">044</span> * }<a name="line.44"></a>
<span class="sourceLineNo">045</span> *<a name="line.45"></a>
<span class="sourceLineNo">046</span> * &#064;Category({FastTests.class, SmokeTests.class})<a name="line.46"></a>
<span class="sourceLineNo">047</span> * &#064;Test<a name="line.47"></a>
<span class="sourceLineNo">048</span> * public void c() {<a name="line.48"></a>
<span class="sourceLineNo">049</span> * }<a name="line.49"></a>
<span class="sourceLineNo">050</span> * }<a name="line.50"></a>
<span class="sourceLineNo">051</span> *<a name="line.51"></a>
<span class="sourceLineNo">052</span> * &#064;Category({SlowTests.class, FastTests.class})<a name="line.52"></a>
<span class="sourceLineNo">053</span> * public static class B {<a name="line.53"></a>
<span class="sourceLineNo">054</span> * &#064;Test<a name="line.54"></a>
<span class="sourceLineNo">055</span> * public void d() {<a name="line.55"></a>
<span class="sourceLineNo">056</span> * }<a name="line.56"></a>
<span class="sourceLineNo">057</span> * }<a name="line.57"></a>
<span class="sourceLineNo">058</span> *<a name="line.58"></a>
<span class="sourceLineNo">059</span> * &#064;RunWith(Categories.class)<a name="line.59"></a>
<span class="sourceLineNo">060</span> * &#064;IncludeCategory(SlowTests.class)<a name="line.60"></a>
<span class="sourceLineNo">061</span> * &#064;SuiteClasses({A.class, B.class})<a name="line.61"></a>
<span class="sourceLineNo">062</span> * // Note that Categories is a kind of Suite<a name="line.62"></a>
<span class="sourceLineNo">063</span> * public static class SlowTestSuite {<a name="line.63"></a>
<span class="sourceLineNo">064</span> * // Will run A.b and B.d, but not A.a and A.c<a name="line.64"></a>
<span class="sourceLineNo">065</span> * }<a name="line.65"></a>
<span class="sourceLineNo">066</span> * </pre><a name="line.66"></a>
<span class="sourceLineNo">067</span> * <p><a name="line.67"></a>
<span class="sourceLineNo">068</span> * Example to run multiple categories:<a name="line.68"></a>
<span class="sourceLineNo">069</span> * <pre><a name="line.69"></a>
<span class="sourceLineNo">070</span> * &#064;RunWith(Categories.class)<a name="line.70"></a>
<span class="sourceLineNo">071</span> * &#064;IncludeCategory({FastTests.class, SmokeTests.class})<a name="line.71"></a>
<span class="sourceLineNo">072</span> * &#064;SuiteClasses({A.class, B.class})<a name="line.72"></a>
<span class="sourceLineNo">073</span> * public static class FastOrSmokeTestSuite {<a name="line.73"></a>
<span class="sourceLineNo">074</span> * // Will run A.c and B.d, but not A.b because it is not any of FastTests or SmokeTests<a name="line.74"></a>
<span class="sourceLineNo">075</span> * }<a name="line.75"></a>
<span class="sourceLineNo">076</span> * </pre><a name="line.76"></a>
<span class="sourceLineNo">077</span> *<a name="line.77"></a>
<span class="sourceLineNo">078</span> * @version 4.12<a name="line.78"></a>
<span class="sourceLineNo">079</span> * @see <a href="https://github.com/junit-team/junit/wiki/Categories">Categories at JUnit wiki</a><a name="line.79"></a>
<span class="sourceLineNo">080</span> */<a name="line.80"></a>
<span class="sourceLineNo">081</span>public class Categories extends Suite {<a name="line.81"></a>
<span class="sourceLineNo">082</span><a name="line.82"></a>
<span class="sourceLineNo">083</span> @Retention(RetentionPolicy.RUNTIME)<a name="line.83"></a>
<span class="sourceLineNo">084</span> public @interface IncludeCategory {<a name="line.84"></a>
<span class="sourceLineNo">085</span> /**<a name="line.85"></a>
<span class="sourceLineNo">086</span> * Determines the tests to run that are annotated with categories specified in<a name="line.86"></a>
<span class="sourceLineNo">087</span> * the value of this annotation or their subtypes unless excluded with {@link ExcludeCategory}.<a name="line.87"></a>
<span class="sourceLineNo">088</span> */<a name="line.88"></a>
<span class="sourceLineNo">089</span> public Class<?>[] value() default {};<a name="line.89"></a>
<span class="sourceLineNo">090</span><a name="line.90"></a>
<span class="sourceLineNo">091</span> /**<a name="line.91"></a>
<span class="sourceLineNo">092</span> * If <tt>true</tt>, runs tests annotated with <em>any</em> of the categories in<a name="line.92"></a>
<span class="sourceLineNo">093</span> * {@link IncludeCategory#value()}. Otherwise, runs tests only if annotated with <em>all</em> of the categories.<a name="line.93"></a>
<span class="sourceLineNo">094</span> */<a name="line.94"></a>
<span class="sourceLineNo">095</span> public boolean matchAny() default true;<a name="line.95"></a>
<span class="sourceLineNo">096</span> }<a name="line.96"></a>
<span class="sourceLineNo">097</span><a name="line.97"></a>
<span class="sourceLineNo">098</span> @Retention(RetentionPolicy.RUNTIME)<a name="line.98"></a>
<span class="sourceLineNo">099</span> public @interface ExcludeCategory {<a name="line.99"></a>
<span class="sourceLineNo">100</span> /**<a name="line.100"></a>
<span class="sourceLineNo">101</span> * Determines the tests which do not run if they are annotated with categories specified in the<a name="line.101"></a>
<span class="sourceLineNo">102</span> * value of this annotation or their subtypes regardless of being included in {@link IncludeCategory#value()}.<a name="line.102"></a>
<span class="sourceLineNo">103</span> */<a name="line.103"></a>
<span class="sourceLineNo">104</span> public Class<?>[] value() default {};<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> * If <tt>true</tt>, the tests annotated with <em>any</em> of the categories in {@link ExcludeCategory#value()}<a name="line.107"></a>
<span class="sourceLineNo">108</span> * do not run. Otherwise, the tests do not run if and only if annotated with <em>all</em> categories.<a name="line.108"></a>
<span class="sourceLineNo">109</span> */<a name="line.109"></a>
<span class="sourceLineNo">110</span> public boolean matchAny() default true;<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> public static class CategoryFilter extends Filter {<a name="line.113"></a>
<span class="sourceLineNo">114</span> private final Set<Class<?>> included;<a name="line.114"></a>
<span class="sourceLineNo">115</span> private final Set<Class<?>> excluded;<a name="line.115"></a>
<span class="sourceLineNo">116</span> private final boolean includedAny;<a name="line.116"></a>
<span class="sourceLineNo">117</span> private final boolean excludedAny;<a name="line.117"></a>
<span class="sourceLineNo">118</span><a name="line.118"></a>
<span class="sourceLineNo">119</span> public static CategoryFilter include(boolean matchAny, Class<?>... categories) {<a name="line.119"></a>
<span class="sourceLineNo">120</span> if (hasNull(categories)) {<a name="line.120"></a>
<span class="sourceLineNo">121</span> throw new NullPointerException("has null category");<a name="line.121"></a>
<span class="sourceLineNo">122</span> }<a name="line.122"></a>
<span class="sourceLineNo">123</span> return categoryFilter(matchAny, createSet(categories), true, null);<a name="line.123"></a>
<span class="sourceLineNo">124</span> }<a name="line.124"></a>
<span class="sourceLineNo">125</span><a name="line.125"></a>
<span class="sourceLineNo">126</span> public static CategoryFilter include(Class<?> category) {<a name="line.126"></a>
<span class="sourceLineNo">127</span> return include(true, category);<a name="line.127"></a>
<span class="sourceLineNo">128</span> }<a name="line.128"></a>
<span class="sourceLineNo">129</span><a name="line.129"></a>
<span class="sourceLineNo">130</span> public static CategoryFilter include(Class<?>... categories) {<a name="line.130"></a>
<span class="sourceLineNo">131</span> return include(true, categories);<a name="line.131"></a>
<span class="sourceLineNo">132</span> }<a name="line.132"></a>
<span class="sourceLineNo">133</span><a name="line.133"></a>
<span class="sourceLineNo">134</span> public static CategoryFilter exclude(boolean matchAny, Class<?>... categories) {<a name="line.134"></a>
<span class="sourceLineNo">135</span> if (hasNull(categories)) {<a name="line.135"></a>
<span class="sourceLineNo">136</span> throw new NullPointerException("has null category");<a name="line.136"></a>
<span class="sourceLineNo">137</span> }<a name="line.137"></a>
<span class="sourceLineNo">138</span> return categoryFilter(true, null, matchAny, createSet(categories));<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> public static CategoryFilter exclude(Class<?> category) {<a name="line.141"></a>
<span class="sourceLineNo">142</span> return exclude(true, category);<a name="line.142"></a>
<span class="sourceLineNo">143</span> }<a name="line.143"></a>
<span class="sourceLineNo">144</span><a name="line.144"></a>
<span class="sourceLineNo">145</span> public static CategoryFilter exclude(Class<?>... categories) {<a name="line.145"></a>
<span class="sourceLineNo">146</span> return exclude(true, categories);<a name="line.146"></a>
<span class="sourceLineNo">147</span> }<a name="line.147"></a>
<span class="sourceLineNo">148</span><a name="line.148"></a>
<span class="sourceLineNo">149</span> public static CategoryFilter categoryFilter(boolean matchAnyInclusions, Set<Class<?>> inclusions,<a name="line.149"></a>
<span class="sourceLineNo">150</span> boolean matchAnyExclusions, Set<Class<?>> exclusions) {<a name="line.150"></a>
<span class="sourceLineNo">151</span> return new CategoryFilter(matchAnyInclusions, inclusions, matchAnyExclusions, exclusions);<a name="line.151"></a>
<span class="sourceLineNo">152</span> }<a name="line.152"></a>
<span class="sourceLineNo">153</span><a name="line.153"></a>
<span class="sourceLineNo">154</span> protected CategoryFilter(boolean matchAnyIncludes, Set<Class<?>> includes,<a name="line.154"></a>
<span class="sourceLineNo">155</span> boolean matchAnyExcludes, Set<Class<?>> excludes) {<a name="line.155"></a>
<span class="sourceLineNo">156</span> includedAny = matchAnyIncludes;<a name="line.156"></a>
<span class="sourceLineNo">157</span> excludedAny = matchAnyExcludes;<a name="line.157"></a>
<span class="sourceLineNo">158</span> included = copyAndRefine(includes);<a name="line.158"></a>
<span class="sourceLineNo">159</span> excluded = copyAndRefine(excludes);<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> * @see #toString()<a name="line.163"></a>
<span class="sourceLineNo">164</span> */<a name="line.164"></a>
<span class="sourceLineNo">165</span> @Override<a name="line.165"></a>
<span class="sourceLineNo">166</span> public String describe() {<a name="line.166"></a>
<span class="sourceLineNo">167</span> return toString();<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>
<span class="sourceLineNo">170</span> /**<a name="line.170"></a>
<span class="sourceLineNo">171</span> * Returns string in the form <tt>&quot;[included categories] - [excluded categories]&quot;</tt>, where both<a name="line.171"></a>
<span class="sourceLineNo">172</span> * sets have comma separated names of categories.<a name="line.172"></a>
<span class="sourceLineNo">173</span> *<a name="line.173"></a>
<span class="sourceLineNo">174</span> * @return string representation for the relative complement of excluded categories set<a name="line.174"></a>
<span class="sourceLineNo">175</span> * in the set of included categories. Examples:<a name="line.175"></a>
<span class="sourceLineNo">176</span> * <ul><a name="line.176"></a>
<span class="sourceLineNo">177</span> * <li> <tt>&quot;categories [all]&quot;</tt> for all included categories and no excluded ones;<a name="line.177"></a>
<span class="sourceLineNo">178</span> * <li> <tt>&quot;categories [all] - [A, B]&quot;</tt> for all included categories and given excluded ones;<a name="line.178"></a>
<span class="sourceLineNo">179</span> * <li> <tt>&quot;categories [A, B] - [C, D]&quot;</tt> for given included categories and given excluded ones.<a name="line.179"></a>
<span class="sourceLineNo">180</span> * </ul><a name="line.180"></a>
<span class="sourceLineNo">181</span> * @see Class#toString() name of category<a name="line.181"></a>
<span class="sourceLineNo">182</span> */<a name="line.182"></a>
<span class="sourceLineNo">183</span> @Override public String toString() {<a name="line.183"></a>
<span class="sourceLineNo">184</span> StringBuilder description= new StringBuilder("categories ")<a name="line.184"></a>
<span class="sourceLineNo">185</span> .append(included.isEmpty() ? "[all]" : included);<a name="line.185"></a>
<span class="sourceLineNo">186</span> if (!excluded.isEmpty()) {<a name="line.186"></a>
<span class="sourceLineNo">187</span> description.append(" - ").append(excluded);<a name="line.187"></a>
<span class="sourceLineNo">188</span> }<a name="line.188"></a>
<span class="sourceLineNo">189</span> return description.toString();<a name="line.189"></a>
<span class="sourceLineNo">190</span> }<a name="line.190"></a>
<span class="sourceLineNo">191</span><a name="line.191"></a>
<span class="sourceLineNo">192</span> @Override<a name="line.192"></a>
<span class="sourceLineNo">193</span> public boolean shouldRun(Description description) {<a name="line.193"></a>
<span class="sourceLineNo">194</span> if (hasCorrectCategoryAnnotation(description)) {<a name="line.194"></a>
<span class="sourceLineNo">195</span> return true;<a name="line.195"></a>
<span class="sourceLineNo">196</span> }<a name="line.196"></a>
<span class="sourceLineNo">197</span><a name="line.197"></a>
<span class="sourceLineNo">198</span> for (Description each : description.getChildren()) {<a name="line.198"></a>
<span class="sourceLineNo">199</span> if (shouldRun(each)) {<a name="line.199"></a>
<span class="sourceLineNo">200</span> return true;<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> return false;<a name="line.204"></a>
<span class="sourceLineNo">205</span> }<a name="line.205"></a>
<span class="sourceLineNo">206</span><a name="line.206"></a>
<span class="sourceLineNo">207</span> private boolean hasCorrectCategoryAnnotation(Description description) {<a name="line.207"></a>
<span class="sourceLineNo">208</span> final Set<Class<?>> childCategories= categories(description);<a name="line.208"></a>
<span class="sourceLineNo">209</span><a name="line.209"></a>
<span class="sourceLineNo">210</span> // If a child has no categories, immediately return.<a name="line.210"></a>
<span class="sourceLineNo">211</span> if (childCategories.isEmpty()) {<a name="line.211"></a>
<span class="sourceLineNo">212</span> return included.isEmpty();<a name="line.212"></a>
<span class="sourceLineNo">213</span> }<a name="line.213"></a>
<span class="sourceLineNo">214</span><a name="line.214"></a>
<span class="sourceLineNo">215</span> if (!excluded.isEmpty()) {<a name="line.215"></a>
<span class="sourceLineNo">216</span> if (excludedAny) {<a name="line.216"></a>
<span class="sourceLineNo">217</span> if (matchesAnyParentCategories(childCategories, excluded)) {<a name="line.217"></a>
<span class="sourceLineNo">218</span> return false;<a name="line.218"></a>
<span class="sourceLineNo">219</span> }<a name="line.219"></a>
<span class="sourceLineNo">220</span> } else {<a name="line.220"></a>
<span class="sourceLineNo">221</span> if (matchesAllParentCategories(childCategories, excluded)) {<a name="line.221"></a>
<span class="sourceLineNo">222</span> return false;<a name="line.222"></a>
<span class="sourceLineNo">223</span> }<a name="line.223"></a>
<span class="sourceLineNo">224</span> }<a name="line.224"></a>
<span class="sourceLineNo">225</span> }<a name="line.225"></a>
<span class="sourceLineNo">226</span><a name="line.226"></a>
<span class="sourceLineNo">227</span> if (included.isEmpty()) {<a name="line.227"></a>
<span class="sourceLineNo">228</span> // Couldn't be excluded, and with no suite's included categories treated as should run.<a name="line.228"></a>
<span class="sourceLineNo">229</span> return true;<a name="line.229"></a>
<span class="sourceLineNo">230</span> } else {<a name="line.230"></a>
<span class="sourceLineNo">231</span> if (includedAny) {<a name="line.231"></a>
<span class="sourceLineNo">232</span> return matchesAnyParentCategories(childCategories, included);<a name="line.232"></a>
<span class="sourceLineNo">233</span> } else {<a name="line.233"></a>
<span class="sourceLineNo">234</span> return matchesAllParentCategories(childCategories, included);<a name="line.234"></a>
<span class="sourceLineNo">235</span> }<a name="line.235"></a>
<span class="sourceLineNo">236</span> }<a name="line.236"></a>
<span class="sourceLineNo">237</span> }<a name="line.237"></a>
<span class="sourceLineNo">238</span><a name="line.238"></a>
<span class="sourceLineNo">239</span> /**<a name="line.239"></a>
<span class="sourceLineNo">240</span> * @return <tt>true</tt> if at least one (any) parent category match a child, otherwise <tt>false</tt>.<a name="line.240"></a>
<span class="sourceLineNo">241</span> * If empty <tt>parentCategories</tt>, returns <tt>false</tt>.<a name="line.241"></a>
<span class="sourceLineNo">242</span> */<a name="line.242"></a>
<span class="sourceLineNo">243</span> private boolean matchesAnyParentCategories(Set<Class<?>> childCategories, Set<Class<?>> parentCategories) {<a name="line.243"></a>
<span class="sourceLineNo">244</span> for (Class<?> parentCategory : parentCategories) {<a name="line.244"></a>
<span class="sourceLineNo">245</span> if (hasAssignableTo(childCategories, parentCategory)) {<a name="line.245"></a>
<span class="sourceLineNo">246</span> return true;<a name="line.246"></a>
<span class="sourceLineNo">247</span> }<a name="line.247"></a>
<span class="sourceLineNo">248</span> }<a name="line.248"></a>
<span class="sourceLineNo">249</span> return false;<a name="line.249"></a>
<span class="sourceLineNo">250</span> }<a name="line.250"></a>
<span class="sourceLineNo">251</span><a name="line.251"></a>
<span class="sourceLineNo">252</span> /**<a name="line.252"></a>
<span class="sourceLineNo">253</span> * @return <tt>false</tt> if at least one parent category does not match children, otherwise <tt>true</tt>.<a name="line.253"></a>
<span class="sourceLineNo">254</span> * If empty <tt>parentCategories</tt>, returns <tt>true</tt>.<a name="line.254"></a>
<span class="sourceLineNo">255</span> */<a name="line.255"></a>
<span class="sourceLineNo">256</span> private boolean matchesAllParentCategories(Set<Class<?>> childCategories, Set<Class<?>> parentCategories) {<a name="line.256"></a>
<span class="sourceLineNo">257</span> for (Class<?> parentCategory : parentCategories) {<a name="line.257"></a>
<span class="sourceLineNo">258</span> if (!hasAssignableTo(childCategories, parentCategory)) {<a name="line.258"></a>
<span class="sourceLineNo">259</span> return false;<a name="line.259"></a>
<span class="sourceLineNo">260</span> }<a name="line.260"></a>
<span class="sourceLineNo">261</span> }<a name="line.261"></a>
<span class="sourceLineNo">262</span> return true;<a name="line.262"></a>
<span class="sourceLineNo">263</span> }<a name="line.263"></a>
<span class="sourceLineNo">264</span><a name="line.264"></a>
<span class="sourceLineNo">265</span> private static Set<Class<?>> categories(Description description) {<a name="line.265"></a>
<span class="sourceLineNo">266</span> Set<Class<?>> categories= new HashSet<Class<?>>();<a name="line.266"></a>
<span class="sourceLineNo">267</span> Collections.addAll(categories, directCategories(description));<a name="line.267"></a>
<span class="sourceLineNo">268</span> Collections.addAll(categories, directCategories(parentDescription(description)));<a name="line.268"></a>
<span class="sourceLineNo">269</span> return categories;<a name="line.269"></a>
<span class="sourceLineNo">270</span> }<a name="line.270"></a>
<span class="sourceLineNo">271</span><a name="line.271"></a>
<span class="sourceLineNo">272</span> private static Description parentDescription(Description description) {<a name="line.272"></a>
<span class="sourceLineNo">273</span> Class<?> testClass= description.getTestClass();<a name="line.273"></a>
<span class="sourceLineNo">274</span> return testClass == null ? null : Description.createSuiteDescription(testClass);<a name="line.274"></a>
<span class="sourceLineNo">275</span> }<a name="line.275"></a>
<span class="sourceLineNo">276</span><a name="line.276"></a>
<span class="sourceLineNo">277</span> private static Class<?>[] directCategories(Description description) {<a name="line.277"></a>
<span class="sourceLineNo">278</span> if (description == null) {<a name="line.278"></a>
<span class="sourceLineNo">279</span> return new Class<?>[0];<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> Category annotation= description.getAnnotation(Category.class);<a name="line.282"></a>
<span class="sourceLineNo">283</span> return annotation == null ? new Class<?>[0] : annotation.value();<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> private static Set<Class<?>> copyAndRefine(Set<Class<?>> classes) {<a name="line.286"></a>
<span class="sourceLineNo">287</span> HashSet<Class<?>> c= new HashSet<Class<?>>();<a name="line.287"></a>
<span class="sourceLineNo">288</span> if (classes != null) {<a name="line.288"></a>
<span class="sourceLineNo">289</span> c.addAll(classes);<a name="line.289"></a>
<span class="sourceLineNo">290</span> }<a name="line.290"></a>
<span class="sourceLineNo">291</span> c.remove(null);<a name="line.291"></a>
<span class="sourceLineNo">292</span> return c;<a name="line.292"></a>
<span class="sourceLineNo">293</span> }<a name="line.293"></a>
<span class="sourceLineNo">294</span><a name="line.294"></a>
<span class="sourceLineNo">295</span> private static boolean hasNull(Class<?>... classes) {<a name="line.295"></a>
<span class="sourceLineNo">296</span> if (classes == null) return false;<a name="line.296"></a>
<span class="sourceLineNo">297</span> for (Class<?> clazz : classes) {<a name="line.297"></a>
<span class="sourceLineNo">298</span> if (clazz == null) {<a name="line.298"></a>
<span class="sourceLineNo">299</span> return true;<a name="line.299"></a>
<span class="sourceLineNo">300</span> }<a name="line.300"></a>
<span class="sourceLineNo">301</span> }<a name="line.301"></a>
<span class="sourceLineNo">302</span> return false;<a name="line.302"></a>
<span class="sourceLineNo">303</span> }<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> public Categories(Class<?> klass, RunnerBuilder builder) throws InitializationError {<a name="line.306"></a>
<span class="sourceLineNo">307</span> super(klass, builder);<a name="line.307"></a>
<span class="sourceLineNo">308</span> try {<a name="line.308"></a>
<span class="sourceLineNo">309</span> Set<Class<?>> included= getIncludedCategory(klass);<a name="line.309"></a>
<span class="sourceLineNo">310</span> Set<Class<?>> excluded= getExcludedCategory(klass);<a name="line.310"></a>
<span class="sourceLineNo">311</span> boolean isAnyIncluded= isAnyIncluded(klass);<a name="line.311"></a>
<span class="sourceLineNo">312</span> boolean isAnyExcluded= isAnyExcluded(klass);<a name="line.312"></a>
<span class="sourceLineNo">313</span><a name="line.313"></a>
<span class="sourceLineNo">314</span> filter(CategoryFilter.categoryFilter(isAnyIncluded, included, isAnyExcluded, excluded));<a name="line.314"></a>
<span class="sourceLineNo">315</span> } catch (NoTestsRemainException e) {<a name="line.315"></a>
<span class="sourceLineNo">316</span> throw new InitializationError(e);<a name="line.316"></a>
<span class="sourceLineNo">317</span> }<a name="line.317"></a>
<span class="sourceLineNo">318</span> assertNoCategorizedDescendentsOfUncategorizeableParents(getDescription());<a name="line.318"></a>
<span class="sourceLineNo">319</span> }<a name="line.319"></a>
<span class="sourceLineNo">320</span><a name="line.320"></a>
<span class="sourceLineNo">321</span> private static Set<Class<?>> getIncludedCategory(Class<?> klass) {<a name="line.321"></a>
<span class="sourceLineNo">322</span> IncludeCategory annotation= klass.getAnnotation(IncludeCategory.class);<a name="line.322"></a>
<span class="sourceLineNo">323</span> return createSet(annotation == null ? null : annotation.value());<a name="line.323"></a>
<span class="sourceLineNo">324</span> }<a name="line.324"></a>
<span class="sourceLineNo">325</span><a name="line.325"></a>
<span class="sourceLineNo">326</span> private static boolean isAnyIncluded(Class<?> klass) {<a name="line.326"></a>
<span class="sourceLineNo">327</span> IncludeCategory annotation= klass.getAnnotation(IncludeCategory.class);<a name="line.327"></a>
<span class="sourceLineNo">328</span> return annotation == null || annotation.matchAny();<a name="line.328"></a>
<span class="sourceLineNo">329</span> }<a name="line.329"></a>
<span class="sourceLineNo">330</span><a name="line.330"></a>
<span class="sourceLineNo">331</span> private static Set<Class<?>> getExcludedCategory(Class<?> klass) {<a name="line.331"></a>
<span class="sourceLineNo">332</span> ExcludeCategory annotation= klass.getAnnotation(ExcludeCategory.class);<a name="line.332"></a>
<span class="sourceLineNo">333</span> return createSet(annotation == null ? null : annotation.value());<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> private static boolean isAnyExcluded(Class<?> klass) {<a name="line.336"></a>
<span class="sourceLineNo">337</span> ExcludeCategory annotation= klass.getAnnotation(ExcludeCategory.class);<a name="line.337"></a>
<span class="sourceLineNo">338</span> return annotation == null || annotation.matchAny();<a name="line.338"></a>
<span class="sourceLineNo">339</span> }<a name="line.339"></a>
<span class="sourceLineNo">340</span><a name="line.340"></a>
<span class="sourceLineNo">341</span> private static void assertNoCategorizedDescendentsOfUncategorizeableParents(Description description) throws InitializationError {<a name="line.341"></a>
<span class="sourceLineNo">342</span> if (!canHaveCategorizedChildren(description)) {<a name="line.342"></a>
<span class="sourceLineNo">343</span> assertNoDescendantsHaveCategoryAnnotations(description);<a name="line.343"></a>
<span class="sourceLineNo">344</span> }<a name="line.344"></a>
<span class="sourceLineNo">345</span> for (Description each : description.getChildren()) {<a name="line.345"></a>
<span class="sourceLineNo">346</span> assertNoCategorizedDescendentsOfUncategorizeableParents(each);<a name="line.346"></a>
<span class="sourceLineNo">347</span> }<a name="line.347"></a>
<span class="sourceLineNo">348</span> }<a name="line.348"></a>
<span class="sourceLineNo">349</span><a name="line.349"></a>
<span class="sourceLineNo">350</span> private static void assertNoDescendantsHaveCategoryAnnotations(Description description) throws InitializationError {<a name="line.350"></a>
<span class="sourceLineNo">351</span> for (Description each : description.getChildren()) {<a name="line.351"></a>
<span class="sourceLineNo">352</span> if (each.getAnnotation(Category.class) != null) {<a name="line.352"></a>
<span class="sourceLineNo">353</span> throw new InitializationError("Category annotations on Parameterized classes are not supported on individual methods.");<a name="line.353"></a>
<span class="sourceLineNo">354</span> }<a name="line.354"></a>
<span class="sourceLineNo">355</span> assertNoDescendantsHaveCategoryAnnotations(each);<a name="line.355"></a>
<span class="sourceLineNo">356</span> }<a name="line.356"></a>
<span class="sourceLineNo">357</span> }<a name="line.357"></a>
<span class="sourceLineNo">358</span><a name="line.358"></a>
<span class="sourceLineNo">359</span> // If children have names like [0], our current magical category code can't determine their parentage.<a name="line.359"></a>
<span class="sourceLineNo">360</span> private static boolean canHaveCategorizedChildren(Description description) {<a name="line.360"></a>
<span class="sourceLineNo">361</span> for (Description each : description.getChildren()) {<a name="line.361"></a>
<span class="sourceLineNo">362</span> if (each.getTestClass() == null) {<a name="line.362"></a>
<span class="sourceLineNo">363</span> return false;<a name="line.363"></a>
<span class="sourceLineNo">364</span> }<a name="line.364"></a>
<span class="sourceLineNo">365</span> }<a name="line.365"></a>
<span class="sourceLineNo">366</span> return true;<a name="line.366"></a>
<span class="sourceLineNo">367</span> }<a name="line.367"></a>
<span class="sourceLineNo">368</span><a name="line.368"></a>
<span class="sourceLineNo">369</span> private static boolean hasAssignableTo(Set<Class<?>> assigns, Class<?> to) {<a name="line.369"></a>
<span class="sourceLineNo">370</span> for (final Class<?> from : assigns) {<a name="line.370"></a>
<span class="sourceLineNo">371</span> if (to.isAssignableFrom(from)) {<a name="line.371"></a>
<span class="sourceLineNo">372</span> return true;<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> return false;<a name="line.375"></a>
<span class="sourceLineNo">376</span> }<a name="line.376"></a>
<span class="sourceLineNo">377</span><a name="line.377"></a>
<span class="sourceLineNo">378</span> private static Set<Class<?>> createSet(Class<?>... t) {<a name="line.378"></a>
<span class="sourceLineNo">379</span> final Set<Class<?>> set= new HashSet<Class<?>>();<a name="line.379"></a>
<span class="sourceLineNo">380</span> if (t != null) {<a name="line.380"></a>
<span class="sourceLineNo">381</span> Collections.addAll(set, t);<a name="line.381"></a>
<span class="sourceLineNo">382</span> }<a name="line.382"></a>
<span class="sourceLineNo">383</span> return set;<a name="line.383"></a>
<span class="sourceLineNo">384</span> }<a name="line.384"></a>
<span class="sourceLineNo">385</span>}<a name="line.385"></a>
</pre>
</div>
</body>
</html>
|