mirror of
https://github.com/corda/corda.git
synced 2024-12-19 04:57:58 +00:00
Update README
This commit is contained in:
parent
cd079de4b8
commit
bd707eb9c8
@ -1,3 +1,29 @@
|
|||||||
|
# Introduction
|
||||||
|
|
||||||
|
This project illustrates how one can use Cucumber / BDD to drive
|
||||||
|
and test homogeneous and heterogeneous Corda networks on a local
|
||||||
|
machine. The framework has built-in support for Dockerised node
|
||||||
|
dependencies so that you easily can spin up a Corda node locally
|
||||||
|
that, for instance, uses a 3rd party database provider such as
|
||||||
|
MS SQL Server or Postgres.
|
||||||
|
|
||||||
|
# Structure
|
||||||
|
|
||||||
|
The project is split into three pieces:
|
||||||
|
|
||||||
|
* **Testing Library** (main) - This library contains auxiliary
|
||||||
|
functions that help in configuring and bootstrapping Corda
|
||||||
|
networks on a local machine. The purpose of the library is to
|
||||||
|
aid in black-box testing and automation.
|
||||||
|
|
||||||
|
* **Unit Tests** (test) - These are various tests for the
|
||||||
|
library described above. Note that there's only limited
|
||||||
|
coverage for now.
|
||||||
|
|
||||||
|
* **BDD Framework** (scenario) - This module shows how to use
|
||||||
|
BDD-style frameworks to control the testing of Corda networks;
|
||||||
|
more specifically, using [Cucumber](cucumber.io).
|
||||||
|
|
||||||
# Setup
|
# Setup
|
||||||
|
|
||||||
To get started, please run the following command:
|
To get started, please run the following command:
|
||||||
@ -6,6 +32,6 @@ To get started, please run the following command:
|
|||||||
$ ./prepare.sh
|
$ ./prepare.sh
|
||||||
```
|
```
|
||||||
|
|
||||||
This command will download necessary database drivers and set up
|
This script will download necessary database drivers and set up
|
||||||
the dependencies directory with copies of the Corda fat-JAR and
|
the dependencies directory with copies of the Corda fat-JAR and
|
||||||
the network bootstrapping tool.
|
the network bootstrapping tool.
|
Loading…
Reference in New Issue
Block a user