|
| 1 | +# Copyright 2025 Google LLC |
| 2 | +# |
| 3 | +# Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 | +# you may not use this file except in compliance with the License. |
| 5 | +# You may obtain a copy of the License at |
| 6 | +# |
| 7 | +# http://www.apache.org/licenses/LICENSE-2.0 |
| 8 | +# |
| 9 | +# Unless required by applicable law or agreed to in writing, software |
| 10 | +# distributed under the License is distributed on an "AS IS" BASIS, |
| 11 | +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 | +# See the License for the specific language governing permissions and |
| 13 | +# limitations under the License. |
| 14 | + |
| 15 | +from __future__ import annotations |
| 16 | + |
| 17 | +from importlib import reload |
| 18 | +import io |
| 19 | +import json |
| 20 | +import logging |
| 21 | +from unittest import mock |
| 22 | +from unittest import TestCase |
| 23 | + |
| 24 | +from google.adk.cli.utils import logs as logs_module |
| 25 | + |
| 26 | +logs = reload(logs_module) |
| 27 | + |
| 28 | + |
| 29 | +class TestSetupAdkLogger(TestCase): |
| 30 | + """Tests for setup_adk_logger helper.""" |
| 31 | + |
| 32 | + def setUp(self): |
| 33 | + super().setUp() |
| 34 | + self._reset_logging() |
| 35 | + self.addCleanup(self._reset_logging) |
| 36 | + |
| 37 | + def _reset_logging(self): |
| 38 | + root_logger = logging.getLogger() |
| 39 | + for handler in list(root_logger.handlers): |
| 40 | + root_logger.removeHandler(handler) |
| 41 | + try: |
| 42 | + handler.close() |
| 43 | + except Exception: # pylint: disable=broad-except |
| 44 | + pass |
| 45 | + root_logger.setLevel(logging.WARNING) |
| 46 | + root_logger.propagate = True |
| 47 | + |
| 48 | + def test_log_to_cloud_uses_google_cloud_logging_client(self): |
| 49 | + """Log setup delegates to google.cloud.logging client when available.""" |
| 50 | + buffer = io.StringIO() |
| 51 | + |
| 52 | + class _JsonFormatter(logging.Formatter): |
| 53 | + |
| 54 | + def format(self, record): |
| 55 | + return json.dumps({'message': record.getMessage()}, ensure_ascii=False) |
| 56 | + |
| 57 | + class FakeClient: |
| 58 | + |
| 59 | + def __init__(self): |
| 60 | + self.called_with = None |
| 61 | + |
| 62 | + def setup_logging(self, log_level=logging.INFO): |
| 63 | + self.called_with = log_level |
| 64 | + handler = logging.StreamHandler(buffer) |
| 65 | + handler.setLevel(log_level) |
| 66 | + handler.setFormatter(_JsonFormatter()) |
| 67 | + root = logging.getLogger() |
| 68 | + root.handlers = [handler] |
| 69 | + root.setLevel(log_level) |
| 70 | + root.propagate = False |
| 71 | + |
| 72 | + fake_client = FakeClient() |
| 73 | + client_factory = mock.Mock(return_value=fake_client) |
| 74 | + with mock.patch.object(logs, 'cloud_logging', autospec=True) as mock_module: |
| 75 | + mock_module.Client = client_factory |
| 76 | + logs.setup_adk_logger(level=logging.INFO, log_to_cloud=True) |
| 77 | + logging.getLogger('google_adk.test').info('hello\nworld') |
| 78 | + |
| 79 | + client_factory.assert_called_once() |
| 80 | + self.assertEqual(logging.getLogger('google_adk').level, logging.INFO) |
| 81 | + self.assertEqual(fake_client.called_with, logging.INFO) |
| 82 | + output_lines = [ |
| 83 | + line for line in buffer.getvalue().splitlines() if line.strip() |
| 84 | + ] |
| 85 | + self.assertEqual(len(output_lines), 1) |
| 86 | + entry = json.loads(output_lines[0]) |
| 87 | + self.assertEqual(entry['message'], 'hello\nworld') |
| 88 | + |
| 89 | + def test_log_to_cloud_client_failure_surfaces_error(self): |
| 90 | + """Cloud logging setup failures surface as actionable errors.""" |
| 91 | + |
| 92 | + class FailingClient: |
| 93 | + |
| 94 | + def setup_logging(self, log_level=logging.INFO): |
| 95 | + del log_level |
| 96 | + raise OSError('boom') |
| 97 | + |
| 98 | + client_factory = mock.Mock(return_value=FailingClient()) |
| 99 | + with mock.patch.object(logs, 'cloud_logging', autospec=True) as mock_module: |
| 100 | + mock_module.Client = client_factory |
| 101 | + with self.assertRaises(OSError): |
| 102 | + logs.setup_adk_logger(level=logging.INFO, log_to_cloud=True) |
| 103 | + |
| 104 | + client_factory.assert_called_once() |
| 105 | + |
| 106 | + def test_text_logging_configures_basic_logging(self): |
| 107 | + """Fallback text logging configures default formatter and handlers.""" |
| 108 | + logs.setup_adk_logger(level=logging.ERROR, log_to_cloud=False) |
| 109 | + |
| 110 | + root_logger = logging.getLogger() |
| 111 | + self.assertEqual(root_logger.level, logging.ERROR) |
| 112 | + self.assertTrue(root_logger.handlers) |
| 113 | + handler = root_logger.handlers[0] |
| 114 | + formatter = handler.formatter |
| 115 | + self.assertIsInstance(formatter, logging.Formatter) |
| 116 | + self.assertEqual( |
| 117 | + formatter._style._fmt, # pylint: disable=protected-access |
| 118 | + logs.LOGGING_FORMAT, |
| 119 | + ) |
| 120 | + |
| 121 | + def test_text_logging_sets_adk_logger_level(self): |
| 122 | + """ADK logger level is aligned when text logging is used.""" |
| 123 | + logs.setup_adk_logger(level=logging.WARNING, log_to_cloud=False) |
| 124 | + self.assertEqual(logging.getLogger('google_adk').level, logging.WARNING) |
0 commit comments