blob: 3f9f3d8cd100d00f99596e4655939461ce19770f [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.mob;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>import static org.apache.hadoop.hbase.mob.MobConstants.MOB_CLEANER_BATCH_SIZE_UPPER_BOUND;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import static org.junit.Assert.assertEquals;<a name="line.21"></a>
<span class="sourceLineNo">022</span><a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.apache.hadoop.fs.FileStatus;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.hadoop.fs.Path;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.hadoop.hbase.HBaseClassTestRule;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.hadoop.hbase.HBaseTestingUtil;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.hadoop.hbase.TableName;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.hadoop.hbase.client.Admin;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.hadoop.hbase.client.BufferedMutator;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.hadoop.hbase.client.ColumnFamilyDescriptor;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.hadoop.hbase.client.ColumnFamilyDescriptorBuilder;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.hadoop.hbase.client.ConnectionFactory;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.hadoop.hbase.client.Put;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.hadoop.hbase.client.TableDescriptorBuilder;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.apache.hadoop.hbase.testclassification.MediumTests;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import org.apache.hadoop.hbase.util.Bytes;<a name="line.36"></a>
<span class="sourceLineNo">037</span>import org.apache.hadoop.hbase.util.EnvironmentEdgeManager;<a name="line.37"></a>
<span class="sourceLineNo">038</span>import org.apache.hadoop.util.ToolRunner;<a name="line.38"></a>
<span class="sourceLineNo">039</span>import org.junit.After;<a name="line.39"></a>
<span class="sourceLineNo">040</span>import org.junit.AfterClass;<a name="line.40"></a>
<span class="sourceLineNo">041</span>import org.junit.Before;<a name="line.41"></a>
<span class="sourceLineNo">042</span>import org.junit.BeforeClass;<a name="line.42"></a>
<span class="sourceLineNo">043</span>import org.junit.ClassRule;<a name="line.43"></a>
<span class="sourceLineNo">044</span>import org.junit.Test;<a name="line.44"></a>
<span class="sourceLineNo">045</span>import org.junit.experimental.categories.Category;<a name="line.45"></a>
<span class="sourceLineNo">046</span><a name="line.46"></a>
<span class="sourceLineNo">047</span>@Category(MediumTests.class)<a name="line.47"></a>
<span class="sourceLineNo">048</span>public class TestExpiredMobFileCleaner {<a name="line.48"></a>
<span class="sourceLineNo">049</span><a name="line.49"></a>
<span class="sourceLineNo">050</span> @ClassRule<a name="line.50"></a>
<span class="sourceLineNo">051</span> public static final HBaseClassTestRule CLASS_RULE =<a name="line.51"></a>
<span class="sourceLineNo">052</span> HBaseClassTestRule.forClass(TestExpiredMobFileCleaner.class);<a name="line.52"></a>
<span class="sourceLineNo">053</span><a name="line.53"></a>
<span class="sourceLineNo">054</span> private final static HBaseTestingUtil TEST_UTIL = new HBaseTestingUtil();<a name="line.54"></a>
<span class="sourceLineNo">055</span> private final static TableName tableName = TableName.valueOf("TestExpiredMobFileCleaner");<a name="line.55"></a>
<span class="sourceLineNo">056</span> private final static String family = "family";<a name="line.56"></a>
<span class="sourceLineNo">057</span> private final static byte[] row1 = Bytes.toBytes("row1");<a name="line.57"></a>
<span class="sourceLineNo">058</span> private final static byte[] row2 = Bytes.toBytes("row2");<a name="line.58"></a>
<span class="sourceLineNo">059</span> private final static byte[] row3 = Bytes.toBytes("row3");<a name="line.59"></a>
<span class="sourceLineNo">060</span> private final static byte[] qf = Bytes.toBytes("qf");<a name="line.60"></a>
<span class="sourceLineNo">061</span><a name="line.61"></a>
<span class="sourceLineNo">062</span> private static BufferedMutator table;<a name="line.62"></a>
<span class="sourceLineNo">063</span> private static Admin admin;<a name="line.63"></a>
<span class="sourceLineNo">064</span><a name="line.64"></a>
<span class="sourceLineNo">065</span> @BeforeClass<a name="line.65"></a>
<span class="sourceLineNo">066</span> public static void setUpBeforeClass() throws Exception {<a name="line.66"></a>
<span class="sourceLineNo">067</span> TEST_UTIL.getConfiguration().setInt("hfile.format.version", 3);<a name="line.67"></a>
<span class="sourceLineNo">068</span> TEST_UTIL.getConfiguration().setInt(MOB_CLEANER_BATCH_SIZE_UPPER_BOUND, 2);<a name="line.68"></a>
<span class="sourceLineNo">069</span> }<a name="line.69"></a>
<span class="sourceLineNo">070</span><a name="line.70"></a>
<span class="sourceLineNo">071</span> @AfterClass<a name="line.71"></a>
<span class="sourceLineNo">072</span> public static void tearDownAfterClass() throws Exception {<a name="line.72"></a>
<span class="sourceLineNo">073</span><a name="line.73"></a>
<span class="sourceLineNo">074</span> }<a name="line.74"></a>
<span class="sourceLineNo">075</span><a name="line.75"></a>
<span class="sourceLineNo">076</span> @Before<a name="line.76"></a>
<span class="sourceLineNo">077</span> public void setUp() throws Exception {<a name="line.77"></a>
<span class="sourceLineNo">078</span> TEST_UTIL.startMiniCluster(1);<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> @After<a name="line.81"></a>
<span class="sourceLineNo">082</span> public void tearDown() throws Exception {<a name="line.82"></a>
<span class="sourceLineNo">083</span> admin.disableTable(tableName);<a name="line.83"></a>
<span class="sourceLineNo">084</span> admin.deleteTable(tableName);<a name="line.84"></a>
<span class="sourceLineNo">085</span> admin.close();<a name="line.85"></a>
<span class="sourceLineNo">086</span> TEST_UTIL.shutdownMiniCluster();<a name="line.86"></a>
<span class="sourceLineNo">087</span> TEST_UTIL.getTestFileSystem().delete(TEST_UTIL.getDataTestDir(), true);<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> private void init() throws Exception {<a name="line.90"></a>
<span class="sourceLineNo">091</span> TableDescriptorBuilder tableDescriptorBuilder = TableDescriptorBuilder.newBuilder(tableName);<a name="line.91"></a>
<span class="sourceLineNo">092</span> ColumnFamilyDescriptor columnFamilyDescriptor =<a name="line.92"></a>
<span class="sourceLineNo">093</span> ColumnFamilyDescriptorBuilder.newBuilder(Bytes.toBytes(family)).setMobEnabled(true)<a name="line.93"></a>
<span class="sourceLineNo">094</span> .setMobThreshold(3L).setMaxVersions(4).build();<a name="line.94"></a>
<span class="sourceLineNo">095</span> tableDescriptorBuilder.setColumnFamily(columnFamilyDescriptor);<a name="line.95"></a>
<span class="sourceLineNo">096</span><a name="line.96"></a>
<span class="sourceLineNo">097</span> admin = TEST_UTIL.getAdmin();<a name="line.97"></a>
<span class="sourceLineNo">098</span> admin.createTable(tableDescriptorBuilder.build());<a name="line.98"></a>
<span class="sourceLineNo">099</span> table = ConnectionFactory.createConnection(TEST_UTIL.getConfiguration())<a name="line.99"></a>
<span class="sourceLineNo">100</span> .getBufferedMutator(tableName);<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> private void modifyColumnExpiryDays(int expireDays) throws Exception {<a name="line.103"></a>
<span class="sourceLineNo">104</span> ColumnFamilyDescriptorBuilder columnFamilyDescriptorBuilder = ColumnFamilyDescriptorBuilder<a name="line.104"></a>
<span class="sourceLineNo">105</span> .newBuilder(Bytes.toBytes(family)).setMobEnabled(true).setMobThreshold(3L);<a name="line.105"></a>
<span class="sourceLineNo">106</span> // change ttl as expire days to make some row expired<a name="line.106"></a>
<span class="sourceLineNo">107</span> int timeToLive = expireDays * secondsOfDay();<a name="line.107"></a>
<span class="sourceLineNo">108</span> columnFamilyDescriptorBuilder.setTimeToLive(timeToLive);<a name="line.108"></a>
<span class="sourceLineNo">109</span><a name="line.109"></a>
<span class="sourceLineNo">110</span> admin.modifyColumnFamily(tableName, columnFamilyDescriptorBuilder.build());<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> private void putKVAndFlush(BufferedMutator table, byte[] row, byte[] value, long ts)<a name="line.113"></a>
<span class="sourceLineNo">114</span> throws Exception {<a name="line.114"></a>
<span class="sourceLineNo">115</span><a name="line.115"></a>
<span class="sourceLineNo">116</span> Put put = new Put(row, ts);<a name="line.116"></a>
<span class="sourceLineNo">117</span> put.addColumn(Bytes.toBytes(family), qf, value);<a name="line.117"></a>
<span class="sourceLineNo">118</span> table.mutate(put);<a name="line.118"></a>
<span class="sourceLineNo">119</span><a name="line.119"></a>
<span class="sourceLineNo">120</span> table.flush();<a name="line.120"></a>
<span class="sourceLineNo">121</span> admin.flush(tableName);<a name="line.121"></a>
<span class="sourceLineNo">122</span> }<a name="line.122"></a>
<span class="sourceLineNo">123</span><a name="line.123"></a>
<span class="sourceLineNo">124</span> /**<a name="line.124"></a>
<span class="sourceLineNo">125</span> * Creates a 3 day old hfile and an 1 day old hfile then sets expiry to 2 days. Verifies that the<a name="line.125"></a>
<span class="sourceLineNo">126</span> * 3 day old hfile is removed but the 1 day one is still present after the expiry based cleaner is<a name="line.126"></a>
<span class="sourceLineNo">127</span> * run.<a name="line.127"></a>
<span class="sourceLineNo">128</span> */<a name="line.128"></a>
<span class="sourceLineNo">129</span> @Test<a name="line.129"></a>
<span class="sourceLineNo">130</span> public void testCleaner() throws Exception {<a name="line.130"></a>
<span class="sourceLineNo">131</span> init();<a name="line.131"></a>
<span class="sourceLineNo">132</span><a name="line.132"></a>
<span class="sourceLineNo">133</span> Path mobDirPath = MobUtils.getMobFamilyPath(TEST_UTIL.getConfiguration(), tableName, family);<a name="line.133"></a>
<span class="sourceLineNo">134</span><a name="line.134"></a>
<span class="sourceLineNo">135</span> byte[] dummyData = makeDummyData(600);<a name="line.135"></a>
<span class="sourceLineNo">136</span> long ts = EnvironmentEdgeManager.currentTime() - 3 * secondsOfDay() * 1000; // 3 days before<a name="line.136"></a>
<span class="sourceLineNo">137</span> putKVAndFlush(table, row1, dummyData, ts);<a name="line.137"></a>
<span class="sourceLineNo">138</span> FileStatus[] firstFiles = TEST_UTIL.getTestFileSystem().listStatus(mobDirPath);<a name="line.138"></a>
<span class="sourceLineNo">139</span> // the first mob file<a name="line.139"></a>
<span class="sourceLineNo">140</span> assertEquals("Before cleanup without delay 1", 1, firstFiles.length);<a name="line.140"></a>
<span class="sourceLineNo">141</span> String firstFile = firstFiles[0].getPath().getName();<a name="line.141"></a>
<span class="sourceLineNo">142</span><a name="line.142"></a>
<span class="sourceLineNo">143</span> // 1.5 day before<a name="line.143"></a>
<span class="sourceLineNo">144</span> ts = (long) (EnvironmentEdgeManager.currentTime() - 1.5 * secondsOfDay() * 1000);<a name="line.144"></a>
<span class="sourceLineNo">145</span> putKVAndFlush(table, row2, dummyData, ts);<a name="line.145"></a>
<span class="sourceLineNo">146</span> FileStatus[] secondFiles = TEST_UTIL.getTestFileSystem().listStatus(mobDirPath);<a name="line.146"></a>
<span class="sourceLineNo">147</span> // now there are 2 mob files<a name="line.147"></a>
<span class="sourceLineNo">148</span> assertEquals("Before cleanup without delay 2", 2, secondFiles.length);<a name="line.148"></a>
<span class="sourceLineNo">149</span> String f1 = secondFiles[0].getPath().getName();<a name="line.149"></a>
<span class="sourceLineNo">150</span> String f2 = secondFiles[1].getPath().getName();<a name="line.150"></a>
<span class="sourceLineNo">151</span> String secondFile = f1.equals(firstFile) ? f2 : f1;<a name="line.151"></a>
<span class="sourceLineNo">152</span><a name="line.152"></a>
<span class="sourceLineNo">153</span> ts = EnvironmentEdgeManager.currentTime() - 4 * secondsOfDay() * 1000; // 4 days before<a name="line.153"></a>
<span class="sourceLineNo">154</span> putKVAndFlush(table, row3, dummyData, ts);<a name="line.154"></a>
<span class="sourceLineNo">155</span> ts = EnvironmentEdgeManager.currentTime() - 4 * secondsOfDay() * 1000; // 4 days before<a name="line.155"></a>
<span class="sourceLineNo">156</span> putKVAndFlush(table, row3, dummyData, ts);<a name="line.156"></a>
<span class="sourceLineNo">157</span> FileStatus[] thirdFiles = TEST_UTIL.getTestFileSystem().listStatus(mobDirPath);<a name="line.157"></a>
<span class="sourceLineNo">158</span> // now there are 4 mob files<a name="line.158"></a>
<span class="sourceLineNo">159</span> assertEquals("Before cleanup without delay 3", 4, thirdFiles.length);<a name="line.159"></a>
<span class="sourceLineNo">160</span><a name="line.160"></a>
<span class="sourceLineNo">161</span> modifyColumnExpiryDays(2); // ttl = 2, make the first row expired<a name="line.161"></a>
<span class="sourceLineNo">162</span><a name="line.162"></a>
<span class="sourceLineNo">163</span> // run the cleaner<a name="line.163"></a>
<span class="sourceLineNo">164</span> String[] args = new String[2];<a name="line.164"></a>
<span class="sourceLineNo">165</span> args[0] = tableName.getNameAsString();<a name="line.165"></a>
<span class="sourceLineNo">166</span> args[1] = family;<a name="line.166"></a>
<span class="sourceLineNo">167</span> ToolRunner.run(TEST_UTIL.getConfiguration(), new ExpiredMobFileCleaner(), args);<a name="line.167"></a>
<span class="sourceLineNo">168</span><a name="line.168"></a>
<span class="sourceLineNo">169</span> FileStatus[] filesAfterClean = TEST_UTIL.getTestFileSystem().listStatus(mobDirPath);<a name="line.169"></a>
<span class="sourceLineNo">170</span> String lastFile = filesAfterClean[0].getPath().getName();<a name="line.170"></a>
<span class="sourceLineNo">171</span> // there are 4 mob files in total, but only 3 need to be cleaned<a name="line.171"></a>
<span class="sourceLineNo">172</span> assertEquals("After cleanup without delay 1", 1, filesAfterClean.length);<a name="line.172"></a>
<span class="sourceLineNo">173</span> assertEquals("After cleanup without delay 2", secondFile, lastFile);<a name="line.173"></a>
<span class="sourceLineNo">174</span> }<a name="line.174"></a>
<span class="sourceLineNo">175</span><a name="line.175"></a>
<span class="sourceLineNo">176</span> private int secondsOfDay() {<a name="line.176"></a>
<span class="sourceLineNo">177</span> return 24 * 3600;<a name="line.177"></a>
<span class="sourceLineNo">178</span> }<a name="line.178"></a>
<span class="sourceLineNo">179</span><a name="line.179"></a>
<span class="sourceLineNo">180</span> private byte[] makeDummyData(int size) {<a name="line.180"></a>
<span class="sourceLineNo">181</span> byte[] dummyData = new byte[size];<a name="line.181"></a>
<span class="sourceLineNo">182</span> Bytes.random(dummyData);<a name="line.182"></a>
<span class="sourceLineNo">183</span> return dummyData;<a name="line.183"></a>
<span class="sourceLineNo">184</span> }<a name="line.184"></a>
<span class="sourceLineNo">185</span>}<a name="line.185"></a>
</pre>
</div>
</body>
</html>