corda / net.corda.testing.node / MockServices

MockServices

open class MockServices : ServiceHub

An implementation of ServiceHub that is designed for in-memory unit tests of contract validation logic. It has enough functionality to do tests of code that queries the vault, inserts to the vault, and constructs/checks transactions. However it isn't enough to test flows and other aspects of an app that require a network. For that you should investigate MockNetwork.

There are a variety of constructors that can be used to supply enough data to simulate a node. Each mock service hub must have at least an identity of its own. The other components have defaults that work in most situations.

Constructors

<init>

MockServices(cordappPackages: List<String>, initialIdentity: TestIdentity, identityService: IdentityService = makeTestIdentityService(), vararg moreKeys: KeyPair)
MockServices(cordappPackages: List<String>, initialIdentityName: CordaX500Name, identityService: IdentityService = makeTestIdentityService(), key: KeyPair, vararg moreKeys: KeyPair)

Create a mock ServiceHub that looks for app code in the given package names, uses the provided identity service (you can get one from makeTestIdentityService) and represents the given identity.

MockServices(cordappPackages: List<String>, initialIdentity: TestIdentity, identityService: IdentityService, networkParameters: NetworkParameters, vararg moreKeys: KeyPair)MockServices(cordappPackages: List<String>, initialIdentityName: CordaX500Name, identityService: IdentityService = makeTestIdentityService())

Create a mock ServiceHub that can't load CorDapp code, which uses the provided identity service (you can get one from makeTestIdentityService) and which represents the given identity.

MockServices(cordappPackages: List<String>)

Create a mock ServiceHub that can't load CorDapp code, and which uses a default service identity.

MockServices(initialIdentityName: CordaX500Name, identityService: IdentityService = makeTestIdentityService(), key: KeyPair, vararg moreKeys: KeyPair)

Create a mock ServiceHub which uses the package of the caller to find CorDapp code. It uses the provided identity service (you can get one from makeTestIdentityService) and which represents the given identity.

MockServices(initialIdentityName: CordaX500Name, identityService: IdentityService = makeTestIdentityService())

Create a mock ServiceHub which uses the package of the caller to find CorDapp code. It uses the provided identity service (you can get one from makeTestIdentityService) and which represents the given identity. It has no keys.

MockServices(firstIdentity: TestIdentity, vararg moreIdentities: TestIdentity)

A helper constructor that requires at least one test identity to be registered, and which takes the package of the caller as the package in which to find app code. This is the most convenient constructor and the one that is normally worth using. The first identity is the identity of this service hub, the rest are identities that it is aware of.

MockServices()

Create a mock ServiceHub which uses the package of the caller to find CorDapp code. It uses a default service identity.

Properties

attachments

val attachments: MockAttachmentStorage

Provides access to storage of arbitrary JAR files (which may contain only data, no code).

clock

open val clock: Clock

A Clock representing the node's current time. This should be used in preference to directly accessing the clock so the current time can be controlled during unit testing.

contractUpgradeService

open val contractUpgradeService: ContractUpgradeService

The ContractUpgradeService is responsible for securely upgrading contract state objects according to a specified and mutually agreed (amongst participants) contract version.

cordappProvider

open val cordappProvider: CordappProvider

Provides access to anything relating to cordapps including contract attachment resolution and app context

identityService

open val identityService: IdentityService

An identity service maintains a directory of parties by their associated distinguished name/public keys and thus supports lookup of a party given its key, or name. The service also manages the certificates linking confidential identities back to the well known identity (i.e. the identity in the network map) of a party.

keyManagementService

open val keyManagementService: KeyManagementService

The key management service is responsible for storing and using private keys to sign things. An implementation of this may, for example, call out to a hardware security module that enforces various auditing and frequency-of-use requirements.

myInfo

open val myInfo: NodeInfo

The NodeInfo object corresponding to our own entry in the network map.

networkMapCache

open val networkMapCache: NetworkMapCache

A network map contains lists of nodes on the network along with information about their identity keys, services they provide and host names or IP addresses where they can be connected to. The cache wraps around a map fetched from an authoritative service, and adds easy lookup of the data stored within it. Generally it would be initialised with a specified network map service, which it fetches data from and then subscribes to updates of.

networkParameters

val networkParameters: NetworkParameters

Returns the network parameters the node is operating under.

servicesForResolution

val servicesForResolution: ServicesForResolution

validatedTransactions

open val validatedTransactions: TransactionStorage

A map of hash->tx where tx has been signature/contract validated and the states are known to be correct. The signatures aren't technically needed after that point, but we keep them around so that we can relay the transaction data to other nodes that need it.

vaultService

open val vaultService: VaultService

The vault service lets you observe, soft lock and add notes to states that involve you or are relevant to your node in some way. Additionally you may query and track states that correspond to various criteria.

Functions

addMockCordapp

fun addMockCordapp(contractClassName: ContractClassName): Unit

Add the given package name to the list of packages which will be scanned for cordapp contract verification code

cordaService

open fun <T : SerializeAsToken> cordaService(type: Class<T>): T

Return the singleton instance of the given Corda service type. This is a class that is annotated with CordaService and will have automatically been registered by the node.

jdbcSession

open fun jdbcSession(): Connection

Exposes a JDBC connection (session) object using the currently configured database. Applications can use this to execute arbitrary SQL queries (native, direct, prepared, callable) against its Node database tables (including custom contract tables defined by extending net.corda.core.schemas.QueryableState).

loadState

open fun loadState(stateRef: StateRef): TransactionState<*>

Given a StateRef loads the referenced transaction and looks up the specified output ContractState.

loadStates

open fun loadStates(stateRefs: Set<StateRef>): Set<StateAndRef<ContractState>>

Given a Set of StateRef's loads the referenced transaction and looks up the specified output ContractState.

recordTransactions

open fun recordTransactions(statesToRecord: StatesToRecord, txs: Iterable<SignedTransaction>): Unit

Stores the given SignedTransactions in the local transaction storage and then sends them to the vault for further processing if statesToRecord is not StatesToRecord.NONE. This is expected to be run within a database transaction.

registerUnloadHandler

open fun registerUnloadHandler(runOnStop: () -> Unit): Nothing

Allows the registration of a callback that may inform services when the app is shutting down.

Inherited Functions

addSignature

open fun addSignature(signedTransaction: SignedTransaction, publicKey: PublicKey): SignedTransaction

Helper method to append an additional signature to an existing (partially) SignedTransaction.

open fun addSignature(signedTransaction: SignedTransaction): SignedTransaction

Helper method to append an additional signature for an existing (partially) SignedTransaction using the default identity signing key of the node.

createSignature

open fun createSignature(signedTransaction: SignedTransaction, publicKey: PublicKey): TransactionSignature

Helper method to create an additional signature for an existing (partially) SignedTransaction. Additional SignatureMetadata, including the platform version used during signing and the cryptographic signature scheme use, is added to the signature.

open fun createSignature(signedTransaction: SignedTransaction): TransactionSignature

Helper method to create a signature for an existing (partially) SignedTransaction using the default identity signing key of the node. The legal identity key is used to sign. Additional SignatureMetadata, including the platform version used during signing and the cryptographic signature scheme use, is added to the signature.

open fun createSignature(filteredTransaction: FilteredTransaction, publicKey: PublicKey): TransactionSignature

Helper method to create a signature for a FilteredTransaction. Additional SignatureMetadata, including the platform version used during signing and the cryptographic signature scheme use, is added to the signature.

open fun createSignature(filteredTransaction: FilteredTransaction): TransactionSignature

Helper method to create a signature for a FilteredTransaction using the default identity signing key of the node. The legal identity key is used to sign. Additional SignatureMetadata, including the platform version used during signing and the cryptographic signature scheme use, is added to the signature.

getAppContext

open fun getAppContext(): CordappContext

See CordappProvider.getAppContext

recordTransactions

open fun recordTransactions(notifyVault: Boolean, txs: Iterable<SignedTransaction>): Unit
open fun recordTransactions(notifyVault: Boolean, first: SignedTransaction, vararg remaining: SignedTransaction): Unit

Stores the given SignedTransactions in the local transaction storage and then sends them to the vault for further processing if notifyVault is true. This is expected to be run within a database transaction.

open fun recordTransactions(first: SignedTransaction, vararg remaining: SignedTransaction): Unit
open fun recordTransactions(txs: Iterable<SignedTransaction>): Unit

Stores the given SignedTransactions in the local transaction storage and then sends them to the vault for further processing. This is expected to be run within a database transaction.

signInitialTransaction

open fun signInitialTransaction(builder: TransactionBuilder, publicKey: PublicKey): SignedTransaction

Helper method to construct an initial partially signed transaction from a TransactionBuilder using keys stored inside the node. Signature metadata is added automatically.

open fun signInitialTransaction(builder: TransactionBuilder): SignedTransaction

Helper method to construct an initial partially signed transaction from a TransactionBuilder using the default identity key contained in the node. The legal identity key is used to sign.

open fun signInitialTransaction(builder: TransactionBuilder, signingPubKeys: Iterable<PublicKey>): SignedTransaction

Helper method to construct an initial partially signed transaction from a TransactionBuilder using a set of keys all held in this node.

toStateAndRef

open fun <T : ContractState> toStateAndRef(stateRef: StateRef): StateAndRef<T>

Converts the given StateRef into a StateAndRef object.

Companion Object Functions

makeTestDataSourceProperties

fun makeTestDataSourceProperties(nodeName: String = SecureHash.randomSHA256().toString()): Properties

Make properties appropriate for creating a DataSource for unit tests. Defaults configuration of in-memory H2 instance. If 'databaseProvider' system property is set then creates a config from the relevant config file is present in resources folder (used to parametrize test to run against a remote database).

makeTestDatabaseAndMockServices

fun makeTestDatabaseAndMockServices(cordappPackages: List<String>, identityService: IdentityService, initialIdentity: TestIdentity, networkParameters: NetworkParameters = testNetworkParameters(), vararg moreKeys: KeyPair): Pair<CordaPersistence, MockServices>

Makes database and mock services appropriate for unit tests.

Extension Functions

contextLogger

fun Any.contextLogger(): Logger

When called from a companion object, returns the logger for the enclosing class.

getCashBalance

fun ServiceHub.getCashBalance(currency: Currency): Amount<Currency>

getCashBalances

fun ServiceHub.getCashBalances(): Map<Currency, Amount<Currency>>

ledger

fun ServiceHub.ledger(notary: Party = TestIdentity.fresh("ledger notary").party, script: LedgerDSL<TestTransactionDSLInterpreter, TestLedgerDSLInterpreter>.() -> Unit): LedgerDSL<TestTransactionDSLInterpreter, TestLedgerDSLInterpreter>

Creates and tests a ledger built by the passed in dsl.

transaction

fun ServiceHub.transaction(notary: Party = TestIdentity.fresh("transaction notary").party, script: TransactionDSL<TransactionDSLInterpreter>.() -> EnforceVerifyOrFail): LedgerDSL<TestTransactionDSLInterpreter, TestLedgerDSLInterpreter>

Creates a ledger with a single transaction, built by the passed in dsl.