From 4511435fd353b98551be17d02e1d91e8896164ed Mon Sep 17 00:00:00 2001 From: Amar Tumballi Date: Mon, 24 Sep 2018 10:31:23 +0530 Subject: README: add a section for giving hints on testing Change-Id: I1529494504c38172f56759c0f06231864e32df24 updates: bz#1193929 Signed-off-by: Amar Tumballi --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/README.md b/README.md index ff8804d0b81..92f829e431e 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,32 @@ ## Deployment Quick instructions to build and install can be found in [INSTALL](INSTALL) file. +## Testing + + GlusterFS source contains some functional tests under `tests/` directory. All + these tests are run against every patch submitted for review. If you want your + patch to be tested, please add a `.t` test file as part of your patch submission. + You can also submit a patch to only add a `.t` file for the test case you are + aware of. + + To run these tests, on your test-machine, just run `./run-tests.sh`. Don't run + this on a machine where you have 'production' glusterfs is running, as it would + blindly kill all gluster processes in each runs. + + If you are sending a patch, and want to validate one or few specific tests, then + run a single test by running the below command. + +``` + bash# /bin/bash ${path_to_gluster}/tests/basic/rpc-coverage.t +``` + + You can also use `prove` tool if available in your machine, as follows. + +``` + bash# prove -vmfe '/bin/bash' ${path_to_gluster}/tests/basic/rpc-coverage.t +``` + + ## Maintainers The list of Gluster maintainers is available in [MAINTAINERS](MAINTAINERS) file. -- cgit