RandomizedTest (RandomizedTesting Randomized Runner v2.3.2 API Documentation)

java.lang.Object
- com.carrotsearch.randomizedtesting.RandomizedTest

```
public class RandomizedTest
extends java.lang.Object
```
Common scaffolding for subclassing randomized tests.

See Also:
Listeners, RandomizedContext

Field Summary

Fields
Modifier and Type	Field and Description
`protected static java.nio.charset.Charset`	`ISO8859_1`
`static java.lang.String`	`SYSPROP_MULTIPLIER` The global multiplier property (Double).
`protected static java.nio.charset.Charset`	`US_ASCII`
`protected static java.nio.charset.Charset`	`UTF16`
`protected static java.nio.charset.Charset`	`UTF32`
`protected static java.nio.charset.Charset`	`UTF8`

Constructor Summary

Constructors
Constructor and Description

RandomizedTest()

Constructors
Constructor and Description
`RandomizedTest()`

Method Summary

Methods
Modifier and Type	Method and Description
`static java.lang.Object[]`	`$(java.lang.Object... objects)` This is an absolutely hacky utility to take a vararg as input and return the array of arguments as output.
`static java.lang.Object[][]`	`$$(java.lang.Object[]... objects)`
`static void`	`assumeFalse(boolean condition)` Reverse of `assumeTrue(boolean)`.
`static void`	`assumeFalse(java.lang.String message, boolean condition)` Reverse of `assumeTrue(String, boolean)`.
`static void`	`assumeNoException(java.lang.String msg, java.lang.Throwable t)` Assume `t` is `null`.
`static void`	`assumeNoException(java.lang.Throwable t)` Making `Assume.assumeNoException(Throwable)` directly available.
`static void`	`assumeNotNull(java.lang.Object... objects)` Making `Assume.assumeNotNull(Object...)` directly available.
`static void`	`assumeTrue(boolean condition)` Making `Assume.assumeTrue(boolean)` directly available.
`static void`	`assumeTrue(java.lang.String message, boolean condition)`
`static int`	`atLeast(int min)` Returns a random value greater or equal to `min`.
`static int`	`atMost(int max)` Returns a non-negative random value smaller or equal `max`.
`static int`	`between(int min, int max)` An alias for `randomIntBetween(int, int)`.
`static <T extends java.io.Closeable> T`	`closeAfterSuite(T resource)` Registers a `Closeable` resource that should be closed after the suite completes.
`<T extends java.io.Closeable> T`	`closeAfterTest(T resource)` Registers a `Closeable` resource that should be closed after the test completes.
`static boolean`	`frequently()` The exact opposite of `rarely()`.
`static RandomizedContext`	`getContext()` Shortcut for `RandomizedContext.current()`.
`static java.util.Random`	`getRandom()` Shortcut for `RandomizedContext.getRandom()`.
`static java.nio.file.Path`	`globalTempDir()` Global temporary directory created for the duration of this class's lifespan.
`static boolean`	`isNightly()` Deprecated. Will be removed in 2.4.0
`static int`	`iterations(int min, int max)` Returns a "scaled" number of iterations for loops which can have a variable iteration count.
`static double`	`multiplier()` A multiplier can be used to linearly scale certain values.
`static java.net.ServerSocket`	`newServerSocket(LifecycleScope scope)` Assign a temporary server socket.
`java.nio.file.Path`	`newTempDir()` Creates a new temporary directory for the `LifecycleScope.TEST` duration.
`static java.nio.file.Path`	`newTempDir(LifecycleScope scope)` Creates a temporary directory, deleted after the given lifecycle phase.
`java.nio.file.Path`	`newTempFile()` Creates a new temporary file for the `LifecycleScope.TEST` duration.
`static java.nio.file.Path`	`newTempFile(LifecycleScope scope)` Creates a new temporary file deleted after the given lifecycle phase completes.
`static java.lang.String`	`randomAsciiOfLength(int codeUnits)`
`static java.lang.String`	`randomAsciiOfLengthBetween(int minCodeUnits, int maxCodeUnits)`
`static boolean`	`randomBoolean()`
`static byte`	`randomByte()`
`static byte[]`	`randomBytesOfLength(int length)` Returns a byte array with random content.
`static byte[]`	`randomBytesOfLength(int minLength, int maxLength)` Returns a byte array with random content.
`static double`	`randomDouble()`
`static float`	`randomFloat()`
`static <T> T`	`randomFrom(java.util.List<T> list)` Pick a random object from the given list.
`static <T> T`	`randomFrom(T[] array)` Pick a random object from the given array.
`static double`	`randomGaussian()`
`static int`	`randomInt()`
`static int`	`randomInt(int max)` A random integer from 0..max (inclusive).
`static int`	`randomIntBetween(int min, int max)` A random integer from `min` to `max` (inclusive).
`static java.util.Locale`	`randomLocale()` Return a random Locale from the available locales on the system.
`static long`	`randomLong()`
`static java.lang.String`	`randomRealisticUnicodeOfCodepointLength(int codePoints)`
`static java.lang.String`	`randomRealisticUnicodeOfCodepointLengthBetween(int minCodePoints, int maxCodePoints)`
`static java.lang.String`	`randomRealisticUnicodeOfLength(int codeUnits)`
`static java.lang.String`	`randomRealisticUnicodeOfLengthBetween(int minCodeUnits, int maxCodeUnits)`
`static short`	`randomShort()`
`static java.util.TimeZone`	`randomTimeZone()` Return a random TimeZone from the available timezones on the system.
`static java.lang.String`	`randomUnicodeOfCodepointLength(int codePoints)`
`static java.lang.String`	`randomUnicodeOfCodepointLengthBetween(int minCodePoints, int maxCodePoints)`
`static java.lang.String`	`randomUnicodeOfLength(int codeUnits)`
`static java.lang.String`	`randomUnicodeOfLengthBetween(int minCodeUnits, int maxCodeUnits)`
`static boolean`	`rarely()` Rarely returns `true` in about 10% of all calls (regardless of the `isNightly()` mode).
`static void`	`rmDir(java.nio.file.Path path)` Recursively delete a folder.
`static int`	`scaledRandomIntBetween(int min, int max)` Returns a "scaled" random number between min and max (inclusive).
`static void`	`sleep(long millis)` Same as `Thread.sleep(long)`.
`static boolean`	`systemPropertyAsBoolean(java.lang.String propertyName, boolean defaultValue)` Get a system property and convert it to a boolean, if defined.
`static double`	`systemPropertyAsDouble(java.lang.String propertyName, double defaultValue)` Get a system property and convert it to a double, if defined.
`static float`	`systemPropertyAsFloat(java.lang.String propertyName, float defaultValue)` Get a system property and convert it to a float, if defined.
`static int`	`systemPropertyAsInt(java.lang.String propertyName, int defaultValue)` Get a system property and convert it to an int, if defined.
`static float`	`systemPropertyAsLong(java.lang.String propertyName, int defaultValue)` Get a system property and convert it to a long, if defined.

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

- Field Detail
  - SYSPROP_MULTIPLIER
```
public static final java.lang.String SYSPROP_MULTIPLIER
```
    The global multiplier property (Double).
    
    See Also:
    multiplier(), Constant Field Values
  - UTF8
```
protected static final java.nio.charset.Charset UTF8
```
  - UTF16
```
protected static final java.nio.charset.Charset UTF16
```
  - ISO8859_1
```
protected static final java.nio.charset.Charset ISO8859_1
```
  - US_ASCII
```
protected static final java.nio.charset.Charset US_ASCII
```
  - UTF32
```
protected static final java.nio.charset.Charset UTF32
```
- Constructor Detail
  - RandomizedTest
```
public RandomizedTest()
```
- Method Detail
  - getContext
```
public static RandomizedContext getContext()
```
    Shortcut for RandomizedContext.current().
  - isNightly
```
public static boolean isNightly()
```
    Deprecated. Will be removed in 2.4.0
    
    Returns true if we're running nightly tests.
    
    See Also:
    Nightly
  - getRandom
```
public static java.util.Random getRandom()
```
    Shortcut for RandomizedContext.getRandom(). Even though this method is static, it returns per-thread Random instance, so no race conditions can occur.
    It is recommended that specific methods are used to pick random values.
  - randomBoolean
```
public static boolean randomBoolean()
```
  - randomByte
```
public static byte randomByte()
```
  - randomShort
```
public static short randomShort()
```
  - randomInt
```
public static int randomInt()
```
  - randomFloat
```
public static float randomFloat()
```
  - randomDouble
```
public static double randomDouble()
```
  - randomLong
```
public static long randomLong()
```
  - randomGaussian
```
public static double randomGaussian()
```
    See Also:
    Random.nextGaussian()
  - randomBytesOfLength
```
public static byte[] randomBytesOfLength(int length)
```
    Returns a byte array with random content.
    
    Parameters:
    length - The length of the byte array. Can be zero.
    
    Returns:
    Returns a byte array with random content.
  - randomBytesOfLength
```
public static byte[] randomBytesOfLength(int minLength,
                         int maxLength)
```
    Returns a byte array with random content.
    
    Parameters:
    minLength - The minimum length of the byte array. Can be zero.
    maxLength - The maximum length of the byte array. Can be zero.
    
    Returns:
    Returns a byte array with random content.
  - randomInt
```
public static int randomInt(int max)
```
    A random integer from 0..max (inclusive).
  - randomIntBetween
```
public static int randomIntBetween(int min,
                   int max)
```
    A random integer from min to max (inclusive).
    
    See Also:
    scaledRandomIntBetween(int, int)
  - between
```
public static int between(int min,
          int max)
```
    An alias for randomIntBetween(int, int).
    
    See Also:
    scaledRandomIntBetween(int, int)
  - atLeast
```
public static int atLeast(int min)
```
    Returns a random value greater or equal to min. The value picked is affected by isNightly() and multiplier().
    
    See Also:
    scaledRandomIntBetween(int, int)
  - atMost
```
public static int atMost(int max)
```
    Returns a non-negative random value smaller or equal max. The value picked is affected by isNightly() and multiplier().
    This method is effectively an alias to:
```
 scaledRandomIntBetween(0, max)
 
```
    See Also:
    scaledRandomIntBetween(int, int)
  - rarely
```
public static boolean rarely()
```
    Rarely returns true in about 10% of all calls (regardless of the isNightly() mode).
  - frequently
```
public static boolean frequently()
```
    The exact opposite of rarely().
  - randomFrom
```
public static <T> T randomFrom(T[] array)
```
    Pick a random object from the given array. The array must not be empty.
  - randomFrom
```
public static <T> T randomFrom(java.util.List<T> list)
```
    Pick a random object from the given list.
  - multiplier
```
public static double multiplier()
```
    A multiplier can be used to linearly scale certain values. It can be used to make data or iterations of certain tests "heavier" for nightly runs, for example.
    The default multiplier value is 1.
    
    See Also:
    SYSPROP_MULTIPLIER
  - iterations
```
public static int iterations(int min,
             int max)
```
    Returns a "scaled" number of iterations for loops which can have a variable iteration count. This method is effectively an alias to scaledRandomIntBetween(int, int).
  - scaledRandomIntBetween
```
public static int scaledRandomIntBetween(int min,
                         int max)
```
    Returns a "scaled" random number between min and max (inclusive). The number of iterations will fall between [min, max], but the selection will also try to achieve the points below:
    - the multiplier can be used to move the number of iterations closer to min (if it is smaller than 1) or closer to max (if it is larger than 1). Setting the multiplier to 0 will always result in picking min.
    - on normal runs, the number will be closer to min than to max.
    - on nightly runs, the number will be closer to max than to min.
    Parameters:
    min - Minimum (inclusive).
    max - Maximum (inclusive).
    
    Returns:
    Returns a random number between min and max.
    See Also:
    multiplier()
  - globalTempDir
```
public static java.nio.file.Path globalTempDir()
                                        throws java.io.IOException
```
    Global temporary directory created for the duration of this class's lifespan. If multiple class loaders are used, there may be more global temp dirs, but it shouldn't really be the case in practice.
    
    Throws:
    
    java.io.IOException
  - newTempDir
```
public java.nio.file.Path newTempDir()
                              throws java.io.IOException
```
    Creates a new temporary directory for the LifecycleScope.TEST duration.
    
    Throws:
    
    java.io.IOException
    See Also:
    globalTempDir()
  - newTempDir
```
public static java.nio.file.Path newTempDir(LifecycleScope scope)
                                     throws java.io.IOException
```
    Creates a temporary directory, deleted after the given lifecycle phase. Temporary directory is created relative to a globally picked temporary directory.
    
    Throws:
    
    java.io.IOException
  - closeAfterTest
```
public <T extends java.io.Closeable> T closeAfterTest(T resource)
```
    Registers a Closeable resource that should be closed after the test completes.
    
    Returns:
    resource (for call chaining).
  - closeAfterSuite
```
public static <T extends java.io.Closeable> T closeAfterSuite(T resource)
```
    Registers a Closeable resource that should be closed after the suite completes.
    
    Returns:
    resource (for call chaining).
  - newTempFile
```
public java.nio.file.Path newTempFile()
                               throws java.io.IOException
```
    Creates a new temporary file for the LifecycleScope.TEST duration.
    
    Throws:
    
    java.io.IOException
  - newTempFile
```
public static java.nio.file.Path newTempFile(LifecycleScope scope)
                                      throws java.io.IOException
```
    Creates a new temporary file deleted after the given lifecycle phase completes. The file is physically created on disk, but is not locked or opened.
    
    Throws:
    
    java.io.IOException
  - rmDir
```
public static void rmDir(java.nio.file.Path path)
                  throws java.io.IOException
```
    Recursively delete a folder. Throws an exception if any failure occurs.
    
    Parameters:
    path - Path to the folder to be (recursively) deleted. The folder must exist.
    
    Throws:
    
    java.io.IOException
  - newServerSocket
```
public static java.net.ServerSocket newServerSocket(LifecycleScope scope)
                                             throws java.io.IOException
```
    Assign a temporary server socket. If you need a temporary port one can assign a server socket and close it immediately, just to acquire its port number.
    
    Parameters:
    scope - The lifecycle scope to close the socket after. If the socket is closed earlier, nothing happens (silently dropped).
    
    Throws:
    
    java.io.IOException
  - randomLocale
```
public static java.util.Locale randomLocale()
```
    Return a random Locale from the available locales on the system.
    Warning: This test assumes the returned array of locales is repeatable from jvm execution to jvm execution. It _may_ be different from jvm to jvm and as such, it can render tests execute in a different way.
  - randomTimeZone
```
public static java.util.TimeZone randomTimeZone()
```
    Return a random TimeZone from the available timezones on the system.
    Warning: This test assumes the returned array of time zones is repeatable from jvm execution to jvm execution. It _may_ be different from jvm to jvm and as such, it can render tests execute in a different way.
  - randomAsciiOfLengthBetween
```
public static java.lang.String randomAsciiOfLengthBetween(int minCodeUnits,
                                          int maxCodeUnits)
```
    See Also:
    StringGenerator.ofCodeUnitsLength(Random, int, int)
  - randomAsciiOfLength
```
public static java.lang.String randomAsciiOfLength(int codeUnits)
```
    See Also:
    StringGenerator.ofCodeUnitsLength(Random, int, int)
  - randomUnicodeOfLengthBetween
```
public static java.lang.String randomUnicodeOfLengthBetween(int minCodeUnits,
                                            int maxCodeUnits)
```
    See Also:
    StringGenerator.ofCodeUnitsLength(Random, int, int)
  - randomUnicodeOfLength
```
public static java.lang.String randomUnicodeOfLength(int codeUnits)
```
    See Also:
    StringGenerator.ofCodeUnitsLength(Random, int, int)
  - randomUnicodeOfCodepointLengthBetween
```
public static java.lang.String randomUnicodeOfCodepointLengthBetween(int minCodePoints,
                                                     int maxCodePoints)
```
    See Also:
    StringGenerator.ofCodePointsLength(Random, int, int)
  - randomUnicodeOfCodepointLength
```
public static java.lang.String randomUnicodeOfCodepointLength(int codePoints)
```
    See Also:
    StringGenerator.ofCodePointsLength(Random, int, int)
  - randomRealisticUnicodeOfLengthBetween
```
public static java.lang.String randomRealisticUnicodeOfLengthBetween(int minCodeUnits,
                                                     int maxCodeUnits)
```
    See Also:
    StringGenerator.ofCodeUnitsLength(Random, int, int)
  - randomRealisticUnicodeOfLength
```
public static java.lang.String randomRealisticUnicodeOfLength(int codeUnits)
```
    See Also:
    StringGenerator.ofCodeUnitsLength(Random, int, int)
  - randomRealisticUnicodeOfCodepointLengthBetween
```
public static java.lang.String randomRealisticUnicodeOfCodepointLengthBetween(int minCodePoints,
                                                              int maxCodePoints)
```
    See Also:
    StringGenerator.ofCodePointsLength(Random, int, int)
  - randomRealisticUnicodeOfCodepointLength
```
public static java.lang.String randomRealisticUnicodeOfCodepointLength(int codePoints)
```
    See Also:
    StringGenerator.ofCodePointsLength(Random, int, int)
  - $
```
public static java.lang.Object[] $(java.lang.Object... objects)
```
    This is an absolutely hacky utility to take a vararg as input and return the array of arguments as output. The name is a dollar for brevity, idea borrowed from http://code.google.com/p/junitparams/.
  - $$
```
public static java.lang.Object[][] $$(java.lang.Object[]... objects)
```
    See Also:
    $(java.lang.Object...)
  - sleep
```
public static void sleep(long millis)
```
    Same as Thread.sleep(long).
  - assumeTrue
```
public static void assumeTrue(boolean condition)
```
    Making Assume.assumeTrue(boolean) directly available.
  - assumeFalse
```
public static void assumeFalse(boolean condition)
```
    Reverse of assumeTrue(boolean).
  - assumeNotNull
```
public static void assumeNotNull(java.lang.Object... objects)
```
    Making Assume.assumeNotNull(Object...) directly available.
  - assumeTrue
```
public static void assumeTrue(java.lang.String message,
              boolean condition)
```
    Parameters:
    condition - If false an InternalAssumptionViolatedException is thrown by this method and the test case (should be) ignored (or rather technically, flagged as a failure not passing a certain assumption). Tests that are assumption-failures do not break builds (again: typically).
    message - Message to be included in the exception's string.
  - assumeFalse
```
public static void assumeFalse(java.lang.String message,
               boolean condition)
```
    Reverse of assumeTrue(String, boolean).
  - assumeNoException
```
public static void assumeNoException(java.lang.String msg,
                     java.lang.Throwable t)
```
    Assume t is null.
  - assumeNoException
```
public static void assumeNoException(java.lang.Throwable t)
```
    Making Assume.assumeNoException(Throwable) directly available.
  - systemPropertyAsDouble
```
public static double systemPropertyAsDouble(java.lang.String propertyName,
                            double defaultValue)
```
    Get a system property and convert it to a double, if defined. Otherwise, return the default value.
  - systemPropertyAsFloat
```
public static float systemPropertyAsFloat(java.lang.String propertyName,
                          float defaultValue)
```
    Get a system property and convert it to a float, if defined. Otherwise, return the default value.
  - systemPropertyAsInt
```
public static int systemPropertyAsInt(java.lang.String propertyName,
                      int defaultValue)
```
    Get a system property and convert it to an int, if defined. Otherwise, return the default value.
  - systemPropertyAsLong
```
public static float systemPropertyAsLong(java.lang.String propertyName,
                         int defaultValue)
```
    Get a system property and convert it to a long, if defined. Otherwise, return the default value.
  - systemPropertyAsBoolean
```
public static boolean systemPropertyAsBoolean(java.lang.String propertyName,
                              boolean defaultValue)
```
    Get a system property and convert it to a boolean, if defined. This method returns true if the property exists an is set to any of the following strings (case-insensitive): true, on, yes, enabled.
    false is returned if the property exists and is set to any of the following strings (case-insensitive): false, off, no, disabled.

Class RandomizedTest

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SYSPROP_MULTIPLIER

UTF8

UTF16

ISO8859_1

US_ASCII

UTF32

Constructor Detail

RandomizedTest

Method Detail

getContext

isNightly

getRandom

randomBoolean

randomByte

randomShort

randomInt

randomFloat

randomDouble

randomLong

randomGaussian

randomBytesOfLength

randomBytesOfLength

randomInt

randomIntBetween

between

atLeast

atMost

rarely

frequently

randomFrom

randomFrom

multiplier

iterations

scaledRandomIntBetween

globalTempDir

newTempDir

newTempDir

closeAfterTest

closeAfterSuite

newTempFile

newTempFile

rmDir

newServerSocket

randomLocale

randomTimeZone

randomAsciiOfLengthBetween

randomAsciiOfLength

randomUnicodeOfLengthBetween

randomUnicodeOfLength

randomUnicodeOfCodepointLengthBetween

randomUnicodeOfCodepointLength

randomRealisticUnicodeOfLengthBetween

randomRealisticUnicodeOfLength

randomRealisticUnicodeOfCodepointLengthBetween

randomRealisticUnicodeOfCodepointLength

$

$$

sleep

assumeTrue

assumeFalse

assumeNotNull

assumeTrue

assumeFalse

assumeNoException

assumeNoException

systemPropertyAsDouble

systemPropertyAsFloat

systemPropertyAsInt

systemPropertyAsLong

systemPropertyAsBoolean