github/OpenHands
1
0
Fork 0
mirror of https://github.com/OpenHands/OpenHands.git synced 2025-12-26 05:48:36 +08:00
Code Issues Packages Projects Releases Wiki Activity
OpenHands/enterprise/tests/unit/test_logger.py
Ray Myers e37f7b0e0f
Enterprise code and docker build (#10770)
2025-09-04 15:44:54 -04:00

270 lines
17 KiB
Python
Raw Blame History

import json
import logging
import os
from io import StringIO
from unittest.mock import patch
import pytest
from server.logger import format_stack, setup_json_logger
from openhands.core.logger import openhands_logger
@pytest.fixture
def log_output():
"""Fixture to capture log output"""
string_io = StringIO()
logger = logging.Logger('test')
setup_json_logger(logger, 'INFO', _out=string_io)
return logger, string_io
class TestLogOutput:
def test_info(self, log_output):
logger, string_io = log_output
logger.info('Test message')
output = json.loads(string_io.getvalue())
assert output == {'message': 'Test message', 'severity': 'INFO'}
def test_error(self, log_output):
logger, string_io = log_output
logger.error('Test message')
output = json.loads(string_io.getvalue())
assert output == {'message': 'Test message', 'severity': 'ERROR'}
def test_extra_fields(self, log_output):
logger, string_io = log_output
logger.info('Test message', extra={'key': '..val..'})
output = json.loads(string_io.getvalue())
assert output == {
'key': '..val..',
'message': 'Test message',
'severity': 'INFO',
}
def test_format_stack(self):
stack = (
'" + Exception Group Traceback (most recent call last):\n'
''
' | File "/app/.venv/lib/python3.12/site-packages/starlette/_utils.py", line 76, in collapse_excgroups\n'
' | yield\n'
' | File "/app/.venv/lib/python3.12/site-packages/starlette/middleware/base.py", line 174, in __call__\n'
' | async with anyio.create_task_group() as task_group:\n'
' | File "/app/.venv/lib/python3.12/site-packages/anyio/_backends/_asyncio.py", line 772, in __aexit__\n'
' | raise BaseExceptionGroup(\n'
' | ExceptionGroup: unhandled errors in a TaskGroup (1 sub-exception)\n'
' +-+---------------- 1 ----------------\n'
' | Traceback (most recent call last):\n'
' | File "/app/.venv/lib/python3.12/site-packages/uvicorn/protocols/http/h11_impl.py", line 403, in run_asgi\n'
' | result = await app( # type: ignore[func-returns-value]\n'
' | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n'
' | File "/app/.venv/lib/python3.12/site-packages/uvicorn/middleware/proxy_headers.py", line 60, in __call__\n'
' | return await self.app(scope, receive, send)\n'
' | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n'
' | File "/app/.venv/lib/python3.12/site-packages/engineio/async_drivers/asgi.py", line 75, in __call__\n'
' | await self.other_asgi_app(scope, receive, send)\n'
' | File "/app/.venv/lib/python3.12/site-packages/fastapi/applications.py", line 1054, in __call__\n'
' | await super().__call__(scope, receive, send)\n'
' | File "/app/.venv/lib/python3.12/site-packages/starlette/applications.py", line 112, in __call__\n'
' | await self.middleware_stack(scope, receive, send)\n'
' | File "/app/.venv/lib/python3.12/site-packages/starlette/middleware/errors.py", line 187, in __call__\n'
' | raise exc\n'
' | File "/app/.venv/lib/python3.12/site-packages/starlette/middleware/errors.py", line 165, in __call__\n'
' | await self.app(scope, receive, _send)\n'
' | File "/app/.venv/lib/python3.12/site-packages/starlette/middleware/base.py", line 173, in __call__\n'
' | with recv_stream, send_stream, collapse_excgroups():\n'
' | File "/usr/local/lib/python3.12/contextlib.py", line 158, in __exit__\n'
' | self.gen.throw(value)\n'
' | File "/app/.venv/lib/python3.12/site-packages/starlette/_utils.py", line 82, in collapse_excgroups\n'
' | raise exc\n'
' | File "/app/.venv/lib/python3.12/site-packages/starlette/middleware/base.py", line 175, in __call__\n'
' | response = await self.dispatch_func(request, call_next)\n'
' | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n'
' | File "/app/server/middleware.py", line 66, in __call__\n'
' | self._check_tos(request)\n'
' | File "/app/server/middleware.py", line 110, in _check_tos\n'
' | decoded = jwt.decode(\n'
' | ^^^^^^^^^^^\n'
' | File "/app/.venv/lib/python3.12/site-packages/jwt/api_jwt.py", line 222, in decode\n'
' | decoded = self.decode_complete(\n'
' | ^^^^^^^^^^^^^^^^^^^^^\n'
' | File "/app/.venv/lib/python3.12/site-packages/jwt/api_jwt.py", line 156, in decode_complete\n'
' | decoded = api_jws.decode_complete(\n'
' | ^^^^^^^^^^^^^^^^^^^^^^^^\n'
' | File "/app/.venv/lib/python3.12/site-packages/jwt/api_jws.py", line 220, in decode_complete\n'
' | self._verify_signature(signing_input, header, signature, key, algorithms)\n'
' | File "/app/.venv/lib/python3.12/site-packages/jwt/api_jws.py", line 328, in _verify_signature\n'
' | raise InvalidSignatureError("Signature verification failed")\n'
' | jwt.exceptions.InvalidSignatureError: Signature verification failed\n'
' +------------------------------------\n'
'\n'
'During handling of the above exception, another exception occurred:\n'
'\n'
'Traceback (most recent call last):\n'
' File "/app/.venv/lib/python3.12/site-packages/uvicorn/protocols/http/h11_impl.py", line 403, in run_asgi\n'
' result = await app( # type: ignore[func-returns-value]\n'
' ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n'
' File "/app/.venv/lib/python3.12/site-packages/uvicorn/middleware/proxy_headers.py", line 60, in __call__\n'
' return await self.app(scope, receive, send)\n'
' ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n'
' File "/app/.venv/lib/python3.12/site-packages/engineio/async_drivers/asgi.py", line 75, in __call__\n'
' await self.other_asgi_app(scope, receive, send)\n'
' File "/app/.venv/lib/python3.12/site-packages/fastapi/applications.py", line 1054, in __call__\n'
' await super().__call__(scope, receive, send)\n'
' File "/app/.venv/lib/python3.12/site-packages/starlette/applications.py", line 112, in __call__\n'
' await self.middleware_stack(scope, receive, send)\n'
' File "/app/.venv/lib/python3.12/site-packages/starlette/middleware/errors.py", line 187, in __call__\n'
' raise exc\n'
' File "/app/.venv/lib/python3.12/site-packages/starlette/middleware/errors.py", line 165, in __call__\n'
' await self.app(scope, receive, _send)\n'
' File "/app/.venv/lib/python3.12/site-packages/starlette/middleware/base.py", line 173, in __call__\n'
' with recv_stream, send_stream, collapse_excgroups():\n'
' File "/usr/local/lib/python3.12/contextlib.py", line 158, in __exit__\n'
' self.gen.throw(value)\n'
' File "/app/.venv/lib/python3.12/site-packages/starlette/_utils.py", line 82, in collapse_excgroups\n'
' raise exc\n'
' File "/app/.venv/lib/python3.12/site-packages/starlette/middleware/base.py", line 175, in __call__\n'
' response = await self.dispatch_func(request, call_next)\n'
' ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n'
' File "/app/server/middleware.py", line 66, in __call__\n'
' self._check_tos(request)\n'
' File "/app/server/middleware.py", line 110, in _check_tos\n'
' decoded = jwt.decode(\n'
' ^^^^^^^^^^^\n'
' File "/app/.venv/lib/python3.12/site-packages/jwt/api_jwt.py", line 222, in decode\n'
' decoded = self.decode_complete(\n'
' ^^^^^^^^^^^^^^^^^^^^^\n'
' File "/app/.venv/lib/python3.12/site-packages/jwt/api_jwt.py", line 156, in decode_complete\n'
' decoded = api_jws.decode_complete(\n'
' ^^^^^^^^^^^^^^^^^^^^^^^^\n'
' File "/app/.venv/lib/python3.12/site-packages/jwt/api_jws.py", line 220, in decode_complete\n'
' self._verify_signature(signing_input, header, signature, key, algorithms)\n'
' File "/app/.venv/lib/python3.12/site-packages/jwt/api_jws.py", line 328, in _verify_signature\n'
' raise InvalidSignatureError("Signature verification failed")\n'
'jwt.exceptions.InvalidSignatureError: Signature verification failed"'
)
with (
patch('server.logger.LOG_JSON_FOR_CONSOLE', 1),
patch('server.logger.CWD_PREFIX', 'File "/app/'),
patch(
'server.logger.SITE_PACKAGES_PREFIX',
'File "/app/.venv/lib/python3.12/site-packages/',
),
):
formatted = format_stack(stack)
expected = [
"' + Exception Group Traceback (most recent call last):",
" | File 'starlette/_utils.py', line 76, in collapse_excgroups",
' | yield',
" | File 'starlette/middleware/base.py', line 174, in __call__",
' | async with anyio.create_task_group() as task_group:',
" | File 'anyio/_backends/_asyncio.py', line 772, in __aexit__",
' | raise BaseExceptionGroup(',
' | ExceptionGroup: unhandled errors in a TaskGroup (1 sub-exception)',
' +-+---------------- 1 ----------------',
' | Traceback (most recent call last):',
" | File 'uvicorn/protocols/http/h11_impl.py', line 403, in run_asgi",
' | result = await app( # type: ignore[func-returns-value]',
' | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^',
" | File 'uvicorn/middleware/proxy_headers.py', line 60, in __call__",
' | return await self.app(scope, receive, send)',
' | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^',
" | File 'engineio/async_drivers/asgi.py', line 75, in __call__",
' | await self.other_asgi_app(scope, receive, send)',
" | File 'fastapi/applications.py', line 1054, in __call__",
' | await super().__call__(scope, receive, send)',
" | File 'starlette/applications.py', line 112, in __call__",
' | await self.middleware_stack(scope, receive, send)',
" | File 'starlette/middleware/errors.py', line 187, in __call__",
' | raise exc',
" | File 'starlette/middleware/errors.py', line 165, in __call__",
' | await self.app(scope, receive, _send)',
" | File 'starlette/middleware/base.py', line 173, in __call__",
' | with recv_stream, send_stream, collapse_excgroups():',
" | File '/usr/local/lib/python3.12/contextlib.py', line 158, in __exit__",
' | self.gen.throw(value)',
" | File 'starlette/_utils.py', line 82, in collapse_excgroups",
' | raise exc',
" | File 'starlette/middleware/base.py', line 175, in __call__",
' | response = await self.dispatch_func(request, call_next)',
' | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^',
" | File 'server/middleware.py', line 66, in __call__",
' | self._check_tos(request)',
" | File 'server/middleware.py', line 110, in _check_tos",
' | decoded = jwt.decode(',
' | ^^^^^^^^^^^',
" | File 'jwt/api_jwt.py', line 222, in decode",
' | decoded = self.decode_complete(',
' | ^^^^^^^^^^^^^^^^^^^^^',
" | File 'jwt/api_jwt.py', line 156, in decode_complete",
' | decoded = api_jws.decode_complete(',
' | ^^^^^^^^^^^^^^^^^^^^^^^^',
" | File 'jwt/api_jws.py', line 220, in decode_complete",
' | self._verify_signature(signing_input, header, signature, key, algorithms)',
" | File 'jwt/api_jws.py', line 328, in _verify_signature",
" | raise InvalidSignatureError('Signature verification failed')",
' | jwt.exceptions.InvalidSignatureError: Signature verification failed',
' +------------------------------------',
'',
'During handling of the above exception, another exception occurred:',
'',
'Traceback (most recent call last):',
" File 'uvicorn/protocols/http/h11_impl.py', line 403, in run_asgi",
' result = await app( # type: ignore[func-returns-value]',
' ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^',
" File 'uvicorn/middleware/proxy_headers.py', line 60, in __call__",
' return await self.app(scope, receive, send)',
' ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^',
" File 'engineio/async_drivers/asgi.py', line 75, in __call__",
' await self.other_asgi_app(scope, receive, send)',
" File 'fastapi/applications.py', line 1054, in __call__",
' await super().__call__(scope, receive, send)',
" File 'starlette/applications.py', line 112, in __call__",
' await self.middleware_stack(scope, receive, send)',
" File 'starlette/middleware/errors.py', line 187, in __call__",
' raise exc',
" File 'starlette/middleware/errors.py', line 165, in __call__",
' await self.app(scope, receive, _send)',
" File 'starlette/middleware/base.py', line 173, in __call__",
' with recv_stream, send_stream, collapse_excgroups():',
" File '/usr/local/lib/python3.12/contextlib.py', line 158, in __exit__",
' self.gen.throw(value)',
" File 'starlette/_utils.py', line 82, in collapse_excgroups",
' raise exc',
" File 'starlette/middleware/base.py', line 175, in __call__",
' response = await self.dispatch_func(request, call_next)',
' ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^',
" File 'server/middleware.py', line 66, in __call__",
' self._check_tos(request)',
" File 'server/middleware.py', line 110, in _check_tos",
' decoded = jwt.decode(',
' ^^^^^^^^^^^',
" File 'jwt/api_jwt.py', line 222, in decode",
' decoded = self.decode_complete(',
' ^^^^^^^^^^^^^^^^^^^^^',
" File 'jwt/api_jwt.py', line 156, in decode_complete",
' decoded = api_jws.decode_complete(',
' ^^^^^^^^^^^^^^^^^^^^^^^^',
" File 'jwt/api_jws.py', line 220, in decode_complete",
' self._verify_signature(signing_input, header, signature, key, algorithms)',
" File 'jwt/api_jws.py', line 328, in _verify_signature",
" raise InvalidSignatureError('Signature verification failed')",
"jwt.exceptions.InvalidSignatureError: Signature verification failed'",
]
assert formatted == expected
def test_filtering(self):
# Ensure that secret values are still filtered
string_io = StringIO()
with (
patch.dict(os.environ, {'my_secret_key': 'supersecretvalue'}),
patch.object(openhands_logger.handlers[0], 'stream', string_io),
):
openhands_logger.info('The secret key was supersecretvalue')
output = json.loads(string_io.getvalue())
assert output == {'message': 'The secret key was ******', 'severity': 'INFO'}
Reference in New Issue View Git Blame Copy Permalink