From 61358128bd75f475069addc6108c7b1b5c787085 Mon Sep 17 00:00:00 2001 From: "anatoly@nspcc.ru" Date: Sun, 29 Nov 2020 01:16:52 +0300 Subject: [PATCH] update readme --- README.md | 58 ++++++++++++++++++++++++---- robot/resources/lib/payment_neogo.py | 1 - 2 files changed, 50 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 2184a54b..f3d244f1 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,22 @@ +## Запуск тесткейсов ### Локальный запуск тесткейсов + 1. Устаносить зависимости (только для первого запуска): - pip3 install robotframework - - pip3 install neocore + - pip3 install pexpect - pip3 install requests (pip3 заменить на соответсвующий менеджер пакетов python в системе). При этом должен быть запущен dev-env с тестируемым окружением. -Из корня dev-env выполнить команду: -``` -docker cp wallets/wallet.json main_chain:/wallets/ -``` - 2. Выпольнить `make run` 3. Логи будут доступны в папке artifacts/ после завершения тестов с любым из статусов. ### Запуск произвольного тесткейса + Для запуска произвольного тесткейса нужно выполнить команду: `robot --timestampoutputs --outputdir artifacts/ robot/testsuites/integration/.robot ` @@ -28,8 +26,8 @@ docker cp wallets/wallet.json main_chain:/wallets/ * object_complex.robot - операции над простым объектом * object_simple.robot - операции над большим объектом - ### Запуск тесткейсов в докере + 1. Задать переменные окружения для работы с dev-env: ``` export REG_USR= @@ -49,5 +47,49 @@ docker cp wallets/wallet.json main_chain:/wallets/ Для этого достаточно задать переменные окружения перед запуском `make build`. ``` export BUILD_NEOFS_NODE= -export BUILD_CLI= ``` + +## Создание тесткейсов + +### Source code overview + +`robot/` - Files related/depended on Robot Framework. + +`robot/resources/` - All resources (Robot Framework Keywords, Python Libraries, etc) which could be used for creating test suites. + +`robot/resources/lib/` - Common Python Libraries depended on Robot Framework (with Keywords). For example neofs.py, payment.py. + +`robot/variables/` - All variables for tests. It is possible to add the auto-loading logic of parameters from the smart-contract in the future. Contain python files. + +`robot/testsuites/` - Robot Test Suites and Test Cases. + +`robot/testsuites/integration/` - Integration test suites and test cases + +`robot/testsuites/fi/` - Fault Injection test suites and test cases + +## Code style + +Robot Framework keyword should use space as a separator between particular words + +The name of the library function in Robot Framework keyword usage and the name of the same function in the Python library must be identical. + +The name of GLOBAL VARIABLE must be in UPPER CASE, the underscore ('_')' symbol must be used as a separator between words. + +The name of local variable must be in lower case, the underscore symbol must be used as a separator between words. + +The names of Python variables, functions and classes must comply with accepted rules, in particular: +Name of variable/function must be in lower case with underscore symbol between words +Name of class must start with a capital letter. It is not allowed to use underscore symbol in name, use capital for each particular word. +For example: NeoFSConf + +Name of other variables should not be ended with underscore symbol + +On keywords definition, one should specify variable type, e.g. path: str + +## Robot style + +Следует всегда заполнять секции [Tags] и [Documentation] для Testcase'ов и Documentation для Test Suite'ов. + +## Robot-framework User Guide + +http://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html \ No newline at end of file diff --git a/robot/resources/lib/payment_neogo.py b/robot/resources/lib/payment_neogo.py index 401cfa9e..6c532d5c 100644 --- a/robot/resources/lib/payment_neogo.py +++ b/robot/resources/lib/payment_neogo.py @@ -14,7 +14,6 @@ import requests import json from robot.libraries.BuiltIn import BuiltIn -from neocore.KeyPair import KeyPair ROBOT_AUTO_KEYWORDS = False