Asserts (Apache Brooklyn)

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Asserts.BooleanWithMessage

Nested Classes
Modifier and Type	Class and Description
`static class`	`Asserts.BooleanWithMessage`

Field Summary

Fields
Modifier and Type Field and Description

static Duration DEFAULT_TIMEOUT
The default timeout for assertions - 30s.

Fields
Modifier and Type	Field and Description
`static Duration`	`DEFAULT_TIMEOUT` The default timeout for assertions - 30s.

Method Summary

Methods
Modifier and Type	Method and Description
`static void`	`assertEqualsIgnoringOrder(java.lang.Iterable<?> actual, java.lang.Iterable<?> expected)`
`static void`	`assertEqualsIgnoringOrder(java.lang.Iterable<?> actual, java.lang.Iterable<?> expected, boolean logDuplicates, java.lang.String errmsg)`
`static void`	`assertFails(java.util.concurrent.Callable<?> c)`
`static void`	`assertFails(java.lang.Runnable r)`
`static void`	`assertFailsWith(java.util.concurrent.Callable<?> c, groovy.lang.Closure<java.lang.Boolean> exceptionChecker)`
`static void`	`assertFailsWith(java.util.concurrent.Callable<?> c, com.google.common.base.Predicate<? super java.lang.Throwable> exceptionChecker)`
`static void`	`assertFailsWith(java.lang.Runnable c, java.lang.Class<? extends java.lang.Throwable> validException, java.lang.Class<? extends java.lang.Throwable>... otherValidExceptions)`
`static void`	`assertFailsWith(java.lang.Runnable r, com.google.common.base.Predicate<? super java.lang.Throwable> exceptionChecker)`
`static void`	`assertFalse(boolean condition, java.lang.String message)` Asserts that a condition is false.
`static void`	`assertReturnsEventually(java.lang.Runnable r, Duration timeout)`
`static <T> void`	`assertThat(T object, com.google.common.base.Predicate<T> condition)`
`static void`	`assertTrue(boolean condition, java.lang.String message)` Asserts that a condition is true.
`static <T> void`	`continually(java.util.Map<java.lang.String,?> flags, com.google.common.base.Supplier<? extends T> supplier, com.google.common.base.Predicate<? super T> predicate)`
`static <T> void`	`continually(java.util.Map<java.lang.String,?> flags, com.google.common.base.Supplier<? extends T> supplier, com.google.common.base.Predicate<T> predicate, java.lang.String errMsg)`
`static <T> void`	`continually(com.google.common.base.Supplier<? extends T> supplier, com.google.common.base.Predicate<T> predicate)`
`static <T> void`	`eventually(java.util.Map<java.lang.String,?> flags, com.google.common.base.Supplier<? extends T> supplier, com.google.common.base.Predicate<T> predicate)`
`static <T> void`	`eventually(java.util.Map<java.lang.String,?> flags, com.google.common.base.Supplier<? extends T> supplier, com.google.common.base.Predicate<T> predicate, java.lang.String errMsg)`
`static <T> void`	`eventually(com.google.common.base.Supplier<? extends T> supplier, com.google.common.base.Predicate<T> predicate)`
`static java.lang.AssertionError`	`fail(java.lang.String message)` Fails a test with the given message.
`static <T> T`	`succeedsContinually(java.util.concurrent.Callable<T> c)`
`static <T> T`	`succeedsContinually(java.util.Map<?,?> flags, java.util.concurrent.Callable<T> job)`
`static <T> void`	`succeedsContinually(java.util.Map<?,?> flags, java.lang.Runnable r)`
`static <T> void`	`succeedsContinually(java.lang.Runnable r)`
`static <T> T`	`succeedsEventually(java.util.concurrent.Callable<T> c)`
`static <T> T`	`succeedsEventually(java.util.Map<java.lang.String,?> flags, java.util.concurrent.Callable<T> c)` Convenience method for cases where we need to test until something is true.
`static void`	`succeedsEventually(java.util.Map<java.lang.String,?> flags, java.lang.Runnable r)`
`static void`	`succeedsEventually(java.lang.Runnable r)`

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

Field Detail
- DEFAULT_TIMEOUT
```
public static final Duration DEFAULT_TIMEOUT
```
  The default timeout for assertions - 30s. Alter in individual tests by giving a "timeout" entry in method flags.

Method Detail

assertTrue
```
public static void assertTrue(boolean condition,
              java.lang.String message)
```
Asserts that a condition is true. If it isn't, an AssertionError, with the given message, is thrown.

Parameters:
condition - the condition to evaluate
message - the assertion error message

assertFalse
```
public static void assertFalse(boolean condition,
               java.lang.String message)
```
Asserts that a condition is false. If it isn't, an AssertionError, with the given message, is thrown.

Parameters:
condition - the condition to evaluate
message - the assertion error message

fail
```
public static java.lang.AssertionError fail(java.lang.String message)
```
Fails a test with the given message.

Parameters:
message - the assertion error message

assertEqualsIgnoringOrder

public static void assertEqualsIgnoringOrder(java.lang.Iterable<?> actual,
                             java.lang.Iterable<?> expected)

assertEqualsIgnoringOrder

public static void assertEqualsIgnoringOrder(java.lang.Iterable<?> actual,
                             java.lang.Iterable<?> expected,
                             boolean logDuplicates,
                             java.lang.String errmsg)

eventually

public static <T> void eventually(com.google.common.base.Supplier<? extends T> supplier,
                  com.google.common.base.Predicate<T> predicate)

eventually

public static <T> void eventually(java.util.Map<java.lang.String,?> flags,
                  com.google.common.base.Supplier<? extends T> supplier,
                  com.google.common.base.Predicate<T> predicate)

eventually

public static <T> void eventually(java.util.Map<java.lang.String,?> flags,
                  com.google.common.base.Supplier<? extends T> supplier,
                  com.google.common.base.Predicate<T> predicate,
                  java.lang.String errMsg)

continually

public static <T> void continually(com.google.common.base.Supplier<? extends T> supplier,
                   com.google.common.base.Predicate<T> predicate)

continually

public static <T> void continually(java.util.Map<java.lang.String,?> flags,
                   com.google.common.base.Supplier<? extends T> supplier,
                   com.google.common.base.Predicate<? super T> predicate)

continually

public static <T> void continually(java.util.Map<java.lang.String,?> flags,
                   com.google.common.base.Supplier<? extends T> supplier,
                   com.google.common.base.Predicate<T> predicate,
                   java.lang.String errMsg)

succeedsEventually

public static void succeedsEventually(java.lang.Runnable r)

See Also:: succeedsContinually(Map, Callable)

succeedsEventually

public static void succeedsEventually(java.util.Map<java.lang.String,?> flags,
                      java.lang.Runnable r)

See Also:: succeedsContinually(Map, Callable)

succeedsEventually

public static <T> T succeedsEventually(java.util.concurrent.Callable<T> c)

See Also:: succeedsContinually(Map, Callable)

succeedsEventually
```
public static <T> T succeedsEventually(java.util.Map<java.lang.String,?> flags,
                       java.util.concurrent.Callable<T> c)
```
Convenience method for cases where we need to test until something is true. The runnable will be invoked periodically until it succesfully concludes.
The following flags are supported:
- abortOnError (boolean, default true)
- abortOnException - (boolean, default false)
- timeout - (a Duration or an integer in millis, defaults to DEFAULT_TIMEOUT)
- period - (a Duration or an integer in millis, for fixed retry time; if not set, defaults to exponentially increasing from 1 to 500ms)
- minPeriod - (a Duration or an integer in millis; only used if period not explicitly set; the minimum period when exponentially increasing; defaults to 1ms)
- maxPeriod - (a Duration or an integer in millis; only used if period not explicitly set; the maximum period when exponentially increasing; defaults to 500ms)
- maxAttempts - (integer, Integer.MAX_VALUE)
The following flags are deprecated:
- useGroovyTruth - (defaults to false; any result code apart from 'false' will be treated as success including null; ignored for Runnables which aren't Callables)
Parameters:
flags, - accepts the flags listed above
r -
finallyBlock -

succeedsContinually

public static <T> void succeedsContinually(java.lang.Runnable r)

succeedsContinually

public static <T> void succeedsContinually(java.util.Map<?,?> flags,
                           java.lang.Runnable r)

succeedsContinually

public static <T> T succeedsContinually(java.util.concurrent.Callable<T> c)

succeedsContinually

public static <T> T succeedsContinually(java.util.Map<?,?> flags,
                        java.util.concurrent.Callable<T> job)

assertFails

public static void assertFails(java.lang.Runnable r)

assertFails

public static void assertFails(java.util.concurrent.Callable<?> c)

assertFailsWith

public static void assertFailsWith(java.util.concurrent.Callable<?> c,
                   groovy.lang.Closure<java.lang.Boolean> exceptionChecker)

assertFailsWith

@SafeVarargs
public static void assertFailsWith(java.lang.Runnable c,
                               java.lang.Class<? extends java.lang.Throwable> validException,
                               java.lang.Class<? extends java.lang.Throwable>... otherValidExceptions)

assertFailsWith

public static void assertFailsWith(java.lang.Runnable r,
                   com.google.common.base.Predicate<? super java.lang.Throwable> exceptionChecker)

assertFailsWith

public static void assertFailsWith(java.util.concurrent.Callable<?> c,
                   com.google.common.base.Predicate<? super java.lang.Throwable> exceptionChecker)

assertReturnsEventually

public static void assertReturnsEventually(java.lang.Runnable r,
                           Duration timeout)
                                    throws java.lang.InterruptedException,
                                           java.util.concurrent.ExecutionException,
                                           java.util.concurrent.TimeoutException

Throws:: java.lang.InterruptedException; java.util.concurrent.ExecutionException; java.util.concurrent.TimeoutException

assertThat

public static <T> void assertThat(T object,
                  com.google.common.base.Predicate<T> condition)

Class Asserts

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_TIMEOUT

Method Detail

assertTrue

assertFalse

fail

assertEqualsIgnoringOrder

assertEqualsIgnoringOrder

eventually

eventually

eventually

continually

continually

continually

succeedsEventually

succeedsEventually

succeedsEventually

succeedsEventually

succeedsContinually

succeedsContinually

succeedsContinually

succeedsContinually

assertFails

assertFails

assertFailsWith

assertFailsWith

assertFailsWith

assertFailsWith

assertReturnsEventually

assertThat