summaryrefslogtreecommitdiffstats
path: root/tools/verify_test_execution/README.md
diff options
context:
space:
mode:
authorPranav <prprakas@redhat.com>2020-05-19 10:01:40 +0530
committerBala Konda Reddy M <bala12352@gmail.com>2020-05-29 08:43:23 +0000
commit1e82a9e5a2275edc5fdfd40d7f9b79334da7682f (patch)
treedc85ea0d6a7136028302b0b6fdadaaf51217d495 /tools/verify_test_execution/README.md
parent823d053c472183c22caa31aee281e2e595177187 (diff)
[Tool] Add tool to verify multiple runs for a given set of testcase(s)
This tool verifies the stability of a given set of testcase(s) by executing it consecutively for a pre-defined number of times. This ensures that the written code is stable and also helps the user to identify unexpected failures or errors that may arise while executing it multiple times. It also checks the given code for any pylint/flake8 issues. Change-Id: I731277a448d4fc8d0028f43f51e08d6d9366c19a Signed-off-by: Pranav <prprakas@redhat.com>
Diffstat (limited to 'tools/verify_test_execution/README.md')
-rw-r--r--tools/verify_test_execution/README.md38
1 files changed, 38 insertions, 0 deletions
diff --git a/tools/verify_test_execution/README.md b/tools/verify_test_execution/README.md
new file mode 100644
index 000000000..d78819515
--- /dev/null
+++ b/tools/verify_test_execution/README.md
@@ -0,0 +1,38 @@
+# verify_test_execution
+This tool verifies the stability of a given set of testcase(s) by executing it
+consecutively for a pre-defined number of times. This ensures that the written
+code is stable and also helps the user to identify unexpected failures or errors
+that may arise while executing it multiple times. It also checks the given code
+for any pylint/flake8 issues.
+
+## Prerequisites
+Python 3.x
+
+To use this you need to have a valid glusto-tests config file
+
+## Usage
+- Download the project files from github.
+
+ ```
+ # git clone https://github.com/gluster/glusto-tests.git
+ ```
+- Change directory to the project directory.
+ ```
+ # cd glusto-tests/tool/verify_test_execution/
+ ```
+- To get help run:
+ ```
+ # python3 verify_test_execution.py --help
+ ```
+- To run the test(s):
+ ```
+ # python3 verify_test_execution.py --config < Config file> --test <test_path>
+ ```
+
+If you wish to specify the commands for flake8 and pylint (optional) use
+`--flake8 <flake8 cmd> `and `--pylint <pylint command>` arguments.
+Also, use `--iterations` to specify the number of times the test(s)
+should be run (by default its 5) eg. `-- iterations 10 `
+
+## License
+GPLv3