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
199
200
201
202
203
204
205
206
207
208
|
# Licensed to Elasticsearch B.V. under one or more contributor
# license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright
# ownership. Elasticsearch B.V. licenses this file to you under
# the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
import json
from io import StringIO
from unittest import mock
import pytest
import structlog
import ecs_logging
class NotSerializable:
def __repr__(self):
return "<NotSerializable>"
@pytest.fixture
def event_dict():
return {
"event": "test message",
"log.logger": "logger-name",
"foo": "bar",
"baz": NotSerializable(),
}
@pytest.fixture
def event_dict_with_exception():
return {
"event": "test message",
"log.logger": "logger-name",
"foo": "bar",
"exception": "<stack trace here>",
}
def test_conflicting_event_dict(event_dict):
formatter = ecs_logging.StructlogFormatter()
event_dict["foo.bar"] = "baz"
with pytest.raises(TypeError):
formatter(None, "debug", event_dict)
@mock.patch("time.time")
def test_event_dict_formatted(time, spec_validator, event_dict):
time.return_value = 1584720997.187709
formatter = ecs_logging.StructlogFormatter()
assert spec_validator(formatter(None, "debug", event_dict)) == (
'{"@timestamp":"2020-03-20T16:16:37.187Z","log.level":"debug",'
'"message":"test message",'
'"baz":"<NotSerializable>",'
'"ecs.version":"1.6.0",'
'"foo":"bar",'
'"log":{"logger":"logger-name"}}'
)
@mock.patch("time.time")
def test_can_be_set_as_processor(time, spec_validator):
time.return_value = 1584720997.187709
stream = StringIO()
structlog.configure(
processors=[ecs_logging.StructlogFormatter()],
wrapper_class=structlog.BoundLogger,
context_class=dict,
logger_factory=structlog.PrintLoggerFactory(stream),
)
logger = structlog.get_logger("logger-name")
logger.debug("test message", custom="key", **{"dot.ted": 1})
assert spec_validator(stream.getvalue()) == (
'{"@timestamp":"2020-03-20T16:16:37.187Z","log.level":"debug",'
'"message":"test message","custom":"key","dot":{"ted":1},'
'"ecs.version":"1.6.0"}\n'
)
def test_exception_log_is_ecs_compliant_when_used_with_format_exc_info(
event_dict_with_exception,
):
formatter = ecs_logging.StructlogFormatter()
formatted_event_dict = json.loads(
formatter(None, "debug", event_dict_with_exception)
)
assert (
"exception" not in formatted_event_dict
), "The key 'exception' at the root of a log is not ECS-compliant"
assert "error" in formatted_event_dict
assert "stack_trace" in formatted_event_dict["error"]
assert "<stack trace here>" in formatted_event_dict["error"]["stack_trace"]
@mock.patch("time.time")
def test_ensure_ascii_default(time):
"""Test that ensure_ascii defaults to True (escaping non-ASCII characters)"""
time.return_value = 1584720997.187709
formatter = ecs_logging.StructlogFormatter()
result = formatter(None, "debug", {"event": "Hello 世界", "log.logger": "test"})
# With ensure_ascii=True (default), non-ASCII characters should be escaped
assert "\\u4e16\\u754c" in result
assert "世界" not in result
# Verify the JSON is valid
parsed = json.loads(result)
assert parsed["message"] == "Hello 世界"
@mock.patch("time.time")
def test_ensure_ascii_true(time):
"""Test that ensure_ascii=True escapes non-ASCII characters"""
time.return_value = 1584720997.187709
formatter = ecs_logging.StructlogFormatter(ensure_ascii=True)
result = formatter(None, "info", {"event": "Café ☕", "log.logger": "test"})
# With ensure_ascii=True, non-ASCII characters should be escaped
assert "\\u00e9" in result # é is escaped
assert "\\u2615" in result # ☕ is escaped
assert "Café" not in result
assert "☕" not in result
# Verify the JSON is valid and correctly decoded
parsed = json.loads(result)
assert parsed["message"] == "Café ☕"
@mock.patch("time.time")
def test_ensure_ascii_false(time):
"""Test that ensure_ascii=False preserves non-ASCII characters"""
time.return_value = 1584720997.187709
formatter = ecs_logging.StructlogFormatter(ensure_ascii=False)
result = formatter(None, "debug", {"event": "Hello 世界", "log.logger": "test"})
# With ensure_ascii=False, non-ASCII characters should be preserved
assert "世界" in result
assert "\\u4e16" not in result
# Verify the JSON is valid
parsed = json.loads(result)
assert parsed["message"] == "Hello 世界"
@mock.patch("time.time")
def test_ensure_ascii_false_with_emoji(time):
"""Test that ensure_ascii=False preserves emoji and special characters"""
time.return_value = 1584720997.187709
formatter = ecs_logging.StructlogFormatter(ensure_ascii=False)
result = formatter(None, "info", {"event": "Café ☕ 你好", "log.logger": "test"})
# With ensure_ascii=False, all non-ASCII characters should be preserved
assert "Café" in result
assert "☕" in result
assert "你好" in result
# Verify the JSON is valid and correctly decoded
parsed = json.loads(result)
assert parsed["message"] == "Café ☕ 你好"
@mock.patch("time.time")
def test_ensure_ascii_with_custom_fields(time):
"""Test that ensure_ascii works with custom fields containing non-ASCII"""
time.return_value = 1584720997.187709
formatter = ecs_logging.StructlogFormatter(ensure_ascii=False)
result = formatter(
None,
"info",
{
"event": "Test",
"log.logger": "test",
"user": "用户",
"city": "北京",
},
)
# With ensure_ascii=False, non-ASCII in custom fields should be preserved
assert "用户" in result
assert "北京" in result
# Verify the JSON is valid
parsed = json.loads(result)
assert parsed["user"] == "用户"
assert parsed["city"] == "北京"
|
