summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorkshithijiyer <kshithij.ki@gmail.com>2019-06-27 17:54:55 +0530
committerBala Konda Reddy M <bmekala@redhat.com>2019-06-30 17:54:59 +0000
commitf5831a8cd7f6fe54cf6d3ec693b15301516570b8 (patch)
treebccd3a4731b4d7d88f1fa0bd56e6b861c42a8988
parentf54b94609a3b5fce1fd85f23c06b27bcdfc99b46 (diff)
Converting text files to markdown files.
It's better to use markdown files instead of text files for readme files. Hence converting readme files to readme.md files. Change-Id: I41c1b2f065895d885f4b1fabdc9b9e4051810e80 Signed-off-by: kshithijiyer <kshithij.ki@gmail.com>
-rw-r--r--docker/README26
-rw-r--r--docker/README.md34
-rw-r--r--tests/functional/README21
-rw-r--r--tests/functional/README.md20
4 files changed, 54 insertions, 47 deletions
diff --git a/docker/README b/docker/README
deleted file mode 100644
index 3844e6d..0000000
--- a/docker/README
+++ /dev/null
@@ -1,26 +0,0 @@
-This Dockerfile adds Glusto and the Gluster glustolibs libraries on top of the Fedora container to provide the complete environment required to run Gluster QE tests under Glusto.
-This container is currently based on Fedora and also installs gdeploy as required by NFS Ganesha tests.
-
-This is currently a minimal implementation. More to come.
-
-To use the glusto-tests container, you can run tests using the pre-gen'd container or create a Dockerfile and customize to fit your own needs.
-
-To use the pre-gen'd image...
-
-1. Pull the docker image down to your local system.
-
- # docker pull gluster/glusto-tests
-
-2. Run the image with docker.
-
- # docker run -it --rm --privileged=true -v <local_dir_path>:<container_dir_path> docker.io/gluster/glusto-tests /bin/bash
-
- ... or for example to run a test directly...
-
- # docker run -it --rm --privileged=true \
- -v $WORKSPACE/:/workspace \
- docker.io/gluster/glusto-tests \
- /usr/bin/glusto -c /workspace/myservers.yml \
- --pytest="-vv /workspace/testdir/test_your_test_file.py"
-
-More robust docs and examples coming soon.
diff --git a/docker/README.md b/docker/README.md
new file mode 100644
index 0000000..b2d8e09
--- /dev/null
+++ b/docker/README.md
@@ -0,0 +1,34 @@
+# Glusto in docker
+This Dockerfile adds Glusto and the Gluster glustolibs libraries on top of the
+Fedora container to provide the complete environment required to run Gluster
+QE tests under Glusto. This container is currently based on Fedora and also
+installs gdeploy as required by NFS Ganesha tests.
+
+**This is currently a minimal implementation. More to come.**
+
+To use the glusto-tests container, you can run tests using the pre-gen'd
+container or create a Dockerfile and customize to fit your own needs.
+To use the pre-gen'd image...
+
+- Pull the docker image down to your local system.
+
+```
+$ docker pull gluster/glusto-tests
+```
+
+- Run the image with docker.
+
+```
+$ docker run -it --rm --privileged=true -v <local_dir_path>:<container_dir_path> docker.io/gluster/glusto-tests /bin/bash
+```
+or for example to run a test directly.
+
+```
+$ docker run -it --rm --privileged=true \
+ -v $WORKSPACE/:/workspace \
+ docker.io/gluster/glusto-tests \
+ /usr/bin/glusto -c /workspace/myservers.yml \
+ --pytest="-vv /workspace/testdir/test_your_test_file.py"
+```
+
+More robust docs and examples coming soon. \ No newline at end of file
diff --git a/tests/functional/README b/tests/functional/README
deleted file mode 100644
index 07d029d..0000000
--- a/tests/functional/README
+++ /dev/null
@@ -1,21 +0,0 @@
-Functional Testing:
- Process of validating that the software conforms to its specifications and
- correctly performs its required functions.
-
- This entails a series of feature by feature validation of behavior using
- a wide range of normal and erroneous input data.
-
- Functional testing divided in 3 categories:
- - Build Validation tests:
- Build Verification Test (BVT), also known as Build Acceptance Test,
- is a set of tests run on each new build of a software to verify that
- the build is testable before the build is released into further testing.
-
- - Smoke Testing:
- A subset of test cases that are designed to broadly and minimally
- test to confirm that changes in the code of a particular build
- function as expected and do not break an entire build.
-
- - Regression:
- Process of retesitng a build after bug fixes and code changes to
- find any unexpected loss of functionality in the new code base.
diff --git a/tests/functional/README.md b/tests/functional/README.md
new file mode 100644
index 0000000..ca33fd0
--- /dev/null
+++ b/tests/functional/README.md
@@ -0,0 +1,20 @@
+# Functional Testing
+Process of validating that the software conforms to its specifications and
+correctly performs its required functions. This entails a series of feature
+by feature validation of behavior using a wide range of normal and erroneous
+input data.
+
+## Functional testing divided in 3 categories:
+### Build Verification Tests:
+Build Verification Test (BVT), also known as Build Acceptance Test,
+is a set of tests run on each new build of a software to verify that
+the build is testable before the build is released into further testing.
+
+### Smoke Testing:
+A subset of test cases that are designed to broadly and minimally
+test to confirm that changes in the code of a particular build
+function as expected and do not break an entire build.
+
+### Regression:
+Process of retesting a build after bug fixes and code changes to
+find any unexpected loss of functionality in the new code base. \ No newline at end of file