com.klarna.hiverunner.HiveShell Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of hiverunner Show documentation
Show all versions of hiverunner Show documentation
HiveRunner is a unit test framework based on JUnit (4 or 5) that enables TDD development of Hive SQL without the need of any installed dependencies.
/**
* Copyright (C) 2013-2019 Klarna AB
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.klarna.hiverunner;
import com.klarna.hiverunner.data.InsertIntoTable;
import org.apache.hadoop.hive.conf.HiveConf;
import java.io.File;
import java.io.OutputStream;
import java.nio.charset.Charset;
import java.nio.file.Path;
import java.util.List;
/**
* Test handle to the hive server.
*
* Please refer to test class {@code com.klarna.hiverunner.examples.HelloHiveRunner} for usage examples.
*/
public interface HiveShell {
/**
* Executes a single query.
*
* May only be called post #start()
*
*/
List executeQuery(String hiveSql);
/**
* Executes a single query.
*
* May only be called post #start()
*
*/
List executeQuery(String hiveSql, String rowValuesDelimitedBy, String replaceNullWith);
/**
* Executes a single query from a script file, returning any results.
*
* May only be called post #start()
*
*/
List executeQuery(File script);
/**
* Executes a single query from a script file, returning any results.
*
* May only be called post #start()
*
*/
List executeQuery(Path script);
/**
* Executes a single query from a script file, returning any results.
*
* May only be called post #start()
*
*/
List executeQuery(Charset charset, File script);
/**
* Executes a single query from a script file, returning any results.
*
* May only be called post #start()
*
*/
List executeQuery(Charset charset, Path script);
/**
* Executes a single query from a script file, returning any results.
*
* May only be called post #start()
*
*/
List executeQuery(File script, String rowValuesDelimitedBy, String replaceNullWith);
/**
* Executes a single query from a script file, returning any results.
*
* May only be called post #start()
*
*/
List executeQuery(Path script, String rowValuesDelimitedBy, String replaceNullWith);
/**
* Executes a single query from a script file, returning any results.
*
* May only be called post #start()
*
*/
List executeQuery(Charset charset, File script, String rowValuesDelimitedBy, String replaceNullWith);
/**
* Executes a single query from a script file, returning any results.
*
* May only be called post #start()
*
*/
List executeQuery(Charset charset, Path script, String rowValuesDelimitedBy, String replaceNullWith);
/**
* Execute a single hive query
*
* May only be called post #start()
*
*/
List executeStatement(String hiveSql);
/**
* Executes a hive script. The script may contain multiple statements delimited by ';'
*
* May only be called post #start()
*
*/
void execute(String script);
/**
* Executes a hive script. The script may contain multiple statements delimited by ';'.
* Default charset will be used to read the given files.
*
* May only be called post #start()
*
*/
void execute(File file);
/**
* Executes a hive script. The script may contain multiple statements delimited by ';'.
* Default charset will be used to read the given files.
*
* May only be called post #start()
*
*/
void execute(Path path);
/**
* Executes a hive script. The script may contain multiple statements delimited by ';'
*
* May only be called post #start()
*
*/
void execute(Charset charset, File file);
/**
* Executes a hive script. The script may contain multiple statements delimited by ';'
*
* May only be called post #start()
*
*/
void execute(Charset charset, Path path);
/**
* Start the shell. May only be called once. The test engine will by default call this method,
* Set {@link com.klarna.hiverunner.annotations.HiveSQL#autoStart()} to false to explicitly control
* when to start from the test case.
*
* This might be useful for test methods that needs additional setup not catered for with the provided annotations.
*
*/
void start();
/**
* Set a HiveConf property.
*
* May only be called pre #start()
*
* @deprecated Use {@link HiveShell#setHiveConfValue(String, String)} instead
*/
@Deprecated
void setProperty(String key, String value);
/**
* Set HiveConf property.
*
* May only be called pre #start()
*
*/
void setHiveConfValue(String key, String value);
/**
* Set Hive variable.
*
* May only be called pre #start()
*
*/
void setHiveVarValue(String var, String value);
/**
* Get the current HiveConf from hive
*/
HiveConf getHiveConf();
void setCwd(Path cwd);
Path getCwd();
/**
* Copy test data into hdfs
* May only be called pre #start()
*
* {@link com.klarna.hiverunner.MethodLevelResourceTest#resourceLoadingAsFileTest()}
* and {@link com.klarna.hiverunner.MethodLevelResourceTest#resourceLoadingAsStringTest()}
*
*/
void addResource(String targetFile, File sourceFile);
/**
* Copy test data into hdfs
* May only be called pre #start()
*
* {@link com.klarna.hiverunner.MethodLevelResourceTest#resourceLoadingAsFileTest()}
* and {@link com.klarna.hiverunner.MethodLevelResourceTest#resourceLoadingAsStringTest()}
*
*/
void addResource(String targetFile, Path sourceFile);
/**
* Copy test data into hdfs
* May only be called pre #start()
*
* {@link com.klarna.hiverunner.MethodLevelResourceTest#resourceLoadingAsFileTest()}
* and {@link com.klarna.hiverunner.MethodLevelResourceTest#resourceLoadingAsStringTest()}
*
*/
void addResource(String targetFile, String data);
/**
* Add a hive script that will be executed when the hive shell is started
* Scripts will be executed in the order they are added.
*
* Note that execution order is not guaranteed with
* fields annotated with {@link com.klarna.hiverunner.annotations.HiveSetupScript}
*/
void addSetupScript(String script);
/**
* Add hive scripts that will be executed when the hive shell is started. Scripts will be executed in given order.
*
* Note that execution order is not guaranteed with
* fields annotated with {@link com.klarna.hiverunner.annotations.HiveSetupScript}
*/
void addSetupScripts(Charset charset, File... scripts);
/**
* Add hive scripts that will be executed when the hive shell is started. Scripts will be executed in given order.
*
* Note that execution order is not guaranteed with
* fields annotated with {@link com.klarna.hiverunner.annotations.HiveSetupScript}
*/
void addSetupScripts(Charset charset, Path... scripts);
/**
* Add hive scripts that will be executed when the hive shell is started. Scripts will be executed in given order.
*
* Default charset will be used to read the given files
*
* Note that execution order is not guaranteed with
* fields annotated with {@link com.klarna.hiverunner.annotations.HiveSetupScript}
*/
void addSetupScripts(File... scripts);
/**
* Add hive scripts that will be executed when the hive shell is started. Scripts will be executed in given order.
*
* Default charset will be used to read the given files
*
* Note that execution order is not guaranteed with
* fields annotated with {@link com.klarna.hiverunner.annotations.HiveSetupScript}
*/
void addSetupScripts(Path... scripts);
/**
* Get the test case sand box base dir
*/
Path getBaseDir();
/**
* Resolve all substituted variables with the hive conf.
* @throws IllegalArgumentException if not all substitutes could be resolved
* @throws IllegalStateException if the HiveShell was not started yet.
*/
String expandVariableSubstitutes(String expression);
/**
* Open up a stream to write test data into HDFS.
*
* May only be called pre #start().
* No writes to the stream will be allowed post #start().
*
* @param targetFile The path to the target file relative to the hive work space.
*
* See test class {@code com.klarna.hiverunner.ResourceOutputStreamTest#sequenceFile()} for an example of how this works.
* with sequence files.
*/
OutputStream getResourceOutputStream(String targetFile);
/**
* Returns an {@link InsertIntoTable} that allows programmatically inserting data into a table in a fluent manner.
*
* May only be called post #start()
*
*
* @param databaseName The database name
* @param tableName The table name
*/
InsertIntoTable insertInto(String databaseName, String tableName);
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy