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