You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@predictionio.apache.org by do...@apache.org on 2016/08/09 21:43:55 UTC

[47/52] [abbrv] incubator-predictionio git commit: Added README.md for the tests directory

Added README.md for the tests directory


Project: http://git-wip-us.apache.org/repos/asf/incubator-predictionio/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-predictionio/commit/bea01212
Tree: http://git-wip-us.apache.org/repos/asf/incubator-predictionio/tree/bea01212
Diff: http://git-wip-us.apache.org/repos/asf/incubator-predictionio/diff/bea01212

Branch: refs/heads/develop
Commit: bea01212ac08202016099a597380ae92545222b3
Parents: 0b99a11
Author: Marcin Ziemi\u0144ski <zi...@gmail.com>
Authored: Fri Aug 5 11:48:26 2016 -0700
Committer: Marcin Ziemi\u0144ski <zi...@gmail.com>
Committed: Fri Aug 5 11:48:26 2016 -0700

----------------------------------------------------------------------
 testing/README.md | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-predictionio/blob/bea01212/testing/README.md
----------------------------------------------------------------------
diff --git a/testing/README.md b/testing/README.md
new file mode 100644
index 0000000..a9e5dea
--- /dev/null
+++ b/testing/README.md
@@ -0,0 +1,31 @@
+# Testing PredictionIO
+
+Intention of this subdirectory is to amass different types of tests other than unit-tests and also to make developers life easier giving them with means to check the application deterministically for different configurations.
+Moreover, it provides testing scenarios for **TravisCI** to be run on pull requests and commits.
+
+
+## Integration Tests
+These tests are mostly user-functionality tests. They check logic and reliability of the system.
+In order to get familiar with their structure, please see [README](pio_tests/README.md).
+
+## Docker image
+After introducing some changes, a developer would like to try them against different configurations, namely to see if everything works as expected e.g. when you change the data repository for the events or meta-data.
+A good way to that is to use the docker image with installed and running dependencies.
+
+To download the image run:
+```
+$ docker pull ziemin/pio-testing
+```
+
+The most convenient way to make use of it is to execute ***run_docker.sh*** script passing it the configuration, the path to PredictionIO's repository with archived snapshot and the command to run. When no command is provided it opens a bash shell inside the docker image. Example of usage:
+```sh
+$ ./run_docker.sh ELASTICSEARCH HBASE LOCALFS \ 
+    ~/projects/incubator-preadictionio "echo 'All tests passed...'"
+```
+
+Directory structure inside the image:
+* ***/PredictionIO*** - extracted snapshot
+* ***/pio_host*** - mounted path to repository
+* ***/tests/pio_tests*** - copy of integration tests
+* ***/vendors*** - directory with installed services
+* ***/drivers*** - jars with database drivers