From f20b25a123438746ffb64ba7531032a3722f5cac Mon Sep 17 00:00:00 2001 From: Anton Evangelatov Date: Thu, 9 Jul 2020 15:41:27 +0200 Subject: [PATCH] improve readme with instructions on how to run test cases (#129) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Raúl Kripalani --- README.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/README.md b/README.md index 9405f668d..cbb22e45f 100644 --- a/README.md +++ b/README.md @@ -34,6 +34,39 @@ These are the topics we are currently centering our testing efforts on. Our test * **presealing:** [_(view test scenarios)_](https://github.com/filecoin-project/oni/issues?q=is%3Aissue+sort%3Aupdated-desc+label%3Atopic%2Fpresealing) * TBD, anything related to this worth testing? +## Repository contents + +This repository consists of [test plans](https://docs.testground.ai/concepts-and-architecture/test-structure) built to be run on [Testground](https://github.com/testground/testground). + +The source code for the various test cases can be found in the [`lotus-soup` directory](https://github.com/filecoin-project/oni/tree/master/lotus-soup). + +## Running the test cases + +If you are unfamiliar with Testground, we strongly suggest you read the Testground [Getting Started guide](https://docs.testground.ai/getting-started) in order to learn how to install Testground and how to use it. + +You can find various [composition files](https://docs.testground.ai/running-test-plans#composition-runs) describing various test scenarios built as part of Project Oni at [`lotus-soup/compositions` directory](https://github.com/filecoin-project/oni/tree/master/lotus-soup/compositions). + +We've designed the test cases so that you can run them via the `local:exec`, `local:docker` and the `cluster:k8s` runners. Note that Lotus miners are quite resource intensive, requiring gigabytes of memory. Hence you would have to run these test cases on a beafy machine (when using `local:docker` and `local:exec`), or on a Kubernetes cluster (when using `cluster:k8s`). + +Here are the basics of how to run the baseline deals end-to-end test case: + +### Running the baseline deals end-to-end test case + +1. Compile and Install Testground from source code from the [`oni`](https://github.com/testground/testground/pull/1083) branch. + * See the [Getting Started](https://github.com/testground/testground#getting-started) section of the README for instructions. + +2. Run a Testground daemon + +``` +testground daemon +``` + +3. Run a composition for the baseline deals end-to-end test case + +``` +testground run composition -f compositions/composition.toml +``` + ## Team composition * [@raulk](https://github.com/raulk) (Captain + TL)