docs/net.corda.testing.driver

Package-level declarations

Types

Underlying interface for the driver DSL. Do not instantiate directly, instead use the driver function.

data class DriverParameters(val isDebug: Boolean = false, val driverDirectory: Path = Paths.get("build") / "node-driver" / getTimestampAsDirectoryName(), val portAllocation: PortAllocation = incrementalPortAllocation(), val debugPortAllocation: PortAllocation = incrementalPortAllocation(), val systemProperties: Map<String, String> = emptyMap(), val useTestClock: Boolean = false, val startNodesInProcess: Boolean = false, val waitForAllNodesToFinish: Boolean = false, val notarySpecs: List<NotarySpec> = listOf(NotarySpec(DUMMY_NOTARY_NAME)), val extraCordappPackagesToScan: List<String> = emptyList(), val jmxPolicy: JmxPolicy = JmxPolicy(), val networkParameters: NetworkParameters = testNetworkParameters(notaries = emptyList()), val notaryCustomOverrides: Map<String, Any?> = emptyMap(), val inMemoryDB: Boolean = false, val cordappsForAllNodes: Collection<TestCordapp>? = null, val environmentVariables: Map<String, String> = emptyMap(), val allowHibernateToManageAppSchema: Boolean = true, val premigrateH2Database: Boolean = true, val notaryHandleTimeout: Duration = Duration.ofMinutes(1))

Builder for configuring a driver.

InProcess

@DoNotImplement

interface InProcess : NodeHandle

Interface which represents an in process node and exposes available services.

JmxPolicy

data class JmxPolicy constructor(val startJmxHttpServer: Boolean = false, val jmxHttpServerPortAllocation: PortAllocation = incrementalPortAllocation())

A class containing configuration information for Jolokia JMX, to be used when creating a node via the driver.

NodeHandle

@DoNotImplement

interface NodeHandle : AutoCloseable

A base interface which represents a node as part of the driver dsl, extended by InProcess and OutOfProcess

NodeParameters

data class NodeParameters(val providedName: CordaX500Name? = null, val rpcUsers: List<User> = emptyList(), val verifierType: VerifierType = VerifierType.InMemory, val customOverrides: Map<String, Any?> = emptyMap(), val startInSameProcess: Boolean? = null, val maximumHeapSize: String = System.getenv("DRIVER_NODE_MEMORY") ?: "512m", val additionalCordapps: Collection<TestCordapp> = emptySet(), val flowOverrides: Map<out Class<out FlowLogic<*>>, Class<out FlowLogic<*>>> = emptyMap(), val logLevelOverride: String? = null, val rpcAddress: NetworkHostAndPort? = null, val systemProperties: Map<String, String> = emptyMap(), val legacyContracts: Collection<TestCordapp> = emptySet())

Parameters for creating a node for DriverDSL.startNode.

NotaryHandle

data class NotaryHandle(val identity: Party, val validating: Boolean, val nodeHandles: CordaFuture<List<NodeHandle>>)

Object ecapsulating a notary started automatically by the driver.

OutOfProcess

@DoNotImplement

interface OutOfProcess : NodeHandle

Interface which represents an out of process node and exposes its process handle.

PortAllocation

@DoNotImplement

abstract class PortAllocation

VerifierType

enum VerifierType : Enum<VerifierType>

WebserverHandle

data class ~~WebserverHandle~~(val listenAddress: NetworkHostAndPort, val process: Process)

Class which represents a handle to a webserver process and its NetworkHostAndPort for testing purposes.

Functions

driver

fun <A> driver(defaultParameters: DriverParameters = DriverParameters(), dsl: DriverDSL.() -> A): A

driver allows one to start up nodes like this: driver { val noService = startNode(providedName = DUMMY_BANK_A.name) val notary = startNode(providedName = DUMMY_NOTARY.name)

logFile

fun NodeHandle.logFile(): File