blob: c1e54a5cd9a2257dc20c3ca358d0fb5009bb41d1 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>Source code</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="source: package: org.apache.hadoop.hbase, class: ClassTestFinder">
<meta name="generator" content="javadoc/SourceToHTMLConverter">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body class="source-page">
<main role="main">
<div class="source-container">
<pre><span class="source-line-no">001</span><span id="line-1">/*</span>
<span class="source-line-no">002</span><span id="line-2"> * Licensed to the Apache Software Foundation (ASF) under one</span>
<span class="source-line-no">003</span><span id="line-3"> * or more contributor license agreements. See the NOTICE file</span>
<span class="source-line-no">004</span><span id="line-4"> * distributed with this work for additional information</span>
<span class="source-line-no">005</span><span id="line-5"> * regarding copyright ownership. The ASF licenses this file</span>
<span class="source-line-no">006</span><span id="line-6"> * to you under the Apache License, Version 2.0 (the</span>
<span class="source-line-no">007</span><span id="line-7"> * "License"); you may not use this file except in compliance</span>
<span class="source-line-no">008</span><span id="line-8"> * with the License. You may obtain a copy of the License at</span>
<span class="source-line-no">009</span><span id="line-9"> *</span>
<span class="source-line-no">010</span><span id="line-10"> * http://www.apache.org/licenses/LICENSE-2.0</span>
<span class="source-line-no">011</span><span id="line-11"> *</span>
<span class="source-line-no">012</span><span id="line-12"> * Unless required by applicable law or agreed to in writing, software</span>
<span class="source-line-no">013</span><span id="line-13"> * distributed under the License is distributed on an "AS IS" BASIS,</span>
<span class="source-line-no">014</span><span id="line-14"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<span class="source-line-no">015</span><span id="line-15"> * See the License for the specific language governing permissions and</span>
<span class="source-line-no">016</span><span id="line-16"> * limitations under the License.</span>
<span class="source-line-no">017</span><span id="line-17"> */</span>
<span class="source-line-no">018</span><span id="line-18">package org.apache.hadoop.hbase;</span>
<span class="source-line-no">019</span><span id="line-19"></span>
<span class="source-line-no">020</span><span id="line-20">import java.lang.reflect.Method;</span>
<span class="source-line-no">021</span><span id="line-21">import java.lang.reflect.Modifier;</span>
<span class="source-line-no">022</span><span id="line-22">import java.util.regex.Pattern;</span>
<span class="source-line-no">023</span><span id="line-23">import org.junit.Test;</span>
<span class="source-line-no">024</span><span id="line-24">import org.junit.experimental.categories.Category;</span>
<span class="source-line-no">025</span><span id="line-25">import org.junit.runners.Suite;</span>
<span class="source-line-no">026</span><span id="line-26"></span>
<span class="source-line-no">027</span><span id="line-27">/**</span>
<span class="source-line-no">028</span><span id="line-28"> * ClassFinder that is pre-configured with filters that will only allow test classes. The name is</span>
<span class="source-line-no">029</span><span id="line-29"> * strange because a logical name would start with "Test" and be confusing.</span>
<span class="source-line-no">030</span><span id="line-30"> */</span>
<span class="source-line-no">031</span><span id="line-31">public class ClassTestFinder extends ClassFinder {</span>
<span class="source-line-no">032</span><span id="line-32"></span>
<span class="source-line-no">033</span><span id="line-33"> public ClassTestFinder() {</span>
<span class="source-line-no">034</span><span id="line-34"> super(new TestFileNameFilter(), new TestFileNameFilter(), new TestClassFilter());</span>
<span class="source-line-no">035</span><span id="line-35"> }</span>
<span class="source-line-no">036</span><span id="line-36"></span>
<span class="source-line-no">037</span><span id="line-37"> public ClassTestFinder(Class&lt;?&gt; category) {</span>
<span class="source-line-no">038</span><span id="line-38"> super(new TestFileNameFilter(), new TestFileNameFilter(), new TestClassFilter(category));</span>
<span class="source-line-no">039</span><span id="line-39"> }</span>
<span class="source-line-no">040</span><span id="line-40"></span>
<span class="source-line-no">041</span><span id="line-41"> public static Class&lt;?&gt;[] getCategoryAnnotations(Class&lt;?&gt; c) {</span>
<span class="source-line-no">042</span><span id="line-42"> Category category = c.getAnnotation(Category.class);</span>
<span class="source-line-no">043</span><span id="line-43"> if (category != null) {</span>
<span class="source-line-no">044</span><span id="line-44"> return category.value();</span>
<span class="source-line-no">045</span><span id="line-45"> }</span>
<span class="source-line-no">046</span><span id="line-46"> return new Class&lt;?&gt;[0];</span>
<span class="source-line-no">047</span><span id="line-47"> }</span>
<span class="source-line-no">048</span><span id="line-48"></span>
<span class="source-line-no">049</span><span id="line-49"> /** Filters both test classes and anything in the hadoop-compat modules */</span>
<span class="source-line-no">050</span><span id="line-50"> public static class TestFileNameFilter implements FileNameFilter, ResourcePathFilter {</span>
<span class="source-line-no">051</span><span id="line-51"> private static final Pattern hadoopCompactRe = Pattern.compile("hbase-hadoop\\d?-compat");</span>
<span class="source-line-no">052</span><span id="line-52"></span>
<span class="source-line-no">053</span><span id="line-53"> @Override</span>
<span class="source-line-no">054</span><span id="line-54"> public boolean isCandidateFile(String fileName, String absFilePath) {</span>
<span class="source-line-no">055</span><span id="line-55"> boolean isTestFile = fileName.startsWith("Test") || fileName.startsWith("IntegrationTest");</span>
<span class="source-line-no">056</span><span id="line-56"> return isTestFile &amp;&amp; !hadoopCompactRe.matcher(absFilePath).find();</span>
<span class="source-line-no">057</span><span id="line-57"> }</span>
<span class="source-line-no">058</span><span id="line-58"></span>
<span class="source-line-no">059</span><span id="line-59"> @Override</span>
<span class="source-line-no">060</span><span id="line-60"> public boolean isCandidatePath(String resourcePath, boolean isJar) {</span>
<span class="source-line-no">061</span><span id="line-61"> return !hadoopCompactRe.matcher(resourcePath).find();</span>
<span class="source-line-no">062</span><span id="line-62"> }</span>
<span class="source-line-no">063</span><span id="line-63"> }</span>
<span class="source-line-no">064</span><span id="line-64"></span>
<span class="source-line-no">065</span><span id="line-65"> /*</span>
<span class="source-line-no">066</span><span id="line-66"> * A class is considered as a test class if: - it's not Abstract AND - one or more of its methods</span>
<span class="source-line-no">067</span><span id="line-67"> * is annotated with org.junit.Test OR - the class is annotated with Suite.SuiteClasses</span>
<span class="source-line-no">068</span><span id="line-68"> */</span>
<span class="source-line-no">069</span><span id="line-69"> public static class TestClassFilter implements ClassFilter {</span>
<span class="source-line-no">070</span><span id="line-70"> private Class&lt;?&gt; categoryAnnotation = null;</span>
<span class="source-line-no">071</span><span id="line-71"></span>
<span class="source-line-no">072</span><span id="line-72"> public TestClassFilter(Class&lt;?&gt; categoryAnnotation) {</span>
<span class="source-line-no">073</span><span id="line-73"> this.categoryAnnotation = categoryAnnotation;</span>
<span class="source-line-no">074</span><span id="line-74"> }</span>
<span class="source-line-no">075</span><span id="line-75"></span>
<span class="source-line-no">076</span><span id="line-76"> public TestClassFilter() {</span>
<span class="source-line-no">077</span><span id="line-77"> this(null);</span>
<span class="source-line-no">078</span><span id="line-78"> }</span>
<span class="source-line-no">079</span><span id="line-79"></span>
<span class="source-line-no">080</span><span id="line-80"> @Override</span>
<span class="source-line-no">081</span><span id="line-81"> public boolean isCandidateClass(Class&lt;?&gt; c) {</span>
<span class="source-line-no">082</span><span id="line-82"> return isTestClass(c) &amp;&amp; isCategorizedClass(c);</span>
<span class="source-line-no">083</span><span id="line-83"> }</span>
<span class="source-line-no">084</span><span id="line-84"></span>
<span class="source-line-no">085</span><span id="line-85"> private boolean isTestClass(Class&lt;?&gt; c) {</span>
<span class="source-line-no">086</span><span id="line-86"> if (Modifier.isAbstract(c.getModifiers())) {</span>
<span class="source-line-no">087</span><span id="line-87"> return false;</span>
<span class="source-line-no">088</span><span id="line-88"> }</span>
<span class="source-line-no">089</span><span id="line-89"></span>
<span class="source-line-no">090</span><span id="line-90"> if (c.getAnnotation(Suite.SuiteClasses.class) != null) {</span>
<span class="source-line-no">091</span><span id="line-91"> return true;</span>
<span class="source-line-no">092</span><span id="line-92"> }</span>
<span class="source-line-no">093</span><span id="line-93"></span>
<span class="source-line-no">094</span><span id="line-94"> for (Method met : c.getMethods()) {</span>
<span class="source-line-no">095</span><span id="line-95"> if (met.getAnnotation(Test.class) != null) {</span>
<span class="source-line-no">096</span><span id="line-96"> return true;</span>
<span class="source-line-no">097</span><span id="line-97"> }</span>
<span class="source-line-no">098</span><span id="line-98"> }</span>
<span class="source-line-no">099</span><span id="line-99"></span>
<span class="source-line-no">100</span><span id="line-100"> return false;</span>
<span class="source-line-no">101</span><span id="line-101"> }</span>
<span class="source-line-no">102</span><span id="line-102"></span>
<span class="source-line-no">103</span><span id="line-103"> private boolean isCategorizedClass(Class&lt;?&gt; c) {</span>
<span class="source-line-no">104</span><span id="line-104"> if (this.categoryAnnotation == null) {</span>
<span class="source-line-no">105</span><span id="line-105"> return true;</span>
<span class="source-line-no">106</span><span id="line-106"> }</span>
<span class="source-line-no">107</span><span id="line-107"> for (Class&lt;?&gt; cc : getCategoryAnnotations(c)) {</span>
<span class="source-line-no">108</span><span id="line-108"> if (cc.equals(this.categoryAnnotation)) {</span>
<span class="source-line-no">109</span><span id="line-109"> return true;</span>
<span class="source-line-no">110</span><span id="line-110"> }</span>
<span class="source-line-no">111</span><span id="line-111"> }</span>
<span class="source-line-no">112</span><span id="line-112"> return false;</span>
<span class="source-line-no">113</span><span id="line-113"> }</span>
<span class="source-line-no">114</span><span id="line-114"> }</span>
<span class="source-line-no">115</span><span id="line-115">}</span>
</pre>
</div>
</main>
</body>
</html>