From 76aa7ce0abb49d0cfac2517c20f07cf5550ae456 Mon Sep 17 00:00:00 2001
From: Bert Blommers <info@bertblommers.nl>
Date: Sun, 13 Sep 2020 16:28:38 +0100
Subject: [PATCH] Dependency-integration test - add documentation to the top of
 the script

---
 scripts/int_test.sh | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/scripts/int_test.sh b/scripts/int_test.sh
index bc029eca4..f57bb157f 100755
--- a/scripts/int_test.sh
+++ b/scripts/int_test.sh
@@ -1,3 +1,25 @@
+#
+# Dependency Integration Test script
+#
+
+# Runs a test to verify whether each service has the correct dependencies listed in setup.py
+#
+# ::Algorithm::
+# For each valid service:
+#   - Create a virtual environment
+#   - Install only the necessary dependencies
+#   - Run the tests for that service
+#   - If the tests fail:
+#     - This service is probably missing a dependency
+#     - A log file with the test results will be created (test_results_service.log)
+#   - Delete the virtual environment
+#
+# Note:
+#   Only tested on Linux
+#   Parallelized to test 4 services at the time.
+#   Could take some time to run - around 20 minutes on the author's machine
+
+
 overwrite() { echo -e "\r\033[1A\033[0K$@"; }
 
 contains() {