| <!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, class: TestShellExecEndpointCoprocessor"> |
| <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;</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"></span> |
| <span class="source-line-no">024</span><span id="line-24">import java.io.File;</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.nio.charset.StandardCharsets;</span> |
| <span class="source-line-no">027</span><span id="line-27">import java.nio.file.Files;</span> |
| <span class="source-line-no">028</span><span id="line-28">import java.nio.file.Path;</span> |
| <span class="source-line-no">029</span><span id="line-29">import java.nio.file.Paths;</span> |
| <span class="source-line-no">030</span><span id="line-30">import java.util.Optional;</span> |
| <span class="source-line-no">031</span><span id="line-31">import java.util.function.Consumer;</span> |
| <span class="source-line-no">032</span><span id="line-32">import org.apache.hadoop.conf.Configuration;</span> |
| <span class="source-line-no">033</span><span id="line-33">import org.apache.hadoop.hbase.client.AsyncAdmin;</span> |
| <span class="source-line-no">034</span><span id="line-34">import org.apache.hadoop.hbase.client.AsyncConnection;</span> |
| <span class="source-line-no">035</span><span id="line-35">import org.apache.hadoop.hbase.coprocessor.protobuf.generated.ShellExecEndpoint.ShellExecRequest;</span> |
| <span class="source-line-no">036</span><span id="line-36">import org.apache.hadoop.hbase.coprocessor.protobuf.generated.ShellExecEndpoint.ShellExecResponse;</span> |
| <span class="source-line-no">037</span><span id="line-37">import org.apache.hadoop.hbase.coprocessor.protobuf.generated.ShellExecEndpoint.ShellExecService;</span> |
| <span class="source-line-no">038</span><span id="line-38">import org.apache.hadoop.hbase.testclassification.MediumTests;</span> |
| <span class="source-line-no">039</span><span id="line-39">import org.junit.ClassRule;</span> |
| <span class="source-line-no">040</span><span id="line-40">import org.junit.Rule;</span> |
| <span class="source-line-no">041</span><span id="line-41">import org.junit.Test;</span> |
| <span class="source-line-no">042</span><span id="line-42">import org.junit.experimental.categories.Category;</span> |
| <span class="source-line-no">043</span><span id="line-43"></span> |
| <span class="source-line-no">044</span><span id="line-44">/**</span> |
| <span class="source-line-no">045</span><span id="line-45"> * Test for the {@link ShellExecEndpointCoprocessor}.</span> |
| <span class="source-line-no">046</span><span id="line-46"> */</span> |
| <span class="source-line-no">047</span><span id="line-47">@Category(MediumTests.class)</span> |
| <span class="source-line-no">048</span><span id="line-48">public class TestShellExecEndpointCoprocessor {</span> |
| <span class="source-line-no">049</span><span id="line-49"></span> |
| <span class="source-line-no">050</span><span id="line-50"> @ClassRule</span> |
| <span class="source-line-no">051</span><span id="line-51"> public static final HBaseClassTestRule testRule =</span> |
| <span class="source-line-no">052</span><span id="line-52"> HBaseClassTestRule.forClass(TestShellExecEndpointCoprocessor.class);</span> |
| <span class="source-line-no">053</span><span id="line-53"></span> |
| <span class="source-line-no">054</span><span id="line-54"> @ClassRule</span> |
| <span class="source-line-no">055</span><span id="line-55"> public static final MiniClusterRule miniClusterRule =</span> |
| <span class="source-line-no">056</span><span id="line-56"> MiniClusterRule.newBuilder().setConfiguration(createConfiguration()).build();</span> |
| <span class="source-line-no">057</span><span id="line-57"></span> |
| <span class="source-line-no">058</span><span id="line-58"> @Rule</span> |
| <span class="source-line-no">059</span><span id="line-59"> public final ConnectionRule connectionRule =</span> |
| <span class="source-line-no">060</span><span id="line-60"> ConnectionRule.createAsyncConnectionRule(miniClusterRule::createAsyncConnection);</span> |
| <span class="source-line-no">061</span><span id="line-61"></span> |
| <span class="source-line-no">062</span><span id="line-62"> @Test</span> |
| <span class="source-line-no">063</span><span id="line-63"> public void testShellExecUnspecified() {</span> |
| <span class="source-line-no">064</span><span id="line-64"> testShellExecForeground(b -> {</span> |
| <span class="source-line-no">065</span><span id="line-65"> });</span> |
| <span class="source-line-no">066</span><span id="line-66"> }</span> |
| <span class="source-line-no">067</span><span id="line-67"></span> |
| <span class="source-line-no">068</span><span id="line-68"> @Test</span> |
| <span class="source-line-no">069</span><span id="line-69"> public void testShellExecForeground() {</span> |
| <span class="source-line-no">070</span><span id="line-70"> testShellExecForeground(b -> b.setAwaitResponse(true));</span> |
| <span class="source-line-no">071</span><span id="line-71"> }</span> |
| <span class="source-line-no">072</span><span id="line-72"></span> |
| <span class="source-line-no">073</span><span id="line-73"> private void testShellExecForeground(final Consumer<ShellExecRequest.Builder> consumer) {</span> |
| <span class="source-line-no">074</span><span id="line-74"> final AsyncConnection conn = connectionRule.getAsyncConnection();</span> |
| <span class="source-line-no">075</span><span id="line-75"> final AsyncAdmin admin = conn.getAdmin();</span> |
| <span class="source-line-no">076</span><span id="line-76"></span> |
| <span class="source-line-no">077</span><span id="line-77"> final String command = "echo -n \"hello world\"";</span> |
| <span class="source-line-no">078</span><span id="line-78"> final ShellExecRequest.Builder builder = ShellExecRequest.newBuilder().setCommand(command);</span> |
| <span class="source-line-no">079</span><span id="line-79"> consumer.accept(builder);</span> |
| <span class="source-line-no">080</span><span id="line-80"> final ShellExecResponse resp =</span> |
| <span class="source-line-no">081</span><span id="line-81"> admin.<ShellExecService.Stub, ShellExecResponse> coprocessorService(ShellExecService::newStub,</span> |
| <span class="source-line-no">082</span><span id="line-82"> (stub, controller, callback) -> stub.shellExec(controller, builder.build(), callback))</span> |
| <span class="source-line-no">083</span><span id="line-83"> .join();</span> |
| <span class="source-line-no">084</span><span id="line-84"> assertEquals(0, resp.getExitCode());</span> |
| <span class="source-line-no">085</span><span id="line-85"> assertEquals("hello world", resp.getStdout());</span> |
| <span class="source-line-no">086</span><span id="line-86"> }</span> |
| <span class="source-line-no">087</span><span id="line-87"></span> |
| <span class="source-line-no">088</span><span id="line-88"> @Test</span> |
| <span class="source-line-no">089</span><span id="line-89"> public void testShellExecBackground() throws IOException {</span> |
| <span class="source-line-no">090</span><span id="line-90"> final AsyncConnection conn = connectionRule.getAsyncConnection();</span> |
| <span class="source-line-no">091</span><span id="line-91"> final AsyncAdmin admin = conn.getAdmin();</span> |
| <span class="source-line-no">092</span><span id="line-92"></span> |
| <span class="source-line-no">093</span><span id="line-93"> final File testDataDir = ensureTestDataDirExists(miniClusterRule.getTestingUtility());</span> |
| <span class="source-line-no">094</span><span id="line-94"> final File testFile = new File(testDataDir, "shell_exec_background.txt");</span> |
| <span class="source-line-no">095</span><span id="line-95"> assertTrue(testFile.createNewFile());</span> |
| <span class="source-line-no">096</span><span id="line-96"> assertEquals(0, testFile.length());</span> |
| <span class="source-line-no">097</span><span id="line-97"></span> |
| <span class="source-line-no">098</span><span id="line-98"> final String command = "echo \"hello world\" >> " + testFile.getAbsolutePath();</span> |
| <span class="source-line-no">099</span><span id="line-99"> final ShellExecRequest req =</span> |
| <span class="source-line-no">100</span><span id="line-100"> ShellExecRequest.newBuilder().setCommand(command).setAwaitResponse(false).build();</span> |
| <span class="source-line-no">101</span><span id="line-101"> final ShellExecResponse resp =</span> |
| <span class="source-line-no">102</span><span id="line-102"> admin.<ShellExecService.Stub, ShellExecResponse> coprocessorService(ShellExecService::newStub,</span> |
| <span class="source-line-no">103</span><span id="line-103"> (stub, controller, callback) -> stub.shellExec(controller, req, callback)).join();</span> |
| <span class="source-line-no">104</span><span id="line-104"></span> |
| <span class="source-line-no">105</span><span id="line-105"> assertFalse("the response from a background task should have no exit code", resp.hasExitCode());</span> |
| <span class="source-line-no">106</span><span id="line-106"> assertFalse("the response from a background task should have no stdout", resp.hasStdout());</span> |
| <span class="source-line-no">107</span><span id="line-107"> assertFalse("the response from a background task should have no stderr", resp.hasStderr());</span> |
| <span class="source-line-no">108</span><span id="line-108"></span> |
| <span class="source-line-no">109</span><span id="line-109"> Waiter.waitFor(conn.getConfiguration(), 5_000, () -> testFile.length() > 0);</span> |
| <span class="source-line-no">110</span><span id="line-110"> final String content =</span> |
| <span class="source-line-no">111</span><span id="line-111"> new String(Files.readAllBytes(testFile.toPath()), StandardCharsets.UTF_8).trim();</span> |
| <span class="source-line-no">112</span><span id="line-112"> assertEquals("hello world", content);</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"> private static File ensureTestDataDirExists(final HBaseTestingUtil testingUtility)</span> |
| <span class="source-line-no">116</span><span id="line-116"> throws IOException {</span> |
| <span class="source-line-no">117</span><span id="line-117"> final Path testDataDir = Optional.of(testingUtility).map(HBaseTestingUtil::getDataTestDir)</span> |
| <span class="source-line-no">118</span><span id="line-118"> .map(Object::toString).map(Paths::get)</span> |
| <span class="source-line-no">119</span><span id="line-119"> .orElseThrow(() -> new RuntimeException("Unable to locate temp directory path."));</span> |
| <span class="source-line-no">120</span><span id="line-120"> final File testDataDirFile = Files.createDirectories(testDataDir).toFile();</span> |
| <span class="source-line-no">121</span><span id="line-121"> assertTrue(testDataDirFile.exists());</span> |
| <span class="source-line-no">122</span><span id="line-122"> return testDataDirFile;</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"> private static Configuration createConfiguration() {</span> |
| <span class="source-line-no">126</span><span id="line-126"> final Configuration conf = HBaseConfiguration.create();</span> |
| <span class="source-line-no">127</span><span id="line-127"> conf.set("hbase.coprocessor.master.classes", ShellExecEndpointCoprocessor.class.getName());</span> |
| <span class="source-line-no">128</span><span id="line-128"> return conf;</span> |
| <span class="source-line-no">129</span><span id="line-129"> }</span> |
| <span class="source-line-no">130</span><span id="line-130">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
