ivandasch commented on a change in pull request #8274: URL: https://github.com/apache/ignite/pull/8274#discussion_r495044040
########## File path: modules/ducktests/tests/README.md ########## @@ -2,21 +2,59 @@ The `ignitetest` framework provides basic functionality and services to write integration tests for Apache Ignite. This framework bases on the `ducktape` test framework, for information about it check the links: -- https://github.com/confluentinc/ducktape - source code of the `ducktape`; +- https://github.com/confluentinc/ducktape - source code of the `ducktape`. - http://ducktape-docs.readthedocs.io - documentation to the `ducktape`. -Structure of the `ignitetest` directory is: -- `./ignitetest/services` contains basic services functionality; -- `./ignitetest/utils` contains utils for testing; +Structure of the `tests` directory is: +- `./ignitetest/services` contains basic services functionality. +- `./ignitetest/utils` contains utils for testing. - `./ignitetest/tests` contains tests. +- `./checks` contains unit tests of utils, tests' decorators etc. Docker is used to emulate distributed environment. Single container represents a running node. ## Requirements To just start tests locally the only requirement is preinstalled `docker`. +For development process requirements are `python` >= 3.6. -For development process requirements are: -1. `python` >= 3.6; -2. `tox` (check python codestyle); -3. `docker`. +## Run tests locally +- Change a current directory to`${IGNITE_HOME}` +- Build Apache IGNITE invoking `${IGNITE_HOME}/scripts/build.sh` +- Change a current directory to `${IGNITE_HOME}/modules/ducktests/tests` +- Run tests in docker containers using a following command: +``` +./docker/run_tests.sh +``` +- For detailed help and instructions, use a following command: +``` +./docker/run_tests.sh --help +``` + +## Preparing development environment +- Create a virtual environment and activate it using following commands: +``` +python3 -m venv ~/.virtualenvs/ignite-ducktests-dev +source ~/.virtualenvs/ignite-ducktests-dev/bin/activate +``` +- Change a current directory to `${IGNITE_HOME}/modules/ducktests/tests`. We refer to it as `${DUCKTESTS_DIR}`. +- Install requirements and `ignitetests` as editable using following commands: +``` +pip install -r docker/requirements-dev.txt +pip install -e . Review comment: This is required for pytest. Usual thing ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected]
