This is an automated email from the ASF dual-hosted git repository.
mmerli pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-pulsar.git
The following commit(s) were added to refs/heads/master by this push:
new cc28dd0 Readme for integration tests (#1518)
cc28dd0 is described below
commit cc28dd027f02249233e37b73ca08e5e49a8069ae
Author: Ivan Kelly <iv...@apache.org>
AuthorDate: Fri Apr 6 23:36:32 2018 +0200
Readme for integration tests (#1518)
---
tests/README.md | 22 ++++++++++++++++++++++
1 file changed, 22 insertions(+)
diff --git a/tests/README.md b/tests/README.md
new file mode 100644
index 0000000..2fb4e8f
--- /dev/null
+++ b/tests/README.md
@@ -0,0 +1,22 @@
+This directory contains integration tests for Pulsar.
+
+The integration tests use a framework called [Arquillian
Cube](https://github.com/arquillian/arquillian-cube) to bring up a bunch of
docker containers running Pulsar services. TestNG can then be used to test
functionallity against these containers.
+
+Arquillian sets up a clean set of containers for each test suite. However, if
maven is configured to fork per test class, Arquillian will set up a clean set
of containers _per test class_. The test cases within the class will share the
environment, so tests which leave the cluster in a different state after
running should be put in their own test class.
+
+The tests require that docker is installed and running. Tests will only run if
the integrationTests system property is defined. To run the tests:
+```shell
+# in the top level directory
+pulsar/ $ mvn install -DskipTests -Pdocker # builds the docker images
+...
+pulsar/ $ mvn -f tests/pom.xml test -DintegrationTests
+```
+
+The directories are as follows:
+
+- docker-images/ : Docker images for integration testing.
+- integration/ : The integration tests themselves.
+- integration-tests-base/ : A base module for integration test modules.
Contains common settings and dependencies.
+- integration-tests-topologies/ : Arquillian cluster definitions for use in
integration tests.
+- integration-tests-utils/ : Utilities for working with arquillian test
clusters.
+
--
To stop receiving notification emails like this one, please contact
mme...@apache.org.
