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
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
|
# test_log_utils.py -- Tests for log_utils.py
# Copyright (C) 2025 Jelmer Vernooij <jelmer@jelmer.uk>
#
# SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
# Dulwich is dual-licensed under the Apache License, Version 2.0 and the GNU
# General Public License as published by the Free Software Foundation; version 2.0
# or (at your option) any later version. You can redistribute it and/or
# modify it under the terms of either of these two licenses.
#
# 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.
#
# You should have received a copy of the licenses; if not, see
# <http://www.gnu.org/licenses/> for a copy of the GNU General Public License
# and <http://www.apache.org/licenses/LICENSE-2.0> for a copy of the Apache
# License, Version 2.0.
#
"""Tests for dulwich.log_utils."""
import logging
import os
import tempfile
from dulwich.log_utils import (
_DULWICH_LOGGER,
_NULL_HANDLER,
_get_trace_target,
_NullHandler,
_should_trace,
default_logging_config,
getLogger,
remove_null_handler,
)
from . import TestCase
class LogUtilsTests(TestCase):
"""Tests for log_utils."""
def setUp(self) -> None:
super().setUp()
# Save original handler configuration
self.original_handlers = list(_DULWICH_LOGGER.handlers)
# Save original GIT_TRACE value
self.original_git_trace = os.environ.get("GIT_TRACE")
def tearDown(self) -> None:
# Restore original handler configuration
_DULWICH_LOGGER.handlers = self.original_handlers
# Restore original GIT_TRACE value
if self.original_git_trace is None:
os.environ.pop("GIT_TRACE", None)
else:
os.environ["GIT_TRACE"] = self.original_git_trace
super().tearDown()
def _set_git_trace(self, value: str | None) -> None:
"""Helper to set GIT_TRACE environment variable."""
if value is None:
os.environ.pop("GIT_TRACE", None)
else:
os.environ["GIT_TRACE"] = value
def test_null_handler(self) -> None:
"""Test the _NullHandler class."""
handler = _NullHandler()
# Create a test record
record = logging.LogRecord(
name="test",
level=logging.INFO,
pathname="test_log_utils.py",
lineno=1,
msg="Test message",
args=(),
exc_info=None,
)
# Should not raise any exceptions
handler.emit(record)
def test_get_logger(self) -> None:
"""Test the getLogger function."""
# Should return a logger instance
logger = getLogger("dulwich.test")
self.assertIsInstance(logger, logging.Logger)
self.assertEqual(logger.name, "dulwich.test")
def test_remove_null_handler(self) -> None:
"""Test removing the null handler."""
# Make sure _NULL_HANDLER is in the handlers
if _NULL_HANDLER not in _DULWICH_LOGGER.handlers:
_DULWICH_LOGGER.addHandler(_NULL_HANDLER)
# Remove the null handler
remove_null_handler()
# Check that it was removed
self.assertNotIn(_NULL_HANDLER, _DULWICH_LOGGER.handlers)
def test_default_logging_config(self) -> None:
"""Test the default logging configuration."""
# Apply default config
default_logging_config()
# Check that the null handler was removed
self.assertNotIn(_NULL_HANDLER, _DULWICH_LOGGER.handlers)
# Check that the root logger has a handler
root_logger = logging.getLogger()
self.assertTrue(root_logger.handlers)
# Reset the root logger to not affect other tests
root_logger.handlers = []
def test_should_trace_disabled(self) -> None:
"""Test _should_trace with tracing disabled."""
# Test with unset environment variable
self._set_git_trace(None)
self.assertFalse(_should_trace())
# Test with empty string
self._set_git_trace("")
self.assertFalse(_should_trace())
# Test with "0"
self._set_git_trace("0")
self.assertFalse(_should_trace())
# Test with "false" (case insensitive)
self._set_git_trace("false")
self.assertFalse(_should_trace())
self._set_git_trace("FALSE")
self.assertFalse(_should_trace())
def test_should_trace_enabled(self) -> None:
"""Test _should_trace with tracing enabled."""
self._set_git_trace("1")
self.assertTrue(_should_trace())
self._set_git_trace("/tmp/trace.log")
self.assertTrue(_should_trace())
def test_get_trace_target_disabled(self) -> None:
"""Test _get_trace_target with tracing disabled."""
# Test with unset environment variable
self._set_git_trace(None)
self.assertIsNone(_get_trace_target())
# Test with empty string
self._set_git_trace("")
self.assertIsNone(_get_trace_target())
# Test with "0"
self._set_git_trace("0")
self.assertIsNone(_get_trace_target())
# Test with "false"
self._set_git_trace("false")
self.assertIsNone(_get_trace_target())
def test_get_trace_target_stderr(self) -> None:
"""Test _get_trace_target with stderr output."""
# Test with "1"
self._set_git_trace("1")
self.assertEqual(_get_trace_target(), 2)
# Test with "2"
self._set_git_trace("2")
self.assertEqual(_get_trace_target(), 2)
# Test with "true" (case insensitive)
self._set_git_trace("true")
self.assertEqual(_get_trace_target(), 2)
self._set_git_trace("TRUE")
self.assertEqual(_get_trace_target(), 2)
def test_get_trace_target_file_descriptor(self) -> None:
"""Test _get_trace_target with file descriptor."""
for fd in range(3, 10):
self._set_git_trace(str(fd))
self.assertEqual(_get_trace_target(), fd)
# Test out of range values
self._set_git_trace("10")
self.assertIsNone(_get_trace_target())
self._set_git_trace("2")
self.assertEqual(_get_trace_target(), 2) # Special case: stderr
def test_get_trace_target_file(self) -> None:
"""Test _get_trace_target with file path."""
with tempfile.NamedTemporaryFile(mode="w", delete=False) as f:
trace_file = f.name
try:
self._set_git_trace(trace_file)
self.assertEqual(_get_trace_target(), trace_file)
finally:
if os.path.exists(trace_file):
os.unlink(trace_file)
def test_get_trace_target_directory(self) -> None:
"""Test _get_trace_target with directory path."""
with tempfile.TemporaryDirectory() as tmpdir:
self._set_git_trace(tmpdir)
self.assertEqual(_get_trace_target(), tmpdir)
def test_get_trace_target_other_values(self) -> None:
"""Test _get_trace_target with other values."""
# Any non-absolute path should be treated as disabled
self._set_git_trace("relative/path")
self.assertIsNone(_get_trace_target())
def test_default_logging_config_with_trace(self) -> None:
"""Test default_logging_config with GIT_TRACE enabled."""
# Save current root logger state
root_logger = logging.getLogger()
original_level = root_logger.level
original_handlers = list(root_logger.handlers)
# Clean up after test
def cleanup() -> None:
root_logger.handlers = original_handlers
root_logger.level = original_level
self.addCleanup(cleanup)
# Reset root logger to ensure clean state
root_logger.handlers = []
root_logger.level = logging.WARNING
self._set_git_trace("1")
default_logging_config()
# Check that the null handler was removed
self.assertNotIn(_NULL_HANDLER, _DULWICH_LOGGER.handlers)
# Check that the root logger has a handler
self.assertTrue(root_logger.handlers)
# Check that the level is DEBUG when tracing is enabled
self.assertEqual(root_logger.level, logging.DEBUG)
def test_configure_logging_from_trace_file_path(self) -> None:
"""Test _configure_logging_from_trace with file path."""
from dulwich.log_utils import _configure_logging_from_trace
# Save current root logger state
root_logger = logging.getLogger()
original_level = root_logger.level
original_handlers = list(root_logger.handlers)
def cleanup() -> None:
root_logger.handlers = original_handlers
root_logger.level = original_level
self.addCleanup(cleanup)
# Reset root logger
root_logger.handlers = []
root_logger.level = logging.WARNING
# Create a temporary file for trace output
with tempfile.NamedTemporaryFile(mode="w", delete=False) as f:
trace_file = f.name
try:
self._set_git_trace(trace_file)
result = _configure_logging_from_trace()
# Should succeed
self.assertTrue(result)
# Check that the root logger has a handler
self.assertTrue(root_logger.handlers)
self.assertEqual(root_logger.level, logging.DEBUG)
finally:
# Close all handlers to release file locks (needed on Windows)
for handler in root_logger.handlers[:]:
handler.close()
root_logger.removeHandler(handler)
if os.path.exists(trace_file):
os.unlink(trace_file)
def test_configure_logging_from_trace_directory(self) -> None:
"""Test _configure_logging_from_trace with directory path."""
from dulwich.log_utils import _configure_logging_from_trace
# Save current root logger state
root_logger = logging.getLogger()
original_level = root_logger.level
original_handlers = list(root_logger.handlers)
def cleanup() -> None:
root_logger.handlers = original_handlers
root_logger.level = original_level
self.addCleanup(cleanup)
# Reset root logger
root_logger.handlers = []
root_logger.level = logging.WARNING
# Create a temporary directory for trace output
with tempfile.TemporaryDirectory() as tmpdir:
self._set_git_trace(tmpdir)
result = _configure_logging_from_trace()
# Should succeed
self.assertTrue(result)
# Check that the root logger has a handler
self.assertTrue(root_logger.handlers)
self.assertEqual(root_logger.level, logging.DEBUG)
# Check that a file was created in the directory
trace_file = os.path.join(tmpdir, f"trace.{os.getpid()}")
# The file should exist after some logging
root_logger.debug("Test message")
self.assertTrue(os.path.exists(trace_file))
# Close all handlers to release file locks (needed on Windows)
for handler in root_logger.handlers[:]:
handler.close()
root_logger.removeHandler(handler)
def test_configure_logging_from_trace_invalid_file(self) -> None:
"""Test _configure_logging_from_trace with invalid file path."""
from dulwich.log_utils import _configure_logging_from_trace
# Save current root logger state
root_logger = logging.getLogger()
original_level = root_logger.level
original_handlers = list(root_logger.handlers)
def cleanup() -> None:
root_logger.handlers = original_handlers
root_logger.level = original_level
self.addCleanup(cleanup)
# Reset root logger
root_logger.handlers = []
root_logger.level = logging.WARNING
# Use an invalid path (directory that doesn't exist)
self._set_git_trace("/nonexistent/path/trace.log")
result = _configure_logging_from_trace()
# Should fail
self.assertFalse(result)
|
