BaseTestCase

java.lang.Object
- junit.framework.Assert
- - junit.framework.TestCase
  - - com.splicemachine.dbTesting.junit.BaseTestCase

All Implemented Interfaces:

junit.framework.Test

Direct Known Subclasses:

BaseJDBCTestCase
```
public abstract class BaseTestCase
extends junit.framework.TestCase
```
Base class for JUnit tests.

Field Summary

Fields
Modifier and Type	Field and Description
`protected static java.lang.String`	`DEFAULT_DB_DIR`
`protected static java.lang.String`	`DERBY_LOG`
`protected static java.lang.String`	`ERRORSTACKTRACEFILE`

Constructor Summary

Constructors
Constructor and Description

BaseTestCase(java.lang.String name)
Create a test case with the given name.

Constructors
Constructor and Description
`BaseTestCase(java.lang.String name)` Create a test case with the given name.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`alarm(java.lang.String text)` Print alarm string
`static void`	`assertEquals(java.io.File file1, java.io.File file2)` Assert that two files in the filesystem are identical.
`static void`	`assertEquals(java.io.InputStream is1, java.io.InputStream is2)` Compare the contents of two streams.
`static void`	`assertEquals(java.io.Reader r1, java.io.Reader r2)` Compare the contents of two readers.
`static void`	`assertExecJavaCmdAsExpected(java.lang.String[] expectedString, java.lang.String[] cmd, int expectedExitValue)` Execute command using 'java' executable and verify that it completes with expected results
`static void`	`assertLaunchedJUnitTestMethod(java.lang.String testLaunchMethod)` assert a method from an executing test
`static void`	`assertLaunchedJUnitTestMethod(java.lang.String testLaunchMethod, java.lang.String databaseName)` assert a method from an executing test
`static void`	`assertSecurityManager()` Assert a security manager is installed.
`static void`	`assertThrowableEquals(java.lang.Throwable t1, java.lang.Throwable t2)` Assert that the detailed messages of the 2 passed-in Throwable's are equal (rather than '=='), as well as their class types.
`static java.io.File`	`currentDirectory()` Return the current directory.
`static java.lang.Process`	`execJavaCmd(java.lang.String[] cmd)` Execute a java command and return the process.
`static void`	`fail(java.lang.String msg, java.lang.Throwable t)` Fail; attaching an exception for more detail on cause.
`static int`	`getClassVersionMajor()` Returns the major version of the class specification version supported by the running JVM.
`java.io.File`	`getFailureFolder()` Get the folder where a test leaves any information about its failure.
`protected static java.lang.String[]`	`getFilesWith(java.io.File dir, java.lang.String prefix)` Get files in a directory which contain certain prefix
`static java.lang.String`	`getJavaExecutableName()` Return the executable name for spawning java commands.
`protected static java.lang.String`	`getSystemProperty(java.lang.String name)` Get system property.
`TestConfiguration`	`getTestConfiguration()` Return the current configuration for the test.
`protected static java.net.URL`	`getTestResource(java.lang.String name)` Obtain the URL for a test resource, e.g.
`static boolean`	`hasInterruptibleIO()` Check if we have old style (before Sun Java 1.7) Solaris interruptible IO.
`static boolean`	`isCVM()` Check if this is a CVM-based VM (like phoneME or Oracle Java ME Embedded Client).
`static boolean`	`isIBMJVM()`
`static boolean`	`isJ9Platform()`
`static boolean`	`isJava5()` Check if this is java 5
`static boolean`	`isJava7()`
`static boolean`	`isPhoneME()` Check if the VM is phoneME.
`static boolean`	`isPlatform(java.lang.String osName)` Determine if there is a platform match with os.name.
`static boolean`	`isSunJVM()`
`static boolean`	`isWindowsPlatform()` Determine if platform is a Windows variant.
`protected static java.io.InputStream`	`openTestResource(java.net.URL url)` Open the URL for a a test resource, e.g.
`static void`	`println(java.lang.String text)` Print debug string.
`static void`	`printStackTrace(java.lang.Throwable t)` Print debug string.
`static java.lang.String`	`readProcessOutput(java.lang.Process pr)` Reads output from a process and returns it as a string.
`static void`	`removeDirectory(java.io.File dir)` Remove the directory and its contents.
`static void`	`removeDirectory(java.lang.String path)` Remove the directory and its contents.
`static void`	`removeFiles(java.lang.String[] list)` Remove all the files in the list
`static void`	`removeSystemProperty(java.lang.String name)` Remove system property
`void`	`runBare()` Run the test and force installation of a security manager with the default test policy file.
`static boolean`	`runsWithEmma()`
`protected static void`	`setSystemProperty(java.lang.String name, java.lang.String value)` Set system property
`static void`	`sleep(long ms)` Makes the current thread sleep up to `ms` milliseconds.
`static void`	`sleepAtLeastOneTick()` Returns once the system timer has advanced at least one tick.
`static void`	`traceit(java.lang.String text)` Print trace string.

Methods inherited from class junit.framework.TestCase
assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertFalse, assertFalse, assertNotNull, assertNotNull, assertNotSame, assertNotSame, assertNull, assertNull, assertSame, assertSame, assertTrue, assertTrue, countTestCases, createResult, fail, fail, failNotEquals, failNotSame, failSame, format, getName, run, run, runTest, setName, setUp, tearDown, toString

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

- Field Detail
  - ERRORSTACKTRACEFILE
```
protected static final java.lang.String ERRORSTACKTRACEFILE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_DB_DIR
```
protected static final java.lang.String DEFAULT_DB_DIR
```
    See Also:
    
    Constant Field Values
  - DERBY_LOG
```
protected static final java.lang.String DERBY_LOG
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - BaseTestCase
```
public BaseTestCase(java.lang.String name)
```
    Create a test case with the given name.
    
    Parameters:
    
    name - name of the test case.
- Method Detail
  - runBare
```
public void runBare()
             throws java.lang.Throwable
```
    Run the test and force installation of a security manager with the default test policy file. Individual tests can run without a security manager or with a different policy file using the decorators obtained from SecurityManagerSetup.
    Method is final to ensure security manager is enabled by default. Tests should not need to override runTest, instead use test methods setUp, tearDown methods and decorators.
    
    Overrides:
    
    runBare in class junit.framework.TestCase
    
    Throws:
    
    java.lang.Throwable
  - getTestConfiguration
```
public final TestConfiguration getTestConfiguration()
```
    Return the current configuration for the test.
  - getFailureFolder
```
public final java.io.File getFailureFolder()
```
    Get the folder where a test leaves any information about its failure.
    
    Returns:
    
    Folder to use.
    
    See Also:
    
    TestConfiguration.getFailureFolder(TestCase)
  - alarm
```
public static void alarm(java.lang.String text)
```
    Print alarm string
    
    Parameters:
    
    text - String to print
  - println
```
public static void println(java.lang.String text)
```
    Print debug string.
    
    Parameters:
    
    text - String to print
  - traceit
```
public static void traceit(java.lang.String text)
```
    Print trace string.
    
    Parameters:
    
    text - String to print
  - printStackTrace
```
public static void printStackTrace(java.lang.Throwable t)
```
    Print debug string.
    
    Parameters:
    
    t - Throwable object to print stack trace from
  - setSystemProperty
```
protected static void setSystemProperty(java.lang.String name,
                                        java.lang.String value)
```
    Set system property
    
    Parameters:
    
    name - name of the property
    
    value - value of the property
  - removeSystemProperty
```
public static void removeSystemProperty(java.lang.String name)
```
    Remove system property
    
    Parameters:
    
    name - name of the property
  - getSystemProperty
```
protected static java.lang.String getSystemProperty(java.lang.String name)
```
    Get system property.
    
    Parameters:
    
    name - name of the property
  - getFilesWith
```
protected static java.lang.String[] getFilesWith(java.io.File dir,
                                                 java.lang.String prefix)
```
    Get files in a directory which contain certain prefix
    
    Parameters:
    
    dir - The directory we are checking for files with certain prefix
    
    prefix - The prefix pattern we are interested.
    
    Returns:
    
    The list indicates files with certain prefix.
  - getTestResource
```
protected static java.net.URL getTestResource(java.lang.String name)
```
    Obtain the URL for a test resource, e.g. a policy file or a SQL script.
    
    Parameters:
    
    name - Resource name, typically - org.apache.derbyTesing.something
    
    Returns:
    
    URL to the resource, null if it does not exist.
  - openTestResource
```
protected static java.io.InputStream openTestResource(java.net.URL url)
                                               throws java.security.PrivilegedActionException
```
    Open the URL for a a test resource, e.g. a policy file or a SQL script.
    
    Parameters:
    
    url - URL obtained from getTestResource
    
    Returns:
    
    An open stream
    
    Throws:
    
    java.security.PrivilegedActionException
  - assertSecurityManager
```
public static void assertSecurityManager()
```
    Assert a security manager is installed.
  - assertEquals
```
public static void assertEquals(java.io.InputStream is1,
                                java.io.InputStream is2)
                         throws java.io.IOException
```
    Compare the contents of two streams. The streams are closed after they are exhausted.
    
    Parameters:
    
    is1 - the first stream
    
    is2 - the second stream
    
    Throws:
    
    java.io.IOException - if reading from the streams fail
    
    junit.framework.AssertionFailedError - if the stream contents are not equal
  - assertEquals
```
public static void assertEquals(java.io.Reader r1,
                                java.io.Reader r2)
                         throws java.io.IOException
```
    Compare the contents of two readers. The readers are closed after they are exhausted.
    
    Parameters:
    
    r1 - the first reader
    
    r2 - the second reader
    
    Throws:
    
    java.io.IOException - if reading from the streams fail
    
    junit.framework.AssertionFailedError - if the reader contents are not equal
  - assertThrowableEquals
```
public static void assertThrowableEquals(java.lang.Throwable t1,
                                         java.lang.Throwable t2)
```
    Assert that the detailed messages of the 2 passed-in Throwable's are equal (rather than '=='), as well as their class types.
    
    Parameters:
    
    t1 - first throwable to compare
    
    t2 - second throwable to compare
  - assertEquals
```
public static void assertEquals(java.io.File file1,
                                java.io.File file2)
```
    Assert that two files in the filesystem are identical.
    
    Parameters:
    
    file1 - the first file to compare
    
    file2 - the second file to compare
  - assertExecJavaCmdAsExpected
```
public static void assertExecJavaCmdAsExpected(java.lang.String[] expectedString,
                                               java.lang.String[] cmd,
                                               int expectedExitValue)
                                        throws java.lang.InterruptedException,
                                               java.io.IOException
```
    Execute command using 'java' executable and verify that it completes with expected results
    
    Parameters:
    
    expectedString - String to compare the resulting output with. May be null if the output is not expected to be of interest.
    
    cmd - array of java arguments for command
    
    expectedExitValue - expected return value from the command
    
    Throws:
    
    java.lang.InterruptedException
    
    java.io.IOException
  - execJavaCmd
```
public static java.lang.Process execJavaCmd(java.lang.String[] cmd)
                                     throws java.io.IOException
```
    Execute a java command and return the process. The caller should decide what to do with the process, if anything, typical activities would be to do a pr.waitFor, or to get a getInputStream or getErrorStream Note, that for verifying the output of a Java process, there is assertExecJavaCmdAsExpected
    
    Parameters:
    
    cmd - array of java arguments for command
    
    Returns:
    
    the process that was started
    
    Throws:
    
    java.io.IOException
  - getJavaExecutableName
```
public static final java.lang.String getJavaExecutableName()
```
    Return the executable name for spawning java commands. This will be /j9 for j9 jvms.
    
    Returns:
    
    full path to java executable.
  - currentDirectory
```
public static java.io.File currentDirectory()
```
    Return the current directory.
  - isJ9Platform
```
public static final boolean isJ9Platform()
```
    Returns:
    
    true if this is a j9 VM
  - isSunJVM
```
public static final boolean isSunJVM()
```
  - isCVM
```
public static boolean isCVM()
```
    Check if this is a CVM-based VM (like phoneME or Oracle Java ME Embedded Client).
  - isPhoneME
```
public static boolean isPhoneME()
```
    Check if the VM is phoneME.
    
    Returns:
    
    true if it is phoneME
  - isPlatform
```
public static final boolean isPlatform(java.lang.String osName)
```
    Determine if there is a platform match with os.name. This method uses an exact equals. Other methods might be useful later for starts with.
    
    Parameters:
    
    osName - value we want to check against the system property os.name
    
    Returns:
    
    return true if osName is an exact match for osName
  - isWindowsPlatform
```
public static final boolean isWindowsPlatform()
```
    Determine if platform is a Windows variant.
    Return true if platform is a windows platform. Just looks for os.name starting with "Windows". The os.name property can have at least the following values (there are probably more): AIX Digital Unix FreeBSD HP UX Irix Linux Mac OS Mac OS X MPE/iX Netware 4.11 OS/2 SunOS Windows 2000 Windows 95 Windows 98 Windows NT Windows Vista Windows XP
    
    Returns:
    
    true if running on a Windows platform.
  - isJava5
```
public static final boolean isJava5()
```
    Check if this is java 5
    
    Returns:
    
    true if java.version system property starts with 1.5
  - isJava7
```
public static final boolean isJava7()
```
  - runsWithEmma
```
public static final boolean runsWithEmma()
```
  - getClassVersionMajor
```
public static int getClassVersionMajor()
```
    Returns the major version of the class specification version supported by the running JVM.
    - 48 = Java 1.4
    - 49 = Java 1.5
    - 50 = Java 1.6
    - 51 = Java 1.7
    Returns:
    
    Major version of class version specification, i.e. 49 for 49.0, or -1 if the version can't be obtained for some reason.
  - hasInterruptibleIO
```
public static final boolean hasInterruptibleIO()
```
    Check if we have old style (before Sun Java 1.7) Solaris interruptible IO. On Sun Java 1.5 >= update 22 and Sun Java 1.6 this can be disabled with Java option -XX:-UseVMInterruptibleIO. On Sun Java 1.7 it is by default disabled.
    
    Returns:
    
    true if we have old style interruptible IO
  - isIBMJVM
```
public static final boolean isIBMJVM()
```
  - readProcessOutput
```
public static java.lang.String readProcessOutput(java.lang.Process pr)
                                          throws java.lang.InterruptedException
```
    Reads output from a process and returns it as a string.
    This will block until the process terminates.
    
    Parameters:
    
    pr - a running process
    
    Returns:
    
    Output of the process, both STDOUT and STDERR.
    
    Throws:
    
    java.lang.InterruptedException - if interrupted while waiting for the subprocess or one of the output collector threads to terminate
  - removeDirectory
```
public static void removeDirectory(java.lang.String path)
```
    Remove the directory and its contents.
    
    Parameters:
    
    path - Path of the directory
  - removeDirectory
```
public static void removeDirectory(java.io.File dir)
```
    Remove the directory and its contents.
    
    Parameters:
    
    dir - File of the directory
  - removeFiles
```
public static void removeFiles(java.lang.String[] list)
```
    Remove all the files in the list
    
    Parameters:
    
    list - the list contains all the files
  - fail
```
public static void fail(java.lang.String msg,
                        java.lang.Throwable t)
                 throws junit.framework.AssertionFailedError
```
    Fail; attaching an exception for more detail on cause.
    
    Parameters:
    
    msg - message explaining the failure
    
    t - the cause of the failure
    
    Throws:
    
    junit.framework.AssertionFailedError
  - assertLaunchedJUnitTestMethod
```
public static void assertLaunchedJUnitTestMethod(java.lang.String testLaunchMethod)
                                          throws java.lang.Exception
```
    assert a method from an executing test
    
    Parameters:
    
    testLaunchMethod - complete pathname of the method to be executed
    
    Throws:
    
    java.lang.Exception
  - assertLaunchedJUnitTestMethod
```
public static void assertLaunchedJUnitTestMethod(java.lang.String testLaunchMethod,
                                                 java.lang.String databaseName)
                                          throws java.lang.Exception
```
    assert a method from an executing test
    
    Parameters:
    
    testLaunchMethod - complete pathname of the method to be executed
    
    databaseName - name of the database to be used
    
    Throws:
    
    java.lang.Exception
  - sleepAtLeastOneTick
```
public static void sleepAtLeastOneTick()
```
    Returns once the system timer has advanced at least one tick.
  - sleep
```
public static void sleep(long ms)
```
    Makes the current thread sleep up to ms milliseconds.

Class BaseTestCase

Field Summary

Constructor Summary

Method Summary

Methods inherited from class junit.framework.TestCase

Methods inherited from class java.lang.Object

Field Detail

ERRORSTACKTRACEFILE

DEFAULT_DB_DIR

DERBY_LOG

Constructor Detail

BaseTestCase

Method Detail

runBare

getTestConfiguration

getFailureFolder

alarm

println

traceit

printStackTrace

setSystemProperty

removeSystemProperty

getSystemProperty

getFilesWith

getTestResource

openTestResource

assertSecurityManager

assertEquals

assertEquals

assertThrowableEquals

assertEquals

assertExecJavaCmdAsExpected

execJavaCmd

getJavaExecutableName

currentDirectory

isJ9Platform

isSunJVM

isCVM

isPhoneME

isPlatform

isWindowsPlatform

isJava5

isJava7

runsWithEmma

getClassVersionMajor

hasInterruptibleIO

isIBMJVM

readProcessOutput

removeDirectory

removeDirectory

removeFiles

fail

assertLaunchedJUnitTestMethod

assertLaunchedJUnitTestMethod

sleepAtLeastOneTick

sleep