blob: c5221569af39d18f0dafc01cae8223d55c2d669e [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.client, class: TestSnapshotWithTTLFromClient">
<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.client;</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">import static org.junit.Assert.assertFalse;</span>
<span class="source-line-no">022</span><span id="line-22">import static org.junit.Assert.assertTrue;</span>
<span class="source-line-no">023</span><span id="line-23">import static org.junit.Assert.fail;</span>
<span class="source-line-no">024</span><span id="line-24"></span>
<span class="source-line-no">025</span><span id="line-25">import java.io.IOException;</span>
<span class="source-line-no">026</span><span id="line-26">import java.util.HashMap;</span>
<span class="source-line-no">027</span><span id="line-27">import java.util.List;</span>
<span class="source-line-no">028</span><span id="line-28">import java.util.Map;</span>
<span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.conf.Configuration;</span>
<span class="source-line-no">030</span><span id="line-30">import org.apache.hadoop.hbase.HBaseClassTestRule;</span>
<span class="source-line-no">031</span><span id="line-31">import org.apache.hadoop.hbase.HBaseTestingUtil;</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.master.snapshot.SnapshotManager;</span>
<span class="source-line-no">034</span><span id="line-34">import org.apache.hadoop.hbase.snapshot.SnapshotTTLExpiredException;</span>
<span class="source-line-no">035</span><span id="line-35">import org.apache.hadoop.hbase.snapshot.SnapshotTestingUtils;</span>
<span class="source-line-no">036</span><span id="line-36">import org.apache.hadoop.hbase.testclassification.ClientTests;</span>
<span class="source-line-no">037</span><span id="line-37">import org.apache.hadoop.hbase.testclassification.LargeTests;</span>
<span class="source-line-no">038</span><span id="line-38">import org.apache.hadoop.hbase.util.Bytes;</span>
<span class="source-line-no">039</span><span id="line-39">import org.apache.hadoop.hbase.util.Threads;</span>
<span class="source-line-no">040</span><span id="line-40">import org.junit.After;</span>
<span class="source-line-no">041</span><span id="line-41">import org.junit.AfterClass;</span>
<span class="source-line-no">042</span><span id="line-42">import org.junit.Before;</span>
<span class="source-line-no">043</span><span id="line-43">import org.junit.BeforeClass;</span>
<span class="source-line-no">044</span><span id="line-44">import org.junit.ClassRule;</span>
<span class="source-line-no">045</span><span id="line-45">import org.junit.Test;</span>
<span class="source-line-no">046</span><span id="line-46">import org.junit.experimental.categories.Category;</span>
<span class="source-line-no">047</span><span id="line-47">import org.slf4j.Logger;</span>
<span class="source-line-no">048</span><span id="line-48">import org.slf4j.LoggerFactory;</span>
<span class="source-line-no">049</span><span id="line-49"></span>
<span class="source-line-no">050</span><span id="line-50">/**</span>
<span class="source-line-no">051</span><span id="line-51"> * Test restore/clone snapshots with TTL from the client</span>
<span class="source-line-no">052</span><span id="line-52"> */</span>
<span class="source-line-no">053</span><span id="line-53">@Category({ LargeTests.class, ClientTests.class })</span>
<span class="source-line-no">054</span><span id="line-54">public class TestSnapshotWithTTLFromClient {</span>
<span class="source-line-no">055</span><span id="line-55"></span>
<span class="source-line-no">056</span><span id="line-56"> @ClassRule</span>
<span class="source-line-no">057</span><span id="line-57"> public static final HBaseClassTestRule CLASS_RULE =</span>
<span class="source-line-no">058</span><span id="line-58"> HBaseClassTestRule.forClass(TestSnapshotWithTTLFromClient.class);</span>
<span class="source-line-no">059</span><span id="line-59"></span>
<span class="source-line-no">060</span><span id="line-60"> private static final Logger LOG = LoggerFactory.getLogger(TestSnapshotWithTTLFromClient.class);</span>
<span class="source-line-no">061</span><span id="line-61"></span>
<span class="source-line-no">062</span><span id="line-62"> private static final HBaseTestingUtil UTIL = new HBaseTestingUtil();</span>
<span class="source-line-no">063</span><span id="line-63"> private static final int NUM_RS = 2;</span>
<span class="source-line-no">064</span><span id="line-64"> private static final String STRING_TABLE_NAME = "test";</span>
<span class="source-line-no">065</span><span id="line-65"> private static final byte[] TEST_FAM = Bytes.toBytes("fam");</span>
<span class="source-line-no">066</span><span id="line-66"> private static final TableName TABLE_NAME = TableName.valueOf(STRING_TABLE_NAME);</span>
<span class="source-line-no">067</span><span id="line-67"> private static final TableName CLONED_TABLE_NAME = TableName.valueOf("clonedTable");</span>
<span class="source-line-no">068</span><span id="line-68"> private static final String TTL_KEY = "TTL";</span>
<span class="source-line-no">069</span><span id="line-69"> private static final int CHORE_INTERVAL_SECS = 30;</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"> * Setup the config for the cluster</span>
<span class="source-line-no">073</span><span id="line-73"> * @throws Exception on failure</span>
<span class="source-line-no">074</span><span id="line-74"> */</span>
<span class="source-line-no">075</span><span id="line-75"> @BeforeClass</span>
<span class="source-line-no">076</span><span id="line-76"> public static void setupCluster() throws Exception {</span>
<span class="source-line-no">077</span><span id="line-77"> setupConf(UTIL.getConfiguration());</span>
<span class="source-line-no">078</span><span id="line-78"> UTIL.startMiniCluster(NUM_RS);</span>
<span class="source-line-no">079</span><span id="line-79"> }</span>
<span class="source-line-no">080</span><span id="line-80"></span>
<span class="source-line-no">081</span><span id="line-81"> protected static void setupConf(Configuration conf) {</span>
<span class="source-line-no">082</span><span id="line-82"> // Enable snapshot</span>
<span class="source-line-no">083</span><span id="line-83"> conf.setBoolean(SnapshotManager.HBASE_SNAPSHOT_ENABLED, true);</span>
<span class="source-line-no">084</span><span id="line-84"></span>
<span class="source-line-no">085</span><span id="line-85"> // Set this to high value so that cleaner chore is not triggered</span>
<span class="source-line-no">086</span><span id="line-86"> conf.setInt("hbase.master.cleaner.snapshot.interval", CHORE_INTERVAL_SECS * 60 * 1000);</span>
<span class="source-line-no">087</span><span id="line-87"> }</span>
<span class="source-line-no">088</span><span id="line-88"></span>
<span class="source-line-no">089</span><span id="line-89"> @Before</span>
<span class="source-line-no">090</span><span id="line-90"> public void setup() throws Exception {</span>
<span class="source-line-no">091</span><span id="line-91"> createTable();</span>
<span class="source-line-no">092</span><span id="line-92"> }</span>
<span class="source-line-no">093</span><span id="line-93"></span>
<span class="source-line-no">094</span><span id="line-94"> protected void createTable() throws Exception {</span>
<span class="source-line-no">095</span><span id="line-95"> UTIL.createTable(TABLE_NAME, new byte[][] { TEST_FAM });</span>
<span class="source-line-no">096</span><span id="line-96"> }</span>
<span class="source-line-no">097</span><span id="line-97"></span>
<span class="source-line-no">098</span><span id="line-98"> @After</span>
<span class="source-line-no">099</span><span id="line-99"> public void tearDown() throws Exception {</span>
<span class="source-line-no">100</span><span id="line-100"> UTIL.deleteTableIfAny(TABLE_NAME);</span>
<span class="source-line-no">101</span><span id="line-101"> UTIL.deleteTableIfAny(CLONED_TABLE_NAME);</span>
<span class="source-line-no">102</span><span id="line-102"> SnapshotTestingUtils.deleteAllSnapshots(UTIL.getAdmin());</span>
<span class="source-line-no">103</span><span id="line-103"> SnapshotTestingUtils.deleteArchiveDirectory(UTIL);</span>
<span class="source-line-no">104</span><span id="line-104"> }</span>
<span class="source-line-no">105</span><span id="line-105"></span>
<span class="source-line-no">106</span><span id="line-106"> @AfterClass</span>
<span class="source-line-no">107</span><span id="line-107"> public static void cleanupTest() throws Exception {</span>
<span class="source-line-no">108</span><span id="line-108"> try {</span>
<span class="source-line-no">109</span><span id="line-109"> UTIL.shutdownMiniCluster();</span>
<span class="source-line-no">110</span><span id="line-110"> } catch (Exception e) {</span>
<span class="source-line-no">111</span><span id="line-111"> LOG.warn("failure shutting down cluster", e);</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"></span>
<span class="source-line-no">115</span><span id="line-115"> @Test</span>
<span class="source-line-no">116</span><span id="line-116"> public void testRestoreSnapshotWithTTLSuccess() throws Exception {</span>
<span class="source-line-no">117</span><span id="line-117"> String snapshotName = "nonExpiredTTLRestoreSnapshotTest";</span>
<span class="source-line-no">118</span><span id="line-118"></span>
<span class="source-line-no">119</span><span id="line-119"> // table should exist</span>
<span class="source-line-no">120</span><span id="line-120"> assertTrue(UTIL.getAdmin().tableExists(TABLE_NAME));</span>
<span class="source-line-no">121</span><span id="line-121"></span>
<span class="source-line-no">122</span><span id="line-122"> // create snapshot fo given table with specified ttl</span>
<span class="source-line-no">123</span><span id="line-123"> createSnapshotWithTTL(TABLE_NAME, snapshotName, CHORE_INTERVAL_SECS * 2);</span>
<span class="source-line-no">124</span><span id="line-124"> Admin admin = UTIL.getAdmin();</span>
<span class="source-line-no">125</span><span id="line-125"></span>
<span class="source-line-no">126</span><span id="line-126"> // Disable and drop table</span>
<span class="source-line-no">127</span><span id="line-127"> admin.disableTable(TABLE_NAME);</span>
<span class="source-line-no">128</span><span id="line-128"> admin.deleteTable(TABLE_NAME);</span>
<span class="source-line-no">129</span><span id="line-129"> assertFalse(UTIL.getAdmin().tableExists(TABLE_NAME));</span>
<span class="source-line-no">130</span><span id="line-130"></span>
<span class="source-line-no">131</span><span id="line-131"> // restore snapshot</span>
<span class="source-line-no">132</span><span id="line-132"> admin.restoreSnapshot(snapshotName);</span>
<span class="source-line-no">133</span><span id="line-133"></span>
<span class="source-line-no">134</span><span id="line-134"> // table should be created</span>
<span class="source-line-no">135</span><span id="line-135"> assertTrue(UTIL.getAdmin().tableExists(TABLE_NAME));</span>
<span class="source-line-no">136</span><span id="line-136"> }</span>
<span class="source-line-no">137</span><span id="line-137"></span>
<span class="source-line-no">138</span><span id="line-138"> @Test</span>
<span class="source-line-no">139</span><span id="line-139"> public void testRestoreSnapshotFailsDueToTTLExpired() throws Exception {</span>
<span class="source-line-no">140</span><span id="line-140"> String snapshotName = "expiredTTLRestoreSnapshotTest";</span>
<span class="source-line-no">141</span><span id="line-141"></span>
<span class="source-line-no">142</span><span id="line-142"> // table should exist</span>
<span class="source-line-no">143</span><span id="line-143"> assertTrue(UTIL.getAdmin().tableExists(TABLE_NAME));</span>
<span class="source-line-no">144</span><span id="line-144"></span>
<span class="source-line-no">145</span><span id="line-145"> // create snapshot fo given table with specified ttl</span>
<span class="source-line-no">146</span><span id="line-146"> createSnapshotWithTTL(TABLE_NAME, snapshotName, 1);</span>
<span class="source-line-no">147</span><span id="line-147"> Admin admin = UTIL.getAdmin();</span>
<span class="source-line-no">148</span><span id="line-148"></span>
<span class="source-line-no">149</span><span id="line-149"> // Disable and drop table</span>
<span class="source-line-no">150</span><span id="line-150"> admin.disableTable(TABLE_NAME);</span>
<span class="source-line-no">151</span><span id="line-151"> admin.deleteTable(TABLE_NAME);</span>
<span class="source-line-no">152</span><span id="line-152"> assertFalse(UTIL.getAdmin().tableExists(TABLE_NAME));</span>
<span class="source-line-no">153</span><span id="line-153"></span>
<span class="source-line-no">154</span><span id="line-154"> // Sleep so that TTL may expire</span>
<span class="source-line-no">155</span><span id="line-155"> Threads.sleep(2000);</span>
<span class="source-line-no">156</span><span id="line-156"></span>
<span class="source-line-no">157</span><span id="line-157"> // restore snapshot which has expired</span>
<span class="source-line-no">158</span><span id="line-158"> try {</span>
<span class="source-line-no">159</span><span id="line-159"> admin.restoreSnapshot(snapshotName);</span>
<span class="source-line-no">160</span><span id="line-160"> fail("Restore snapshot succeeded even though TTL has expired.");</span>
<span class="source-line-no">161</span><span id="line-161"> } catch (SnapshotTTLExpiredException e) {</span>
<span class="source-line-no">162</span><span id="line-162"> LOG.info("Correctly failed to restore a TTL expired snapshot table:" + e.getMessage());</span>
<span class="source-line-no">163</span><span id="line-163"> }</span>
<span class="source-line-no">164</span><span id="line-164"></span>
<span class="source-line-no">165</span><span id="line-165"> // table should not be created</span>
<span class="source-line-no">166</span><span id="line-166"> assertFalse(UTIL.getAdmin().tableExists(TABLE_NAME));</span>
<span class="source-line-no">167</span><span id="line-167"> }</span>
<span class="source-line-no">168</span><span id="line-168"></span>
<span class="source-line-no">169</span><span id="line-169"> @Test</span>
<span class="source-line-no">170</span><span id="line-170"> public void testCloneSnapshotWithTTLSuccess() throws Exception {</span>
<span class="source-line-no">171</span><span id="line-171"> String snapshotName = "nonExpiredTTLCloneSnapshotTest";</span>
<span class="source-line-no">172</span><span id="line-172"></span>
<span class="source-line-no">173</span><span id="line-173"> // table should exist</span>
<span class="source-line-no">174</span><span id="line-174"> assertTrue(UTIL.getAdmin().tableExists(TABLE_NAME));</span>
<span class="source-line-no">175</span><span id="line-175"></span>
<span class="source-line-no">176</span><span id="line-176"> // create snapshot fo given table with specified ttl</span>
<span class="source-line-no">177</span><span id="line-177"> createSnapshotWithTTL(TABLE_NAME, snapshotName, CHORE_INTERVAL_SECS * 2);</span>
<span class="source-line-no">178</span><span id="line-178"> Admin admin = UTIL.getAdmin();</span>
<span class="source-line-no">179</span><span id="line-179"></span>
<span class="source-line-no">180</span><span id="line-180"> // restore snapshot</span>
<span class="source-line-no">181</span><span id="line-181"> admin.cloneSnapshot(snapshotName, CLONED_TABLE_NAME);</span>
<span class="source-line-no">182</span><span id="line-182"></span>
<span class="source-line-no">183</span><span id="line-183"> // table should be created</span>
<span class="source-line-no">184</span><span id="line-184"> assertTrue(UTIL.getAdmin().tableExists(CLONED_TABLE_NAME));</span>
<span class="source-line-no">185</span><span id="line-185"> }</span>
<span class="source-line-no">186</span><span id="line-186"></span>
<span class="source-line-no">187</span><span id="line-187"> @Test</span>
<span class="source-line-no">188</span><span id="line-188"> public void testCloneSnapshotFailsDueToTTLExpired() throws Exception {</span>
<span class="source-line-no">189</span><span id="line-189"> String snapshotName = "expiredTTLCloneSnapshotTest";</span>
<span class="source-line-no">190</span><span id="line-190"></span>
<span class="source-line-no">191</span><span id="line-191"> // table should exist</span>
<span class="source-line-no">192</span><span id="line-192"> assertTrue(UTIL.getAdmin().tableExists(TABLE_NAME));</span>
<span class="source-line-no">193</span><span id="line-193"></span>
<span class="source-line-no">194</span><span id="line-194"> // create snapshot fo given table with specified ttl</span>
<span class="source-line-no">195</span><span id="line-195"> createSnapshotWithTTL(TABLE_NAME, snapshotName, 1);</span>
<span class="source-line-no">196</span><span id="line-196"> Admin admin = UTIL.getAdmin();</span>
<span class="source-line-no">197</span><span id="line-197"></span>
<span class="source-line-no">198</span><span id="line-198"> assertTrue(UTIL.getAdmin().tableExists(TABLE_NAME));</span>
<span class="source-line-no">199</span><span id="line-199"></span>
<span class="source-line-no">200</span><span id="line-200"> // Sleep so that TTL may expire</span>
<span class="source-line-no">201</span><span id="line-201"> Threads.sleep(2000);</span>
<span class="source-line-no">202</span><span id="line-202"></span>
<span class="source-line-no">203</span><span id="line-203"> // clone snapshot which has expired</span>
<span class="source-line-no">204</span><span id="line-204"> try {</span>
<span class="source-line-no">205</span><span id="line-205"> admin.cloneSnapshot(snapshotName, CLONED_TABLE_NAME);</span>
<span class="source-line-no">206</span><span id="line-206"> fail("Clone snapshot succeeded even though TTL has expired.");</span>
<span class="source-line-no">207</span><span id="line-207"> } catch (SnapshotTTLExpiredException e) {</span>
<span class="source-line-no">208</span><span id="line-208"> LOG.info("Correctly failed to clone a TTL expired snapshot table:" + e.getMessage());</span>
<span class="source-line-no">209</span><span id="line-209"> }</span>
<span class="source-line-no">210</span><span id="line-210"></span>
<span class="source-line-no">211</span><span id="line-211"> // table should not be created</span>
<span class="source-line-no">212</span><span id="line-212"> assertFalse(UTIL.getAdmin().tableExists(CLONED_TABLE_NAME));</span>
<span class="source-line-no">213</span><span id="line-213"> }</span>
<span class="source-line-no">214</span><span id="line-214"></span>
<span class="source-line-no">215</span><span id="line-215"> private void createSnapshotWithTTL(TableName tableName, final String snapshotName,</span>
<span class="source-line-no">216</span><span id="line-216"> final int snapshotTTL) throws IOException {</span>
<span class="source-line-no">217</span><span id="line-217"> Admin admin = UTIL.getAdmin();</span>
<span class="source-line-no">218</span><span id="line-218"></span>
<span class="source-line-no">219</span><span id="line-219"> // make sure we don't fail on listing snapshots</span>
<span class="source-line-no">220</span><span id="line-220"> SnapshotTestingUtils.assertNoSnapshots(admin);</span>
<span class="source-line-no">221</span><span id="line-221"></span>
<span class="source-line-no">222</span><span id="line-222"> // put some stuff in the table</span>
<span class="source-line-no">223</span><span id="line-223"> Table table = UTIL.getConnection().getTable(tableName);</span>
<span class="source-line-no">224</span><span id="line-224"> UTIL.loadTable(table, TEST_FAM);</span>
<span class="source-line-no">225</span><span id="line-225"></span>
<span class="source-line-no">226</span><span id="line-226"> Map&lt;String, Object&gt; props = new HashMap&lt;&gt;();</span>
<span class="source-line-no">227</span><span id="line-227"> props.put(TTL_KEY, snapshotTTL);</span>
<span class="source-line-no">228</span><span id="line-228"></span>
<span class="source-line-no">229</span><span id="line-229"> // take a snapshot of the table</span>
<span class="source-line-no">230</span><span id="line-230"> SnapshotTestingUtils.snapshot(UTIL.getAdmin(), snapshotName, tableName, SnapshotType.FLUSH, 3,</span>
<span class="source-line-no">231</span><span id="line-231"> props);</span>
<span class="source-line-no">232</span><span id="line-232"> LOG.debug("Snapshot completed.");</span>
<span class="source-line-no">233</span><span id="line-233"></span>
<span class="source-line-no">234</span><span id="line-234"> // make sure we have the snapshot with expectd TTL</span>
<span class="source-line-no">235</span><span id="line-235"> List&lt;SnapshotDescription&gt; snapshots =</span>
<span class="source-line-no">236</span><span id="line-236"> SnapshotTestingUtils.assertOneSnapshotThatMatches(admin, snapshotName, tableName);</span>
<span class="source-line-no">237</span><span id="line-237"> assertEquals(1, snapshots.size());</span>
<span class="source-line-no">238</span><span id="line-238"> assertEquals(snapshotTTL, snapshots.get(0).getTtl());</span>
<span class="source-line-no">239</span><span id="line-239"> }</span>
<span class="source-line-no">240</span><span id="line-240">}</span>
</pre>
</div>
</main>
</body>
</html>