github/open-cas-linux
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #159 from robertbaldyga/update-readme-tests

Browse Source 
Update Readme - installation and running tests
This commit is contained in:
Michał Mielewczyk 2019-10-21 15:02:39 +02:00 committed by GitHub
commit 06b3e69c0f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 53 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
README.md
View File

@ -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=<CONFIG>` where `<CONFIG>` 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).

9
test/functional/config/example_dut_config.yml
View File

@ -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: