io.vertx.rxjava.ext.unit.TestContext Maven / Gradle / Ivy
/*
* Copyright 2014 Red Hat, Inc.
*
* Red Hat licenses this file to you under the Apache License, version 2.0
* (the "License"); you may not use this file except in compliance with the
* License. You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations
* under the License.
*/
package io.vertx.rxjava.ext.unit;
import java.util.Map;
import rx.Observable;
import io.vertx.core.AsyncResult;
import io.vertx.core.Handler;
/**
* The test context is used for performing test assertions and manage the completion of the test. This context
* is provided by vertx-unit as argument of the test case.
*
*
* NOTE: This class has been automatically generated from the {@link io.vertx.ext.unit.TestContext original} non RX-ified interface using Vert.x codegen.
*/
public class TestContext {
final io.vertx.ext.unit.TestContext delegate;
public TestContext(io.vertx.ext.unit.TestContext delegate) {
this.delegate = delegate;
}
public Object getDelegate() {
return delegate;
}
/**
* Get some data from the context.
* @param key the key of the data
* @return the data
*/
public T get(String key) {
T ret = (T) delegate.get(key);
return ret;
}
/**
* Put some data in the context.
*
* This can be used to share data between different tests and before/after phases.
* @param key the key of the data
* @param value the data
* @return the previous object when it exists
*/
public T put(String key, Object value) {
T ret = (T) delegate.put(key, value);
return ret;
}
/**
* Remove some data from the context.
* @param key the key to remove
* @return the removed object when it exists
*/
public T remove(String key) {
T ret = (T) delegate.remove(key);
return ret;
}
/**
* Assert the expected argument is null. If the argument is not, an assertion error is thrown
* otherwise the execution continue.
* @param expected the argument being asserted to be null
* @return a reference to this, so the API can be used fluently
*/
public TestContext assertNull(Object expected) {
delegate.assertNull(expected);
return this;
}
/**
* Assert the expected argument is null. If the argument is not, an assertion error is thrown
* otherwise the execution continue.
* @param expected the argument being asserted to be null
* @param message the failure message
* @return a reference to this, so the API can be used fluently
*/
public TestContext assertNull(Object expected, String message) {
delegate.assertNull(expected, message);
return this;
}
/**
* Assert the expected argument is not null. If the argument is null, an assertion error is thrown
* otherwise the execution continue.
* @param expected the argument being asserted to be not null
* @return a reference to this, so the API can be used fluently
*/
public TestContext assertNotNull(Object expected) {
delegate.assertNotNull(expected);
return this;
}
/**
* Assert the expected argument is not null. If the argument is null, an assertion error is thrown
* otherwise the execution continue.
* @param expected the argument being asserted to be not null
* @param message the failure message
* @return a reference to this, so the API can be used fluently
*/
public TestContext assertNotNull(Object expected, String message) {
delegate.assertNotNull(expected, message);
return this;
}
/**
* Assert the specified condition is true. If the condition is false, an assertion error is thrown
* otherwise the execution continue.
* @param condition the condition to assert
* @return a reference to this, so the API can be used fluently
*/
public TestContext assertTrue(boolean condition) {
delegate.assertTrue(condition);
return this;
}
/**
* Assert the specified condition is true. If the condition is false, an assertion error is thrown
* otherwise the execution continue.
* @param condition the condition to assert
* @param message the failure message
* @return a reference to this, so the API can be used fluently
*/
public TestContext assertTrue(boolean condition, String message) {
delegate.assertTrue(condition, message);
return this;
}
/**
* Assert the specified condition is false. If the condition is true, an assertion error is thrown
* otherwise the execution continue.
* @param condition the condition to assert
* @return a reference to this, so the API can be used fluently
*/
public TestContext assertFalse(boolean condition) {
delegate.assertFalse(condition);
return this;
}
/**
* Assert the specified condition is false. If the condition is true, an assertion error is thrown
* otherwise the execution continue.
* @param condition the condition to assert
* @param message the failure message
* @return a reference to this, so the API can be used fluently
*/
public TestContext assertFalse(boolean condition, String message) {
delegate.assertFalse(condition, message);
return this;
}
/**
* Assert the expected argument is equals to the actual argument. If the arguments are not equals
* an assertion error is thrown otherwise the execution continue.
* @param expected the object the actual object is supposedly equals to
* @param actual the actual object to test
* @return a reference to this, so the API can be used fluently
*/
public TestContext assertEquals(Object expected, Object actual) {
delegate.assertEquals(expected, actual);
return this;
}
/**
* Assert the expected argument is equals to the actual argument. If the arguments are not equals
* an assertion error is thrown otherwise the execution continue.
* @param expected the object the actual object is supposedly equals to
* @param actual the actual object to test
* @param message the failure message
* @return a reference to this, so the API can be used fluently
*/
public TestContext assertEquals(Object expected, Object actual, String message) {
delegate.assertEquals(expected, actual, message);
return this;
}
/**
* Asserts that the expected double argument is equals to the actual double argument
* within a positive delta. If the arguments do not satisfy this, an assertion error is thrown otherwise
* the execution continue.
* @param expected the object the actual object is supposedly equals to
* @param actual the actual object to test
* @param delta the maximum delta
* @return a reference to this, so the API can be used fluently
*/
public TestContext assertInRange(double expected, double actual, double delta) {
delegate.assertInRange(expected, actual, delta);
return this;
}
/**
* Asserts that the expected double argument is equals to the actual double argument
* within a positive delta. If the arguments do not satisfy this, an assertion error is thrown otherwise
* the execution continue.
* @param expected the object the actual object is supposedly equals to
* @param actual the actual object to test
* @param delta the maximum delta
* @param message the failure message
* @return a reference to this, so the API can be used fluently
*/
public TestContext assertInRange(double expected, double actual, double delta, String message) {
delegate.assertInRange(expected, actual, delta, message);
return this;
}
/**
* Assert the first argument is not equals to the second argument. If the arguments are equals
* an assertion error is thrown otherwise the execution continue.
* @param first the first object to test
* @param second the second object to test
* @return a reference to this, so the API can be used fluently
*/
public TestContext assertNotEquals(Object first, Object second) {
delegate.assertNotEquals(first, second);
return this;
}
/**
* Assert the first argument is not equals to the second argument. If the arguments are equals
* an assertion error is thrown otherwise the execution continue.
* @param first the first object to test
* @param second the second object to test
* @param message the failure message
* @return a reference to this, so the API can be used fluently
*/
public TestContext assertNotEquals(Object first, Object second, String message) {
delegate.assertNotEquals(first, second, message);
return this;
}
/**
* Throw a failure.
*/
public void fail() {
delegate.fail();
}
/**
* Throw a failure with the specified failure message.
* @param message the failure message
*/
public void fail(String message) {
delegate.fail(message);
}
/**
* Throw a failure with the specified failure cause.
* @param cause the failure cause
*/
public void fail(Throwable cause) {
delegate.fail(cause);
}
/**
* Create and returns a new async object, the returned async controls the completion of the test. Calling the
* {@link io.vertx.rxjava.ext.unit.Async#complete} completes the async operation.
*
* The test case will complete when all the async objects have their {@link io.vertx.rxjava.ext.unit.Async#complete}
* method called at least once.
*
* This method shall be used for creating asynchronous exit points for the executed test.
* @return the async instance
*/
public Async async() {
Async ret = Async.newInstance(delegate.async());
return ret;
}
/**
* Create and returns a new async object, the returned async controls the completion of the test. This async operation
* completes when the {@link io.vertx.rxjava.ext.unit.Async#complete} is called count times.
*
* The test case will complete when all the async objects have their {@link io.vertx.rxjava.ext.unit.Async#complete}
* method called at least once.
*
* This method shall be used for creating asynchronous exit points for the executed test.
* @param count
* @return the async instance
*/
public Async async(int count) {
Async ret = Async.newInstance(delegate.async(count));
return ret;
}
/**
* Creates and returns a new async handler, the returned handler controls the completion of the test.
*
* When the returned handler is called back with a succeeded result it completes the async operation.
*
* When the returned handler is called back with a failed result it fails the test with the cause of the failure.
* @return the async result handler
*/
public Handler> asyncAssertSuccess() {
Handler> ret = new Handler>() {
public void handle(AsyncResult ar) {
if (ar.succeeded()) {
delegate.asyncAssertSuccess().handle(io.vertx.core.Future.succeededFuture(ar.result()));
} else {
delegate.asyncAssertSuccess().handle(io.vertx.core.Future.failedFuture(ar.cause()));
}
}
};
return ret;
}
/**
* Creates and returns a new async handler, the returned handler controls the completion of the test.
*
* When the returned handler is called back with a succeeded result it invokes the resultHandler argument
* with the async result. The test completes after the result handler is invoked and does not fails.
*
* When the returned handler is called back with a failed result it fails the test with the cause of the failure.
*
* Note that the result handler can create other async objects during its invocation that would postpone
* the completion of the test case until those objects are resolved.
* @param resultHandler the result handler
* @return the async result handler
*/
public Handler> asyncAssertSuccess(Handler resultHandler) {
Handler> ret = new Handler>() {
public void handle(AsyncResult ar) {
if (ar.succeeded()) {
delegate.asyncAssertSuccess(resultHandler).handle(io.vertx.core.Future.succeededFuture(ar.result()));
} else {
delegate.asyncAssertSuccess(resultHandler).handle(io.vertx.core.Future.failedFuture(ar.cause()));
}
}
};
return ret;
}
/**
* Creates and returns a new async handler, the returned handler controls the completion of the test.
*
* When the returned handler is called back with a failed result it completes the async operation.
*
* When the returned handler is called back with a succeeded result it fails the test.
* @return the async result handler
*/
public Handler> asyncAssertFailure() {
Handler> ret = new Handler>() {
public void handle(AsyncResult ar) {
if (ar.succeeded()) {
delegate.asyncAssertFailure().handle(io.vertx.core.Future.succeededFuture(ar.result()));
} else {
delegate.asyncAssertFailure().handle(io.vertx.core.Future.failedFuture(ar.cause()));
}
}
};
return ret;
}
/**
* Creates and returns a new async handler, the returned handler controls the completion of the test.
*
* When the returned handler is called back with a failed result it completes the async operation.
*
* When the returned handler is called back with a succeeded result it fails the test.
* @param causeHandler the cause handler
* @return the async result handler
*/
public Handler> asyncAssertFailure(Handler causeHandler) {
Handler> ret = new Handler>() {
public void handle(AsyncResult ar) {
if (ar.succeeded()) {
delegate.asyncAssertFailure(causeHandler).handle(io.vertx.core.Future.succeededFuture(ar.result()));
} else {
delegate.asyncAssertFailure(causeHandler).handle(io.vertx.core.Future.failedFuture(ar.cause()));
}
}
};
return ret;
}
/**
* @return an exception handler that will fail this context
* @return
*/
public Handler exceptionHandler() {
Handler ret = new Handler() {
public void handle(Throwable event) {
delegate.exceptionHandler().handle(event);
}
};
return ret;
}
public static TestContext newInstance(io.vertx.ext.unit.TestContext arg) {
return arg != null ? new TestContext(arg) : null;
}
}