TestScripts (Drill : 1.19.0 API)

java.lang.Object
- org.apache.drill.test.BaseTest
- - org.apache.drill.yarn.scripts.TestScripts

```
public class TestScripts
extends BaseTest
```
Unit tests to test the many ways that the Drill shell scripts can run. Since it would be difficult to test options using the actual Drillbit, the scripts make use of a special test fixture in runbit: the ability to pass a "wrapper" script to run in place of the Drillit. That script probes stderr, stdout and log files, and writes its arguments (which is the Drillbit launch command) to a file. As a result, we can capture this output and analyze it to ensure we are passing the right arguments to the Drillbit, and that output is going to the right destinations.

Constructor Summary

Constructors
Constructor and Description

TestScripts()

Constructors
Constructor and Description
`TestScripts()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`initialSetup()`
`void`	`testBadSiteDir()`
`void`	`testClassPath()` Use the "stock" setup, but add each custom bit of the class path to ensure it is passed to the Drillbit.
`void`	`testDistribEnv()` Repeat the above test using distrib-env.sh in the $DRILL_HOME/conf location.
`void`	`testDistribEnvWithNegativeCond()`
`void`	`testDistribEnvWithPositiveCond()`
`void`	`testDrillAndDistribEnv()` Test that drill-env.sh overrides distrib-env.sh, and that the environment overrides both.
`void`	`testDrillbitSymlink()` Some distributions create symlinks to drillbit.sh in standard locations such as /usr/bin.
`void`	`testDrillEnv()` Try setting custom environment variable values in drill-env.sh in the $DRILL_HOME/conf location.
`void`	`testForcedKill()` Simulate a Drillbit that refuses to die.
`void`	`testJavaLibDir()` Test the Java library path.
`void`	`testLibPath()` Create a custom Java lib path.
`void`	`testLogDir()` Create a custom log folder location.
`void`	`testLogDirWithDaemon()` Launch the Drill daemon using a custom log file location.
`void`	`testPidDir()` The Daemon process creates a pid file.
`void`	`testRestart()` Test the restart command of drillbit.sh
`void`	`testSiteDir()` Move configuration to a site folder out of $DRILL_HOME/conf.
`void`	`testSiteDirWithDaemon()` Test a custom site directory with the Drill daemon process.
`void`	`testSqlline()` Verify the basics of the sqlline script, including the env vars that can be customized.
`void`	`testSqllineSiteDir()` Verify that the sqlline client works with the --site option by customizing items in the site directory.
`void`	`testSqllineWithDrillbitContextEnv()` Test to verify no effect of DRILLBIT_CONTEXT for Sqlline.
`void`	`testSqllineWrappers()` Tests the three scripts that wrap sqlline for specific purposes: drill-conf — Wrapper for sqlline, uses drill config to find Drill.
`void`	`testStockCombined()` Test the simplest case: use the $DRILL_HOME/conf directory and default log location.
`void`	`testStockDaemon()` Test running a (simulated) Drillbit as a daemon with start, status, stop.
`void`	`testStockDaemonWithArg()`

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

- Constructor Detail
  - TestScripts
```
public TestScripts()
```
- Method Detail
  - initialSetup
```
public static void initialSetup()
                         throws IOException
```
    Throws:
    
    IOException
  - testStockCombined
```
public void testStockCombined()
                       throws IOException
```
    Test the simplest case: use the $DRILL_HOME/conf directory and default log location. Non-existent drill-env.sh and drill-config.sh files. Everything is at its Drill-provided defaults. Then, try overriding each user-settable environment variable in the environment (which simulates what YARN might do.)
    
    Throws:
    
    IOException
  - testClassPath
```
public void testClassPath()
                   throws IOException
```
    Use the "stock" setup, but add each custom bit of the class path to ensure it is passed to the Drillbit.
    
    Throws:
    
    IOException
  - testLogDir
```
public void testLogDir()
                throws IOException
```
    Create a custom log folder location.
    
    Throws:
    
    IOException
  - testLibPath
```
public void testLibPath()
                 throws IOException
```
    Create a custom Java lib path. This uses the new DRILL_JAVA_LIB_PATH variable.
    
    Throws:
    
    IOException
  - testDrillEnv
```
public void testDrillEnv()
                  throws IOException
```
    Try setting custom environment variable values in drill-env.sh in the $DRILL_HOME/conf location.
    
    Throws:
    
    IOException
  - testDistribEnv
```
public void testDistribEnv()
                    throws IOException
```
    Repeat the above test using distrib-env.sh in the $DRILL_HOME/conf location.
    
    Throws:
    
    IOException
  - testDistribEnvWithNegativeCond
```
public void testDistribEnvWithNegativeCond()
                                    throws IOException
```
    Throws:
    
    IOException
  - testDistribEnvWithPositiveCond
```
public void testDistribEnvWithPositiveCond()
                                    throws IOException
```
    Throws:
    
    IOException
  - testDrillAndDistribEnv
```
public void testDrillAndDistribEnv()
                            throws IOException
```
    Test that drill-env.sh overrides distrib-env.sh, and that the environment overrides both. Assumes the basics were tested above.
    
    Throws:
    
    IOException
  - testBadSiteDir
```
public void testBadSiteDir()
                    throws IOException
```
    Throws:
    
    IOException
  - testSiteDir
```
public void testSiteDir()
                 throws IOException
```
    Move configuration to a site folder out of $DRILL_HOME/conf. The site folder can contain code (which is why we call it "site" and not "config".) The site directory can be passed to the Drillbit in several ways.
    
    Throws:
    
    IOException
  - testJavaLibDir
```
public void testJavaLibDir()
                    throws IOException
```
    Test the Java library path. Three sources:
    1. DRILL_JAVA_LIB_PATH Set in drill-env.sh
    2. DOY_JAVA_LIB_PATH passed in from an env. var.
    3. $DRILL_SITE/lib, if it exists.
    Throws:
    
    IOException
  - testStockDaemon
```
public void testStockDaemon()
                     throws IOException
```
    Test running a (simulated) Drillbit as a daemon with start, status, stop.
    
    Throws:
    
    IOException
  - testStockDaemonWithArg
```
public void testStockDaemonWithArg()
                            throws IOException
```
    Throws:
    
    IOException
  - testPidDir
```
public void testPidDir()
                throws IOException
```
    The Daemon process creates a pid file. Verify that the DRILL_PID_DIR can be set to put the pid file in a custom location. The test is done with the site (conf) dir in the default location.
    
    Throws:
    
    IOException
  - testSiteDirWithDaemon
```
public void testSiteDirWithDaemon()
                           throws IOException
```
    Test a custom site directory with the Drill daemon process. The custom directory contains a drill-env.sh with a custom option. Verify that that option is picked up when starting Drill.
    
    Throws:
    
    IOException
  - testLogDirWithDaemon
```
public void testLogDirWithDaemon()
                          throws IOException
```
    Launch the Drill daemon using a custom log file location. The config is in the default location.
    
    Throws:
    
    IOException
  - testDrillbitSymlink
```
public void testDrillbitSymlink()
                         throws IOException
```
    Some distributions create symlinks to drillbit.sh in standard locations such as /usr/bin. Because drillbit.sh uses its own location to compute DRILL_HOME, it must handle symlinks. This test verifies that process.
    
    Throws:
    
    IOException
  - testRestart
```
public void testRestart()
                 throws IOException
```
    Test the restart command of drillbit.sh
    
    Throws:
    
    IOException
  - testForcedKill
```
public void testForcedKill()
                    throws IOException
```
    Simulate a Drillbit that refuses to die. The stop script wait a while, then forces killing.
    
    Throws:
    
    IOException
  - testSqlline
```
public void testSqlline()
                 throws IOException
```
    Verify the basics of the sqlline script, including the env vars that can be customized. Also validate running in embedded mode (using drillbit memory and other options.)
    
    Throws:
    
    IOException
  - testSqllineWithDrillbitContextEnv
```
public void testSqllineWithDrillbitContextEnv()
                                       throws IOException
```
    Test to verify no effect of DRILLBIT_CONTEXT for Sqlline.
    
    Throws:
    
    IOException
  - testSqllineSiteDir
```
public void testSqllineSiteDir()
                        throws IOException
```
    Verify that the sqlline client works with the --site option by customizing items in the site directory.
    
    Throws:
    
    IOException
  - testSqllineWrappers
```
public void testSqllineWrappers()
                         throws IOException
```
    Tests the three scripts that wrap sqlline for specific purposes:
    - drill-conf — Wrapper for sqlline, uses drill config to find Drill. Seems this one needs fixing to use a config other than the hard-coded $DRILL_HOME/conf location.
    - drill-embedded — Starts a drill "embedded" in SqlLine, using a local ZK.
    - drill-localhost — Wrapper for sqlline, uses a local ZK.
    Of these, drill-embedded runs an embedded Drillbit and so should use the Drillbit memory options. The other two are clients, but with simple default options for finding the Drillbit.
    Because the scripts are simple wrappers, all we do is verify that the right "extra" options are set, not the fundamentals (which were already covered in the sqlline tests.)
    Throws:
    
    IOException

Class TestScripts

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TestScripts

Method Detail

initialSetup

testStockCombined

testClassPath

testLogDir

testLibPath

testDrillEnv

testDistribEnv

testDistribEnvWithNegativeCond

testDistribEnvWithPositiveCond

testDrillAndDistribEnv

testBadSiteDir

testSiteDir

testJavaLibDir

testStockDaemon

testStockDaemonWithArg

testPidDir

testSiteDirWithDaemon

testLogDirWithDaemon

testDrillbitSymlink

testRestart

testForcedKill

testSqlline

testSqllineWithDrillbitContextEnv

testSqllineSiteDir

testSqllineWrappers