blob: 19f1d657dbfb38271f9d7db74f186c07bd3a6863 [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 java.util.List;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.util.Objects;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.util.StringJoiner;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.util.concurrent.CompletableFuture;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.util.function.Supplier;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.util.stream.Collectors;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.hadoop.hbase.client.AsyncAdmin;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.hadoop.hbase.client.AsyncConnection;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.junit.ClassRule;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.junit.Rule;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.junit.rules.ExternalResource;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.junit.rules.TestRule;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.slf4j.Logger;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.slf4j.LoggerFactory;<a name="line.33"></a>
<span class="sourceLineNo">034</span><a name="line.34"></a>
<span class="sourceLineNo">035</span>/**<a name="line.35"></a>
<span class="sourceLineNo">036</span> * A {@link TestRule} that clears all user namespaces and tables<a name="line.36"></a>
<span class="sourceLineNo">037</span> * {@link ExternalResource#before() before} the test executes. Can be used in either the<a name="line.37"></a>
<span class="sourceLineNo">038</span> * {@link Rule} or {@link ClassRule} positions. Lazily realizes the provided<a name="line.38"></a>
<span class="sourceLineNo">039</span> * {@link AsyncConnection} so as to avoid initialization races with other {@link Rule Rules}.<a name="line.39"></a>
<span class="sourceLineNo">040</span> * &lt;b&gt;Does not&lt;/b&gt; {@link AsyncConnection#close() close()} provided connection instance when<a name="line.40"></a>
<span class="sourceLineNo">041</span> * finished.<a name="line.41"></a>
<span class="sourceLineNo">042</span> * &lt;/p&gt;<a name="line.42"></a>
<span class="sourceLineNo">043</span> * Use in combination with {@link MiniClusterRule} and {@link ConnectionRule}, for example:<a name="line.43"></a>
<span class="sourceLineNo">044</span> *<a name="line.44"></a>
<span class="sourceLineNo">045</span> * &lt;pre&gt;{@code<a name="line.45"></a>
<span class="sourceLineNo">046</span> * public class TestMyClass {<a name="line.46"></a>
<span class="sourceLineNo">047</span> * @ClassRule<a name="line.47"></a>
<span class="sourceLineNo">048</span> * public static final MiniClusterRule miniClusterRule = MiniClusterRule.newBuilder().build();<a name="line.48"></a>
<span class="sourceLineNo">049</span> *<a name="line.49"></a>
<span class="sourceLineNo">050</span> * private final ConnectionRule connectionRule =<a name="line.50"></a>
<span class="sourceLineNo">051</span> * new ConnectionRule(miniClusterRule::createConnection);<a name="line.51"></a>
<span class="sourceLineNo">052</span> * private final ClearUserNamespacesAndTablesRule clearUserNamespacesAndTablesRule =<a name="line.52"></a>
<span class="sourceLineNo">053</span> * new ClearUserNamespacesAndTablesRule(connectionRule::getConnection);<a name="line.53"></a>
<span class="sourceLineNo">054</span> *<a name="line.54"></a>
<span class="sourceLineNo">055</span> * @Rule<a name="line.55"></a>
<span class="sourceLineNo">056</span> * public TestRule rule = RuleChain<a name="line.56"></a>
<span class="sourceLineNo">057</span> * .outerRule(connectionRule)<a name="line.57"></a>
<span class="sourceLineNo">058</span> * .around(clearUserNamespacesAndTablesRule);<a name="line.58"></a>
<span class="sourceLineNo">059</span> * }<a name="line.59"></a>
<span class="sourceLineNo">060</span> * }&lt;/pre&gt;<a name="line.60"></a>
<span class="sourceLineNo">061</span> */<a name="line.61"></a>
<span class="sourceLineNo">062</span>public class ClearUserNamespacesAndTablesRule extends ExternalResource {<a name="line.62"></a>
<span class="sourceLineNo">063</span> private static final Logger logger =<a name="line.63"></a>
<span class="sourceLineNo">064</span> LoggerFactory.getLogger(ClearUserNamespacesAndTablesRule.class);<a name="line.64"></a>
<span class="sourceLineNo">065</span><a name="line.65"></a>
<span class="sourceLineNo">066</span> private final Supplier&lt;AsyncConnection&gt; connectionSupplier;<a name="line.66"></a>
<span class="sourceLineNo">067</span> private AsyncAdmin admin;<a name="line.67"></a>
<span class="sourceLineNo">068</span><a name="line.68"></a>
<span class="sourceLineNo">069</span> public ClearUserNamespacesAndTablesRule(final Supplier&lt;AsyncConnection&gt; connectionSupplier) {<a name="line.69"></a>
<span class="sourceLineNo">070</span> this.connectionSupplier = connectionSupplier;<a name="line.70"></a>
<span class="sourceLineNo">071</span> }<a name="line.71"></a>
<span class="sourceLineNo">072</span><a name="line.72"></a>
<span class="sourceLineNo">073</span> @Override<a name="line.73"></a>
<span class="sourceLineNo">074</span> protected void before() throws Throwable {<a name="line.74"></a>
<span class="sourceLineNo">075</span> final AsyncConnection connection = Objects.requireNonNull(connectionSupplier.get());<a name="line.75"></a>
<span class="sourceLineNo">076</span> admin = connection.getAdmin();<a name="line.76"></a>
<span class="sourceLineNo">077</span><a name="line.77"></a>
<span class="sourceLineNo">078</span> clearTablesAndNamespaces().join();<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> private CompletableFuture&lt;Void&gt; clearTablesAndNamespaces() {<a name="line.81"></a>
<span class="sourceLineNo">082</span> return deleteUserTables().thenCompose(_void -&gt; deleteUserNamespaces());<a name="line.82"></a>
<span class="sourceLineNo">083</span> }<a name="line.83"></a>
<span class="sourceLineNo">084</span><a name="line.84"></a>
<span class="sourceLineNo">085</span> private CompletableFuture&lt;Void&gt; deleteUserTables() {<a name="line.85"></a>
<span class="sourceLineNo">086</span> return listTableNames()<a name="line.86"></a>
<span class="sourceLineNo">087</span> .thenApply(tableNames -&gt; tableNames.stream()<a name="line.87"></a>
<span class="sourceLineNo">088</span> .map(tableName -&gt; disableIfEnabled(tableName).thenCompose(_void -&gt; deleteTable(tableName)))<a name="line.88"></a>
<span class="sourceLineNo">089</span> .toArray(CompletableFuture[]::new))<a name="line.89"></a>
<span class="sourceLineNo">090</span> .thenCompose(CompletableFuture::allOf);<a name="line.90"></a>
<span class="sourceLineNo">091</span> }<a name="line.91"></a>
<span class="sourceLineNo">092</span><a name="line.92"></a>
<span class="sourceLineNo">093</span> private CompletableFuture&lt;List&lt;TableName&gt;&gt; listTableNames() {<a name="line.93"></a>
<span class="sourceLineNo">094</span> return CompletableFuture<a name="line.94"></a>
<span class="sourceLineNo">095</span> .runAsync(() -&gt; logger.trace("listing tables"))<a name="line.95"></a>
<span class="sourceLineNo">096</span> .thenCompose(_void -&gt; admin.listTableNames(false))<a name="line.96"></a>
<span class="sourceLineNo">097</span> .thenApply(tableNames -&gt; {<a name="line.97"></a>
<span class="sourceLineNo">098</span> if (logger.isTraceEnabled()) {<a name="line.98"></a>
<span class="sourceLineNo">099</span> final StringJoiner joiner = new StringJoiner(", ", "[", "]");<a name="line.99"></a>
<span class="sourceLineNo">100</span> tableNames.stream().map(TableName::getNameAsString).forEach(joiner::add);<a name="line.100"></a>
<span class="sourceLineNo">101</span> logger.trace("found existing tables {}", joiner.toString());<a name="line.101"></a>
<span class="sourceLineNo">102</span> }<a name="line.102"></a>
<span class="sourceLineNo">103</span> return tableNames;<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> private CompletableFuture&lt;Boolean&gt; isTableEnabled(final TableName tableName) {<a name="line.107"></a>
<span class="sourceLineNo">108</span> return admin.isTableEnabled(tableName)<a name="line.108"></a>
<span class="sourceLineNo">109</span> .thenApply(isEnabled -&gt; {<a name="line.109"></a>
<span class="sourceLineNo">110</span> logger.trace("table {} is enabled.", tableName);<a name="line.110"></a>
<span class="sourceLineNo">111</span> return isEnabled;<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><a name="line.114"></a>
<span class="sourceLineNo">115</span> private CompletableFuture&lt;Void&gt; disableIfEnabled(final TableName tableName) {<a name="line.115"></a>
<span class="sourceLineNo">116</span> return isTableEnabled(tableName)<a name="line.116"></a>
<span class="sourceLineNo">117</span> .thenCompose(isEnabled -&gt; isEnabled<a name="line.117"></a>
<span class="sourceLineNo">118</span> ? disableTable(tableName)<a name="line.118"></a>
<span class="sourceLineNo">119</span> : CompletableFuture.completedFuture(null));<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> private CompletableFuture&lt;Void&gt; disableTable(final TableName tableName) {<a name="line.122"></a>
<span class="sourceLineNo">123</span> return CompletableFuture<a name="line.123"></a>
<span class="sourceLineNo">124</span> .runAsync(() -&gt; logger.trace("disabling enabled table {}", tableName))<a name="line.124"></a>
<span class="sourceLineNo">125</span> .thenCompose(_void -&gt; admin.disableTable(tableName));<a name="line.125"></a>
<span class="sourceLineNo">126</span> }<a name="line.126"></a>
<span class="sourceLineNo">127</span><a name="line.127"></a>
<span class="sourceLineNo">128</span> private CompletableFuture&lt;Void&gt; deleteTable(final TableName tableName) {<a name="line.128"></a>
<span class="sourceLineNo">129</span> return CompletableFuture<a name="line.129"></a>
<span class="sourceLineNo">130</span> .runAsync(() -&gt; logger.trace("deleting disabled table {}", tableName))<a name="line.130"></a>
<span class="sourceLineNo">131</span> .thenCompose(_void -&gt; admin.deleteTable(tableName));<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> private CompletableFuture&lt;List&lt;String&gt;&gt; listUserNamespaces() {<a name="line.134"></a>
<span class="sourceLineNo">135</span> return CompletableFuture<a name="line.135"></a>
<span class="sourceLineNo">136</span> .runAsync(() -&gt; logger.trace("listing namespaces"))<a name="line.136"></a>
<span class="sourceLineNo">137</span> .thenCompose(_void -&gt; admin.listNamespaceDescriptors())<a name="line.137"></a>
<span class="sourceLineNo">138</span> .thenApply(namespaceDescriptors -&gt; {<a name="line.138"></a>
<span class="sourceLineNo">139</span> final StringJoiner joiner = new StringJoiner(", ", "[", "]");<a name="line.139"></a>
<span class="sourceLineNo">140</span> final List&lt;String&gt; names = namespaceDescriptors.stream()<a name="line.140"></a>
<span class="sourceLineNo">141</span> .map(NamespaceDescriptor::getName)<a name="line.141"></a>
<span class="sourceLineNo">142</span> .peek(joiner::add)<a name="line.142"></a>
<span class="sourceLineNo">143</span> .collect(Collectors.toList());<a name="line.143"></a>
<span class="sourceLineNo">144</span> logger.trace("found existing namespaces {}", joiner);<a name="line.144"></a>
<span class="sourceLineNo">145</span> return names;<a name="line.145"></a>
<span class="sourceLineNo">146</span> })<a name="line.146"></a>
<span class="sourceLineNo">147</span> .thenApply(namespaces -&gt; namespaces.stream()<a name="line.147"></a>
<span class="sourceLineNo">148</span> .filter(namespace -&gt; !Objects.equals(<a name="line.148"></a>
<span class="sourceLineNo">149</span> namespace, NamespaceDescriptor.SYSTEM_NAMESPACE.getName()))<a name="line.149"></a>
<span class="sourceLineNo">150</span> .filter(namespace -&gt; !Objects.equals(<a name="line.150"></a>
<span class="sourceLineNo">151</span> namespace, NamespaceDescriptor.DEFAULT_NAMESPACE.getName()))<a name="line.151"></a>
<span class="sourceLineNo">152</span> .collect(Collectors.toList()));<a name="line.152"></a>
<span class="sourceLineNo">153</span> }<a name="line.153"></a>
<span class="sourceLineNo">154</span><a name="line.154"></a>
<span class="sourceLineNo">155</span> private CompletableFuture&lt;Void&gt; deleteNamespace(final String namespace) {<a name="line.155"></a>
<span class="sourceLineNo">156</span> return CompletableFuture<a name="line.156"></a>
<span class="sourceLineNo">157</span> .runAsync(() -&gt; logger.trace("deleting namespace {}", namespace))<a name="line.157"></a>
<span class="sourceLineNo">158</span> .thenCompose(_void -&gt; admin.deleteNamespace(namespace));<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> private CompletableFuture&lt;Void&gt; deleteUserNamespaces() {<a name="line.161"></a>
<span class="sourceLineNo">162</span> return listUserNamespaces()<a name="line.162"></a>
<span class="sourceLineNo">163</span> .thenCompose(namespaces -&gt; CompletableFuture.allOf(namespaces.stream()<a name="line.163"></a>
<span class="sourceLineNo">164</span> .map(this::deleteNamespace)<a name="line.164"></a>
<span class="sourceLineNo">165</span> .toArray(CompletableFuture[]::new)));<a name="line.165"></a>
<span class="sourceLineNo">166</span> }<a name="line.166"></a>
<span class="sourceLineNo">167</span>}<a name="line.167"></a>
</pre>
</div>
</body>
</html>