From e6e53b5321b8e991eb23bb9d9d6626e7ac364e1e Mon Sep 17 00:00:00 2001 From: Akarsha Date: Fri, 7 Sep 2018 17:09:05 +0530 Subject: Modified existing doc Change-Id: I84360dd73a951db5db6a574fb10ada57a1e7e1ad Signed-off-by: Akarsha --- README.md | 44 +++++++++++++++++++++++++------------------- 1 file changed, 25 insertions(+), 19 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index b999f2d8d..371229e38 100644 --- a/README.md +++ b/README.md @@ -8,9 +8,10 @@ The Libraries/Modules/Tests in glusto-tests are written using the `glusto` framework. TestCases in glusto-tests can we written/run using standard PyUnit, PyTest or Nose methodologies as supported by `glusto` framework. -Refer the [docs](http://glusto.readthedocs.io/en/latest/) for info on `glusto` -framework. -Issues need to be filed against the Github repo. +Refer the [glusto-doc](http://glusto.readthedocs.io/en/latest/) for info +on `glusto` framework. +Issues need to be filled against the +[Github](https://github.com/gluster/glusto-tests/issues) repo. To automate/run glusto-tests we need to install the following packages: --------------------------------------------------------------------- @@ -49,40 +50,47 @@ How to install gdeploy: ----------------------- - Install latest version of gdeploy from the following [link](https://copr.fedorainfracloud.org/coprs/sac/gdeploy/package/gdeploy/). +To install glusto-tests dependencies: +------------------------------------- +`python-docx` needs to be installed when we run IO's and validates on client node. + +To install run : + # curl "https://bootstrap.pypa.io/get-pip.py" -o "get-pip.py" + # python get-pip.py + # pip install --pre python-docx + How to run the test case: ------------------------- -- Create config file containing info about the servers, clients, volumes, - mounts. Please refer to example config file under tests directory in - glusto-tests repo. The example config file is in yaml format and - defines sections which provides info about the gluster cluster. - We can use any `glusto` framework supported formats for writing the - config files. - Refer the following [link](http://glusto.readthedocs.io/en/latest/userguide/configurable.html). +- Create config file containing info about the servers, clients, + for example refer [config](https://github.com/gluster/glusto-tests/blob/master/tests/gluster_basic_config.yml), + this config file is enough to run all test cases. But if you need to override the default values of volumes, + mount.. etc which is passed in gluster_base_class, can be passed in config + file[config](https://github.com/gluster/glusto-tests/blob/master/tests/gluster_tests_config.yml). + Refer the following for more info [link](http://glusto.readthedocs.io/en/latest/userguide/configurable.html). - glusto-tests are run using the `glusto` command available after installing the glusto framework. The various options to run tests as provided by glusto framework: To run PyUnit tests: - # glusto -c 'config.yml' -d 'tests' # glusto -c 'config.yml unittest_list.yml' -u To run PyTest tests: - # glusto -c 'config.yml' --pytest='-v -x tests -m bvt' To run Nose tests: - # glusto -c 'config.yml' --nosetests='-v -w tests' - For more info refer the [docs](http://glusto.readthedocs.io/en/latest/userguide/glusto.html#options-for-running-unit-tests). + For more info about running these tests, refer the [docs](http://glusto.readthedocs.io/en/latest/userguide/glusto.html#options-for-running-unit-tests). + +- To know how to run glusto-tests from the scratch including creating OS, server, etc.. refer [link](https://github.com/gluster/glusto-tests/blob/master/docs/userguide/HOWTO) Writing tests in glusto-tests: ------------------------------ `tests` directory in glusto-tests contains testcases. One might want to create a dir with feature name as the name of test directory under `tests` to add -new testcases. +new testcases. Testcases name should start with`test_` TestCases in glusto-tests can we written using standard PyUnit, PyTest or Nose methodologies as supported by `glusto` framework. @@ -91,6 +99,8 @@ One can follow the [PyUnit](http://glusto.readthedocs.io/en/latest/userguide/uni or [PyTest](http://glusto.readthedocs.io/en/latest/userguide/pytest.html) docs to write PyTest tests, or [Nose](http://glusto.readthedocs.io/en/latest/userguide/nosetests.html) docs to write Nose tests. +For more info how to write testcases [developing-guide](https://github.com/gluster/glusto-tests/blob/master/docs/userguide/developer-guide.rst) + Logging: -------- Log file name and Log level can be passed as argument to glusto command while @@ -105,7 +115,3 @@ Default log location is: `/tmp/glustomain.log` Note: When using `glusto` via the Python Interactive Interpreter, the default log location is `/tmp/glusto.log`. - -Refer to `docs/userguide/HOWTO` for a detailed information -on how to install/setup/run/ report - -- cgit