[ignite] branch ignite-ducktape updated: IGNITE-13430 Create minimal documentation for ducktape tests (#8829)

[av...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

av pushed a commit to branch ignite-ducktape
in repository https://gitbox.apache.org/repos/asf/ignite.git


The following commit(s) were added to refs/heads/ignite-ducktape by this push:
     new 9656a73f IGNITE-13430 Create minimal documentation for ducktape tests (#8829)
9656a73f is described below

commit 9656a73f561502588c900d2316dbd726765a62ce
Author: Anton Vinogradov <av...@apache.org>
AuthorDate: Fri Feb 26 13:39:06 2021 +0300

    IGNITE-13430 Create minimal documentation for ducktape tests (#8829)
---
 modules/ducktests/{tests => }/README.md     | 43 +++++++++++++++++++++++++++--
 modules/ducktests/tests/docker/run_tests.sh |  7 -----
 modules/ducktests/tests/tox.ini             |  5 ----
 3 files changed, 41 insertions(+), 14 deletions(-)

diff --git a/modules/ducktests/tests/README.md b/modules/ducktests/README.md
similarity index 71%
rename from modules/ducktests/tests/README.md
rename to modules/ducktests/README.md
index 69b1d38..00f770e 100644
--- a/modules/ducktests/tests/README.md
+++ b/modules/ducktests/README.md
@@ -1,4 +1,4 @@
-## Overview
+# Overview
 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:
@@ -11,6 +11,7 @@ Structure of the `tests` directory is:
 - `./ignitetest/tests` contains tests.
 - `./checks` contains unit tests of utils, tests' decorators etc. 
 
+# Local run
 Docker is used to emulate distributed environment. Single container represents 
 a running node.
 
@@ -18,7 +19,7 @@ a running node.
 To just start tests locally the only requirement is preinstalled `docker`. 
 For development process requirements are `python` >= 3.7.
 
-## Run tests locally
+## Run tests
 - Change a current directory to`${IGNITE_HOME}`
 - Build Apache IGNITE invoking `${IGNITE_HOME}/scripts/build-module.sh ducktests`
 - Change a current directory to `${IGNITE_HOME}/modules/ducktests/tests`
@@ -32,6 +33,44 @@ For development process requirements are `python` >= 3.7.
 ```
 - Test reports, including service logs, are located in the `${IGNITE_HOME}/results` directory.
 
+## Runned tests management
+- Tear down all the currently active ducker-ignite nodes using a following command:
+```
+./docker/clean_up.sh
+```
+
+# Real environment run
+[Ducktape](https://ducktape-docs.readthedocs.io/en/latest/index.html) allow runs on 
+Custom cluster, Vagrant, K8s, Mesos, Docker, cloud providers, etc.
+
+## Requirements
+- Set up the cluster.
+  See `./docker/Dockerfile` for servers setup hints.
+
+## Run tests
+- Change a current directory to`${IGNITE_HOME}`
+- Build Apache IGNITE invoking `${IGNITE_HOME}/scripts/build-module.sh ducktests`
+- Run tests using [Ducktape](https://ducktape-docs.readthedocs.io/en/latest/run_tests.html). 
+  For example:
+  ```
+  ducktape --results-root=./results --cluster-file=./cluster.json --repeat 1 --max-parallel 16 ./modules/ducktests/tests/ignitetest
+  ```
+# Custom Ignites (forks) testing
+## Run all tests
+TBD
+
+## Run tests from the external source/repository
+TBD
+
+# Special runs
+## Run with enabled security
+### Run with SSL enabled
+TBD
+
+### Run with build-in authentication enabled
+TBD
+
+# Development
 ## Preparing development environment
 - Create a virtual environment and activate it using following commands:
 ```
diff --git a/modules/ducktests/tests/docker/run_tests.sh b/modules/ducktests/tests/docker/run_tests.sh
index 6ff723c..320f992 100755
--- a/modules/ducktests/tests/docker/run_tests.sh
+++ b/modules/ducktests/tests/docker/run_tests.sh
@@ -69,13 +69,6 @@ The options are as follows:
 -g|--global
     Use specified global param to pass to test context. Could be used multiple times.
 
-    List of supported global parameters:
-    - project: is used to build path to Ignite binaries within container (/opt/PROJECT-VERSION)
-    - ignite_client_config_path: abs path within container to Ignite client config template
-    - ignite_server_config_path: abs path within container to Ignite server config template
-    - jvm_opts: array of JVM options to use when Ignite node started
-    - ignite_version: string representing ignite_versions to test against.
-
 -gj|--global-json)
     Use specified json as globals to pass to test context. Can be extended with -g|--global
 
diff --git a/modules/ducktests/tests/tox.ini b/modules/ducktests/tests/tox.ini
index d9a0ce4..ce136b1 100644
--- a/modules/ducktests/tests/tox.ini
+++ b/modules/ducktests/tests/tox.ini
@@ -16,11 +16,6 @@
 envlist = codestyle, linter, py37, py38
 skipsdist = True
 
-[travis]
-python =
-  3.8: codestyle, linter, py38
-  3.7: py37
-
 [testenv]
 envdir = {homedir}/.virtualenvs/ignite-ducktests-{envname}
 deps =