summaryrefslogtreecommitdiffstats
path: root/tests/README.md
diff options
context:
space:
mode:
authorHumble Devassy Chirammal <humble.devassy@gmail.com>2017-05-09 12:40:37 +0530
committerGitHub <noreply@github.com>2017-05-09 12:40:37 +0530
commit63b0319369976ee38c9cc86fd4835d49de34797f (patch)
tree6207c3a51811f19f8903706bfbfc60ebd401e866 /tests/README.md
parent0739c194d3fe908b6770dde32f7d9efcf2912ce2 (diff)
parent19a04f979a1e2a355c95737cb56b495a75181ad3 (diff)
downloadgluster-63b0319369976ee38c9cc86fd4835d49de34797f.tar.gz
gluster-63b0319369976ee38c9cc86fd4835d49de34797f.tar.bz2
gluster-63b0319369976ee38c9cc86fd4835d49de34797f.tar.xz
gluster-63b0319369976ee38c9cc86fd4835d49de34797f.zip
Merge pull request #41 from MohamedAshiqrh/readme
Adding README for the tests and cleanup the main README
Diffstat (limited to 'tests/README.md')
-rw-r--r--tests/README.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/tests/README.md b/tests/README.md
new file mode 100644
index 0000000..501af35
--- /dev/null
+++ b/tests/README.md
@@ -0,0 +1,31 @@
+# Testsuite
+
+This directory contains tests for gluster-containers.
+These are tests that do not test the full stack end-to-end
+but are syntax-checks or unit-tests.
+
+## Prerequisites
+
+The Dockerfile lint tests require the 'dockerfile_lint' program.
+Install it with
+
+* `dnf install npm`, or
+* `apt-get install npm`
+
+* `npm install dockerfile_lint`
+
+Ref: https://github.com/projectatomic/dockerfile_lint
+
+The test uses ShellCheck.
+Install with
+
+* `dnf install ShellCheck`, or
+* `apt-get install shellcheck`
+
+## TODOs
+
+* Write more tests
+* More elaborate basic tests - docker build, docker run of basic commands.
+* Write full functional tests to be run in vms.
+ (like the atomic vagrant environment)
+