Vladimir Domnich c0bbfd1705 Add README and gitignore

Signed-off-by: Vladimir Domnich <v.domnich@yadro.com>

2022-09-09 18:12:42 +04:00

1.2 KiB

Raw Blame History

neofs-testlib

This library provides building blocks and utilities to facilitate development of automated tests for NeoFS system.

Repository structure

TODO

Installation

TODO

Contributing

Any contributions to the library should conform to the contribution guideline.

Development Environment

To setup development environment for neofs-testlib, please, take the following steps:

Prepare virtualenv

$ virtualenv --python=python3.9 venv
$ source venv/bin/activate

Install all dependencies:

$ pip install -r requirements.txt

Unit Tests

Before submitting any changes to the library, please, make sure that all unit tests are passing. To run the tests, please, use the following command:

python -m unittest discover --start-directory tests

To enable tests that interact with SSH server, please, setup SSH server and set the following environment variables before running the tests:

SSH_SHELL_HOST = <address of the server>
SSH_SHELL_LOGIN = <login that has permissions to run python3 on the server>
SSH_SHELL_PRIVATE_KEY_PATH = <path to SSH private key on your machine>
SSH_SHELL_PRIVATE_KEY_PASSPHRASE = <passphrase for the SSH private key>

1.2 KiB Raw Blame History