Skip to content

Commit bded8ff

Browse files
committed
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 <[email protected]>
1 parent c788137 commit bded8ff

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

docs/BUILD.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,12 @@ make test-install
4545
BMQ_BROKER_URI=tcp://localhost:30114 make check
4646
```
4747

48+
Note that on OSX, the
49+
`tests/integration/test_deadlock_detection.py::test_deadlock_detection_warning`
50+
test may display a dialog warning you of a crashed Python process,
51+
depending on your system configuration. This crash is intentional, and
52+
is part of the test.
53+
4854
Additional `make` targets are provided, such as for test coverage.
4955
Dependencies for these can be installed as follows:
5056

tests/integration/test_deadlock_detection.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,12 @@
1313
# See the License for the specific language governing permissions and
1414
# limitations under the License.
1515

16+
# N.B. On OSX, the
17+
# `tests/integration/test_deadlock_detection.py::test_deadlock_detection_warning`
18+
# test may display a dialog warning you of a crashed Python process, depending
19+
# on your system configuration. This crash is intentional, and is part of the
20+
# test.
21+
1622
import signal
1723
import subprocess
1824
import sys

0 commit comments

Comments
 (0)