Google Git
Sign in
apache / hbase-site / 0082cda45f48d1755543336c908ec6d80d4ec0a9 / . / testdevapidocs / src-html / org / apache / hadoop / hbase / mapreduce / TableSnapshotInputFormatTestBase.html
blob: cbcaa99932e0837dbc2e0ac03dbfdc29f8ee4226 [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: TableSnapshotInputFormatTestBase">
<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.assertFalse;</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.Arrays;</span>
<span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.conf.Configuration;</span>
<span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.fs.FileStatus;</span>
<span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.fs.FileSystem;</span>
<span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.fs.Path;</span>
<span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.hbase.Cell;</span>
<span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.hbase.CellScanner;</span>
<span class="source-line-no">030</span><span id="line-30">import org.apache.hadoop.hbase.HBaseTestingUtil;</span>
<span class="source-line-no">031</span><span id="line-31">import org.apache.hadoop.hbase.StartTestingClusterOption;</span>
<span class="source-line-no">032</span><span id="line-32">import org.apache.hadoop.hbase.TableName;</span>
<span class="source-line-no">033</span><span id="line-33">import org.apache.hadoop.hbase.client.Admin;</span>
<span class="source-line-no">034</span><span id="line-34">import org.apache.hadoop.hbase.client.Result;</span>
<span class="source-line-no">035</span><span id="line-35">import org.apache.hadoop.hbase.client.Table;</span>
<span class="source-line-no">036</span><span id="line-36">import org.apache.hadoop.hbase.io.HFileLink;</span>
<span class="source-line-no">037</span><span id="line-37">import org.apache.hadoop.hbase.io.ImmutableBytesWritable;</span>
<span class="source-line-no">038</span><span id="line-38">import org.apache.hadoop.hbase.master.snapshot.SnapshotManager;</span>
<span class="source-line-no">039</span><span id="line-39">import org.apache.hadoop.hbase.regionserver.StoreFileInfo;</span>
<span class="source-line-no">040</span><span id="line-40">import org.apache.hadoop.hbase.snapshot.SnapshotTestingUtils;</span>
<span class="source-line-no">041</span><span id="line-41">import org.apache.hadoop.hbase.util.Bytes;</span>
<span class="source-line-no">042</span><span id="line-42">import org.apache.hadoop.hbase.util.CommonFSUtils;</span>
<span class="source-line-no">043</span><span id="line-43">import org.apache.hadoop.hbase.util.FSUtils;</span>
<span class="source-line-no">044</span><span id="line-44">import org.apache.hadoop.hbase.util.HFileArchiveUtil;</span>
<span class="source-line-no">045</span><span id="line-45">import org.junit.After;</span>
<span class="source-line-no">046</span><span id="line-46">import org.junit.Assert;</span>
<span class="source-line-no">047</span><span id="line-47">import org.junit.Before;</span>
<span class="source-line-no">048</span><span id="line-48">import org.junit.Test;</span>
<span class="source-line-no">049</span><span id="line-49">import org.slf4j.Logger;</span>
<span class="source-line-no">050</span><span id="line-50">import org.slf4j.LoggerFactory;</span>
<span class="source-line-no">051</span><span id="line-51"></span>
<span class="source-line-no">052</span><span id="line-52">public abstract class TableSnapshotInputFormatTestBase {</span>
<span class="source-line-no">053</span><span id="line-53"> private static final Logger LOG = LoggerFactory.getLogger(TableSnapshotInputFormatTestBase.class);</span>
<span class="source-line-no">054</span><span id="line-54"> protected final HBaseTestingUtil UTIL = new HBaseTestingUtil();</span>
<span class="source-line-no">055</span><span id="line-55"> protected static final int NUM_REGION_SERVERS = 2;</span>
<span class="source-line-no">056</span><span id="line-56"> protected static final byte[][] FAMILIES = { Bytes.toBytes("f1"), Bytes.toBytes("f2") };</span>
<span class="source-line-no">057</span><span id="line-57"></span>
<span class="source-line-no">058</span><span id="line-58"> protected FileSystem fs;</span>
<span class="source-line-no">059</span><span id="line-59"> protected Path rootDir;</span>
<span class="source-line-no">060</span><span id="line-60"></span>
<span class="source-line-no">061</span><span id="line-61"> @Before</span>
<span class="source-line-no">062</span><span id="line-62"> public void setupCluster() throws Exception {</span>
<span class="source-line-no">063</span><span id="line-63"> setupConf(UTIL.getConfiguration());</span>
<span class="source-line-no">064</span><span id="line-64"> StartTestingClusterOption option =</span>
<span class="source-line-no">065</span><span id="line-65"> StartTestingClusterOption.builder().numRegionServers(NUM_REGION_SERVERS)</span>
<span class="source-line-no">066</span><span id="line-66"> .numDataNodes(NUM_REGION_SERVERS).createRootDir(true).build();</span>
<span class="source-line-no">067</span><span id="line-67"> UTIL.startMiniCluster(option);</span>
<span class="source-line-no">068</span><span id="line-68"> rootDir = UTIL.getHBaseCluster().getMaster().getMasterFileSystem().getRootDir();</span>
<span class="source-line-no">069</span><span id="line-69"> fs = rootDir.getFileSystem(UTIL.getConfiguration());</span>
<span class="source-line-no">070</span><span id="line-70"> }</span>
<span class="source-line-no">071</span><span id="line-71"></span>
<span class="source-line-no">072</span><span id="line-72"> @After</span>
<span class="source-line-no">073</span><span id="line-73"> public void tearDownCluster() throws Exception {</span>
<span class="source-line-no">074</span><span id="line-74"> UTIL.shutdownMiniCluster();</span>
<span class="source-line-no">075</span><span id="line-75"> }</span>
<span class="source-line-no">076</span><span id="line-76"></span>
<span class="source-line-no">077</span><span id="line-77"> private static void setupConf(Configuration conf) {</span>
<span class="source-line-no">078</span><span id="line-78"> // Enable snapshot</span>
<span class="source-line-no">079</span><span id="line-79"> conf.setBoolean(SnapshotManager.HBASE_SNAPSHOT_ENABLED, true);</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"> protected abstract void testWithMockedMapReduce(HBaseTestingUtil util, String snapshotName,</span>
<span class="source-line-no">083</span><span id="line-83"> int numRegions, int numSplitsPerRegion, int expectedNumSplits, boolean setLocalityEnabledTo)</span>
<span class="source-line-no">084</span><span id="line-84"> throws Exception;</span>
<span class="source-line-no">085</span><span id="line-85"></span>
<span class="source-line-no">086</span><span id="line-86"> protected abstract void testWithMapReduceImpl(HBaseTestingUtil util, TableName tableName,</span>
<span class="source-line-no">087</span><span id="line-87"> String snapshotName, Path tableDir, int numRegions, int numSplitsPerRegion,</span>
<span class="source-line-no">088</span><span id="line-88"> int expectedNumSplits, boolean shutdownCluster) throws Exception;</span>
<span class="source-line-no">089</span><span id="line-89"></span>
<span class="source-line-no">090</span><span id="line-90"> protected abstract byte[] getStartRow();</span>
<span class="source-line-no">091</span><span id="line-91"></span>
<span class="source-line-no">092</span><span id="line-92"> protected abstract byte[] getEndRow();</span>
<span class="source-line-no">093</span><span id="line-93"></span>
<span class="source-line-no">094</span><span id="line-94"> @Test</span>
<span class="source-line-no">095</span><span id="line-95"> public void testWithMockedMapReduceSingleRegion() throws Exception {</span>
<span class="source-line-no">096</span><span id="line-96"> testWithMockedMapReduce(UTIL, "testWithMockedMapReduceSingleRegion", 1, 1, 1, true);</span>
<span class="source-line-no">097</span><span id="line-97"> }</span>
<span class="source-line-no">098</span><span id="line-98"></span>
<span class="source-line-no">099</span><span id="line-99"> @Test</span>
<span class="source-line-no">100</span><span id="line-100"> public void testWithMockedMapReduceMultiRegion() throws Exception {</span>
<span class="source-line-no">101</span><span id="line-101"> testWithMockedMapReduce(UTIL, "testWithMockedMapReduceMultiRegion", 10, 1, 8, false);</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"> @Test</span>
<span class="source-line-no">105</span><span id="line-105"> public void testWithMapReduceSingleRegion() throws Exception {</span>
<span class="source-line-no">106</span><span id="line-106"> testWithMapReduce(UTIL, "testWithMapReduceSingleRegion", 1, 1, 1, false);</span>
<span class="source-line-no">107</span><span id="line-107"> }</span>
<span class="source-line-no">108</span><span id="line-108"></span>
<span class="source-line-no">109</span><span id="line-109"> @Test</span>
<span class="source-line-no">110</span><span id="line-110"> public void testWithMapReduceMultiRegion() throws Exception {</span>
<span class="source-line-no">111</span><span id="line-111"> testWithMapReduce(UTIL, "testWithMapReduceMultiRegion", 10, 1, 8, false);</span>
<span class="source-line-no">112</span><span id="line-112"> }</span>
<span class="source-line-no">113</span><span id="line-113"></span>
<span class="source-line-no">114</span><span id="line-114"> @Test</span>
<span class="source-line-no">115</span><span id="line-115"> // run the MR job while HBase is offline</span>
<span class="source-line-no">116</span><span id="line-116"> public void testWithMapReduceAndOfflineHBaseMultiRegion() throws Exception {</span>
<span class="source-line-no">117</span><span id="line-117"> testWithMapReduce(UTIL, "testWithMapReduceAndOfflineHBaseMultiRegion", 10, 1, 8, true);</span>
<span class="source-line-no">118</span><span id="line-118"> }</span>
<span class="source-line-no">119</span><span id="line-119"></span>
<span class="source-line-no">120</span><span id="line-120"> // Test that snapshot restore does not create back references in the HBase root dir.</span>
<span class="source-line-no">121</span><span id="line-121"> @Test</span>
<span class="source-line-no">122</span><span id="line-122"> public void testRestoreSnapshotDoesNotCreateBackRefLinks() throws Exception {</span>
<span class="source-line-no">123</span><span id="line-123"> TableName tableName = TableName.valueOf("testRestoreSnapshotDoesNotCreateBackRefLinks");</span>
<span class="source-line-no">124</span><span id="line-124"> String snapshotName = "foo";</span>
<span class="source-line-no">125</span><span id="line-125"></span>
<span class="source-line-no">126</span><span id="line-126"> try {</span>
<span class="source-line-no">127</span><span id="line-127"> createTableAndSnapshot(UTIL, tableName, snapshotName, getStartRow(), getEndRow(), 1);</span>
<span class="source-line-no">128</span><span id="line-128"></span>
<span class="source-line-no">129</span><span id="line-129"> Path tmpTableDir = UTIL.getDataTestDirOnTestFS(snapshotName);</span>
<span class="source-line-no">130</span><span id="line-130"></span>
<span class="source-line-no">131</span><span id="line-131"> testRestoreSnapshotDoesNotCreateBackRefLinksInit(tableName, snapshotName, tmpTableDir);</span>
<span class="source-line-no">132</span><span id="line-132"></span>
<span class="source-line-no">133</span><span id="line-133"> Path rootDir = CommonFSUtils.getRootDir(UTIL.getConfiguration());</span>
<span class="source-line-no">134</span><span id="line-134"> for (Path regionDir : FSUtils.getRegionDirs(fs,</span>
<span class="source-line-no">135</span><span id="line-135"> CommonFSUtils.getTableDir(rootDir, tableName))) {</span>
<span class="source-line-no">136</span><span id="line-136"> for (Path storeDir : FSUtils.getFamilyDirs(fs, regionDir)) {</span>
<span class="source-line-no">137</span><span id="line-137"> for (FileStatus status : fs.listStatus(storeDir)) {</span>
<span class="source-line-no">138</span><span id="line-138"> System.out.println(status.getPath());</span>
<span class="source-line-no">139</span><span id="line-139"> if (StoreFileInfo.isValid(status)) {</span>
<span class="source-line-no">140</span><span id="line-140"> Path archiveStoreDir = HFileArchiveUtil.getStoreArchivePath(UTIL.getConfiguration(),</span>
<span class="source-line-no">141</span><span id="line-141"> tableName, regionDir.getName(), storeDir.getName());</span>
<span class="source-line-no">142</span><span id="line-142"></span>
<span class="source-line-no">143</span><span id="line-143"> Path path = HFileLink.getBackReferencesDir(storeDir, status.getPath().getName());</span>
<span class="source-line-no">144</span><span id="line-144"> // assert back references directory is empty</span>
<span class="source-line-no">145</span><span id="line-145"> assertFalse("There is a back reference in " + path, fs.exists(path));</span>
<span class="source-line-no">146</span><span id="line-146"></span>
<span class="source-line-no">147</span><span id="line-147"> path = HFileLink.getBackReferencesDir(archiveStoreDir, status.getPath().getName());</span>
<span class="source-line-no">148</span><span id="line-148"> // assert back references directory is empty</span>
<span class="source-line-no">149</span><span id="line-149"> assertFalse("There is a back reference in " + path, fs.exists(path));</span>
<span class="source-line-no">150</span><span id="line-150"> }</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>
<span class="source-line-no">153</span><span id="line-153"> }</span>
<span class="source-line-no">154</span><span id="line-154"> } finally {</span>
<span class="source-line-no">155</span><span id="line-155"> UTIL.getAdmin().deleteSnapshot(snapshotName);</span>
<span class="source-line-no">156</span><span id="line-156"> UTIL.deleteTable(tableName);</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"> public abstract void testRestoreSnapshotDoesNotCreateBackRefLinksInit(TableName tableName,</span>
<span class="source-line-no">161</span><span id="line-161"> String snapshotName, Path tmpTableDir) throws Exception;</span>
<span class="source-line-no">162</span><span id="line-162"></span>
<span class="source-line-no">163</span><span id="line-163"> protected void testWithMapReduce(HBaseTestingUtil util, String snapshotName, int numRegions,</span>
<span class="source-line-no">164</span><span id="line-164"> int numSplitsPerRegion, int expectedNumSplits, boolean shutdownCluster) throws Exception {</span>
<span class="source-line-no">165</span><span id="line-165"> Path tableDir = util.getDataTestDirOnTestFS(snapshotName);</span>
<span class="source-line-no">166</span><span id="line-166"> TableName tableName = TableName.valueOf("testWithMapReduce");</span>
<span class="source-line-no">167</span><span id="line-167"> testWithMapReduceImpl(util, tableName, snapshotName, tableDir, numRegions, numSplitsPerRegion,</span>
<span class="source-line-no">168</span><span id="line-168"> expectedNumSplits, shutdownCluster);</span>
<span class="source-line-no">169</span><span id="line-169"> }</span>
<span class="source-line-no">170</span><span id="line-170"></span>
<span class="source-line-no">171</span><span id="line-171"> protected static void verifyRowFromMap(ImmutableBytesWritable key, Result result)</span>
<span class="source-line-no">172</span><span id="line-172"> throws IOException {</span>
<span class="source-line-no">173</span><span id="line-173"> byte[] row = key.get();</span>
<span class="source-line-no">174</span><span id="line-174"> CellScanner scanner = result.cellScanner();</span>
<span class="source-line-no">175</span><span id="line-175"> while (scanner.advance()) {</span>
<span class="source-line-no">176</span><span id="line-176"> Cell cell = scanner.current();</span>
<span class="source-line-no">177</span><span id="line-177"></span>
<span class="source-line-no">178</span><span id="line-178"> // assert that all Cells in the Result have the same key</span>
<span class="source-line-no">179</span><span id="line-179"> Assert.assertEquals(0, Bytes.compareTo(row, 0, row.length, cell.getRowArray(),</span>
<span class="source-line-no">180</span><span id="line-180"> cell.getRowOffset(), cell.getRowLength()));</span>
<span class="source-line-no">181</span><span id="line-181"> }</span>
<span class="source-line-no">182</span><span id="line-182"></span>
<span class="source-line-no">183</span><span id="line-183"> for (byte[] family : FAMILIES) {</span>
<span class="source-line-no">184</span><span id="line-184"> byte[] actual = result.getValue(family, family);</span>
<span class="source-line-no">185</span><span id="line-185"> Assert.assertArrayEquals("Row in snapshot does not match, expected:" + Bytes.toString(row)</span>
<span class="source-line-no">186</span><span id="line-186"> + " ,actual:" + Bytes.toString(actual), row, actual);</span>
<span class="source-line-no">187</span><span id="line-187"> }</span>
<span class="source-line-no">188</span><span id="line-188"> }</span>
<span class="source-line-no">189</span><span id="line-189"></span>
<span class="source-line-no">190</span><span id="line-190"> protected static void createTableAndSnapshot(HBaseTestingUtil util, TableName tableName,</span>
<span class="source-line-no">191</span><span id="line-191"> String snapshotName, byte[] startRow, byte[] endRow, int numRegions) throws Exception {</span>
<span class="source-line-no">192</span><span id="line-192"> try {</span>
<span class="source-line-no">193</span><span id="line-193"> LOG.debug("Ensuring table doesn't exist.");</span>
<span class="source-line-no">194</span><span id="line-194"> util.deleteTable(tableName);</span>
<span class="source-line-no">195</span><span id="line-195"> } catch (Exception ex) {</span>
<span class="source-line-no">196</span><span id="line-196"> // ignore</span>
<span class="source-line-no">197</span><span id="line-197"> }</span>
<span class="source-line-no">198</span><span id="line-198"></span>
<span class="source-line-no">199</span><span id="line-199"> LOG.info("creating table '" + tableName + "'");</span>
<span class="source-line-no">200</span><span id="line-200"> if (numRegions &gt; 1) {</span>
<span class="source-line-no">201</span><span id="line-201"> util.createTable(tableName, FAMILIES, 1, startRow, endRow, numRegions);</span>
<span class="source-line-no">202</span><span id="line-202"> } else {</span>
<span class="source-line-no">203</span><span id="line-203"> util.createTable(tableName, FAMILIES);</span>
<span class="source-line-no">204</span><span id="line-204"> }</span>
<span class="source-line-no">205</span><span id="line-205"> Admin admin = util.getAdmin();</span>
<span class="source-line-no">206</span><span id="line-206"></span>
<span class="source-line-no">207</span><span id="line-207"> LOG.info("put some stuff in the table");</span>
<span class="source-line-no">208</span><span id="line-208"> Table table = util.getConnection().getTable(tableName);</span>
<span class="source-line-no">209</span><span id="line-209"> util.loadTable(table, FAMILIES);</span>
<span class="source-line-no">210</span><span id="line-210"></span>
<span class="source-line-no">211</span><span id="line-211"> Path rootDir = CommonFSUtils.getRootDir(util.getConfiguration());</span>
<span class="source-line-no">212</span><span id="line-212"> FileSystem fs = rootDir.getFileSystem(util.getConfiguration());</span>
<span class="source-line-no">213</span><span id="line-213"></span>
<span class="source-line-no">214</span><span id="line-214"> LOG.info("snapshot");</span>
<span class="source-line-no">215</span><span id="line-215"> SnapshotTestingUtils.createSnapshotAndValidate(admin, tableName, Arrays.asList(FAMILIES), null,</span>
<span class="source-line-no">216</span><span id="line-216"> snapshotName, rootDir, fs, true);</span>
<span class="source-line-no">217</span><span id="line-217"></span>
<span class="source-line-no">218</span><span id="line-218"> LOG.info("load different values");</span>
<span class="source-line-no">219</span><span id="line-219"> byte[] value = Bytes.toBytes("after_snapshot_value");</span>
<span class="source-line-no">220</span><span id="line-220"> util.loadTable(table, FAMILIES, value);</span>
<span class="source-line-no">221</span><span id="line-221"></span>
<span class="source-line-no">222</span><span id="line-222"> LOG.info("cause flush to create new files in the region");</span>
<span class="source-line-no">223</span><span id="line-223"> admin.flush(tableName);</span>
<span class="source-line-no">224</span><span id="line-224"> table.close();</span>
<span class="source-line-no">225</span><span id="line-225"> }</span>
<span class="source-line-no">226</span><span id="line-226">}</span>
</pre>
</div>
</main>
</body>
</html>