summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorDevyani Kota <devyanikota@gmail.com>2017-11-14 17:59:38 +0530
committerNigel Babu <nigelb@redhat.com>2017-11-27 05:27:19 +0000
commitd34305292b0c8633a6654c8024cca6619f45a0bb (patch)
tree7e4d420c6a3f33a9b311b7cc5c4ae1bb91a131cc /README.md
parent84dda30153a2c392d01c4c812ebb2883cf739ea1 (diff)
Docs: Facelift for README.
Change-Id: Id1c7fe24e5cd2931556e2fa6c056a7e8a2a75a5c Signed-off-by: Devyani Kota <devyanikota@gmail.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md66
1 files changed, 33 insertions, 33 deletions
diff --git a/README.md b/README.md
index 44bbc3e..710a9e9 100644
--- a/README.md
+++ b/README.md
@@ -1,17 +1,19 @@
# Glusto Tests
-'glusto-tests' repo contains automated testcases for testing gluster software.
+`glusto-tests` repo contains automated testcases for testing gluster software.
It provides the Libraries/Modules necessary for automating the gluster tests.
+Latest Code for this repo is managed on review.gluster.org
-The Libraries/Modules/Tests in glusto-tests are written using the 'glusto'
+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.
+PyUnit, PyTest or Nose methodologies as supported by `glusto` framework.
-Refer to 'http://glusto.readthedocs.io/en/latest/' for info on 'glusto'
+Refer the [docs](http://glusto.readthedocs.io/en/latest/) for info on `glusto`
framework.
+Issues need to be filed against the Github repo.
To automate/run glusto-tests we need to install the following packages:
-----------------------------------------------------------------------
+---------------------------------------------------------------------
- glusto
- glustolibs-gluster
- glustolibs-io
@@ -19,17 +21,18 @@ To automate/run glusto-tests we need to install the following packages:
How to install glusto:
----------------------
-- pip install
+One can use either of the two methods.
+- using pip
+
# pip install --upgrade git+git://github.com/loadtheaccumulator/glusto.git
- or
+- using git
-- git clone
# git clone https://github.com/loadtheaccumulator/glusto.git
# cd glusto
# python setup.py
-Refer to: http://glusto.readthedocs.io/en/latest/userguide/install.html
+For more info refer the [docs](http://glusto.readthedocs.io/en/latest/userguide/install.html).
How to install the glustolibs-gluster and glustolibs-io libraries:
-----------------------------------------------------------------
@@ -41,8 +44,7 @@ How to install the glustolibs-gluster and glustolibs-io libraries:
How to install gdeploy:
-----------------------
-- Install latest version of gdeploy from below link.
- https://copr.fedorainfracloud.org/coprs/sac/gdeploy/package/gdeploy/
+- Install latest version of gdeploy from the following [link](https://copr.fedorainfracloud.org/coprs/sac/gdeploy/package/gdeploy/).
How to run the test case:
-------------------------
@@ -50,43 +52,41 @@ How to run the test case:
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
+ We can use any `glusto` framework supported formats for writing the
config files.
- Refer : http://glusto.readthedocs.io/en/latest/userguide/configurable.html
+ Refer the following [link](http://glusto.readthedocs.io/en/latest/userguide/configurable.html).
-- glusto-tests are run using the 'glusto' command available after installing
+- 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'
- Refer: http://glusto.readthedocs.io/en/latest/userguide/glusto.html#options-for-running-unit-tests
+ For more info refer the [docs](http://glusto.readthedocs.io/en/latest/userguide/glusto.html#options-for-running-unit-tests).
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
+`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.
TestCases in glusto-tests can we written using standard PyUnit, PyTest or Nose
-methodologies as supported by 'glusto' framework.
-
-To write PyUnit tests:
-http://glusto.readthedocs.io/en/latest/userguide/unittest.html
+methodologies as supported by `glusto` framework.
-To write PyTest tests:
-http://glusto.readthedocs.io/en/latest/userguide/pytest.html
-
-To write Nose tests:
-http://glusto.readthedocs.io/en/latest/userguide/nosetests.html
+One can follow the [PyUnit](http://glusto.readthedocs.io/en/latest/userguide/unittest.html) docs to write PyUnit tests,
+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.
Logging:
--------
@@ -96,13 +96,13 @@ running the glusto-tests. For example:
# glusto -c 'config.yml' -l /tmp/glustotests_bvt.log --log-level DEBUG --pytest='-v -x tests -m bvt'
One can configure log files, log levels in the testcases as well. For details
-on how to use glusto framework for configuring logs in tests Refer to:
-http://glusto.readthedocs.io/en/latest/userguide/loggable.html
+on how to use glusto framework for configuring logs in tests Refer the following [docs](http://glusto.readthedocs.io/en/latest/userguide/loggable.html).
+
+Default log location is: `/tmp/glustomain.log`
-Default log location is '/tmp/glustomain.log'.
+Note: When using `glusto` via the Python Interactive Interpreter,
+the default log location is `/tmp/glusto.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
-Refer to 'docs/userguide/HOWTO' for a detailed information
-on how to install/setup/run/report