HiveRunnerConfig (HiveRunner 6.0.1 API)

java.lang.Object
- com.klarna.hiverunner.config.HiveRunnerConfig

public class HiveRunnerConfig
extends Object

HiveRunner runtime configuration. Configure with System properties via mvn like

 <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-surefire-plugin</artifactId>
      <version>2.17</version>
      <configuration>
          ...
          <systemProperties>
              <hiveconf_any.hive.conf>1000</hiveconf_any.hive.conf>
              <enableTimeout>false</enableTimeout>
              <timeoutSeconds>30</timeoutSeconds>
              <timeoutRetries>2</timeoutRetries>
              <commandShellEmulation>BEELINE</commandShellEmulation>
          </systemProperties>
      </configuration>
 </plugin>

Properties may be overridden per test class by annotating a static HiveRunnerConfig field like:

      @HiveRunnerSetup
      public final static HiveRunnerConfig config = new HiveRunnerConfig(){{
          setTimeoutEnabled(true);
          setTimeoutSeconds(15);
          setTimeoutRetries(2);
          setCommandShellEmulation(CommandShellEmulation.BEELINE);
      }};

See the test class<com.klarna.hiverunner.DisabledTimeoutTest for more information.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`COMMAND_SHELL_EMULATOR_DEFAULT`
`static String`	`COMMAND_SHELL_EMULATOR_PROPERTY_NAME` The shell's `CommandShellEmulator`.
`static boolean`	`ENABLE_TIMEOUT_DEFAULT`
`static String`	`ENABLE_TIMEOUT_PROPERTY_NAME` Enable timeout.
`static String`	`HIVECONF_SYSTEM_OVERRIDE_PREFIX` Suffix used to flag a system property to be a hiveconf setting.
`static int`	`TIMEOUT_RETRIES_DEFAULT`
`static String`	`TIMEOUT_RETRIES_PROPERTY_NAME` Number of retries for a test case that keep timing out.
`static int`	`TIMEOUT_SECONDS_DEFAULT`
`static String`	`TIMEOUT_SECONDS_PROPERTY_NAME` Seconds to wait for a query to terminate before triggering the timeout.

Constructor Summary

Constructors
Constructor and Description
`HiveRunnerConfig()` Construct a HiveRunnerConfig that will override hiveConf with System properties of the format 'hiveconf_[hiveconf property name]'.
`HiveRunnerConfig(Properties systemProperties)` Construct a HiveRunnerConfig that will override hiveConf with the given properties of the format 'hiveconf_[hiveconf property name]'.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CommandShellEmulator`	`getCommandShellEmulator()` Determines the statement parsing behaviour of the interactive shell.
`Map<String,String>`	`getHiveConfSystemOverride()`
`String`	`getHiveExecutionEngine()` Get the configured hive.execution.engine.
`int`	`getTimeoutRetries()`
`int`	`getTimeoutSeconds()`
`boolean`	`isTimeoutEnabled()`
`void`	`override(HiveRunnerConfig hiveRunnerConfig)` Copy values from the inserted config to this config.
`void`	`setCommandShellEmulator(CommandShellEmulator commandShellEmulator)`
`void`	`setHiveExecutionEngine(String executionEngine)`
`void`	`setTimeoutEnabled(boolean isEnabled)`
`void`	`setTimeoutRetries(int retries)`
`void`	`setTimeoutSeconds(int timeout)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ENABLE_TIMEOUT_PROPERTY_NAME
```
public static final String ENABLE_TIMEOUT_PROPERTY_NAME
```
    Enable timeout. Some versions of tez has proven to not always terminate. By enabling timeout, HiveRunner will kill the current query and attempt to retry the test case a configurable number of times. Defaults to disabled
    
    See Also:
    
    Constant Field Values
  - ENABLE_TIMEOUT_DEFAULT
```
public static final boolean ENABLE_TIMEOUT_DEFAULT
```
    See Also:
    
    Constant Field Values
  - TIMEOUT_SECONDS_PROPERTY_NAME
```
public static final String TIMEOUT_SECONDS_PROPERTY_NAME
```
    Seconds to wait for a query to terminate before triggering the timeout. Defaults to 30 seconds
    
    See Also:
    
    Constant Field Values
  - TIMEOUT_SECONDS_DEFAULT
```
public static final int TIMEOUT_SECONDS_DEFAULT
```
    See Also:
    
    Constant Field Values
  - TIMEOUT_RETRIES_PROPERTY_NAME
```
public static final String TIMEOUT_RETRIES_PROPERTY_NAME
```
    Number of retries for a test case that keep timing out. Defaults to 2 retries
    
    See Also:
    
    Constant Field Values
  - TIMEOUT_RETRIES_DEFAULT
```
public static final int TIMEOUT_RETRIES_DEFAULT
```
    See Also:
    
    Constant Field Values
  - HIVECONF_SYSTEM_OVERRIDE_PREFIX
```
public static final String HIVECONF_SYSTEM_OVERRIDE_PREFIX
```
    Suffix used to flag a system property to be a hiveconf setting.
    
    See Also:
    
    Constant Field Values
  - COMMAND_SHELL_EMULATOR_PROPERTY_NAME
```
public static final String COMMAND_SHELL_EMULATOR_PROPERTY_NAME
```
    The shell's CommandShellEmulator. Defaults to HIVE_CLI
    
    See Also:
    
    Constant Field Values
  - COMMAND_SHELL_EMULATOR_DEFAULT
```
public static final String COMMAND_SHELL_EMULATOR_DEFAULT
```
- Constructor Detail
  - HiveRunnerConfig
```
public HiveRunnerConfig()
```
    Construct a HiveRunnerConfig that will override hiveConf with System properties of the format 'hiveconf_[hiveconf property name]'.
  - HiveRunnerConfig
```
public HiveRunnerConfig(Properties systemProperties)
```
    Construct a HiveRunnerConfig that will override hiveConf with the given properties of the format 'hiveconf_[hiveconf property name]'.
- Method Detail
  - isTimeoutEnabled
```
public boolean isTimeoutEnabled()
```
  - getTimeoutRetries
```
public int getTimeoutRetries()
```
  - getTimeoutSeconds
```
public int getTimeoutSeconds()
```
  - getHiveExecutionEngine
```
public String getHiveExecutionEngine()
```
    Get the configured hive.execution.engine. If not set it will default to the default value of HiveConf
  - getHiveConfSystemOverride
```
public Map<String,String> getHiveConfSystemOverride()
```
  - getCommandShellEmulator
```
public CommandShellEmulator getCommandShellEmulator()
```
    Determines the statement parsing behaviour of the interactive shell. Provided to emulate slight differences between different clients.
  - setTimeoutEnabled
```
public void setTimeoutEnabled(boolean isEnabled)
```
  - setTimeoutRetries
```
public void setTimeoutRetries(int retries)
```
  - setTimeoutSeconds
```
public void setTimeoutSeconds(int timeout)
```
  - setHiveExecutionEngine
```
public void setHiveExecutionEngine(String executionEngine)
```
  - setCommandShellEmulator
```
public void setCommandShellEmulator(CommandShellEmulator commandShellEmulator)
```
  - override
```
public void override(HiveRunnerConfig hiveRunnerConfig)
```
    Copy values from the inserted config to this config. Note that if properties has not been explicitly set, the defaults will apply.

Class HiveRunnerConfig

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ENABLE_TIMEOUT_PROPERTY_NAME

ENABLE_TIMEOUT_DEFAULT

TIMEOUT_SECONDS_PROPERTY_NAME

TIMEOUT_SECONDS_DEFAULT

TIMEOUT_RETRIES_PROPERTY_NAME

TIMEOUT_RETRIES_DEFAULT

HIVECONF_SYSTEM_OVERRIDE_PREFIX

COMMAND_SHELL_EMULATOR_PROPERTY_NAME

COMMAND_SHELL_EMULATOR_DEFAULT

Constructor Detail

HiveRunnerConfig

HiveRunnerConfig

Method Detail

isTimeoutEnabled

getTimeoutRetries

getTimeoutSeconds

getHiveExecutionEngine

getHiveConfSystemOverride

getCommandShellEmulator

setTimeoutEnabled

setTimeoutRetries

setTimeoutSeconds

setHiveExecutionEngine

setCommandShellEmulator

override