vertx / io.vertx.reactivex.ext.unit / TestSuite / run

# run

`open fun run(): TestCompletion`

Run the testsuite with the default options. When the test suite is executed in a Vertx context (i.e `Vertx.currentContext()` returns a context) this context's event loop is used for running the test suite. Otherwise it is executed in the current thread. The returned io.vertx.reactivex.ext.unit.Completion object can be used to get a completion callback.

Return
the related test completion

`open fun run(options: TestOptions): TestCompletion`

Run the testsuite with the specified `options`. When the test suite is executed in a Vertx context (i.e `Vertx.currentContext()` returns a context) this context's event loop is used for running the test suite unless the io.vertx.ext.unit.TestOptions is set to `false`. In this case it is executed by the current thread. Otherwise, the test suite will be executed in the current thread when io.vertx.ext.unit.TestOptions is set to `false` or `null`. If the value is `true`, this methods throws an `IllegalStateException`. The returned io.vertx.reactivex.ext.unit.Completion object can be used to get a completion callback.

### Parameters

`options` - the test options

Return
the related test completion

`open fun run(vertx: Vertx): TestCompletion`

Run the testsuite with the default options and the specified `vertx` instance. The test suite will be executed on the event loop provided by the `vertx` argument. The returned io.vertx.reactivex.ext.unit.Completion object can be used to get a completion callback.

### Parameters

`vertx` - the vertx instance

Return
the related test completion

`open fun run(vertx: Vertx, options: TestOptions): TestCompletion`

Run the testsuite with the specified `options` and the specified `vertx` instance. The test suite will be executed on the event loop provided by the `vertx` argument when io.vertx.ext.unit.TestOptions is not set to `false`. The returned io.vertx.reactivex.ext.unit.Completion object can be used to get a completion callback.

### Parameters

`vertx` - the vertx instance

`options` - the test options

Return
the related test completion