Google Git
Sign in
apache / hbase-site / 184b81ff8411d46ef697dbc70af955325fbab85c / . / testdevapidocs / src-html / org / apache / hadoop / hbase / security / access / TestHDFSAclHelper.html
blob: 3361665d1950c69e78e3348c10b8372f175b51f5 [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.security.access;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>import org.apache.hadoop.conf.Configuration;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import org.apache.hadoop.fs.Path;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import org.apache.hadoop.hbase.HBaseTestingUtility;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.apache.hadoop.hbase.NamespaceDescriptor;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.hadoop.hbase.TableName;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.hadoop.hbase.client.*;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.hadoop.hbase.security.User;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.hadoop.hbase.util.Bytes;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.slf4j.Logger;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.slf4j.LoggerFactory;<a name="line.29"></a>
<span class="sourceLineNo">030</span><a name="line.30"></a>
<span class="sourceLineNo">031</span>import java.io.IOException;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import java.security.PrivilegedExceptionAction;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import java.util.ArrayList;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import java.util.Arrays;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import java.util.List;<a name="line.35"></a>
<span class="sourceLineNo">036</span><a name="line.36"></a>
<span class="sourceLineNo">037</span>import static org.junit.Assert.assertEquals;<a name="line.37"></a>
<span class="sourceLineNo">038</span><a name="line.38"></a>
<span class="sourceLineNo">039</span>final class TestHDFSAclHelper {<a name="line.39"></a>
<span class="sourceLineNo">040</span> private static final Logger LOG = LoggerFactory.getLogger(TestHDFSAclHelper.class);<a name="line.40"></a>
<span class="sourceLineNo">041</span><a name="line.41"></a>
<span class="sourceLineNo">042</span> private TestHDFSAclHelper() {<a name="line.42"></a>
<span class="sourceLineNo">043</span> }<a name="line.43"></a>
<span class="sourceLineNo">044</span><a name="line.44"></a>
<span class="sourceLineNo">045</span> static void grantOnTable(HBaseTestingUtility util, String user, TableName tableName,<a name="line.45"></a>
<span class="sourceLineNo">046</span> Permission.Action... actions) throws Exception {<a name="line.46"></a>
<span class="sourceLineNo">047</span> SecureTestUtil.grantOnTable(util, user, tableName, null, null, actions);<a name="line.47"></a>
<span class="sourceLineNo">048</span> }<a name="line.48"></a>
<span class="sourceLineNo">049</span><a name="line.49"></a>
<span class="sourceLineNo">050</span> static void createNamespace(HBaseTestingUtility util, String namespace) throws IOException {<a name="line.50"></a>
<span class="sourceLineNo">051</span> if (Arrays.stream(util.getAdmin().listNamespaceDescriptors())<a name="line.51"></a>
<span class="sourceLineNo">052</span> .noneMatch(ns -&gt; ns.getName().equals(namespace))) {<a name="line.52"></a>
<span class="sourceLineNo">053</span> NamespaceDescriptor namespaceDescriptor = NamespaceDescriptor.create(namespace).build();<a name="line.53"></a>
<span class="sourceLineNo">054</span> util.getAdmin().createNamespace(namespaceDescriptor);<a name="line.54"></a>
<span class="sourceLineNo">055</span> }<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> static Table createTable(HBaseTestingUtility util, TableName tableName) throws IOException {<a name="line.58"></a>
<span class="sourceLineNo">059</span> createNamespace(util, tableName.getNamespaceAsString());<a name="line.59"></a>
<span class="sourceLineNo">060</span> TableDescriptor td = getTableDescriptorBuilder(util, tableName)<a name="line.60"></a>
<span class="sourceLineNo">061</span> .setValue(SnapshotScannerHDFSAclHelper.ACL_SYNC_TO_HDFS_ENABLE, "true").build();<a name="line.61"></a>
<span class="sourceLineNo">062</span> byte[][] splits = new byte[][] { Bytes.toBytes("2"), Bytes.toBytes("4") };<a name="line.62"></a>
<span class="sourceLineNo">063</span> return util.createTable(td, splits);<a name="line.63"></a>
<span class="sourceLineNo">064</span> }<a name="line.64"></a>
<span class="sourceLineNo">065</span><a name="line.65"></a>
<span class="sourceLineNo">066</span> static Table createMobTable(HBaseTestingUtility util, TableName tableName) throws IOException {<a name="line.66"></a>
<span class="sourceLineNo">067</span> createNamespace(util, tableName.getNamespaceAsString());<a name="line.67"></a>
<span class="sourceLineNo">068</span> TableDescriptor td = TableDescriptorBuilder.newBuilder(tableName)<a name="line.68"></a>
<span class="sourceLineNo">069</span> .setColumnFamily(ColumnFamilyDescriptorBuilder.newBuilder(COLUMN1).setMobEnabled(true)<a name="line.69"></a>
<span class="sourceLineNo">070</span> .setMobThreshold(0).build())<a name="line.70"></a>
<span class="sourceLineNo">071</span> .setColumnFamily(ColumnFamilyDescriptorBuilder.newBuilder(COLUMN2).setMobEnabled(true)<a name="line.71"></a>
<span class="sourceLineNo">072</span> .setMobThreshold(0).build())<a name="line.72"></a>
<span class="sourceLineNo">073</span> .setOwner(User.createUserForTesting(util.getConfiguration(), "owner", new String[] {}))<a name="line.73"></a>
<span class="sourceLineNo">074</span> .setValue(SnapshotScannerHDFSAclHelper.ACL_SYNC_TO_HDFS_ENABLE, "true").build();<a name="line.74"></a>
<span class="sourceLineNo">075</span> byte[][] splits = new byte[][] { Bytes.toBytes("2"), Bytes.toBytes("4") };<a name="line.75"></a>
<span class="sourceLineNo">076</span> return util.createTable(td, splits);<a name="line.76"></a>
<span class="sourceLineNo">077</span> }<a name="line.77"></a>
<span class="sourceLineNo">078</span><a name="line.78"></a>
<span class="sourceLineNo">079</span> static TableDescriptor createUserScanSnapshotDisabledTable(HBaseTestingUtility util,<a name="line.79"></a>
<span class="sourceLineNo">080</span> TableName tableName) throws IOException {<a name="line.80"></a>
<span class="sourceLineNo">081</span> createNamespace(util, tableName.getNamespaceAsString());<a name="line.81"></a>
<span class="sourceLineNo">082</span> TableDescriptor td = getTableDescriptorBuilder(util, tableName).build();<a name="line.82"></a>
<span class="sourceLineNo">083</span> byte[][] splits = new byte[][] { Bytes.toBytes("2"), Bytes.toBytes("4") };<a name="line.83"></a>
<span class="sourceLineNo">084</span> try (Table t = util.createTable(td, splits)) {<a name="line.84"></a>
<span class="sourceLineNo">085</span> put(t);<a name="line.85"></a>
<span class="sourceLineNo">086</span> }<a name="line.86"></a>
<span class="sourceLineNo">087</span> return td;<a name="line.87"></a>
<span class="sourceLineNo">088</span> }<a name="line.88"></a>
<span class="sourceLineNo">089</span><a name="line.89"></a>
<span class="sourceLineNo">090</span> static TableDescriptorBuilder getTableDescriptorBuilder(HBaseTestingUtility util,<a name="line.90"></a>
<span class="sourceLineNo">091</span> TableName tableName) {<a name="line.91"></a>
<span class="sourceLineNo">092</span> return TableDescriptorBuilder.newBuilder(tableName)<a name="line.92"></a>
<span class="sourceLineNo">093</span> .setColumnFamily(ColumnFamilyDescriptorBuilder.newBuilder(COLUMN1).build())<a name="line.93"></a>
<span class="sourceLineNo">094</span> .setColumnFamily(ColumnFamilyDescriptorBuilder.newBuilder(COLUMN2).build())<a name="line.94"></a>
<span class="sourceLineNo">095</span> .setOwner(User.createUserForTesting(util.getConfiguration(), "owner", new String[] {}));<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> static void createTableAndPut(HBaseTestingUtility util, TableName tableNam) throws IOException {<a name="line.98"></a>
<span class="sourceLineNo">099</span> try (Table t = createTable(util, tableNam)) {<a name="line.99"></a>
<span class="sourceLineNo">100</span> put(t);<a name="line.100"></a>
<span class="sourceLineNo">101</span> }<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> static final byte[] COLUMN1 = Bytes.toBytes("A");<a name="line.104"></a>
<span class="sourceLineNo">105</span> static final byte[] COLUMN2 = Bytes.toBytes("B");<a name="line.105"></a>
<span class="sourceLineNo">106</span><a name="line.106"></a>
<span class="sourceLineNo">107</span> static void put(Table hTable) throws IOException {<a name="line.107"></a>
<span class="sourceLineNo">108</span> List&lt;Put&gt; puts = new ArrayList&lt;&gt;();<a name="line.108"></a>
<span class="sourceLineNo">109</span> for (int i = 0; i &lt; 6; i++) {<a name="line.109"></a>
<span class="sourceLineNo">110</span> Put put = new Put(Bytes.toBytes(i));<a name="line.110"></a>
<span class="sourceLineNo">111</span> put.addColumn(COLUMN1, null, Bytes.toBytes(i));<a name="line.111"></a>
<span class="sourceLineNo">112</span> put.addColumn(COLUMN2, null, Bytes.toBytes(i + 1));<a name="line.112"></a>
<span class="sourceLineNo">113</span> puts.add(put);<a name="line.113"></a>
<span class="sourceLineNo">114</span> }<a name="line.114"></a>
<span class="sourceLineNo">115</span> hTable.put(puts);<a name="line.115"></a>
<span class="sourceLineNo">116</span> }<a name="line.116"></a>
<span class="sourceLineNo">117</span><a name="line.117"></a>
<span class="sourceLineNo">118</span> static void put2(Table hTable) throws IOException {<a name="line.118"></a>
<span class="sourceLineNo">119</span> List&lt;Put&gt; puts = new ArrayList&lt;&gt;();<a name="line.119"></a>
<span class="sourceLineNo">120</span> for (int i = 0; i &lt; 10; i++) {<a name="line.120"></a>
<span class="sourceLineNo">121</span> if (i == 5) {<a name="line.121"></a>
<span class="sourceLineNo">122</span> continue;<a name="line.122"></a>
<span class="sourceLineNo">123</span> }<a name="line.123"></a>
<span class="sourceLineNo">124</span> Put put = new Put(Bytes.toBytes(i));<a name="line.124"></a>
<span class="sourceLineNo">125</span> put.addColumn(COLUMN1, null, Bytes.toBytes(i + 2));<a name="line.125"></a>
<span class="sourceLineNo">126</span> put.addColumn(COLUMN2, null, Bytes.toBytes(i + 3));<a name="line.126"></a>
<span class="sourceLineNo">127</span> puts.add(put);<a name="line.127"></a>
<span class="sourceLineNo">128</span> }<a name="line.128"></a>
<span class="sourceLineNo">129</span> hTable.put(puts);<a name="line.129"></a>
<span class="sourceLineNo">130</span> }<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> * Check if user is able to read expected rows from the specific snapshot<a name="line.133"></a>
<span class="sourceLineNo">134</span> * @param user the specific user<a name="line.134"></a>
<span class="sourceLineNo">135</span> * @param snapshot the snapshot to be scanned<a name="line.135"></a>
<span class="sourceLineNo">136</span> * @param expectedRowCount expected row count read from snapshot, -1 if expects<a name="line.136"></a>
<span class="sourceLineNo">137</span> * AccessControlException<a name="line.137"></a>
<span class="sourceLineNo">138</span> * @throws IOException user scan snapshot error<a name="line.138"></a>
<span class="sourceLineNo">139</span> * @throws InterruptedException user scan snapshot error<a name="line.139"></a>
<span class="sourceLineNo">140</span> */<a name="line.140"></a>
<span class="sourceLineNo">141</span> static void canUserScanSnapshot(HBaseTestingUtility util, User user, String snapshot,<a name="line.141"></a>
<span class="sourceLineNo">142</span> int expectedRowCount) throws IOException, InterruptedException {<a name="line.142"></a>
<span class="sourceLineNo">143</span> PrivilegedExceptionAction&lt;Void&gt; action =<a name="line.143"></a>
<span class="sourceLineNo">144</span> getScanSnapshotAction(util.getConfiguration(), snapshot, expectedRowCount);<a name="line.144"></a>
<span class="sourceLineNo">145</span> user.runAs(action);<a name="line.145"></a>
<span class="sourceLineNo">146</span> }<a name="line.146"></a>
<span class="sourceLineNo">147</span><a name="line.147"></a>
<span class="sourceLineNo">148</span> static PrivilegedExceptionAction&lt;Void&gt; getScanSnapshotAction(Configuration conf,<a name="line.148"></a>
<span class="sourceLineNo">149</span> String snapshotName, long expectedRowCount) {<a name="line.149"></a>
<span class="sourceLineNo">150</span> return () -&gt; {<a name="line.150"></a>
<span class="sourceLineNo">151</span> try {<a name="line.151"></a>
<span class="sourceLineNo">152</span> Path restoreDir = new Path(SnapshotScannerHDFSAclHelper.SNAPSHOT_RESTORE_TMP_DIR_DEFAULT);<a name="line.152"></a>
<span class="sourceLineNo">153</span> Scan scan = new Scan();<a name="line.153"></a>
<span class="sourceLineNo">154</span> TableSnapshotScanner scanner =<a name="line.154"></a>
<span class="sourceLineNo">155</span> new TableSnapshotScanner(conf, restoreDir, snapshotName, scan);<a name="line.155"></a>
<span class="sourceLineNo">156</span> int rowCount = 0;<a name="line.156"></a>
<span class="sourceLineNo">157</span> while (true) {<a name="line.157"></a>
<span class="sourceLineNo">158</span> Result result = scanner.next();<a name="line.158"></a>
<span class="sourceLineNo">159</span> if (result == null) {<a name="line.159"></a>
<span class="sourceLineNo">160</span> break;<a name="line.160"></a>
<span class="sourceLineNo">161</span> }<a name="line.161"></a>
<span class="sourceLineNo">162</span> rowCount++;<a name="line.162"></a>
<span class="sourceLineNo">163</span> }<a name="line.163"></a>
<span class="sourceLineNo">164</span> scanner.close();<a name="line.164"></a>
<span class="sourceLineNo">165</span> assertEquals(expectedRowCount, rowCount);<a name="line.165"></a>
<span class="sourceLineNo">166</span> } catch (Exception e) {<a name="line.166"></a>
<span class="sourceLineNo">167</span> LOG.debug("Scan snapshot error, snapshot {}", snapshotName, e);<a name="line.167"></a>
<span class="sourceLineNo">168</span> assertEquals(expectedRowCount, -1);<a name="line.168"></a>
<span class="sourceLineNo">169</span> }<a name="line.169"></a>
<span class="sourceLineNo">170</span> return null;<a name="line.170"></a>
<span class="sourceLineNo">171</span> };<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>
</pre>
</div>
</body>
</html>