From c0bbfd170555c07b39f47302ef336937de4db132 Mon Sep 17 00:00:00 2001 From: Vladimir Domnich Date: Wed, 24 Aug 2022 19:01:07 +0400 Subject: [PATCH] Add README and gitignore Signed-off-by: Vladimir Domnich --- .gitignore | 8 ++++++++ README.md | 40 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 48 insertions(+) create mode 100644 .gitignore create mode 100644 README.md diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..e61db30 --- /dev/null +++ b/.gitignore @@ -0,0 +1,8 @@ +# ignore IDE files +.vscode + +# ignore caches under any path +**/__pycache__ + +# ignore virtual environments +venv*/* diff --git a/README.md b/README.md new file mode 100644 index 0000000..736ec88 --- /dev/null +++ b/README.md @@ -0,0 +1,40 @@ +# 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](https://github.com/nspcc-dev/neofs-node/blob/master/CONTRIBUTING.md). + +### Development Environment +To setup development environment for `neofs-testlib`, please, take the following steps: +1. Prepare virtualenv + +``` +$ virtualenv --python=python3.9 venv +$ source venv/bin/activate +``` + +2. 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 =
+SSH_SHELL_LOGIN = +SSH_SHELL_PRIVATE_KEY_PATH = +SSH_SHELL_PRIVATE_KEY_PASSPHRASE = +``` \ No newline at end of file