[GitHub] merlimat closed pull request #1518: Readme for integration tests

[GitBox <gi...@apache.org>]

merlimat closed pull request #1518: Readme for integration tests
URL: https://github.com/apache/incubator-pulsar/pull/1518
 
 
   

This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:

As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):

diff --git a/tests/README.md b/tests/README.md
new file mode 100644
index 0000000000..2fb4e8f58d
--- /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.
+


 

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services