From 72b402455e2b6ecf1ec952588be0cfb97b101351 Mon Sep 17 00:00:00 2001
From: Timm Fitschen <t.fitschen@indiscale.com>
Date: Fri, 9 Jul 2021 10:57:11 +0200
Subject: [PATCH] DOC: add troubleshooting sec to README for unit tests

---
 README_SETUP.md | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/README_SETUP.md b/README_SETUP.md
index d17adb6..67b43dc 100644
--- a/README_SETUP.md
+++ b/README_SETUP.md
@@ -82,6 +82,20 @@ with the then current version of the stored entities.
     * Alternatively, to run the tests in a containerized MariaDB instance, run `make test-docker`,
       followed by `make test-docker-stop`.
 
+### Troubleshooting
+
+#### MySQL has failing tests
+
+Our test suite is developed with mariadb. That is why some test, those which
+check constraints based on auto-generated names, fail because MySQL generates
+other names.
+
+Also some test fail with the message "Expected: NULL / Was: NULL" which is
+obviously what was expected.
+
+Please look carefully through the tests. If something more serious than that
+comes up, please report a bug.
+
 ## Documentation #
 
 Build documentation in `build/` with `make doc`.
-- 
GitLab