mirror of https://github.com/corda/corda.git synced 2024-12-19 04:57:58 +00:00

History

Stefano Franz a842740c9e WIP Kubenetes parallel build (#5396 ) * Split integration tests * add simple example of printing all methods annotated with @Test * add docker plugin to root project remove docker plugin from child projects add Dockerfile for image to use when testing add task to build testing image to root project * add comment describing proposed testing workflow * simple attempt at running tests in docker container * add my first k8s interaction script * add fabric8 as dependnency to buildSrc * before adding classpath * collect reports from containers and run through testReports * re-enable kubes backed testing * for each project 1. add a list tests task 2. use this list tests task to modify the included tests 3. add a parallel version of the test task * tweak logic for downloading test report XML files * use output of parallel testing tasks in report tasks to determine build resultCode * prepare for jenkins test * prepare for jenkins test * make docker reg password system property * add logging to print out docker reg creds * enable docker build * fix gradle build file * gather xml files into root project * change log level for gradle modification * stop printing gradle docker push passwd * tidy up report generation * fix compilation errors * split signature constraints test into two * change Sig constraint tests type hierarchy * tidy up build.gradle * try method based test includes * add unit test for test listing * fix bug with test slicing * stop filtering ignored tests to make the numbers match existing runs * change log level to ensure print out * move all plugin logic to buildSrc files * tidy up test modification add comments to explain what DistributedTesting plugin does * move new plugins into properly named packages * tidy up runConfigs * fix compile errors due to merge with slow-integration-test work * add system parameter to enable / disable build modification * add -Dkubenetise to build command * address review comments * type safe declaration of parameters in KubesTest		2019-09-03 15:40:08 +00:00
..
cordapp	CORDA-2925 Rebase identity service changes onto 4.3 (#5407 )	2019-08-29 11:57:07 +01:00
src	CORDA-3031 Constrain max heap size for Spring boot processes (#5234 )	2019-06-20 18:13:57 +01:00
web	WIP Kubenetes parallel build (#5396 )	2019-09-03 15:40:08 +00:00
build.gradle	CORDA-2333: Updated the majority of the dependencies that were out of date (#5235 )	2019-06-20 16:19:16 +01:00
README.md	Minor docs fix (#4675 )	2019-01-29 13:10:07 +00:00

README.md

IRS Demo

This demo brings up three nodes: Bank A, Bank B and a node that simultaneously runs a notary, a network map and an interest rates oracle. The two banks agree on an interest rate swap, and then do regular fixings of the deal as the time on a simulated clock passes.

Functionality is split into two parts - CordApp which provides actual distributed ledger backend and Spring Boot webapp which provides REST API and web frontend. Application communicate using Corda RPC protocol.

To run from the command line in Unix:

Run ./gradlew samples:irs-demo:cordapp:deployNodes to install configs and a command line tool under samples/irs-demo/cordapp/build
Run ./gradlew samples:irs-demo:web:deployWebapps to install configs and tools for running webservers
Move to the samples/irs-demo/ directory
Run ./cordapp/build/nodes/runnodes to open up three new terminals with the three nodes (you may have to install xterm)
On Linux, run ./web/build/webapps/runwebapps.sh to open three more terminals for associated webservers. On macOS, use the following command instead: osascript ./web/build/webapps/runwebapps.scpt

To run from the command line in Windows:

Run gradlew.bat samples:irs-demo:cordapp:deployNodes to install configs and a command line tool under samples\irs-demo\build
Run gradlew.bat samples:irs-demo:web:deployWebapps to install configs and tools for running webservers
Run cd samples\irs-demo to change current working directory
Run cordapp\build\nodes\runnodes.bat to open up several 3 terminals for each nodes
Run web\build\webapps\runwebapps.bat to open up several 3 terminals for each nodes' webservers

This demo also has a web app. To use this, run nodes and then navigate to http://localhost:10007/ and http://localhost:10010/ to see each node's view of the ledger.

To use the web app, click the "Create Deal" button, fill in the form, then click the "Submit" button. You can then use the time controls at the top left of the home page to run the fixings. Click any individual trade in the blotter to view it.

Note: The IRS web UI currently has a bug when changing the clock time where it may show no numbers or apply fixings inconsistently. The issues will be addressed in a future release. Meanwhile, you can take a look at a simpler oracle example here: https://github.com/corda/oracle-example.

Running the system test

The system test utilizes Docker. The amount of RAM required to run the IRS system test is around 2.5GB, so it is important to make sure the appropriate system resources are allocated (On MacOS/Windows this may require explicit changes to your Docker configuration).

Gradle

The system test is designed to exercise the entire stack, including Corda nodes and the web frontend. It uses Docker, docker-compose, and PhantomJS. Docker and docker-compose need to be installed and configured to on the system path (which happens by default). The PhantomJs binary has to be put in a known location and needs execution permissions enabled (chmod a+x phantomjs on *nix) and the full path to the binary needs to be available as system property named phantomjs.binary.path or an environment variable named PHANTOMJS_BINARY_PATH.

To start the test, run :samples:irs-demo:systemTest.

Other

In order to run the test by other means than the Gradle task - two more environment variables are expected - CORDAPP_DOCKER_COMPOSE and WEB_DOCKER_COMPOSE which should specify the full path for the docker-compose files for the IRS cordapp and web frontend respectively. Those can be obtained by running the :samples:irs-demo:cordapp:prepareDockerNodes and web:generateDockerCompose Gradle tasks. The :samples:irs-demo:systemTest Gradle task simply executes these two tasks and sets up the correct environment variables.