From 97738ac916e17668d0aced2026d07c46333db0e7 Mon Sep 17 00:00:00 2001 From: Robert Baldyga Date: Mon, 21 Oct 2019 12:32:39 +0200 Subject: [PATCH 1/2] Make local test execution the default Signed-off-by: Robert Baldyga --- test/functional/config/example_dut_config.yml | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/test/functional/config/example_dut_config.yml b/test/functional/config/example_dut_config.yml index cc78aca..67020c1 100644 --- a/test/functional/config/example_dut_config.yml +++ b/test/functional/config/example_dut_config.yml @@ -1,8 +1,9 @@ -ip: "x.x.x.x" -user: "example_user" -password: "example_password" +# ip: "x.x.x.x" +# user: "example_user" +# password: "example_password" + +# env: "HTTPS_PROXY=myproxy.example:12345" -env: "HTTPS_PROXY=myproxy.example:12345" working_dir: "/tmp/open-cas-linux/" disks: From 6b35e04044aefaeb805f3b67a0b2ab588ee2d03e Mon Sep 17 00:00:00 2001 From: Robert Baldyga Date: Mon, 21 Oct 2019 12:33:19 +0200 Subject: [PATCH 2/2] Update Readme - installation and running tests Signed-off-by: Robert Baldyga --- README.md | 54 ++++++++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 48 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 3317f1a..7f93eee 100644 --- a/README.md +++ b/README.md @@ -21,17 +21,59 @@ https://opensource.org/licenses/BSD-3-Clause for full license texts). Open CAS uses Safe string library (safeclib) that is MIT licensed. +## Installation + +To download latest Open CAS Linux release run following commands: + +``` +wget https://github.com/Open-CAS/open-cas-linux/releases/download/v19.9/open-cas-linux-v19.9.tar.gz +tar -xf open-cas-linux-v19.9.tar.gz +cd open-cas-linux-v19.9 +``` + +Alternatively, if you want recent development (unstable) version, you can clone GitHub repository: + +``` +git clone https://github.com/Open-CAS/open-cas-linux +cd open-cas-linux +git submodule update --init +``` + +To configure, build and install Open CAS Linux run following commands: + +``` +./configure +make +make install +``` + +The `./configure` performs check for dependencies, so if some of them are missing, +command will print their names in output. After installing missing dependencies +you need to run `./configure` once again - this time it should succeed. + ## Getting Started -To quickly install and deploy Open CAS Linux in your system please follow the instructions -available [here.](https://open-cas.github.io/getting_started_open_cas_linux.html) +To quickly deploy Open CAS Linux in your system please follow the instructions +available [here](https://open-cas.github.io/getting_started_open_cas_linux.html). -## Guide +## Documentation -The complete documentation for Open CAS Linux is available in the Open CAS Linux Administration Guide -available [here.](https://open-cas.github.io/guide_introduction.html) +The complete documentation for Open CAS Linux is available in the +[Open CAS Linux Administration Guide](https://open-cas.github.io/guide_introduction.html). + +## Running Tests + +Before running tests make sure you have a platform with at least 2 disks (one for cache and one for core). Be careful as these devices will be most likely overwritten with random data during tests. Tests can be either executed locally or on a remote platform (via ssh) specified in the dut_config. + +1. Go to test directory `cd test/functional`. +1. Install dependencies with command `pip3 install -r test-framework/requirements.txt`. +1. Create DUT config. See example [here](test/functional/config/example_dut_config.yml). + a) Set disks params. You need at least two disks, of which at least one is an SSD drive. + b) For remote execution uncomment and set the `ip`, `user` and `password` fields. + c) For local execution just leave these fields commented. +1. Run tests using command `pytest-3 --dut-config=` where `` is path to your config file, for example `pytest-3 --dut-config="config/dut_config.yml"`. ## Security To report a potential security vulnerability please follow the instructions -[here.](https://open-cas.github.io/contributing.html#reporting-a-potential-security-vulnerability) +[here](https://open-cas.github.io/contributing.html#reporting-a-potential-security-vulnerability).