From 95ea4929d431f6d49d13b84eb0fec59ca9486f59 Mon Sep 17 00:00:00 2001
From: kansi <kansi13@gmail.com>
Date: Fri, 5 Jan 2018 13:55:24 +0530
Subject: [PATCH] Added description of test setup

---
 proposals/integration-infrastructure.md | 41 +++++++++++++------------
 1 file changed, 22 insertions(+), 19 deletions(-)

diff --git a/proposals/integration-infrastructure.md b/proposals/integration-infrastructure.md
index 2ce75a99..bf73af3d 100644
--- a/proposals/integration-infrastructure.md
+++ b/proposals/integration-infrastructure.md
@@ -11,24 +11,20 @@ The following components shall be required
 The network driver is module which would implement the basic infrastructure management operations which would then be used in test cases to simulate different scenarios.
 
 The `Node` class shall have the following methods:
-- `url`
-- `start()`
-- `stop()`
-- `start_tendermint()`
-- `stop_tendermint()`
-- `configure_tendermint()`
-- `reset_tendermint()`
-- `start_db()`
-- `stop_db()`
-- `reset_db()`
-- `configure_bigchaindb()`
-- `configure_clock()`
-- `configure_QoS()` (discussed later)
-
-
-`configure_clock()`: This method should allow to change the clock on a given node. This could facilitate simulation of nodes located in different time zones.
-
-`configure_QoS()`: This methods allows configuring different scenarios like network latency, packet loss etc. The underlying implementation could be facilitated via [tc](https://wiki.linuxfoundation.org/networking/netem). 
+- `url` : URL to access the BigchainDB node.
+- `start()`: Start a node. This api will ensure that all components required for a fully functional node are up and running.
+- `stop()`: Stop a given node.
+- `reset()`: Reset the state of an existing node i.e. data stored in Tendermint and MongoDB will be purged. **NOTE**: It is only realistic to reset the nodes after all the tests have been executed rather than resetting the network after each test.
+- `start_tendermint()`: Run Tendermint process on a given node.
+- `stop_tendermint()`: Stop Tendermint process on a given node.
+- `configure_tendermint()`: Alter Tendermint configuration on a given node.
+- `reset_tendermint()`: Reset Tendermint i.e. `tendermint unsafe_reset_all`.
+- `start_db()`: Start MongoDB daemon on a given node.
+- `stop_db()`: Stop MongoDB daemon on a given node.
+- `reset_db()`: Flush `Bigchain` collection from MongoDB.
+- `configure_bigchaindb()`: Update BigchainDB configuration.
+- `configure_clock()`: The method should allow to change the clock on a given node. This could facilitate simulation of nodes located in different time zones.
+- `configure_QoS()`: Configure different scenarios like network latency, packet loss etc. The underlying implementation could be facilitated via [tc](https://wiki.linuxfoundation.org/networking/netem). 
 
 
 The network driver implementation could be achieved using the following libraries
@@ -57,6 +53,8 @@ def test_valid_transaction_is_synced_nodes(network):
     network.stop()
 ```
 
+A detailed list of testing scenarios can be found [here](https://github.com/bigchaindb/bigchaindb/blob/tendermint/proposals/integration-test-cases.md).
+
 ### Kubernetes Client resources
 
 - [Create Pod](https://github.com/kubernetes-incubator/client-python/blob/master/kubernetes/docs/CoreV1Api.md#create_namespaced_pod)
@@ -66,6 +64,10 @@ def test_valid_transaction_is_synced_nodes(network):
 - [Exec Command post](https://github.com/kubernetes-incubator/client-python/blob/master/kubernetes/docs/CoreV1Api.md#connect_post_namespaced_pod_exec), [Exec Command get](https://github.com/kubernetes-incubator/client-python/blob/master/kubernetes/docs/CoreV1Api.md#connect_get_namespaced_pod_exec)
 
 
+### Setup integration test environment
+Kubernetes can be run locally using `minikube` but the default parameters used when running Kubernetes via `minikube` start a single-node Kubernetes cluster using a virtual machine which results in major resource consumption. This could be avoided by using command line flag, `minikube start --vm-driver=none`. For more details refer [here](https://github.com/kubernetes/minikube#linux-continuous-integration-with-vm-support).
+
+
 ### Data model impact
 N/A
 
@@ -88,7 +90,8 @@ N/A
 N/A
 
 ### Testing impact
-The network driver would facilitate the design and implementation of components essential for integration testing.
+The network driver would facilitate the design and implementation of components essential for integration testing. But this introduces Kubernetes as a dependency for tests which should be installed and configured before running tests on Travis CI (refer [here](https://blog.travis-ci.com/2017-10-26-running-kubernetes-on-travis-ci-with-minikube)).
+
 
 
 ## Implementation