-
Notifications
You must be signed in to change notification settings - Fork 0
Refine Firebase mock fallback to selectively handle initialization ValueError #133
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
571584d
fix: refine Firebase mock fallback to only catch ValueError
google-labs-jules[bot] 60f7a3f
fix: refine Firebase mock fallback to only catch ValueError
google-labs-jules[bot] fe7a7ac
fix: refine Firebase mock fallback to only catch ValueError
google-labs-jules[bot] 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,45 @@ | ||
| import unittest | ||
| from unittest.mock import patch, MagicMock | ||
|
|
||
| class TestFirebaseUtils(unittest.TestCase): | ||
| def test_reference_value_error_fallback(self): | ||
| # We must clear the module to reload it with our mocked FIREBASE_AVAILABLE state | ||
| import sys | ||
| if 'firebase_utils' in sys.modules: | ||
| del sys.modules['firebase_utils'] | ||
|
|
||
| # Mock firebase_admin and db to simulate an uninitialized state where db.reference raises ValueError | ||
| mock_db = MagicMock() | ||
| mock_db.reference.side_effect = ValueError("The default Firebase app does not exist.") | ||
|
|
||
| with patch.dict(sys.modules, {'firebase_admin': MagicMock(db=mock_db)}): | ||
| import firebase_utils | ||
|
|
||
| # FIREBASE_AVAILABLE should be True because the import succeeds (mocked) | ||
| self.assertTrue(firebase_utils.FIREBASE_AVAILABLE) | ||
|
|
||
| with patch('firebase_utils.logger.warning') as mock_logger: | ||
| ref = firebase_utils.reference() | ||
|
|
||
| # Should fallback to MockRef | ||
| self.assertIsInstance(ref, firebase_utils.MockRef) | ||
| mock_logger.assert_called_once() | ||
| self.assertIn("Firebase not initialized", mock_logger.call_args[0][0]) | ||
|
|
||
| def test_reference_other_exception_bubbles_up(self): | ||
| import sys | ||
| if 'firebase_utils' in sys.modules: | ||
| del sys.modules['firebase_utils'] | ||
|
|
||
| mock_db = MagicMock() | ||
| # Some other error like network permission denied | ||
| mock_db.reference.side_effect = PermissionError("Permission denied.") | ||
|
|
||
| with patch.dict(sys.modules, {'firebase_admin': MagicMock(db=mock_db)}): | ||
| import firebase_utils | ||
|
|
||
| with self.assertRaises(PermissionError): | ||
| firebase_utils.reference() | ||
|
|
||
| if __name__ == '__main__': | ||
| unittest.main() | ||
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Manipulating
sys.modulesby deleting and reloading modules during tests can lead to unexpected side effects, such as breaking other tests or causing issues with modules that have already importedfirebase_utils(e.g.,action_devices).Instead of reloading the module, you can use
unittest.mock.patchto directly mockfirebase_utils.FIREBASE_AVAILABLEandfirebase_utils.db(usingcreate=Trueto handle cases wheredbis not defined due to a missingfirebase_admininstallation). This is much cleaner, more idiomatic, and avoids test isolation issues.