From bd707eb9c88235f48c39738d12e66b54f6a15a67 Mon Sep 17 00:00:00 2001 From: Tommy Lillehagen Date: Fri, 9 Feb 2018 19:23:56 +0000 Subject: [PATCH] Update README --- experimental/behave/README.md | 30 ++++++++++++++++++++++++++++-- 1 file changed, 28 insertions(+), 2 deletions(-) diff --git a/experimental/behave/README.md b/experimental/behave/README.md index 163c6310cc..33c5517cf7 100644 --- a/experimental/behave/README.md +++ b/experimental/behave/README.md @@ -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 To get started, please run the following command: @@ -6,6 +32,6 @@ To get started, please run the following command: $ ./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 network bootstrapping tool. \ No newline at end of file +the network bootstrapping tool.