From 68cf85357dc1a6d5d9ab28373e71647f6de9a1b7 Mon Sep 17 00:00:00 2001 From: "Patrick M. Niedzielski" Date: Mon, 22 Jul 2024 16:11:02 -0400 Subject: [PATCH] docs: Document OSX test crash behavior Depending how your system is configured, running the `test_deadlock_detection.py` integration test on OSX may result in a dialog window warning you about a crashed or aborted Python process. This crash is intentional, as the test introduces a deadlock and tests whether it can be detected. This patch documents this behavior in both the build documentation and the test itself. Signed-off-by: Patrick M. Niedzielski --- docs/BUILD.md | 6 ++++++ tests/integration/test_deadlock_detection.py | 6 ++++++ 2 files changed, 12 insertions(+) diff --git a/docs/BUILD.md b/docs/BUILD.md index 5a552d7..7f2e86c 100644 --- a/docs/BUILD.md +++ b/docs/BUILD.md @@ -45,6 +45,12 @@ make test-install BMQ_BROKER_URI=tcp://localhost:30114 make check ``` +Note that on OSX, the +`tests/integration/test_deadlock_detection.py::test_deadlock_detection_warning` +test may display a dialog warning you of a crashed Python process, +depending on your system configuration. This crash is intentional, and +is part of the test. + Additional `make` targets are provided, such as for test coverage. Dependencies for these can be installed as follows: diff --git a/tests/integration/test_deadlock_detection.py b/tests/integration/test_deadlock_detection.py index 729af5c..f9a140a 100644 --- a/tests/integration/test_deadlock_detection.py +++ b/tests/integration/test_deadlock_detection.py @@ -13,6 +13,12 @@ # See the License for the specific language governing permissions and # limitations under the License. +# N.B. On OSX, the +# `tests/integration/test_deadlock_detection.py::test_deadlock_detection_warning` +# test may display a dialog warning you of a crashed Python process, depending +# on your system configuration. This crash is intentional, and is part of the +# test. + import signal import subprocess import sys