blob: 8869c2246c802751457fc4ddd638b557a328fecb [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.mapreduce, class: TestImportTSVWithTTLs">
<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.mapreduce;</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 static org.junit.Assert.assertEquals;</span>
<span class="source-line-no">021</span><span id="line-21"></span>
<span class="source-line-no">022</span><span id="line-22">import java.io.IOException;</span>
<span class="source-line-no">023</span><span id="line-23">import java.util.ArrayList;</span>
<span class="source-line-no">024</span><span id="line-24">import java.util.Arrays;</span>
<span class="source-line-no">025</span><span id="line-25">import java.util.List;</span>
<span class="source-line-no">026</span><span id="line-26">import java.util.Optional;</span>
<span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.conf.Configurable;</span>
<span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.conf.Configuration;</span>
<span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.fs.FSDataOutputStream;</span>
<span class="source-line-no">030</span><span id="line-30">import org.apache.hadoop.fs.FileSystem;</span>
<span class="source-line-no">031</span><span id="line-31">import org.apache.hadoop.fs.Path;</span>
<span class="source-line-no">032</span><span id="line-32">import org.apache.hadoop.hbase.HBaseClassTestRule;</span>
<span class="source-line-no">033</span><span id="line-33">import org.apache.hadoop.hbase.HBaseTestingUtil;</span>
<span class="source-line-no">034</span><span id="line-34">import org.apache.hadoop.hbase.TableName;</span>
<span class="source-line-no">035</span><span id="line-35">import org.apache.hadoop.hbase.client.Durability;</span>
<span class="source-line-no">036</span><span id="line-36">import org.apache.hadoop.hbase.client.Put;</span>
<span class="source-line-no">037</span><span id="line-37">import org.apache.hadoop.hbase.coprocessor.ObserverContext;</span>
<span class="source-line-no">038</span><span id="line-38">import org.apache.hadoop.hbase.coprocessor.RegionCoprocessor;</span>
<span class="source-line-no">039</span><span id="line-39">import org.apache.hadoop.hbase.coprocessor.RegionCoprocessorEnvironment;</span>
<span class="source-line-no">040</span><span id="line-40">import org.apache.hadoop.hbase.coprocessor.RegionObserver;</span>
<span class="source-line-no">041</span><span id="line-41">import org.apache.hadoop.hbase.regionserver.Region;</span>
<span class="source-line-no">042</span><span id="line-42">import org.apache.hadoop.hbase.testclassification.LargeTests;</span>
<span class="source-line-no">043</span><span id="line-43">import org.apache.hadoop.hbase.testclassification.MapReduceTests;</span>
<span class="source-line-no">044</span><span id="line-44">import org.apache.hadoop.hbase.util.Bytes;</span>
<span class="source-line-no">045</span><span id="line-45">import org.apache.hadoop.hbase.wal.WALEdit;</span>
<span class="source-line-no">046</span><span id="line-46">import org.apache.hadoop.util.Tool;</span>
<span class="source-line-no">047</span><span id="line-47">import org.apache.hadoop.util.ToolRunner;</span>
<span class="source-line-no">048</span><span id="line-48">import org.junit.AfterClass;</span>
<span class="source-line-no">049</span><span id="line-49">import org.junit.BeforeClass;</span>
<span class="source-line-no">050</span><span id="line-50">import org.junit.ClassRule;</span>
<span class="source-line-no">051</span><span id="line-51">import org.junit.Rule;</span>
<span class="source-line-no">052</span><span id="line-52">import org.junit.Test;</span>
<span class="source-line-no">053</span><span id="line-53">import org.junit.experimental.categories.Category;</span>
<span class="source-line-no">054</span><span id="line-54">import org.junit.rules.TestName;</span>
<span class="source-line-no">055</span><span id="line-55">import org.slf4j.Logger;</span>
<span class="source-line-no">056</span><span id="line-56">import org.slf4j.LoggerFactory;</span>
<span class="source-line-no">057</span><span id="line-57"></span>
<span class="source-line-no">058</span><span id="line-58">@Category({ MapReduceTests.class, LargeTests.class })</span>
<span class="source-line-no">059</span><span id="line-59">public class TestImportTSVWithTTLs implements Configurable {</span>
<span class="source-line-no">060</span><span id="line-60"></span>
<span class="source-line-no">061</span><span id="line-61"> @ClassRule</span>
<span class="source-line-no">062</span><span id="line-62"> public static final HBaseClassTestRule CLASS_RULE =</span>
<span class="source-line-no">063</span><span id="line-63"> HBaseClassTestRule.forClass(TestImportTSVWithTTLs.class);</span>
<span class="source-line-no">064</span><span id="line-64"></span>
<span class="source-line-no">065</span><span id="line-65"> protected static final Logger LOG = LoggerFactory.getLogger(TestImportTSVWithTTLs.class);</span>
<span class="source-line-no">066</span><span id="line-66"> protected static final String NAME = TestImportTsv.class.getSimpleName();</span>
<span class="source-line-no">067</span><span id="line-67"> protected static HBaseTestingUtil util = new HBaseTestingUtil();</span>
<span class="source-line-no">068</span><span id="line-68"></span>
<span class="source-line-no">069</span><span id="line-69"> /**</span>
<span class="source-line-no">070</span><span id="line-70"> * Delete the tmp directory after running doMROnTableTest. Boolean. Default is false.</span>
<span class="source-line-no">071</span><span id="line-71"> */</span>
<span class="source-line-no">072</span><span id="line-72"> protected static final String DELETE_AFTER_LOAD_CONF = NAME + ".deleteAfterLoad";</span>
<span class="source-line-no">073</span><span id="line-73"></span>
<span class="source-line-no">074</span><span id="line-74"> /**</span>
<span class="source-line-no">075</span><span id="line-75"> * Force use of combiner in doMROnTableTest. Boolean. Default is true.</span>
<span class="source-line-no">076</span><span id="line-76"> */</span>
<span class="source-line-no">077</span><span id="line-77"> protected static final String FORCE_COMBINER_CONF = NAME + ".forceCombiner";</span>
<span class="source-line-no">078</span><span id="line-78"></span>
<span class="source-line-no">079</span><span id="line-79"> private final String FAMILY = "FAM";</span>
<span class="source-line-no">080</span><span id="line-80"> private static Configuration conf;</span>
<span class="source-line-no">081</span><span id="line-81"></span>
<span class="source-line-no">082</span><span id="line-82"> @Rule</span>
<span class="source-line-no">083</span><span id="line-83"> public TestName name = new TestName();</span>
<span class="source-line-no">084</span><span id="line-84"></span>
<span class="source-line-no">085</span><span id="line-85"> @Override</span>
<span class="source-line-no">086</span><span id="line-86"> public Configuration getConf() {</span>
<span class="source-line-no">087</span><span id="line-87"> return util.getConfiguration();</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"> @Override</span>
<span class="source-line-no">091</span><span id="line-91"> public void setConf(Configuration conf) {</span>
<span class="source-line-no">092</span><span id="line-92"> throw new IllegalArgumentException("setConf not supported");</span>
<span class="source-line-no">093</span><span id="line-93"> }</span>
<span class="source-line-no">094</span><span id="line-94"></span>
<span class="source-line-no">095</span><span id="line-95"> @BeforeClass</span>
<span class="source-line-no">096</span><span id="line-96"> public static void provisionCluster() throws Exception {</span>
<span class="source-line-no">097</span><span id="line-97"> conf = util.getConfiguration();</span>
<span class="source-line-no">098</span><span id="line-98"> // We don't check persistence in HFiles in this test, but if we ever do we will</span>
<span class="source-line-no">099</span><span id="line-99"> // need this where the default hfile version is not 3 (i.e. 0.98)</span>
<span class="source-line-no">100</span><span id="line-100"> conf.setInt("hfile.format.version", 3);</span>
<span class="source-line-no">101</span><span id="line-101"> conf.set("hbase.coprocessor.region.classes", TTLCheckingObserver.class.getName());</span>
<span class="source-line-no">102</span><span id="line-102"> util.startMiniCluster();</span>
<span class="source-line-no">103</span><span id="line-103"> }</span>
<span class="source-line-no">104</span><span id="line-104"></span>
<span class="source-line-no">105</span><span id="line-105"> @AfterClass</span>
<span class="source-line-no">106</span><span id="line-106"> public static void releaseCluster() throws Exception {</span>
<span class="source-line-no">107</span><span id="line-107"> util.shutdownMiniCluster();</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"> @Test</span>
<span class="source-line-no">111</span><span id="line-111"> public void testMROnTable() throws Exception {</span>
<span class="source-line-no">112</span><span id="line-112"> final TableName tableName = TableName.valueOf(name.getMethodName() + util.getRandomUUID());</span>
<span class="source-line-no">113</span><span id="line-113"></span>
<span class="source-line-no">114</span><span id="line-114"> // Prepare the arguments required for the test.</span>
<span class="source-line-no">115</span><span id="line-115"> String[] args = new String[] {</span>
<span class="source-line-no">116</span><span id="line-116"> "-D" + ImportTsv.MAPPER_CONF_KEY + "=org.apache.hadoop.hbase.mapreduce.TsvImporterMapper",</span>
<span class="source-line-no">117</span><span id="line-117"> "-D" + ImportTsv.COLUMNS_CONF_KEY + "=HBASE_ROW_KEY,FAM:A,FAM:B,HBASE_CELL_TTL",</span>
<span class="source-line-no">118</span><span id="line-118"> "-D" + ImportTsv.SEPARATOR_CONF_KEY + "=\u001b", tableName.getNameAsString() };</span>
<span class="source-line-no">119</span><span id="line-119"> String data = "KEY\u001bVALUE1\u001bVALUE2\u001b1000000\n";</span>
<span class="source-line-no">120</span><span id="line-120"> util.createTable(tableName, FAMILY);</span>
<span class="source-line-no">121</span><span id="line-121"> doMROnTableTest(util, FAMILY, data, args, 1);</span>
<span class="source-line-no">122</span><span id="line-122"> util.deleteTable(tableName);</span>
<span class="source-line-no">123</span><span id="line-123"> }</span>
<span class="source-line-no">124</span><span id="line-124"></span>
<span class="source-line-no">125</span><span id="line-125"> protected static Tool doMROnTableTest(HBaseTestingUtil util, String family, String data,</span>
<span class="source-line-no">126</span><span id="line-126"> String[] args, int valueMultiplier) throws Exception {</span>
<span class="source-line-no">127</span><span id="line-127"> TableName table = TableName.valueOf(args[args.length - 1]);</span>
<span class="source-line-no">128</span><span id="line-128"> Configuration conf = new Configuration(util.getConfiguration());</span>
<span class="source-line-no">129</span><span id="line-129"></span>
<span class="source-line-no">130</span><span id="line-130"> // populate input file</span>
<span class="source-line-no">131</span><span id="line-131"> FileSystem fs = FileSystem.get(conf);</span>
<span class="source-line-no">132</span><span id="line-132"> Path inputPath =</span>
<span class="source-line-no">133</span><span id="line-133"> fs.makeQualified(new Path(util.getDataTestDirOnTestFS(table.getNameAsString()), "input.dat"));</span>
<span class="source-line-no">134</span><span id="line-134"> FSDataOutputStream op = fs.create(inputPath, true);</span>
<span class="source-line-no">135</span><span id="line-135"> op.write(Bytes.toBytes(data));</span>
<span class="source-line-no">136</span><span id="line-136"> op.close();</span>
<span class="source-line-no">137</span><span id="line-137"> LOG.debug(String.format("Wrote test data to file: %s", inputPath));</span>
<span class="source-line-no">138</span><span id="line-138"></span>
<span class="source-line-no">139</span><span id="line-139"> if (conf.getBoolean(FORCE_COMBINER_CONF, true)) {</span>
<span class="source-line-no">140</span><span id="line-140"> LOG.debug("Forcing combiner.");</span>
<span class="source-line-no">141</span><span id="line-141"> conf.setInt("mapreduce.map.combine.minspills", 1);</span>
<span class="source-line-no">142</span><span id="line-142"> }</span>
<span class="source-line-no">143</span><span id="line-143"></span>
<span class="source-line-no">144</span><span id="line-144"> // run the import</span>
<span class="source-line-no">145</span><span id="line-145"> List&lt;String&gt; argv = new ArrayList&lt;&gt;(Arrays.asList(args));</span>
<span class="source-line-no">146</span><span id="line-146"> argv.add(inputPath.toString());</span>
<span class="source-line-no">147</span><span id="line-147"> Tool tool = new ImportTsv();</span>
<span class="source-line-no">148</span><span id="line-148"> LOG.debug("Running ImportTsv with arguments: " + argv);</span>
<span class="source-line-no">149</span><span id="line-149"> try {</span>
<span class="source-line-no">150</span><span id="line-150"> // Job will fail if observer rejects entries without TTL</span>
<span class="source-line-no">151</span><span id="line-151"> assertEquals(0, ToolRunner.run(conf, tool, argv.toArray(args)));</span>
<span class="source-line-no">152</span><span id="line-152"> } finally {</span>
<span class="source-line-no">153</span><span id="line-153"> // Clean up</span>
<span class="source-line-no">154</span><span id="line-154"> if (conf.getBoolean(DELETE_AFTER_LOAD_CONF, true)) {</span>
<span class="source-line-no">155</span><span id="line-155"> LOG.debug("Deleting test subdirectory");</span>
<span class="source-line-no">156</span><span id="line-156"> util.cleanupDataTestDirOnTestFS(table.getNameAsString());</span>
<span class="source-line-no">157</span><span id="line-157"> }</span>
<span class="source-line-no">158</span><span id="line-158"> }</span>
<span class="source-line-no">159</span><span id="line-159"></span>
<span class="source-line-no">160</span><span id="line-160"> return tool;</span>
<span class="source-line-no">161</span><span id="line-161"> }</span>
<span class="source-line-no">162</span><span id="line-162"></span>
<span class="source-line-no">163</span><span id="line-163"> public static class TTLCheckingObserver implements RegionCoprocessor, RegionObserver {</span>
<span class="source-line-no">164</span><span id="line-164"></span>
<span class="source-line-no">165</span><span id="line-165"> @Override</span>
<span class="source-line-no">166</span><span id="line-166"> public Optional&lt;RegionObserver&gt; getRegionObserver() {</span>
<span class="source-line-no">167</span><span id="line-167"> return Optional.of(this);</span>
<span class="source-line-no">168</span><span id="line-168"> }</span>
<span class="source-line-no">169</span><span id="line-169"></span>
<span class="source-line-no">170</span><span id="line-170"> @Override</span>
<span class="source-line-no">171</span><span id="line-171"> public void prePut(ObserverContext&lt;RegionCoprocessorEnvironment&gt; e, Put put, WALEdit edit,</span>
<span class="source-line-no">172</span><span id="line-172"> Durability durability) throws IOException {</span>
<span class="source-line-no">173</span><span id="line-173"> Region region = e.getEnvironment().getRegion();</span>
<span class="source-line-no">174</span><span id="line-174"> if (</span>
<span class="source-line-no">175</span><span id="line-175"> !region.getRegionInfo().isMetaRegion() &amp;&amp; !region.getRegionInfo().getTable().isSystemTable()</span>
<span class="source-line-no">176</span><span id="line-176"> ) {</span>
<span class="source-line-no">177</span><span id="line-177"> // The put carries the TTL attribute</span>
<span class="source-line-no">178</span><span id="line-178"> if (put.getTTL() != Long.MAX_VALUE) {</span>
<span class="source-line-no">179</span><span id="line-179"> return;</span>
<span class="source-line-no">180</span><span id="line-180"> }</span>
<span class="source-line-no">181</span><span id="line-181"> throw new IOException("Operation does not have TTL set");</span>
<span class="source-line-no">182</span><span id="line-182"> }</span>
<span class="source-line-no">183</span><span id="line-183"> }</span>
<span class="source-line-no">184</span><span id="line-184"> }</span>
<span class="source-line-no">185</span><span id="line-185">}</span>
</pre>
</div>
</main>
</body>
</html>