Prevent XMPP racing condition causing test failures at random times by caronc · Pull Request #1526 · caronc/apprise

caronc · 2026-02-19T21:50:57Z

Description

Related issue (if applicable): #497

XMPP test coverage would randomly fail due to a race condition that is hopefully handled in this PR

Checklist

Documentation ticket created (if applicable): n/a
The change is tested and works locally.
No commented-out code in this PR.
No lint errors (use tox -e lint and optionally tox -e format).
Test coverage added or updated (use tox -e minimal).

Testing

Anyone can help test as follows:

# Create a virtual environment
python3 -m venv apprise

# Change into our new directory
cd apprise

# Activate our virtual environment
source bin/activate

# Install the branch
pip install git+https://github.com/caronc/apprise.git@xmpp-test-race-condition-fix

# Run tests and do not get an xmpp error:
tox -e qa

codecov · 2026-02-19T22:08:51Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (9d9931a) to head (0214835).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff            @@
##            master     #1526   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          194       194           
  Lines        25372     25372           
  Branches      4118      4118           
=========================================
  Hits         25372     25372

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copilot

Pull request overview

This PR fixes a race condition in XMPP test coverage that caused random test failures. The issue occurred because background runner threads created by SlixmppAdapter.process() could still be running during pytest's teardown phase, causing intermittent conflicts with log capture cleanup.

Changes:

Added thread capture mechanism to ensure background runner threads are properly joined before test completion
Implemented _CapturingThread class to track thread creation in the test
Added explicit thread join with appropriate timeout in the test cleanup phase

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

tests/test_plugin_xmpp.py

Copilot

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 2 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

tests/test_plugin_xmpp.py

Copilot

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 7 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

tests/test_plugin_xmpp.py

Copilot · 2026-02-20T20:21:07Z

tests/test_plugin_xmpp.py

+    # Optional gate the test can set to make `wait()` pause until a checkpoint
+    # is reached. This must be class-level because `threading.Event()` is
+    # constructed with no arguments in the code under test.
+    signal_evt: Optional[threading.Event] = None


The class-level signal_evt attribute creates a potential race condition if multiple tests using _FakeDoneEvent run in parallel. Since this is shared state across all instances, concurrent tests could interfere with each other by overwriting the signal_evt value. Consider using instance-level state or a thread-safe mechanism to avoid test interference.

@copilot open a new pull request to apply changes based on this feedback

Copilot · 2026-02-20T20:21:07Z

tests/test_plugin_xmpp.py

+def _patch_threading(
+        monkeypatch: pytest.MonkeyPatch, *,
+        done_event_cls: type,
+        created_thread: dict[str, Any]) -> None:


The created_thread parameter is populated but never used anywhere in the codebase. If thread tracking is not needed for these tests, consider removing this parameter to simplify the code. If it was intended for future use or debugging, consider adding a comment explaining its purpose.

tests/test_plugin_xmpp.py

Copilot · 2026-02-20T20:21:07Z

tests/test_plugin_xmpp.py

+    created_thread: dict[str, Any] = {"thread": None}
+    _FakeDoneEvent.signal_evt = client_created

-        def __getattr__(self, name: str) -> Any:
-            return getattr(_real_threading, name)
-
-    monkeypatch.setattr(
-        xmpp_adapter, "threading", _ThreadingProxy(), raising=True)
+    _patch_threading(
+        monkeypatch,
+        done_event_cls=_FakeDoneEvent,
+        created_thread=created_thread,
+    )


After setting _FakeDoneEvent.signal_evt to a specific event or None for a test, this class-level state should be restored to its original value to avoid affecting subsequent tests. Consider adding a try-finally block or pytest fixture to ensure cleanup, or document that tests must explicitly set this value before use.

Copilot · 2026-02-20T20:21:07Z

tests/test_plugin_xmpp.py

+    created_thread: dict[str, Any] = {"thread": None}
+    _FakeDoneEvent.signal_evt = loop_created

-    monkeypatch.setattr(
-        xmpp_adapter, "threading", _ThreadingProxy(), raising=True)
+    _patch_threading(
+        monkeypatch,
+        done_event_cls=_FakeDoneEvent,
+        created_thread=created_thread,
+    )


After setting _FakeDoneEvent.signal_evt to a specific event or None for a test, this class-level state should be restored to its original value to avoid affecting subsequent tests. Consider adding a try-finally block or pytest fixture to ensure cleanup, or document that tests must explicitly set this value before use.

Copilot · 2026-02-20T20:21:08Z

tests/test_plugin_xmpp.py

+    created_thread: dict[str, Any] = {"thread": None}
+    _FakeDoneEvent.signal_evt = None

-    monkeypatch.setattr(
-        xmpp_adapter, "threading", _ThreadingProxy(), raising=True)
+    _patch_threading(
+        monkeypatch,
+        done_event_cls=_FakeDoneEvent,
+        created_thread=created_thread,
+    )


After setting _FakeDoneEvent.signal_evt to a specific event or None for a test, this class-level state should be restored to its original value to avoid affecting subsequent tests. Consider adding a try-finally block or pytest fixture to ensure cleanup, or document that tests must explicitly set this value before use.

@copilot open a new pull request to apply changes based on this feedback

Copilot · 2026-02-20T20:27:07Z

@caronc I've opened a new pull request, #1527, to work on those changes. Once the pull request is ready, I'll request review from you.

Copilot · 2026-02-20T20:27:13Z

@caronc I've opened a new pull request, #1528, to work on those changes. Once the pull request is ready, I'll request review from you.

Copilot · 2026-02-20T20:27:21Z

@caronc I've opened a new pull request, #1529, to work on those changes. Once the pull request is ready, I'll request review from you.

…1529)

Copilot · 2026-02-20T20:59:49Z

@caronc I've opened a new pull request, #1530, to work on those changes. Once the pull request is ready, I'll request review from you.

caronc · 2026-02-20T20:59:54Z

@copilot open a new pull request to apply changes based on the comments in this thread

Copilot · 2026-02-20T21:00:05Z

@caronc I've opened a new pull request, #1531, to work on those changes. Once the pull request is ready, I'll request review from you.

…ber in XMPP tests (#1531)

Copilot

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

caronc · 2026-02-20T21:50:13Z

@copilot open a new pull request to apply changes based on the comments in this thread

Copilot · 2026-02-20T21:50:22Z

@caronc I've opened a new pull request, #1533, to work on those changes. Once the pull request is ready, I'll request review from you.

… XMPP tests (#1533)

prevent racing condition during some test coverage

a682161

caronc changed the title ~~prevent racing condition during some test coverage~~ Pevent XMPP racing condition causing test failures in random cases Feb 19, 2026

caronc changed the title ~~Pevent XMPP racing condition causing test failures in random cases~~ Pevent XMPP racing condition causing test failures at random times Feb 19, 2026

caronc changed the title ~~Pevent XMPP racing condition causing test failures at random times~~ Prevent XMPP racing condition causing test failures at random times Feb 19, 2026

bulletproofing timeout

94ba084

caronc requested a review from Copilot February 19, 2026 22:51

Copilot started reviewing on behalf of caronc February 19, 2026 22:51 View session

Copilot AI reviewed Feb 19, 2026

View reviewed changes

tests/test_plugin_xmpp.py Outdated Show resolved Hide resolved

copilot finds applied

afc4e90

caronc requested a review from Copilot February 20, 2026 14:31

Copilot started reviewing on behalf of caronc February 20, 2026 14:31 View session

Copilot AI reviewed Feb 20, 2026

View reviewed changes

tests/test_plugin_xmpp.py Outdated Show resolved Hide resolved

tests/test_plugin_xmpp.py Outdated Show resolved Hide resolved

caronc added 2 commits February 20, 2026 12:47

optimized to assist with points copilot brought forth

84c7af5

line count fix

ccd8fb3

caronc requested a review from Copilot February 20, 2026 20:16

Copilot started reviewing on behalf of caronc February 20, 2026 20:17 View session

Copilot AI reviewed Feb 20, 2026

View reviewed changes

Copilot AI mentioned this pull request Feb 20, 2026

Preserve _wait_calls tracking in _FakeDoneEvent.wait() #1527

Merged

This was referenced Feb 20, 2026

Replace shared class-level state in _FakeDoneEvent with per-test instance state #1528

Closed

Fix _FakeDoneEvent.signal_evt class-state leakage between XMPP tests #1529

Merged

Copilot AI added 2 commits February 20, 2026 15:46

Preserve _wait_calls tracking in _FakeDoneEvent.wait() (#1527)

adece95

Fix _FakeDoneEvent.signal_evt class-state leakage between XMPP tests (#…

175027a

…1529)

Copilot AI mentioned this pull request Feb 20, 2026

Replace magic number in _FakeDoneEvent with named constant #1530

Merged

Copilot AI mentioned this pull request Feb 20, 2026

Clean up dead created_thread code and document pre_wait magic number in XMPP tests #1531

Merged

Copilot AI added 2 commits February 20, 2026 16:16

Replace magic number in _FakeDoneEvent with named constant (#1530)

6c09a65

Clean up dead created_thread code and document pre_wait magic num…

f98e8c2

…ber in XMPP tests (#1531)

caronc requested a review from Copilot February 20, 2026 21:38

Copilot started reviewing on behalf of caronc February 20, 2026 21:39 View session

Copilot AI reviewed Feb 20, 2026

View reviewed changes

Copilot AI mentioned this pull request Feb 20, 2026

Replace shared class-level signal_evt with closure-based factory in XMPP tests #1533

Merged

Replace shared class-level signal_evt with closure-based factory in…

0214835

… XMPP tests (#1533)

caronc merged commit 1401205 into master Feb 20, 2026
19 checks passed

Uh oh!

Conversation

caronc commented Feb 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Testing

Uh oh!

codecov bot commented Feb 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Copilot AI Feb 20, 2026

Choose a reason for hiding this comment

Uh oh!

caronc Feb 20, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 20, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI Feb 20, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 20, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 20, 2026

Choose a reason for hiding this comment

Uh oh!

caronc Feb 20, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI commented Feb 20, 2026

Uh oh!

Copilot AI commented Feb 20, 2026

Uh oh!

Copilot AI commented Feb 20, 2026

Uh oh!

Copilot AI commented Feb 20, 2026

Uh oh!

caronc commented Feb 20, 2026

Uh oh!

Copilot AI commented Feb 20, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

caronc commented Feb 20, 2026

Uh oh!

Copilot AI commented Feb 20, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

caronc commented Feb 19, 2026 •

edited

Loading

codecov bot commented Feb 19, 2026 •

edited

Loading