add documentation for integration tests

Dazu-io · Feb 2, 2021 · 7d517d1 · 7d517d1
1 parent 50ef5ed
commit 7d517d1
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 1 deletion.
diff --git a/Makefile b/Makefile
@@ -33,7 +33,7 @@ help:
 	@echo "        Download all additional resources needed to use spacy as part of Rasa."
 	@echo "    prepare-mitie"
 	@echo "        Download all additional resources needed to use mitie as part of Rasa."
-	@echo "    prepare-transformers:"
+	@echo "    prepare-transformers"
 	@echo "        Download all models needed for testing LanguageModelFeaturizer."
 	@echo "    test"
 	@echo "        Run pytest on tests/."
@@ -47,6 +47,10 @@ help:
 	@echo "        Prepare a release."
 	@echo "    build-docker"
 	@echo "        Build Rasa Open Source Docker image."
+	@echo "    run-integration-containers"
+	@echo "        Run the integration test containers."
+	@echo "    stop-integration-containers"
+	@echo "        Stop the integration test containers."
 
 clean:
 	find . -name '*.pyc' -exec rm -f {} +

diff --git a/README.md b/README.md
@@ -185,6 +185,29 @@ JOBS=[n] make test
 
 Where `[n]` is the number of jobs desired. If omitted, `[n]` will be automatically chosen by pytest.
 
+
+### Running the Integration Tests
+
+In order to run the integration tests, make sure that you have the development requirements installed:
+
+```bash
+make prepare-tests-ubuntu # Only on Ubuntu and Debian based systems
+make prepare-tests-macos  # Only on macOS
+```
+
+Then, you'll need to start services with the following command which uses Docker Compose:
+
+```bash
+make run-integration-containers
+```
+
+Finally, you can run the integration tests like this:
+
+```bash
+make test-integration
+```
+
+
 ### Resolving merge conflicts
 
 Poetry doesn't include any solution that can help to resolve merge conflicts in

diff --git a/changelog/7680.improvement.md b/changelog/7680.improvement.md
@@ -0,0 +1,4 @@
+We're now running integration tests for Rasa, with initial coverage for `SQLTrackerStore` (with PostgreSQL),
+`RedisLockStore` (with Redis) and `PikaEventBroker` (with RabbitMQ). The integration tests are now part of our
+CI, and can also be ran locally using `make test-integration`
+(see [Rasa Open Source README](https://github.com/RasaHQ/rasa) for more information).