-
Notifications
You must be signed in to change notification settings - Fork 7.1k
Fix lock_store crash when redis package is not installed #4943
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| """Tests for lock_store. | ||
|
|
||
| We verify our own logic: the _redis_available guard and which portalocker | ||
| backend is selected. We trust portalocker to handle actual locking mechanics. | ||
| """ | ||
|
|
||
| from __future__ import annotations | ||
|
|
||
| import sys | ||
| from unittest import mock | ||
|
|
||
| import pytest | ||
|
|
||
| import crewai.utilities.lock_store as lock_store | ||
|
vinibrsl marked this conversation as resolved.
Dismissed
|
||
| from crewai.utilities.lock_store import lock | ||
|
|
||
|
|
||
| @pytest.fixture(autouse=True) | ||
| def no_redis_url(monkeypatch): | ||
| monkeypatch.setattr(lock_store, "_REDIS_URL", None) | ||
|
|
||
|
|
||
| # --------------------------------------------------------------------------- | ||
| # _redis_available | ||
| # --------------------------------------------------------------------------- | ||
|
|
||
|
|
||
| def test_redis_not_available_without_url(): | ||
| assert lock_store._redis_available() is False | ||
|
|
||
|
|
||
| def test_redis_not_available_when_package_missing(monkeypatch): | ||
| monkeypatch.setattr(lock_store, "_REDIS_URL", "redis://localhost:6379") | ||
| monkeypatch.setitem(sys.modules, "redis", None) # None → ImportError on import | ||
| assert lock_store._redis_available() is False | ||
|
|
||
|
|
||
| def test_redis_available_with_url_and_package(monkeypatch): | ||
| monkeypatch.setattr(lock_store, "_REDIS_URL", "redis://localhost:6379") | ||
| monkeypatch.setitem(sys.modules, "redis", mock.MagicMock()) | ||
| assert lock_store._redis_available() is True | ||
|
|
||
|
|
||
| # --------------------------------------------------------------------------- | ||
| # lock strategy selection | ||
| # --------------------------------------------------------------------------- | ||
|
|
||
|
|
||
| def test_uses_file_lock_when_redis_unavailable(): | ||
| with mock.patch("portalocker.Lock") as mock_lock: | ||
| with lock("file_test"): | ||
| pass | ||
|
|
||
| mock_lock.assert_called_once() | ||
| assert "crewai:" in mock_lock.call_args.args[0] | ||
|
|
||
|
|
||
| def test_uses_redis_lock_when_redis_available(monkeypatch): | ||
| fake_conn = mock.MagicMock() | ||
| monkeypatch.setattr(lock_store, "_redis_available", mock.Mock(return_value=True)) | ||
| monkeypatch.setattr(lock_store, "_redis_connection", mock.Mock(return_value=fake_conn)) | ||
|
|
||
| with mock.patch("portalocker.RedisLock") as mock_redis_lock: | ||
| with lock("redis_test"): | ||
| pass | ||
|
|
||
| mock_redis_lock.assert_called_once() | ||
| kwargs = mock_redis_lock.call_args.kwargs | ||
| assert kwargs["channel"].startswith("crewai:") | ||
| assert kwargs["connection"] is fake_conn | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.