| <!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.client;<a name="line.18"></a> |
| <span class="sourceLineNo">019</span><a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import java.io.IOException;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.nio.file.Files;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.nio.file.Path;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.nio.file.Paths;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import java.nio.file.StandardCopyOption;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.hadoop.hbase.HBaseTestingUtil;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.hadoop.hbase.util.JVMClusterUtil.RegionServerThread;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.slf4j.Logger;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.slf4j.LoggerFactory;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span><a name="line.29"></a> |
| <span class="sourceLineNo">030</span>/**<a name="line.30"></a> |
| <span class="sourceLineNo">031</span> * Base class to test Configuration Update logic. It wraps up things needed to test configuration<a name="line.31"></a> |
| <span class="sourceLineNo">032</span> * change and provides utility methods for test cluster setup, updating/restoring configuration<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> * file.<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> */<a name="line.34"></a> |
| <span class="sourceLineNo">035</span>public abstract class AbstractTestUpdateConfiguration {<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> private static final Logger LOG = LoggerFactory.getLogger(AbstractTestUpdateConfiguration.class);<a name="line.36"></a> |
| <span class="sourceLineNo">037</span><a name="line.37"></a> |
| <span class="sourceLineNo">038</span> private static final String SERVER_CONFIG = "hbase-site.xml";<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> private static final String OVERRIDE_SERVER_CONFIG = "override-hbase-site.xml";<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> private static final String BACKUP_SERVER_CONFIG = "backup-hbase-site.xml";<a name="line.40"></a> |
| <span class="sourceLineNo">041</span><a name="line.41"></a> |
| <span class="sourceLineNo">042</span> private static Path configFileUnderTestDataDir;<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> private static Path overrideConfigFileUnderTestDataDir;<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> private static Path backupConfigFileUnderTestDataDir;<a name="line.44"></a> |
| <span class="sourceLineNo">045</span><a name="line.45"></a> |
| <span class="sourceLineNo">046</span> protected static void setUpConfigurationFiles(final HBaseTestingUtil testUtil) throws Exception {<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> // Before this change, the test will update hbase-site.xml under target/test-classes and<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> // trigger a config reload. Since target/test-classes/hbase-site.xml is being used by<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> // other testing cases at the same time, this update will break other testing cases so it will<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> // be flakey in nature.<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> // To avoid this, the change is to make target/test-classes/hbase-site.xml immutable. A new<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> // hbase-site.xml will be created under its test data directory, i.e,<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> // hbase-server/target/test-data/UUID, this new file will be added as a resource for the<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> // config, new update will be applied to this new file and only visible to this specific test<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> // case. The target/test-classes/hbase-site.xml will not be changed during the test.<a name="line.55"></a> |
| <span class="sourceLineNo">056</span><a name="line.56"></a> |
| <span class="sourceLineNo">057</span> String absoluteDataPath = testUtil.getDataTestDir().toString();<a name="line.57"></a> |
| <span class="sourceLineNo">058</span><a name="line.58"></a> |
| <span class="sourceLineNo">059</span> // Create test-data directories.<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> Files.createDirectories(Paths.get(absoluteDataPath));<a name="line.60"></a> |
| <span class="sourceLineNo">061</span><a name="line.61"></a> |
| <span class="sourceLineNo">062</span> // Copy hbase-site.xml from target/test-class to target/test-data/UUID directory.<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> Path configFile = Paths.get("target", "test-classes", SERVER_CONFIG);<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> configFileUnderTestDataDir = Paths.get(absoluteDataPath, SERVER_CONFIG);<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> Files.copy(configFile, configFileUnderTestDataDir);<a name="line.65"></a> |
| <span class="sourceLineNo">066</span><a name="line.66"></a> |
| <span class="sourceLineNo">067</span> // Copy override config file overrider-hbase-site.xml from target/test-class to<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> // target/test-data/UUID directory.<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> Path overrideConfigFile = Paths.get("target", "test-classes", OVERRIDE_SERVER_CONFIG);<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> overrideConfigFileUnderTestDataDir = Paths.get(absoluteDataPath, OVERRIDE_SERVER_CONFIG);<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> Files.copy(overrideConfigFile, overrideConfigFileUnderTestDataDir);<a name="line.71"></a> |
| <span class="sourceLineNo">072</span><a name="line.72"></a> |
| <span class="sourceLineNo">073</span> backupConfigFileUnderTestDataDir = Paths.get(absoluteDataPath, BACKUP_SERVER_CONFIG);<a name="line.73"></a> |
| <span class="sourceLineNo">074</span><a name="line.74"></a> |
| <span class="sourceLineNo">075</span> // Add the new custom config file to Configuration<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> testUtil.getConfiguration().addResource(testUtil.getDataTestDir(SERVER_CONFIG));<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> protected static void addResourceToRegionServerConfiguration(final HBaseTestingUtil testUtil) {<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> // When RegionServer is created in MiniHBaseCluster, it uses HBaseConfiguration.create(conf) of<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> // the master Configuration. The create() just copies config params over, it does not do<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> // a clone for a historic reason. Properties such as resources are lost during this process.<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> // Exposing a new method in HBaseConfiguration causes confusion. Instead, the new hbase-site.xml<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> // under test-data directory is added to RegionServer's configuration as a workaround.<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> for (RegionServerThread rsThread : testUtil.getMiniHBaseCluster().getRegionServerThreads()) {<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> rsThread.getRegionServer().getConfiguration()<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> .addResource(testUtil.getDataTestDir(SERVER_CONFIG));<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><a name="line.90"></a> |
| <span class="sourceLineNo">091</span> /**<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> * Replace the hbase-site.xml file under this test's data directory with the content of the<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> * override-hbase-site.xml file. Stashes the current existing file so that it can be restored<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> * using {@link #restoreHBaseSiteXML()}.<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> * @throws IOException if an I/O error occurs<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> */<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> protected final void replaceHBaseSiteXML() throws IOException {<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> LOG.info("Replace hbase config {} with {}", configFileUnderTestDataDir,<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> overrideConfigFileUnderTestDataDir);<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> // make a backup of hbase-site.xml<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> Files.copy(configFileUnderTestDataDir, backupConfigFileUnderTestDataDir,<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> StandardCopyOption.REPLACE_EXISTING);<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> // update hbase-site.xml by overwriting it<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> Files.copy(overrideConfigFileUnderTestDataDir, configFileUnderTestDataDir,<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> StandardCopyOption.REPLACE_EXISTING);<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> }<a name="line.106"></a> |
| <span class="sourceLineNo">107</span><a name="line.107"></a> |
| <span class="sourceLineNo">108</span> /**<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> * Restores the hbase-site.xml file that was stashed by a previous call to<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> * {@link #replaceHBaseSiteXML()}.<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> * @throws IOException if an I/O error occurs<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> */<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> protected final void restoreHBaseSiteXML() throws IOException {<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> LOG.info("Restore hbase config {} with {}", configFileUnderTestDataDir,<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> backupConfigFileUnderTestDataDir);<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> // restore hbase-site.xml<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> Files.copy(backupConfigFileUnderTestDataDir, configFileUnderTestDataDir,<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> StandardCopyOption.REPLACE_EXISTING);<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> }<a name="line.119"></a> |
| <span class="sourceLineNo">120</span>}<a name="line.120"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
