Test utilities for Corda 5 applications. At the moment this project provides utilities for integration testing with the Corda 5 Combined Worker.
Same as CSDE
- Azul Zulu JDK 17
- Git ~v2.24.1
- Docker Engine ~v20.X.Y or Docker Desktop ~v3.5.X
- Corda CLI, see Installing the Corda CLI
In your gradle:
testImplementation("com.github.manosbatsis.corda5.testutils:integration-junit5:$corda5testutilsVersion")
testImplementation("org.junit.jupiter:junit-jupiter:$junitVersion")
testRuntimeOnly("org.junit.jupiter:junit-jupiter-engine:$junitVersion")The JUnit5 extension will automatically launch, setup VNodes and (re)deploy CPIs to the Combined Worker as needed by default. The config exposes three modes:
- SHARED: Default, described above. Leaves the worker running on finish.
- PER_LAUNCHER: Will force a fresh Combined worker for the current JUnit LauncherSession. Stops the worker on finish.
- PER_CLASS: Will force a fresh Combined worker for the current Test Class.
- NONE: Completely disables automation for the Combined Worker to enable manual or external management.
The Corda5NodesExtension will retrieve the list of virtual nodes from the combined worker
and expose them as a NodeHandles parameter to your test methods. Each node has basic info plus
utility methods like waitForFlow that can be used to initiate flows and wait for a final flow status.
import com.github.manosbatsis.corda5.testutils.integration.junit5.CombinedWorkerMode
import com.github.manosbatsis.corda5.testutils.integration.junit5.Corda5NodesConfig
import com.github.manosbatsis.corda5.testutils.integration.junit5.Corda5NodesExtension
import com.github.manosbatsis.corda5.testutils.integration.junit5.nodehandles.NodeHandles
import com.github.manosbatsis.corda5.testutils.rest.client.model.FlowRequest
import org.junit.jupiter.api.Test
import org.junit.jupiter.api.extension.ExtendWith
import kotlin.test.assertEquals
import kotlin.test.assertTrue
// Add the Corda5 nodes extension
@ExtendWith(Corda5NodesExtension::class)
open class DemoApplicationTests {
// Optional config for extension, values bellow are defaults
val config = Corda5NodesConfig(
authUsername = "admin",
authPassword = "admin",
baseUrl = "https://localhost:8888/api/v1/",
httpMaxWaitSeconds = 60,
debug = false,
projectDir = Corda5NodesConfig.gradleRootDir,
combinedWorkerMode = CombinedWorkerMode.SHARED,
// Optional, null by default
objectMapperConfigurer = { objectMapper: ObjectMapper ->
objectMapper.registerModule(myModule)
}
)
// The Corda5NodesExtension provides the NodeHandles
@Test
fun workFlowTests(nodeHandles: NodeHandles) {
// Get node handles
val aliceNode = nodeHandles.getByCommonName("Alice")
val bobNode = nodeHandles.getByCommonName("Bob")
// Create flow args
val flowArgs = MyFirstFlowStartArgs(bobNode.memberX500Name)
// Call Flow
val response = aliceNode.waitForFlow(
FlowRequest(
flowClass = MyFirstFlow::class.java,
requestBody = flowArgs,
flowResultClass = Message::class.java
)
)
// Check status and deserialized flow result
assertTrue(response.isSuccess())
val expectedMessage = Message(bobNode.memberX500Name, "Hello Alice, best wishes from Bob")
assertEquals(expectedMessage, response.flowResult)
}
}Using Github for your CI? Check out corda5-cli-action.
You can find a complete example built on top of CSDE at the CSDE-cordapp-integration-testing repo. There is also a relevant Medium article here.
Issues, PRs etc. welcome. You can also try pinging me on https://cordaledger.slack.com