1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
|
import datetime
import platform
from unittest import mock
import pytest
import aiohttp
from aiohttp import web
from aiohttp.abc import AbstractAccessLogger
from aiohttp.helpers import PY_37
from aiohttp.typedefs import Handler
from aiohttp.web_log import AccessLogger
try:
from contextvars import ContextVar
except ImportError:
ContextVar = None
IS_PYPY = platform.python_implementation() == "PyPy"
def test_access_logger_format() -> None:
log_format = '%T "%{ETag}o" %X {X} %%P'
mock_logger = mock.Mock()
access_logger = AccessLogger(mock_logger, log_format)
expected = '%s "%s" %%X {X} %%%s'
assert expected == access_logger._log_format
@pytest.mark.skipif(
IS_PYPY,
reason="""
Because of patching :py:class:`datetime.datetime`, under PyPy it
fails in :py:func:`isinstance` call in
:py:meth:`datetime.datetime.__sub__` (called from
:py:meth:`aiohttp.AccessLogger._format_t`):
*** TypeError: isinstance() arg 2 must be a class, type, or tuple of classes and types
(Pdb) from datetime import datetime
(Pdb) isinstance(now, datetime)
*** TypeError: isinstance() arg 2 must be a class, type, or tuple of classes and types
(Pdb) datetime.__class__
<class 'unittest.mock.MagicMock'>
(Pdb) isinstance(now, datetime.__class__)
False
Ref: https://bitbucket.org/pypy/pypy/issues/1187/call-to-isinstance-in-__sub__-self-other
Ref: https://github.com/celery/celery/issues/811
Ref: https://stackoverflow.com/a/46102240/595220
""", # noqa: E501
)
def test_access_logger_atoms(mocker) -> None:
utcnow = datetime.datetime(1843, 1, 1, 0, 30)
mock_datetime = mocker.patch("datetime.datetime")
mock_getpid = mocker.patch("os.getpid")
mock_datetime.utcnow.return_value = utcnow
mock_getpid.return_value = 42
log_format = '%a %t %P %r %s %b %T %Tf %D "%{H1}i" "%{H2}i"'
mock_logger = mock.Mock()
access_logger = AccessLogger(mock_logger, log_format)
request = mock.Mock(
headers={"H1": "a", "H2": "b"},
method="GET",
path_qs="/path",
version=aiohttp.HttpVersion(1, 1),
remote="127.0.0.2",
)
response = mock.Mock(headers={}, body_length=42, status=200)
access_logger.log(request, response, 3.1415926)
assert not mock_logger.exception.called
expected = (
"127.0.0.2 [01/Jan/1843:00:29:56 +0000] <42> "
'GET /path HTTP/1.1 200 42 3 3.141593 3141593 "a" "b"'
)
extra = {
"first_request_line": "GET /path HTTP/1.1",
"process_id": "<42>",
"remote_address": "127.0.0.2",
"request_start_time": "[01/Jan/1843:00:29:56 +0000]",
"request_time": "3",
"request_time_frac": "3.141593",
"request_time_micro": "3141593",
"response_size": 42,
"response_status": 200,
"request_header": {"H1": "a", "H2": "b"},
}
mock_logger.info.assert_called_with(expected, extra=extra)
def test_access_logger_dicts() -> None:
log_format = "%{User-Agent}i %{Content-Length}o %{None}i"
mock_logger = mock.Mock()
access_logger = AccessLogger(mock_logger, log_format)
request = mock.Mock(
headers={"User-Agent": "Mock/1.0"}, version=(1, 1), remote="127.0.0.2"
)
response = mock.Mock(headers={"Content-Length": 123})
access_logger.log(request, response, 0.0)
assert not mock_logger.error.called
expected = "Mock/1.0 123 -"
extra = {
"request_header": {"User-Agent": "Mock/1.0", "None": "-"},
"response_header": {"Content-Length": 123},
}
mock_logger.info.assert_called_with(expected, extra=extra)
def test_access_logger_unix_socket() -> None:
log_format = "|%a|"
mock_logger = mock.Mock()
access_logger = AccessLogger(mock_logger, log_format)
request = mock.Mock(headers={"User-Agent": "Mock/1.0"}, version=(1, 1), remote="")
response = mock.Mock()
access_logger.log(request, response, 0.0)
assert not mock_logger.error.called
expected = "||"
mock_logger.info.assert_called_with(expected, extra={"remote_address": ""})
def test_logger_no_message() -> None:
mock_logger = mock.Mock()
access_logger = AccessLogger(mock_logger, "%r %{content-type}i")
extra_dict = {
"first_request_line": "-",
"request_header": {"content-type": "(no headers)"},
}
access_logger.log(None, None, 0.0)
mock_logger.info.assert_called_with("- (no headers)", extra=extra_dict)
def test_logger_internal_error() -> None:
mock_logger = mock.Mock()
access_logger = AccessLogger(mock_logger, "%D")
access_logger.log(None, None, "invalid")
mock_logger.exception.assert_called_with("Error in logging")
def test_logger_no_transport() -> None:
mock_logger = mock.Mock()
access_logger = AccessLogger(mock_logger, "%a")
access_logger.log(None, None, 0)
mock_logger.info.assert_called_with("-", extra={"remote_address": "-"})
def test_logger_abc() -> None:
class Logger(AbstractAccessLogger):
def log(self, request, response, time):
1 / 0
mock_logger = mock.Mock()
access_logger = Logger(mock_logger, None)
with pytest.raises(ZeroDivisionError):
access_logger.log(None, None, None)
class Logger(AbstractAccessLogger):
def log(self, request, response, time):
self.logger.info(
self.log_format.format(request=request, response=response, time=time)
)
mock_logger = mock.Mock()
access_logger = Logger(mock_logger, "{request} {response} {time}")
access_logger.log("request", "response", 1)
mock_logger.info.assert_called_with("request response 1")
@pytest.mark.skipif(not PY_37, reason="contextvars support is required")
async def test_contextvars_logger(aiohttp_server, aiohttp_client):
VAR = ContextVar("VAR")
async def handler(request):
return web.Response()
@web.middleware
async def middleware(request, handler: Handler):
VAR.set("uuid")
return await handler(request)
msg = None
class Logger(AbstractAccessLogger):
def log(self, request, response, time):
nonlocal msg
msg = f"contextvars: {VAR.get()}"
app = web.Application(middlewares=[middleware])
app.router.add_get("/", handler)
server = await aiohttp_server(app, access_log_class=Logger)
client = await aiohttp_client(server)
resp = await client.get("/")
assert 200 == resp.status
assert msg == "contextvars: uuid"
|
