You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@stratos.apache.org by ch...@apache.org on 2014/05/14 23:10:06 UTC
git commit: add some test documentation
Repository: incubator-stratos
Updated Branches:
refs/heads/master 0f6cfd3fa -> b8ca2d208
add some test documentation
Project: http://git-wip-us.apache.org/repos/asf/incubator-stratos/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-stratos/commit/b8ca2d20
Tree: http://git-wip-us.apache.org/repos/asf/incubator-stratos/tree/b8ca2d20
Diff: http://git-wip-us.apache.org/repos/asf/incubator-stratos/diff/b8ca2d20
Branch: refs/heads/master
Commit: b8ca2d208cd0f3778aa8c80017744737597b8c79
Parents: 0f6cfd3
Author: Chris Snow <ch...@apache.org>
Authored: Wed May 14 21:09:38 2014 +0000
Committer: Chris Snow <ch...@apache.org>
Committed: Wed May 14 21:09:38 2014 +0000
----------------------------------------------------------------------
components/org.apache.stratos.cli/README.md | 2 +-
.../src/test/python/README.md | 44 ++++++++++++++++++++
2 files changed, 45 insertions(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-stratos/blob/b8ca2d20/components/org.apache.stratos.cli/README.md
----------------------------------------------------------------------
diff --git a/components/org.apache.stratos.cli/README.md b/components/org.apache.stratos.cli/README.md
index f03d1b3..88cab1b 100644
--- a/components/org.apache.stratos.cli/README.md
+++ b/components/org.apache.stratos.cli/README.md
@@ -4,4 +4,4 @@ Run CLI integration tests with:
```mvn -P cli-test integration-test```
-You will need python ane pexpect installed.
+You will need python installed.
http://git-wip-us.apache.org/repos/asf/incubator-stratos/blob/b8ca2d20/components/org.apache.stratos.cli/src/test/python/README.md
----------------------------------------------------------------------
diff --git a/components/org.apache.stratos.cli/src/test/python/README.md b/components/org.apache.stratos.cli/src/test/python/README.md
new file mode 100644
index 0000000..58038e0
--- /dev/null
+++ b/components/org.apache.stratos.cli/src/test/python/README.md
@@ -0,0 +1,44 @@
+### CLI Integration Tests
+
+#### Running the tests
+
+The CLI integration tests can be run from maven using:
+
+mvn -P cli-test integration-test
+
+You will need python installed and be running a unix like operating system
+
+#### Creating new tests
+
+Run 'mvn -P cli-test integration-test' to download the test dependencies.
+
+Set the environment variables CLI_JAR, PYTHONPATH and WIREMOCK_JAR. For example:
+
+# the stratos CLI_JAR
+export CLI_JAR=~/incubator-stratos/components/org.apache.stratos.cli/target/org.apache.stratos.cli-4.0.0-SNAPSHOT.jar
+
+# set the PYTHONPATH to include pexpect
+export PYTHONPATH=$PYTHONPATH:~/incubator-stratos/components/org.apache.stratos.cli/target/pexpect-3.2
+
+# the wiremock application
+export WIREMOCK_JAR=~/incubator-stratos/components/org.apache.stratos.cli/target/dependency/wiremock-1.46-standalone.jar
+
+The tests are split into three areas:
+
+- test_common.py : tests that are common to interactive and non-interactive CLI usage
+- test_interactive.py : tests for CLI in interactive mode
+- test_noninteractive.py : tests for CLI in non-interactive mode
+
+After setting the above environment variables, the tests can be executed like this:
+
+./test_common.py
+
+The tests have class methods that start wiremock at the start of the tests (setUpClass) and stop it at the end of the test (tearDownClass).
+
+The tests use pexpect to execute the CLI and interact with the CLI's input and output. See the existing tests for examples of pexpect.
+
+The tests depend on wiremock (www.wiremock.org) for simulating the Statos REST services.
+
+The python class wiremock.py is a simple wrapper to start/stop wiremock and provides utility methods so the tests can call wiremock's APIs to retrieve information about the requests that wiremock received.
+
+The response that wiremock chooses to return for a particular request is defined in the 'mappings' folder. A mapping usually has a response body that can be found in the '__files' folder